blob: 8436c8a0dfc3d1afcf1cc97f5cc7dfb6021a2544 [file] [log] [blame]
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001*options.txt* For Vim version 8.1. Last change: 2019 Sep 28
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 Moolenaarb6be1e22015-07-10 18:18:40 +02001922 noinsert Do not insert any text for a match until the user selects
1923 a match from the menu. Only works in combination with
1924 "menu" or "menuone". No effect if "longest" is present.
1925
1926 noselect Do not select a match in the menu, force the user to
1927 select one from the menu. Only works in combination with
1928 "menu" or "menuone".
1929
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001930
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001931 *'completepopup'* *'cpp'*
1932'completepopup' 'cpp' string (default empty)
1933 global
1934 {not available when compiled without the |+textprop|
1935 or |+quickfix| feature}
1936 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar06fe74a2019-08-31 16:20:32 +02001937 properties of the info popup when it is created. You can also use
1938 |popup_findinfo()| and then set properties for an existing info popup
1939 with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001940
1941
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001942 *'concealcursor'* *'cocu'*
1943'concealcursor' 'cocu' string (default: "")
1944 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001945 {not available when compiled without the |+conceal|
1946 feature}
1947 Sets the modes in which text in the cursor line can also be concealed.
1948 When the current mode is listed then concealing happens just like in
1949 other lines.
1950 n Normal mode
1951 v Visual mode
1952 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001953 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001954
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001955 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001956 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001957 are moving around text is concealed, but when starting to insert text
1958 or selecting a Visual area the concealed text is displayed, so that
1959 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001960 Keep in mind that the cursor position is not always where it's
1961 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001962
1963
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001964 *'conceallevel'* *'cole'*
1965'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001966 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001967 {not available when compiled without the |+conceal|
1968 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001969 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1970 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001971
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001972 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001973 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001974 1 Each block of concealed text is replaced with one
1975 character. If the syntax item does not have a custom
1976 replacement character defined (see |:syn-cchar|) the
1977 character defined in 'listchars' is used (default is a
1978 space).
1979 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001980 2 Concealed text is completely hidden unless it has a
1981 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001982 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001983 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001984
Bram Moolenaara7781e02010-07-19 20:13:22 +02001985 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001986 edit and copy the text. This can be changed with the 'concealcursor'
1987 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001988
Bram Moolenaar071d4272004-06-13 20:20:40 +00001989 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1990'confirm' 'cf' boolean (default off)
1991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992 When 'confirm' is on, certain operations that would normally
1993 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1994 instead raise a |dialog| asking if you wish to save the current
1995 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1996 If 'confirm' is off you can still activate confirmation for one
1997 command only (this is most useful in mappings) with the |:confirm|
1998 command.
1999 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2000
2001 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2002'conskey' 'consk' boolean (default off)
2003 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002004 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005
2006 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2007'copyindent' 'ci' boolean (default off)
2008 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 Copy the structure of the existing lines indent when autoindenting a
2010 new line. Normally the new indent is reconstructed by a series of
2011 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2012 in which case only spaces are used). Enabling this option makes the
2013 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002014 existing line. 'expandtab' has no effect on these characters, a Tab
2015 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002017 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018 Also see 'preserveindent'.
2019
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002020 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021'cpoptions' 'cpo' string (Vim default: "aABceFs",
2022 Vi default: all flags)
2023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002025 this indicates Vi-compatible behavior. This is used for things where
2026 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 'cpoptions' stands for "compatible-options".
2028 Commas can be added for readability.
2029 To avoid problems with flags that are added in the future, use the
2030 "+=" and "-=" feature of ":set" |add-option-flags|.
2031 NOTE: This option is set to the Vi default value when 'compatible' is
2032 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002033 NOTE: This option is set to the POSIX default value at startup when
2034 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002035 variable exists |posix|. This means Vim tries to behave like the
2036 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037
2038 contains behavior ~
2039 *cpo-a*
2040 a When included, a ":read" command with a file name
2041 argument will set the alternate file name for the
2042 current window.
2043 *cpo-A*
2044 A When included, a ":write" command with a file name
2045 argument will set the alternate file name for the
2046 current window.
2047 *cpo-b*
2048 b "\|" in a ":map" command is recognized as the end of
2049 the map command. The '\' is included in the mapping,
2050 the text after the '|' is interpreted as the next
2051 command. Use a CTRL-V instead of a backslash to
2052 include the '|' in the mapping. Applies to all
2053 mapping, abbreviation, menu and autocmd commands.
2054 See also |map_bar|.
2055 *cpo-B*
2056 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002057 abbreviations, user commands and the "to" part of the
2058 menu commands. Remove this flag to be able to use a
2059 backslash like a CTRL-V. For example, the command
2060 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061 'B' included: "\^[" (^[ is a real <Esc>)
2062 'B' excluded: "<Esc>" (5 characters)
2063 ('<' excluded in both cases)
2064 *cpo-c*
2065 c Searching continues at the end of any match at the
2066 cursor position, but not further than the start of the
2067 next line. When not present searching continues
2068 one character from the cursor position. With 'c'
2069 "abababababab" only gets three matches when repeating
2070 "/abab", without 'c' there are five matches.
2071 *cpo-C*
2072 C Do not concatenate sourced lines that start with a
2073 backslash. See |line-continuation|.
2074 *cpo-d*
2075 d Using "./" in the 'tags' option doesn't mean to use
2076 the tags file relative to the current file, but the
2077 tags file in the current directory.
2078 *cpo-D*
2079 D Can't use CTRL-K to enter a digraph after Normal mode
2080 commands with a character argument, like |r|, |f| and
2081 |t|.
2082 *cpo-e*
2083 e When executing a register with ":@r", always add a
2084 <CR> to the last line, also when the register is not
2085 linewise. If this flag is not present, the register
2086 is not linewise and the last line does not end in a
2087 <CR>, then the last line is put on the command-line
2088 and can be edited before hitting <CR>.
2089 *cpo-E*
2090 E It is an error when using "y", "d", "c", "g~", "gu" or
2091 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002092 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093 This makes "y0" fail in the first column.
2094 *cpo-f*
2095 f When included, a ":read" command with a file name
2096 argument will set the file name for the current buffer,
2097 if the current buffer doesn't have a file name yet.
2098 *cpo-F*
2099 F When included, a ":write" command with a file name
2100 argument will set the file name for the current
2101 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002102 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103 *cpo-g*
2104 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002105 *cpo-H*
2106 H When using "I" on a line with only blanks, insert
2107 before the last blank. Without this flag insert after
2108 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109 *cpo-i*
2110 i When included, interrupting the reading of a file will
2111 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002112 *cpo-I*
2113 I When moving the cursor up or down just after inserting
2114 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002115 *cpo-j*
2116 j When joining lines, only add two spaces after a '.',
2117 not after '!' or '?'. Also see 'joinspaces'.
2118 *cpo-J*
2119 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002120 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121 white space.
2122 *cpo-k*
2123 k Disable the recognition of raw key codes in
2124 mappings, abbreviations, and the "to" part of menu
2125 commands. For example, if <Key> sends ^[OA (where ^[
2126 is <Esc>), the command ":map X ^[OA" results in X
2127 being mapped to:
2128 'k' included: "^[OA" (3 characters)
2129 'k' excluded: "<Key>" (one key code)
2130 Also see the '<' flag below.
2131 *cpo-K*
2132 K Don't wait for a key code to complete when it is
2133 halfway a mapping. This breaks mapping <F1><F1> when
2134 only part of the second <F1> has been read. It
2135 enables cancelling the mapping by typing <F1><Esc>.
2136 *cpo-l*
2137 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002138 literally, only "\]", "\^", "\-" and "\\" are special.
2139 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2141 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002142 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002143 *cpo-L*
2144 L When the 'list' option is set, 'wrapmargin',
2145 'textwidth', 'softtabstop' and Virtual Replace mode
2146 (see |gR|) count a <Tab> as two characters, instead of
2147 the normal behavior of a <Tab>.
2148 *cpo-m*
2149 m When included, a showmatch will always wait half a
2150 second. When not included, a showmatch will wait half
2151 a second or until a character is typed. |'showmatch'|
2152 *cpo-M*
2153 M When excluded, "%" matching will take backslashes into
2154 account. Thus in "( \( )" and "\( ( \)" the outer
2155 parenthesis match. When included "%" ignores
2156 backslashes, which is Vi compatible.
2157 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002158 n When included, the column used for 'number' and
2159 'relativenumber' will also be used for text of wrapped
2160 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161 *cpo-o*
2162 o Line offset to search command is not remembered for
2163 next search.
2164 *cpo-O*
2165 O Don't complain if a file is being overwritten, even
2166 when it didn't exist when editing it. This is a
2167 protection against a file unexpectedly created by
2168 someone else. Vi didn't complain about this.
2169 *cpo-p*
2170 p Vi compatible Lisp indenting. When not present, a
2171 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002172 *cpo-P*
2173 P When included, a ":write" command that appends to a
2174 file will set the file name for the current buffer, if
2175 the current buffer doesn't have a file name yet and
2176 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002177 *cpo-q*
2178 q When joining multiple lines leave the cursor at the
2179 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180 *cpo-r*
2181 r Redo ("." command) uses "/" to repeat a search
2182 command, instead of the actually used search string.
2183 *cpo-R*
2184 R Remove marks from filtered lines. Without this flag
2185 marks are kept like |:keepmarks| was used.
2186 *cpo-s*
2187 s Set buffer options when entering the buffer for the
2188 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002189 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190 set when the buffer is created.
2191 *cpo-S*
2192 S Set buffer options always when entering a buffer
2193 (except 'readonly', 'fileformat', 'filetype' and
2194 'syntax'). This is the (most) Vi compatible setting.
2195 The options are set to the values in the current
2196 buffer. When you change an option and go to another
2197 buffer, the value is copied. Effectively makes the
2198 buffer options global to all buffers.
2199
2200 's' 'S' copy buffer options
2201 no no when buffer created
2202 yes no when buffer first entered (default)
2203 X yes each time when buffer entered (vi comp.)
2204 *cpo-t*
2205 t Search pattern for the tag command is remembered for
2206 "n" command. Otherwise Vim only puts the pattern in
2207 the history for search pattern, but doesn't change the
2208 last used search pattern.
2209 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002210 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211 *cpo-v*
2212 v Backspaced characters remain visible on the screen in
2213 Insert mode. Without this flag the characters are
2214 erased from the screen right away. With this flag the
2215 screen newly typed text overwrites backspaced
2216 characters.
2217 *cpo-w*
2218 w When using "cw" on a blank character, only change one
2219 character and not all blanks until the start of the
2220 next word.
2221 *cpo-W*
2222 W Don't overwrite a readonly file. When omitted, ":w!"
2223 overwrites a readonly file, if possible.
2224 *cpo-x*
2225 x <Esc> on the command-line executes the command-line.
2226 The default in Vim is to abandon the command-line,
2227 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002228 *cpo-X*
2229 X When using a count with "R" the replaced text is
2230 deleted only once. Also when repeating "R" with "."
2231 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002233 y A yank command can be redone with ".". Think twice if
2234 you really want to use this, it may break some
2235 plugins, since most people expect "." to only repeat a
2236 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002237 *cpo-Z*
2238 Z When using "w!" while the 'readonly' option is set,
2239 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 *cpo-!*
2241 ! When redoing a filter command, use the last used
2242 external command, whatever it was. Otherwise the last
2243 used -filter- command is used.
2244 *cpo-$*
2245 $ When making a change to one line, don't redisplay the
2246 line, but put a '$' at the end of the changed text.
2247 The changed text will be overwritten when you type the
2248 new text. The line is redisplayed if you type any
2249 command that moves the cursor from the insertion
2250 point.
2251 *cpo-%*
2252 % Vi-compatible matching is done for the "%" command.
2253 Does not recognize "#if", "#endif", etc.
2254 Does not recognize "/*" and "*/".
2255 Parens inside single and double quotes are also
2256 counted, causing a string that contains a paren to
2257 disturb the matching. For example, in a line like
2258 "if (strcmp("foo(", s))" the first paren does not
2259 match the last one. When this flag is not included,
2260 parens inside single and double quotes are treated
2261 specially. When matching a paren outside of quotes,
2262 everything inside quotes is ignored. When matching a
2263 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002264 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002265 This flag is also used for other features, such as
2266 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002267 *cpo--*
2268 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002269 it would go above the first line or below the last
2270 line. Without it the cursor moves to the first or
2271 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002272 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002273 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002274 *cpo-+*
2275 + When included, a ":write file" command will reset the
2276 'modified' flag of the buffer, even though the buffer
2277 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002278 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 * Use ":*" in the same way as ":@". When not included,
2280 ":*" is an alias for ":'<,'>", select the Visual area.
2281 *cpo-<*
2282 < Disable the recognition of special key codes in |<>|
2283 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002284 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285 ":map X <Tab>" results in X being mapped to:
2286 '<' included: "<Tab>" (5 characters)
2287 '<' excluded: "^I" (^I is a real <Tab>)
2288 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002289 *cpo->*
2290 > When appending to a register, put a line break before
2291 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002292 *cpo-;*
2293 ; When using |,| or |;| to repeat the last |t| search
2294 and the cursor is right in front of the searched
2295 character, the cursor won't move. When not included,
2296 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002297 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002298
2299 POSIX flags. These are not included in the Vi default value, except
2300 when $VIM_POSIX was set on startup. |posix|
2301
2302 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002303 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002304 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002305 *cpo-&*
2306 & When ":preserve" was used keep the swap file when
2307 exiting normally while this buffer is still loaded.
2308 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002309 *cpo-\*
2310 \ Backslash in a [] range in a search pattern is taken
2311 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002312 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2313 '\' excluded: "/[ \-]" finds <Space> and '-'
2314 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002315 *cpo-/*
2316 / When "%" is used as the replacement string in a |:s|
2317 command, use the previous replacement string. |:s%|
2318 *cpo-{*
2319 { The |{| and |}| commands also stop at a "{" character
2320 at the start of a line.
2321 *cpo-.*
2322 . The ":chdir" and ":cd" commands fail if the current
2323 buffer is modified, unless ! is used. Vim doesn't
2324 need this, since it remembers the full path of an
2325 opened file.
2326 *cpo-bar*
2327 | The value of the $LINES and $COLUMNS environment
2328 variables overrule the terminal size values obtained
2329 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002330
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002332 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002333'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002334 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002335 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002336 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002337 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002338 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002339 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002340 blowfish Blowfish method. Medium strong encryption but it has
2341 an implementation flaw. Requires Vim 7.3 or later,
2342 files can NOT be read by Vim 7.2 and older. This adds
2343 a "seed" to the file, every time you write the file
2344 the encrypted bytes will be different.
2345 *blowfish2*
2346 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002347 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002348 and older. This adds a "seed" to the file, every time
2349 you write the file the encrypted bytes will be
2350 different. The whole undo file is encrypted, not just
2351 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002352
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002353 You should use "blowfish2", also to re-encrypt older files.
2354
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002355 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002356 to the detected method of the file being read. Thus if you write it
2357 without changing 'cryptmethod' the same method will be used.
2358 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002359 explicitly write it, you don't get a warning unless there are other
2360 modifications. Also see |:X|.
2361
2362 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002363 the value "blowfish2". When setting the local value to an empty
2364 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002365
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002366 When a new encryption method is added in a later version of Vim, and
2367 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002368 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002369
2370
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371 *'cscopepathcomp'* *'cspc'*
2372'cscopepathcomp' 'cspc' number (default 0)
2373 global
2374 {not available when compiled without the |+cscope|
2375 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376 Determines how many components of the path to show in a list of tags.
2377 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002378 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379
2380 *'cscopeprg'* *'csprg'*
2381'cscopeprg' 'csprg' string (default "cscope")
2382 global
2383 {not available when compiled without the |+cscope|
2384 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385 Specifies the command to execute cscope. See |cscopeprg|.
2386 This option cannot be set from a |modeline| or in the |sandbox|, for
2387 security reasons.
2388
2389 *'cscopequickfix'* *'csqf'*
2390'cscopequickfix' 'csqf' string (default "")
2391 global
2392 {not available when compiled without the |+cscope|
2393 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002394 Specifies whether to use quickfix window to show cscope results.
2395 See |cscopequickfix|.
2396
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002397 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002398'cscoperelative' 'csre' boolean (default off)
2399 global
2400 {not available when compiled without the |+cscope|
2401 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002402 In the absence of a prefix (-P) for cscope. setting this option enables
2403 to use the basename of cscope.out path as the prefix.
2404 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002405 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002406
Bram Moolenaar071d4272004-06-13 20:20:40 +00002407 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2408'cscopetag' 'cst' boolean (default off)
2409 global
2410 {not available when compiled without the |+cscope|
2411 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412 Use cscope for tag commands. See |cscope-options|.
2413 NOTE: This option is reset when 'compatible' is set.
2414
2415 *'cscopetagorder'* *'csto'*
2416'cscopetagorder' 'csto' number (default 0)
2417 global
2418 {not available when compiled without the |+cscope|
2419 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420 Determines the order in which ":cstag" performs a search. See
2421 |cscopetagorder|.
2422 NOTE: This option is set to 0 when 'compatible' is set.
2423
2424 *'cscopeverbose'* *'csverb'*
2425 *'nocscopeverbose'* *'nocsverb'*
2426'cscopeverbose' 'csverb' boolean (default off)
2427 global
2428 {not available when compiled without the |+cscope|
2429 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002430 Give messages when adding a cscope database. See |cscopeverbose|.
2431 NOTE: This option is reset when 'compatible' is set.
2432
Bram Moolenaar860cae12010-06-05 23:22:07 +02002433 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2434'cursorbind' 'crb' boolean (default off)
2435 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002436 When this option is set, as the cursor in the current
2437 window moves other cursorbound windows (windows that also have
2438 this option set) move their cursors to the corresponding line and
2439 column. This option is useful for viewing the
2440 differences between two versions of a file (see 'diff'); in diff mode,
2441 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002442 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002443
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002444
2445 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2446'cursorcolumn' 'cuc' boolean (default off)
2447 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002448 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002449 feature}
2450 Highlight the screen column of the cursor with CursorColumn
2451 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2452 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002453 If you only want the highlighting in the current window you can use
2454 these autocommands: >
2455 au WinLeave * set nocursorline nocursorcolumn
2456 au WinEnter * set cursorline cursorcolumn
2457<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002458
2459 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2460'cursorline' 'cul' boolean (default off)
2461 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002462 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002463 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002464 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2465 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002466 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002467 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002468
2469
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002470 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002471'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002472 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002473 {not available when compiled without the |+syntax|
2474 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002475 Comma separated list of settings for how 'cursorline' is displayed.
2476 Valid values:
2477 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002478 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002479 "screenline" Highlight only the screen line of the cursor with
2480 CursorLine |hl-CursorLine|.
2481 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002482 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002483
2484 Special value:
2485 "both" Alias for the values "line,number".
2486
2487 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002488
2489
Bram Moolenaar071d4272004-06-13 20:20:40 +00002490 *'debug'*
2491'debug' string (default "")
2492 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002493 These values can be used:
2494 msg Error messages that would otherwise be omitted will be given
2495 anyway.
2496 throw Error messages that would otherwise be omitted will be given
2497 anyway and also throw an exception and set |v:errmsg|.
2498 beep A message will be given when otherwise only a beep would be
2499 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002500 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002501 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2502 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002503
2504 *'define'* *'def'*
2505'define' 'def' string (default "^\s*#\s*define")
2506 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002507 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002508 pattern, just like for the "/" command. This option is used for the
2509 commands like "[i" and "[d" |include-search|. The 'isident' option is
2510 used to recognize the defined name after the match:
2511 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2512 See |option-backslash| about inserting backslashes to include a space
2513 or backslash.
2514 The default value is for C programs. For C++ this value would be
2515 useful, to include const type declarations: >
2516 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002517< You can also use "\ze" just before the name and continue the pattern
2518 to check what is following. E.g. for Javascript, if a function is
2519 defined with "func_name = function(args)": >
2520 ^\s*\ze\i\+\s*=\s*function(
2521< If the function is defined with "func_name : function() {...": >
2522 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002523< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002524 To avoid that use `:let` with a single quote string: >
2525 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002526<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527
2528 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2529'delcombine' 'deco' boolean (default off)
2530 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531 If editing Unicode and this option is set, backspace and Normal mode
2532 "x" delete each combining character on its own. When it is off (the
2533 default) the character along with its combining characters are
2534 deleted.
2535 Note: When 'delcombine' is set "xx" may work different from "2x"!
2536
2537 This is useful for Arabic, Hebrew and many other languages where one
2538 may have combining characters overtop of base characters, and want
2539 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002540 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002541
2542 *'dictionary'* *'dict'*
2543'dictionary' 'dict' string (default "")
2544 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545 List of file names, separated by commas, that are used to lookup words
2546 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2547 contain a list of words. This can be one word per line, or several
2548 words per line, separated by non-keyword characters (white space is
2549 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002550
2551 When this option is empty or an entry "spell" is present, and spell
2552 checking is enabled, words in the word lists for the currently active
2553 'spelllang' are used. See |spell|.
2554
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002555 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002556 after a comma are ignored, otherwise spaces are included in the file
2557 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002558 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002559 Where to find a list of words?
2560 - On FreeBSD, there is the file "/usr/share/dict/words".
2561 - In the Simtel archive, look in the "msdos/linguist" directory.
2562 - In "miscfiles" of the GNU collection.
2563 The use of |:set+=| and |:set-=| is preferred when adding or removing
2564 directories from the list. This avoids problems when a future version
2565 uses another default.
2566 Backticks cannot be used in this option for security reasons.
2567
2568 *'diff'* *'nodiff'*
2569'diff' boolean (default off)
2570 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 {not available when compiled without the |+diff|
2572 feature}
2573 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002574 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575
2576 *'dex'* *'diffexpr'*
2577'diffexpr' 'dex' string (default "")
2578 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579 {not available when compiled without the |+diff|
2580 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002581 Expression which is evaluated to obtain a diff file (either ed-style
2582 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 This option cannot be set from a |modeline| or in the |sandbox|, for
2584 security reasons.
2585
2586 *'dip'* *'diffopt'*
Bram Moolenaarc93262b2018-09-10 21:15:40 +02002587'diffopt' 'dip' string (default "internal,filler")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589 {not available when compiled without the |+diff|
2590 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002591 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002592 All are optional. Items must be separated by a comma.
2593
2594 filler Show filler lines, to keep the text
2595 synchronized with a window that has inserted
2596 lines at the same position. Mostly useful
2597 when windows are side-by-side and 'scrollbind'
2598 is set.
2599
2600 context:{n} Use a context of {n} lines between a change
2601 and a fold that contains unchanged lines.
2602 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002603 When using zero the context is actually one,
2604 since folds require a line in between, also
2605 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002606 See |fold-diff|.
2607
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002608 iblank Ignore changes where lines are all blank. Adds
2609 the "-B" flag to the "diff" command if
2610 'diffexpr' is empty. Check the documentation
2611 of the "diff" command for what this does
2612 exactly.
2613 NOTE: the diff windows will get out of sync,
2614 because no differences between blank lines are
2615 taken into account.
2616
Bram Moolenaar071d4272004-06-13 20:20:40 +00002617 icase Ignore changes in case of text. "a" and "A"
2618 are considered the same. Adds the "-i" flag
2619 to the "diff" command if 'diffexpr' is empty.
2620
2621 iwhite Ignore changes in amount of white space. Adds
2622 the "-b" flag to the "diff" command if
2623 'diffexpr' is empty. Check the documentation
2624 of the "diff" command for what this does
2625 exactly. It should ignore adding trailing
2626 white space, but not leading white space.
2627
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002628 iwhiteall Ignore all white space changes. Adds
2629 the "-w" flag to the "diff" command if
2630 'diffexpr' is empty. Check the documentation
2631 of the "diff" command for what this does
2632 exactly.
2633
2634 iwhiteeol Ignore white space changes at end of line.
2635 Adds the "-Z" flag to the "diff" command if
2636 'diffexpr' is empty. Check the documentation
2637 of the "diff" command for what this does
2638 exactly.
2639
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002640 horizontal Start diff mode with horizontal splits (unless
2641 explicitly specified otherwise).
2642
2643 vertical Start diff mode with vertical splits (unless
2644 explicitly specified otherwise).
2645
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002646 hiddenoff Do not use diff mode for a buffer when it
2647 becomes hidden.
2648
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002649 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2650 starting diff mode. Without this 2 is used.
2651
Bram Moolenaare828b762018-09-10 17:51:58 +02002652 internal Use the internal diff library. This is
2653 ignored when 'diffexpr' is set. *E960*
2654 When running out of memory when writing a
2655 buffer this item will be ignored for diffs
2656 involving that buffer. Set the 'verbose'
2657 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658
Bram Moolenaare828b762018-09-10 17:51:58 +02002659 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002660 Use the indent heuristic for the internal
2661 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002662
2663 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002664 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002665 algorithms are:
2666 myers the default algorithm
2667 minimal spend extra time to generate the
2668 smallest possible diff
2669 patience patience diff algorithm
2670 histogram histogram diff algorithm
2671
2672 Examples: >
2673 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002675 :set diffopt=internal,filler,foldcolumn:3
2676 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002677<
2678 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2679'digraph' 'dg' boolean (default off)
2680 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 {not available when compiled without the |+digraphs|
2682 feature}
2683 Enable the entering of digraphs in Insert mode with {char1} <BS>
2684 {char2}. See |digraphs|.
2685 NOTE: This option is reset when 'compatible' is set.
2686
2687 *'directory'* *'dir'*
2688'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002689 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690 for Unix: ".,~/tmp,/var/tmp,/tmp")
2691 global
2692 List of directory names for the swap file, separated with commas.
2693 - The swap file will be created in the first directory where this is
2694 possible.
2695 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002696 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 - A directory "." means to put the swap file in the same directory as
2698 the edited file. On Unix, a dot is prepended to the file name, so
2699 it doesn't show in a directory listing. On MS-Windows the "hidden"
2700 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002701 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 put the swap file relative to where the edited file is. The leading
2703 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002704 - For Unix and Win32, if a directory ends in two path separators "//",
2705 the swap file name will be built from the complete path to the file
2706 with all path separators substituted to percent '%' signs. This will
2707 ensure file name uniqueness in the preserve directory.
2708 On Win32, it is also possible to end with "\\". However, When a
2709 separating comma is following, you must use "//", since "\\" will
2710 include the comma in the file name. Therefore it is recommended to
2711 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 - Spaces after the comma are ignored, other spaces are considered part
2713 of the directory name. To have a space at the start of a directory
2714 name, precede it with a backslash.
2715 - To include a comma in a directory name precede it with a backslash.
2716 - A directory name may end in an ':' or '/'.
2717 - Environment variables are expanded |:set_env|.
2718 - Careful with '\' characters, type one before a space, type two to
2719 get one in the option (see |option-backslash|), for example: >
2720 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2721< - For backwards compatibility with Vim version 3.0 a '>' at the start
2722 of the option is removed.
2723 Using "." first in the list is recommended. This means that editing
2724 the same file twice will result in a warning. Using "/tmp" on Unix is
2725 discouraged: When the system crashes you lose the swap file.
2726 "/var/tmp" is often not cleared when rebooting, thus is a better
2727 choice than "/tmp". But it can contain a lot of files, your swap
2728 files get lost in the crowd. That is why a "tmp" directory in your
2729 home directory is tried first.
2730 The use of |:set+=| and |:set-=| is preferred when adding or removing
2731 directories from the list. This avoids problems when a future version
2732 uses another default.
2733 This option cannot be set from a |modeline| or in the |sandbox|, for
2734 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735
2736 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002737'display' 'dy' string (default "", set to "truncate" in
2738 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740 Change the way text is displayed. This is comma separated list of
2741 flags:
2742 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002743 in a window will be displayed. "@@@" is put in the
2744 last columns of the last screen line to indicate the
2745 rest of the line is not displayed.
2746 truncate Like "lastline", but "@@@" is displayed in the first
2747 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748 uhex Show unprintable characters hexadecimal as <xx>
2749 instead of using ^C and ~C.
2750
Bram Moolenaard0796902016-09-16 20:02:31 +02002751 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002752 doesn't fit is replaced with "@" lines.
2753
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 *'eadirection'* *'ead'*
2755'eadirection' 'ead' string (default "both")
2756 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 Tells when the 'equalalways' option applies:
2758 ver vertically, width of windows is not affected
2759 hor horizontally, height of windows is not affected
2760 both width and height of windows is affected
2761
2762 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2763'edcompatible' 'ed' boolean (default off)
2764 global
2765 Makes the 'g' and 'c' flags of the ":substitute" command to be
2766 toggled each time the flag is given. See |complex-change|. See
2767 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002768 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769
Bram Moolenaar03413f42016-04-12 21:07:15 +02002770 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002771'emoji' 'emo' boolean (default: on)
2772 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002773 When on all Unicode emoji characters are considered to be full width.
2774
2775
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776 *'encoding'* *'enc'* *E543*
2777'encoding' 'enc' string (default: "latin1" or value from $LANG)
2778 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002779 Sets the character encoding used inside Vim. It applies to text in
2780 the buffers, registers, Strings in expressions, text stored in the
2781 viminfo file, etc. It sets the kind of characters which Vim can work
2782 with. See |encoding-names| for the possible values.
2783
2784 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002785 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002787 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788
Bram Moolenaar865242e2010-07-14 21:12:05 +02002789 This option cannot be set from a |modeline|. It would most likely
2790 corrupt the text.
2791
Bram Moolenaar3df01732017-02-17 22:47:16 +01002792 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2793 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794 'encoding', "utf-8" is the natural choice for the environment and
2795 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002796 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 versions, and to avoid changing the encoding of newly created files
2798 without your knowledge (in case 'fileencodings' is empty).
2799
2800 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002801 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802 iconv() or as specified with 'charconvert'.
2803
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002804 If you need to know whether 'encoding' is a multi-byte encoding, you
2805 can use: >
2806 if has("multi_byte_encoding")
2807<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002808 Normally 'encoding' will be equal to your current locale. This will
2809 be the default if Vim recognizes your environment settings. If
2810 'encoding' is not set to the current locale, 'termencoding' must be
2811 set to convert typed and displayed text. See |encoding-table|.
2812
2813 When you set this option, it fires the |EncodingChanged| autocommand
2814 event so that you can set up fonts if necessary.
2815
2816 When the option is set, the value is converted to lowercase. Thus
2817 you can set it with uppercase values too. Underscores are translated
2818 to '-' signs.
2819 When the encoding is recognized, it is changed to the standard name.
2820 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2821 "iso-8859-2" and "utf8" becomes "utf-8".
2822
2823 Note: "latin1" is also used when the encoding could not be detected.
2824 This only works when editing files in the same encoding! When the
2825 actual character set is not latin1, make sure 'fileencoding' and
2826 'fileencodings' are empty. When conversion is needed, switch to using
2827 utf-8.
2828
2829 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2830 You don't notice this while editing, but it does matter for the
2831 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2832 setting 'encoding' to one of these values instead of utf-8 only has
2833 effect for encoding used for files when 'fileencoding' is empty.
2834
Bram Moolenaar661b1822005-07-28 22:36:45 +00002835 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2836 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837
2838 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2839'endofline' 'eol' boolean (default on)
2840 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002842 is on, or 'fixeol' option is off, no <EOL> will be written for the
2843 last line in the file. This option is automatically set or reset when
2844 starting to edit a new file, depending on whether file has an <EOL>
2845 for the last line in the file. Normally you don't have to set or
2846 reset this option.
2847 When 'binary' is off and 'fixeol' is on the value is not used when
2848 writing the file. When 'binary' is on or 'fixeol' is off it is used
2849 to remember the presence of a <EOL> for the last line in the file, so
2850 that when you write the file the situation from the original file can
2851 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852
2853 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2854'equalalways' 'ea' boolean (default on)
2855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002857 splitting or closing a window. This also happens the moment the
2858 option is switched on. When off, splitting a window will reduce the
2859 size of the current window and leave the other windows the same. When
2860 closing a window the extra lines are given to the window next to it
2861 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862 When mixing vertically and horizontally split windows, a minimal size
2863 is computed and some windows may be larger if there is room. The
2864 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002865 Changing the height and width of a window can be avoided by setting
2866 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002867 If a window size is specified when creating a new window sizes are
2868 currently not equalized (it's complicated, but may be implemented in
2869 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870
2871 *'equalprg'* *'ep'*
2872'equalprg' 'ep' string (default "")
2873 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002875 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002876 or 'indentexpr'. When Vim was compiled without internal formatting,
2877 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002878 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879 about including spaces and backslashes.
2880 This option cannot be set from a |modeline| or in the |sandbox|, for
2881 security reasons.
2882
2883 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2884'errorbells' 'eb' boolean (default off)
2885 global
2886 Ring the bell (beep or screen flash) for error messages. This only
2887 makes a difference for error messages, the bell will be used always
2888 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002889 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002890 screen flash or do nothing. See 'belloff' to finetune when to ring the
2891 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892
2893 *'errorfile'* *'ef'*
2894'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2895 others: "errors.err")
2896 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897 {not available when compiled without the |+quickfix|
2898 feature}
2899 Name of the errorfile for the QuickFix mode (see |:cf|).
2900 When the "-q" command-line argument is used, 'errorfile' is set to the
2901 following argument. See |-q|.
2902 NOT used for the ":make" command. See 'makeef' for that.
2903 Environment variables are expanded |:set_env|.
2904 See |option-backslash| about including spaces and backslashes.
2905 This option cannot be set from a |modeline| or in the |sandbox|, for
2906 security reasons.
2907
2908 *'errorformat'* *'efm'*
2909'errorformat' 'efm' string (default is very long)
2910 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911 {not available when compiled without the |+quickfix|
2912 feature}
2913 Scanf-like description of the format for the lines in the error file
2914 (see |errorformat|).
2915
2916 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2917'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2918 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 Function keys that start with an <Esc> are recognized in Insert
2920 mode. When this option is off, the cursor and function keys cannot be
2921 used in Insert mode if they start with an <Esc>. The advantage of
2922 this is that the single <Esc> is recognized immediately, instead of
2923 after one second. Instead of resetting this option, you might want to
2924 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2925 when 'esckeys' is off, you can still map anything, but the cursor keys
2926 won't work by default.
2927 NOTE: This option is set to the Vi default value when 'compatible' is
2928 set and to the Vim default value when 'compatible' is reset.
2929
2930 *'eventignore'* *'ei'*
2931'eventignore' 'ei' string (default "")
2932 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002934 When set to "all" or when "all" is one of the items, all autocommand
2935 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 Otherwise this is a comma separated list of event names. Example: >
2937 :set ei=WinEnter,WinLeave
2938<
2939 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2940'expandtab' 'et' boolean (default off)
2941 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002943 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2945 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002946 This option is reset when the 'paste' option is set and restored when
2947 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 NOTE: This option is reset when 'compatible' is set.
2949
2950 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2951'exrc' 'ex' boolean (default off)
2952 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002954 directory.
2955
2956 Setting this option is a potential security leak. E.g., consider
2957 unpacking a package or fetching files from github, a .vimrc in there
2958 might be a trojan horse. BETTER NOT SET THIS OPTION!
2959 Instead, define an autocommand in your .vimrc to set options for a
2960 matching directory.
2961
2962 If you do switch this option on you should also consider setting the
2963 'secure' option (see |initialization|).
2964 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 This option cannot be set from a |modeline| or in the |sandbox|, for
2966 security reasons.
2967
2968 *'fileencoding'* *'fenc'* *E213*
2969'fileencoding' 'fenc' string (default: "")
2970 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002972
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002974 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 When 'fileencoding' is empty, the same value as 'encoding' will be
2976 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002977 No error will be given when the value is set, only when it is used,
2978 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002979 Conversion will also be done when 'encoding' and 'fileencoding' are
2980 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2981 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002983 'encoding' is "utf-8" or another Unicode encoding, conversion
2984 is most likely done in a way that the reverse conversion
2985 results in the same text. When 'encoding' is not "utf-8" some
2986 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002987
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 See 'encoding' for the possible values. Additionally, values may be
2989 specified that can be handled by the converter, see
2990 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002991
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 When reading a file 'fileencoding' will be set from 'fileencodings'.
2993 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002994 'fileencoding', use the |++enc| argument. One exception: when
2995 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002996 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002997
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2999 When the option is set, the value is converted to lowercase. Thus
3000 you can set it with uppercase values too. '_' characters are
3001 replaced with '-'. If a name is recognized from the list for
3002 'encoding', it is replaced by the standard name. For example
3003 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003004
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 When this option is set, after starting to edit a file, the 'modified'
3006 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003007
3008 Keep in mind that changing 'fenc' from a modeline happens
3009 AFTER the text has been read, thus it applies to when the file will be
3010 written. If you do set 'fenc' in a modeline, you might want to set
3011 'nomodified' to avoid not being able to ":q".
3012
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 This option can not be changed when 'modifiable' is off.
3014
3015 *'fe'*
3016 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003017 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 old short name was 'fe', which is no longer used.
3019
3020 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003021'fileencodings' 'fencs' string (default: "ucs-bom",
3022 "ucs-bom,utf-8,default,latin1" when
3023 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025 This is a list of character encodings considered when starting to edit
3026 an existing file. When a file is read, Vim tries to use the first
3027 mentioned character encoding. If an error is detected, the next one
3028 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003029 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 an empty string, which means the value of 'encoding' is used.
3031 WARNING: Conversion can cause loss of information! When
3032 'encoding' is "utf-8" (or one of the other Unicode variants)
3033 conversion is most likely done in a way that the reverse
3034 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003035 "utf-8" some non-ASCII characters may be lost! You can use
3036 the |++bad| argument to specify what is done with characters
3037 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 For an empty file or a file with only ASCII characters most encodings
3039 will work and the first entry of 'fileencodings' will be used (except
3040 "ucs-bom", which requires the BOM to be present). If you prefer
3041 another encoding use an BufReadPost autocommand event to test if your
3042 preferred encoding is to be used. Example: >
3043 au BufReadPost * if search('\S', 'w') == 0 |
3044 \ set fenc=iso-2022-jp | endif
3045< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3046 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003047 When the |++enc| argument is used then the value of 'fileencodings' is
3048 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003049 Note that 'fileencodings' is not used for a new file, the global value
3050 of 'fileencoding' is used instead. You can set it with: >
3051 :setglobal fenc=iso-8859-2
3052< This means that a non-existing file may get a different encoding than
3053 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054 The special value "ucs-bom" can be used to check for a Unicode BOM
3055 (Byte Order Mark) at the start of the file. It must not be preceded
3056 by "utf-8" or another Unicode encoding for this to work properly.
3057 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3058 because Vim cannot detect an error, thus the encoding is always
3059 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003060 The special value "default" can be used for the encoding from the
3061 environment. This is the default value for 'encoding'. It is useful
3062 when 'encoding' is set to "utf-8" and your environment uses a
3063 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003064 When 'encoding' is "utf-8" and a file contains an illegal byte
3065 sequence it won't be recognized as UTF-8. You can use the |8g8|
3066 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 WRONG VALUES: WHAT'S WRONG:
3068 latin1,utf-8 "latin1" will always be used
3069 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3070 file
3071 cp1250,latin1 "cp1250" will always be used
3072 If 'fileencodings' is empty, 'fileencoding' is not modified.
3073 See 'fileencoding' for the possible values.
3074 Setting this option does not have an effect until the next time a file
3075 is read.
3076
3077 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003078'fileformat' 'ff' string (MS-Windows default: "dos",
3079 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 This gives the <EOL> of the current buffer, which is used for
3082 reading/writing the buffer from/to a file:
3083 dos <CR> <NL>
3084 unix <NL>
3085 mac <CR>
3086 When "dos" is used, CTRL-Z at the end of a file is ignored.
3087 See |file-formats| and |file-read|.
3088 For the character encoding of the file see 'fileencoding'.
3089 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003090 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 This option is set automatically when starting to edit a file and
3092 'fileformats' is not empty and 'binary' is off.
3093 When this option is set, after starting to edit a file, the 'modified'
3094 option is set, because the file would be different when written.
3095 This option can not be changed when 'modifiable' is off.
3096 For backwards compatibility: When this option is set to "dos",
3097 'textmode' is set, otherwise 'textmode' is reset.
3098
3099 *'fileformats'* *'ffs'*
3100'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003101 Vim+Vi MS-Windows: "dos,unix",
3102 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 Vi Cygwin: "unix,dos",
3104 Vi others: "")
3105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 This gives the end-of-line (<EOL>) formats that will be tried when
3107 starting to edit a new buffer and when reading a file into an existing
3108 buffer:
3109 - When empty, the format defined with 'fileformat' will be used
3110 always. It is not set automatically.
3111 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003112 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 'fileformats' name will be used when a file is read into an existing
3114 buffer, no matter what 'fileformat' for that buffer is set to.
3115 - When more than one name is present, separated by commas, automatic
3116 <EOL> detection will be done when reading a file. When starting to
3117 edit a file, a check is done for the <EOL>:
3118 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3119 'fileformat' is set to "dos".
3120 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003121 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003123 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3124 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003125 This means that "mac" is only chosen when:
3126 "unix" is not present or no <NL> is found in the file, and
3127 "dos" is not present or no <CR><NL> is found in the file.
3128 Except: if "unix" was chosen, but there is a <CR> before
3129 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003130 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 4. If 'fileformat' is still not set, the first name from
3132 'fileformats' is used.
3133 When reading a file into an existing buffer, the same is done, but
3134 this happens like 'fileformat' has been set appropriately for that
3135 file only, the option is not changed.
3136 When 'binary' is set, the value of 'fileformats' is not used.
3137
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003138 When Vim starts up with an empty buffer the first item is used. You
3139 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003140
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3142 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3143 done:
3144 - When 'fileformats' is empty, there is no automatic detection. Dos
3145 format will be used.
3146 - When 'fileformats' is set to one or more names, automatic detection
3147 is done. This is based on the first <NL> in the file: If there is a
3148 <CR> in front of it, Dos format is used, otherwise Unix format is
3149 used.
3150 Also see |file-formats|.
3151 For backwards compatibility: When this option is set to an empty
3152 string or one format (no comma is included), 'textauto' is reset,
3153 otherwise 'textauto' is set.
3154 NOTE: This option is set to the Vi default value when 'compatible' is
3155 set and to the Vim default value when 'compatible' is reset.
3156
Bram Moolenaarbf884932013-04-05 22:26:15 +02003157 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3158'fileignorecase' 'fic' boolean (default on for systems where case in file
3159 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003160 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003161 When set case is ignored when using file names and directories.
3162 See 'wildignorecase' for only ignoring case when doing completion.
3163
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 *'filetype'* *'ft'*
3165'filetype' 'ft' string (default: "")
3166 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 When this option is set, the FileType autocommand event is triggered.
3168 All autocommands that match with the value of this option will be
3169 executed. Thus the value of 'filetype' is used in place of the file
3170 name.
3171 Otherwise this option does not always reflect the current file type.
3172 This option is normally set when the file type is detected. To enable
3173 this use the ":filetype on" command. |:filetype|
3174 Setting this option to a different value is most useful in a modeline,
3175 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003176 Example, for in an IDL file:
3177 /* vim: set filetype=idl : */ ~
3178 |FileType| |filetypes|
3179 When a dot appears in the value then this separates two filetype
3180 names. Example:
3181 /* vim: set filetype=c.doxygen : */ ~
3182 This will use the "c" filetype first, then the "doxygen" filetype.
3183 This works both for filetype plugins and for syntax files. More than
3184 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 This option is not copied to another buffer, independent of the 's' or
3186 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003187 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188
3189 *'fillchars'* *'fcs'*
3190'fillchars' 'fcs' string (default "vert:|,fold:-")
3191 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003192 {not available when compiled without the |+folding|
3193 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 Characters to fill the statuslines and vertical separators.
3195 It is a comma separated list of items:
3196
3197 item default Used for ~
3198 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003199 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 vert:c '|' vertical separators |:vsplit|
3201 fold:c '-' filling 'foldtext'
3202 diff:c '-' deleted lines of the 'diff' option
3203
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003204 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003205 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 otherwise.
3207
3208 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003209 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210< This is similar to the default, except that these characters will also
3211 be used when there is highlighting.
3212
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003213 for "stl" and "stlnc" only single-byte values are supported.
3214
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 The highlighting used for these items:
3216 item highlight group ~
3217 stl:c StatusLine |hl-StatusLine|
3218 stlnc:c StatusLineNC |hl-StatusLineNC|
3219 vert:c VertSplit |hl-VertSplit|
3220 fold:c Folded |hl-Folded|
3221 diff:c DiffDelete |hl-DiffDelete|
3222
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003223 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3224'fixendofline' 'fixeol' boolean (default on)
3225 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003226 When writing a file and this option is on, <EOL> at the end of file
3227 will be restored if missing. Turn this option off if you want to
3228 preserve the situation from the original file.
3229 When the 'binary' option is set the value of this option doesn't
3230 matter.
3231 See the 'endofline' option.
3232
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3234'fkmap' 'fk' boolean (default off) *E198*
3235 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 {only available when compiled with the |+rightleft|
3237 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003238 This option was for using Farsi, which has been removed. See
3239 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240
3241 *'foldclose'* *'fcl'*
3242'foldclose' 'fcl' string (default "")
3243 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 {not available when compiled without the |+folding|
3245 feature}
3246 When set to "all", a fold is closed when the cursor isn't in it and
3247 its level is higher than 'foldlevel'. Useful if you want folds to
3248 automatically close when moving out of them.
3249
3250 *'foldcolumn'* *'fdc'*
3251'foldcolumn' 'fdc' number (default 0)
3252 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253 {not available when compiled without the |+folding|
3254 feature}
3255 When non-zero, a column with the specified width is shown at the side
3256 of the window which indicates open and closed folds. The maximum
3257 value is 12.
3258 See |folding|.
3259
3260 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3261'foldenable' 'fen' boolean (default on)
3262 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 {not available when compiled without the |+folding|
3264 feature}
3265 When off, all folds are open. This option can be used to quickly
3266 switch between showing all text unfolded and viewing the text with
3267 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003268 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 'foldenable' is off.
3270 This option is set by commands that create a new fold or close a fold.
3271 See |folding|.
3272
3273 *'foldexpr'* *'fde'*
3274'foldexpr' 'fde' string (default: "0")
3275 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003277 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003279 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003280
Bram Moolenaar30b65812012-07-12 22:01:11 +02003281 The expression will be evaluated in the |sandbox| if set from a
3282 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003283 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003284 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003285
3286 It is not allowed to change text or jump to another window while
3287 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288
3289 *'foldignore'* *'fdi'*
3290'foldignore' 'fdi' string (default: "#")
3291 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292 {not available when compiled without the |+folding|
3293 feature}
3294 Used only when 'foldmethod' is "indent". Lines starting with
3295 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003296 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 The default "#" works well for C programs. See |fold-indent|.
3298
3299 *'foldlevel'* *'fdl'*
3300'foldlevel' 'fdl' number (default: 0)
3301 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003302 {not available when compiled without the |+folding|
3303 feature}
3304 Sets the fold level: Folds with a higher level will be closed.
3305 Setting this option to zero will close all folds. Higher numbers will
3306 close fewer folds.
3307 This option is set by commands like |zm|, |zM| and |zR|.
3308 See |fold-foldlevel|.
3309
3310 *'foldlevelstart'* *'fdls'*
3311'foldlevelstart' 'fdls' number (default: -1)
3312 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 {not available when compiled without the |+folding|
3314 feature}
3315 Sets 'foldlevel' when starting to edit another buffer in a window.
3316 Useful to always start editing with all folds closed (value zero),
3317 some folds closed (one) or no folds closed (99).
3318 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003319 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 ignores this option and closes all folds.
3321 It is also done before BufReadPre autocommands, to allow an autocmd to
3322 overrule the 'foldlevel' value for specific files.
3323 When the value is negative, it is not used.
3324
3325 *'foldmarker'* *'fmr'* *E536*
3326'foldmarker' 'fmr' string (default: "{{{,}}}")
3327 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 {not available when compiled without the |+folding|
3329 feature}
3330 The start and end marker used when 'foldmethod' is "marker". There
3331 must be one comma, which separates the start and end marker. The
3332 marker is a literal string (a regular expression would be too slow).
3333 See |fold-marker|.
3334
3335 *'foldmethod'* *'fdm'*
3336'foldmethod' 'fdm' string (default: "manual")
3337 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 {not available when compiled without the |+folding|
3339 feature}
3340 The kind of folding used for the current window. Possible values:
3341 |fold-manual| manual Folds are created manually.
3342 |fold-indent| indent Lines with equal indent form a fold.
3343 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3344 |fold-marker| marker Markers are used to specify folds.
3345 |fold-syntax| syntax Syntax highlighting items specify folds.
3346 |fold-diff| diff Fold text that is not changed.
3347
3348 *'foldminlines'* *'fml'*
3349'foldminlines' 'fml' number (default: 1)
3350 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 {not available when compiled without the |+folding|
3352 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003353 Sets the number of screen lines above which a fold can be displayed
3354 closed. Also for manually closed folds. With the default value of
3355 one a fold can only be closed if it takes up two or more screen lines.
3356 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003357 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 "zc" to close a fold, which is displayed open because it's smaller
3359 than 'foldminlines', a following "zc" may close a containing fold.
3360
3361 *'foldnestmax'* *'fdn'*
3362'foldnestmax' 'fdn' number (default: 20)
3363 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 {not available when compiled without the |+folding|
3365 feature}
3366 Sets the maximum nesting of folds for the "indent" and "syntax"
3367 methods. This avoids that too many folds will be created. Using more
3368 than 20 doesn't work, because the internal limit is 20.
3369
3370 *'foldopen'* *'fdo'*
3371'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3372 search,tag,undo")
3373 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 {not available when compiled without the |+folding|
3375 feature}
3376 Specifies for which type of commands folds will be opened, if the
3377 command moves the cursor into a closed fold. It is a comma separated
3378 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003379 NOTE: When the command is part of a mapping this option is not used.
3380 Add the |zv| command to the mapping to get the same effect.
3381 (rationale: the mapping may want to control opening folds itself)
3382
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 item commands ~
3384 all any
3385 block "(", "{", "[[", "[{", etc.
3386 hor horizontal movements: "l", "w", "fx", etc.
3387 insert any command in Insert mode
3388 jump far jumps: "G", "gg", etc.
3389 mark jumping to a mark: "'m", CTRL-O, etc.
3390 percent "%"
3391 quickfix ":cn", ":crew", ":make", etc.
3392 search search for a pattern: "/", "n", "*", "gd", etc.
3393 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003394 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 tag jumping to a tag: ":ta", CTRL-T, etc.
3396 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003397 When a movement command is used for an operator (e.g., "dl" or "y%")
3398 this option is not used. This means the operator will include the
3399 whole closed fold.
3400 Note that vertical movements are not here, because it would make it
3401 very difficult to move onto a closed fold.
3402 In insert mode the folds containing the cursor will always be open
3403 when text is inserted.
3404 To close folds you can re-apply 'foldlevel' with the |zx| command or
3405 set the 'foldclose' option to "all".
3406
3407 *'foldtext'* *'fdt'*
3408'foldtext' 'fdt' string (default: "foldtext()")
3409 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 {not available when compiled without the |+folding|
3411 feature}
3412 An expression which is used to specify the text displayed for a closed
3413 fold. See |fold-foldtext|.
3414
Bram Moolenaar30b65812012-07-12 22:01:11 +02003415 The expression will be evaluated in the |sandbox| if set from a
3416 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003417 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003418
3419 It is not allowed to change text or jump to another window while
3420 evaluating 'foldtext' |textlock|.
3421
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003422 *'formatexpr'* *'fex'*
3423'formatexpr' 'fex' string (default "")
3424 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003425 {not available when compiled without the |+eval|
3426 feature}
3427 Expression which is evaluated to format a range of lines for the |gq|
3428 operator or automatic formatting (see 'formatoptions'). When this
3429 option is empty 'formatprg' is used.
3430
3431 The |v:lnum| variable holds the first line to be formatted.
3432 The |v:count| variable holds the number of lines to be formatted.
3433 The |v:char| variable holds the character that is going to be
3434 inserted if the expression is being evaluated due to
3435 automatic formatting. This can be empty. Don't insert
3436 it yet!
3437
3438 Example: >
3439 :set formatexpr=mylang#Format()
3440< This will invoke the mylang#Format() function in the
3441 autoload/mylang.vim file in 'runtimepath'. |autoload|
3442
3443 The expression is also evaluated when 'textwidth' is set and adding
3444 text beyond that limit. This happens under the same conditions as
3445 when internal formatting is used. Make sure the cursor is kept in the
3446 same spot relative to the text then! The |mode()| function will
3447 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003448
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003449 When the expression evaluates to non-zero Vim will fall back to using
3450 the internal format mechanism.
3451
3452 The expression will be evaluated in the |sandbox| when set from a
3453 modeline, see |sandbox-option|. That stops the option from working,
3454 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003455 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003456 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003457
Bram Moolenaar86b68352004-12-27 21:59:20 +00003458 *'formatlistpat'* *'flp'*
3459'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3460 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003461 A pattern that is used to recognize a list header. This is used for
3462 the "n" flag in 'formatoptions'.
3463 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003464 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003465 while still checking more characters. There must be a character
3466 following the pattern, when it matches the whole line it is handled
3467 like there is no match.
3468 The default recognizes a number, followed by an optional punctuation
3469 character and white space.
3470
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003471 *'formatoptions'* *'fo'*
3472'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3473 local to buffer
3474 This is a sequence of letters which describes how automatic
3475 formatting is to be done. See |fo-table|. When the 'paste' option is
3476 on, no formatting is done (like 'formatoptions' is empty). Commas can
3477 be inserted for readability.
3478 To avoid problems with flags that are added in the future, use the
3479 "+=" and "-=" feature of ":set" |add-option-flags|.
3480 NOTE: This option is set to the Vi default value when 'compatible' is
3481 set and to the Vim default value when 'compatible' is reset.
3482
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 *'formatprg'* *'fp'*
3484'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003485 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003487 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003489 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003490 If the 'formatexpr' option is not empty it will be used instead.
3491 Otherwise, if 'formatprg' option is an empty string, the internal
3492 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003493 Environment variables are expanded |:set_env|. See |option-backslash|
3494 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003495 This option cannot be set from a |modeline| or in the |sandbox|, for
3496 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497
Bram Moolenaard94464e2015-11-02 15:28:18 +01003498 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003499'fsync' 'fs' boolean (default on)
3500 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003501 When on, the library function fsync() will be called after writing a
3502 file. This will flush a file to disk, ensuring that it is safely
3503 written even on filesystems which do metadata-only journaling. This
3504 will force the harddrive to spin up on Linux systems running in laptop
3505 mode, so it may be undesirable in some situations. Be warned that
3506 turning this off increases the chances of data loss after a crash. On
3507 systems without an fsync() implementation, this variable is always
3508 off.
3509 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003510 'fsync' also applies to |writefile()|, unless a flag is used to
3511 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003512 This option cannot be set from a |modeline| or in the |sandbox|, for
3513 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003514
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3516'gdefault' 'gd' boolean (default off)
3517 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 When on, the ":substitute" flag 'g' is default on. This means that
3519 all matches in a line are substituted instead of one. When a 'g' flag
3520 is given to a ":substitute" command, this will toggle the substitution
3521 of all or one match. See |complex-change|.
3522
3523 command 'gdefault' on 'gdefault' off ~
3524 :s/// subst. all subst. one
3525 :s///g subst. one subst. all
3526 :s///gg subst. all subst. one
3527
3528 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003529 DEPRECATED: Setting this option may break plugins that are not aware
3530 of this option. Also, many users get confused that adding the /g flag
3531 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532
3533 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003534'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 Format to recognize for the ":grep" command output.
3537 This is a scanf-like string that uses the same format as the
3538 'errorformat' option: see |errorformat|.
3539
3540 *'grepprg'* *'gp'*
3541'grepprg' 'gp' string (default "grep -n ",
3542 Unix: "grep -n $* /dev/null",
3543 Win32: "findstr /n" or "grep -n",
3544 VMS: "SEARCH/NUMBERS ")
3545 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003546 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547 and '#' characters, which are expanded like when used in a command-
3548 line. The placeholder "$*" is allowed to specify where the arguments
3549 will be included. Environment variables are expanded |:set_env|. See
3550 |option-backslash| about including spaces and backslashes.
3551 When your "grep" accepts the "-H" argument, use this to make ":grep"
3552 also work well with a single file: >
3553 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003554< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003555 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3556 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003557 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 apply equally to 'grepprg'.
3559 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3560 otherwise it's "grep -n".
3561 This option cannot be set from a |modeline| or in the |sandbox|, for
3562 security reasons.
3563
3564 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3565'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3566 ve:ver35-Cursor,
3567 o:hor50-Cursor,
3568 i-ci:ver25-Cursor/lCursor,
3569 r-cr:hor20-Cursor/lCursor,
3570 sm:block-Cursor
3571 -blinkwait175-blinkoff150-blinkon175",
3572 for MS-DOS and Win32 console:
3573 "n-v-c:block,o:hor50,i-ci:hor15,
3574 r-cr:hor30,sm:block")
3575 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576 {only available when compiled with GUI enabled, and
3577 for MS-DOS and Win32 console}
3578 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003579 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 the height of the cursor can be changed. This can be done by
3581 specifying a block cursor, or a percentage for a vertical or
3582 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003583 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3584 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003586 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 mode-list and an argument-list:
3588 mode-list:argument-list,mode-list:argument-list,..
3589 The mode-list is a dash separated list of these modes:
3590 n Normal mode
3591 v Visual mode
3592 ve Visual mode with 'selection' "exclusive" (same as 'v',
3593 if not specified)
3594 o Operator-pending mode
3595 i Insert mode
3596 r Replace mode
3597 c Command-line Normal (append) mode
3598 ci Command-line Insert mode
3599 cr Command-line Replace mode
3600 sm showmatch in Insert mode
3601 a all modes
3602 The argument-list is a dash separated list of these arguments:
3603 hor{N} horizontal bar, {N} percent of the character height
3604 ver{N} vertical bar, {N} percent of the character width
3605 block block cursor, fills the whole character
3606 [only one of the above three should be present]
3607 blinkwait{N} *cursor-blinking*
3608 blinkon{N}
3609 blinkoff{N}
3610 blink times for cursor: blinkwait is the delay before
3611 the cursor starts blinking, blinkon is the time that
3612 the cursor is shown and blinkoff is the time that the
3613 cursor is not shown. The times are in msec. When one
3614 of the numbers is zero, there is no blinking. The
3615 default is: "blinkwait700-blinkon400-blinkoff250".
3616 These numbers are used for a missing entry. This
3617 means that blinking is enabled by default. To switch
3618 blinking off you can use "blinkon0". The cursor only
3619 blinks when Vim is waiting for input, not while
3620 executing a command.
3621 To make the cursor blink in an xterm, see
3622 |xterm-blink|.
3623 {group-name}
3624 a highlight group name, that sets the color and font
3625 for the cursor
3626 {group-name}/{group-name}
3627 Two highlight group names, the first is used when
3628 no language mappings are used, the other when they
3629 are. |language-mapping|
3630
3631 Examples of parts:
3632 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3633 block cursor with colors from the "nCursor"
3634 highlight group
3635 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3636 In Insert and Command-line Insert mode, use a
3637 30% vertical bar cursor with colors from the
3638 "iCursor" highlight group. Blink a bit
3639 faster.
3640
3641 The 'a' mode is different. It will set the given argument-list for
3642 all modes. It does not reset anything to defaults. This can be used
3643 to do a common setting for all modes. For example, to switch off
3644 blinking: "a:blinkon0"
3645
3646 Examples of cursor highlighting: >
3647 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3648 :highlight Cursor gui=NONE guifg=bg guibg=fg
3649<
3650 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003651 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652'guifont' 'gfn' string (default "")
3653 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 {only available when compiled with GUI enabled}
3655 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003656 In its simplest form the value is just one font name.
3657 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003658
3659 *'guifontset'* *'gfs'*
3660 *E250* *E252* *E234* *E597* *E598*
3661'guifontset' 'gfs' string (default "")
3662 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663 {only available when compiled with GUI enabled and
3664 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003665 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 When not empty, specifies two (or more) fonts to be used. The first
3667 one for normal English, the second one for your special language. See
3668 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003669
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3671'guifontwide' 'gfw' string (default "")
3672 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 {only available when compiled with GUI enabled}
3674 When not empty, specifies a comma-separated list of fonts to be used
3675 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003676 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003677
Bram Moolenaar071d4272004-06-13 20:20:40 +00003678 *'guiheadroom'* *'ghr'*
3679'guiheadroom' 'ghr' number (default 50)
3680 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003681 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 The number of pixels subtracted from the screen height when fitting
3683 the GUI window on the screen. Set this before the GUI is started,
3684 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003685 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686 lines will be left for window decorations and other items on the
3687 screen. Set it to a negative value to allow windows taller than the
3688 screen.
3689
3690 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003691'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3692 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003693 "aegimrLtT" (GTK, Motif and Athena),
3694 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003697 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 sequence of letters which describes what components and options of the
3699 GUI should be used.
3700 To avoid problems with flags that are added in the future, use the
3701 "+=" and "-=" feature of ":set" |add-option-flags|.
3702
Bram Moolenaar13568252018-03-16 20:46:58 +01003703 Valid characters are as follows:
3704 *'go-!'*
3705 '!' External commands are executed in a terminal window. Without
3706 this flag the MS-Windows GUI will open a console window to
3707 execute the command. The Unix GUI will simulate a dumb
3708 terminal to list the command output.
3709 The terminal window will be positioned at the bottom, and grow
3710 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003711 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 'a' Autoselect: If present, then whenever VISUAL mode is started,
3713 or the Visual area extended, Vim tries to become the owner of
3714 the windowing system's global selection. This means that the
3715 Visually highlighted text is available for pasting into other
3716 applications as well as into Vim itself. When the Visual mode
3717 ends, possibly due to an operation on the text, or when an
3718 application wants to paste the selection, the highlighted text
3719 is automatically yanked into the "* selection register.
3720 Thus the selection is still available for pasting into other
3721 applications after the VISUAL mode has ended.
3722 If not present, then Vim won't become the owner of the
3723 windowing system's global selection unless explicitly told to
3724 by a yank or delete operation for the "* register.
3725 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003726 *'go-P'*
3727 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003728 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003729 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003730 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731 applies to the modeless selection.
3732
3733 'guioptions' autoselect Visual autoselect modeless ~
3734 "" - -
3735 "a" yes yes
3736 "A" - yes
3737 "aA" yes yes
3738
Bram Moolenaar02467872007-05-06 13:22:01 +00003739 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 'c' Use console dialogs instead of popup dialogs for simple
3741 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003742 *'go-d'*
3743 'd' Use dark theme variant if available. Currently only works for
3744 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003745 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003746 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003747 'guitablabel' can be used to change the text in the labels.
3748 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003749 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003750 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003751 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 'f' Foreground: Don't use fork() to detach the GUI from the shell
3753 where it was started. Use this for programs that wait for the
3754 editor to finish (e.g., an e-mail program). Alternatively you
3755 can use "gvim -f" or ":gui -f" to start the GUI in the
3756 foreground. |gui-fork|
3757 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003758 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003759 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3761 corner of the window. It's black&white on non-GTK, because of
3762 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003763 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003765 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003766 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003768 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003770 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003771 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 'g' Grey menu items: Make menu items that are not active grey. If
3773 'g' is not included inactive menu items are not shown at all.
3774 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003775 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 't' Include tearoff menu items. Currently only works for Win32,
3777 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003778 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003779 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003780 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003781 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003783 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 'R' Right-hand scrollbar is present when there is a vertically
3785 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003786 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003788 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 'L' Left-hand scrollbar is present when there is a vertically
3790 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003791 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3793 the longest visible line, or on the cursor line if the 'h'
3794 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003795 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 'h' Limit horizontal scrollbar size to the length of the cursor
3797 line. Reduces computations. |gui-horiz-scroll|
3798
3799 And yes, you may even have scrollbars on the left AND the right if
3800 you really want to :-). See |gui-scrollbars| for more information.
3801
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003802 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 'v' Use a vertical button layout for dialogs. When not included,
3804 a horizontal layout is preferred, but when it doesn't fit a
3805 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003806 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 'p' Use Pointer callbacks for X11 GUI. This is required for some
3808 window managers. If the cursor is not blinking or hollow at
3809 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003810 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003812 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003813 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003814 *'go-k'*
3815 'k' Keep the GUI window size when adding/removing a scrollbar, or
3816 toolbar, tabline, etc. Instead, the behavior is similar to
3817 when the window is maximized and will adjust 'lines' and
3818 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003819 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003820 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003821
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 *'guipty'* *'noguipty'*
3823'guipty' boolean (default on)
3824 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 {only available when compiled with GUI enabled}
3826 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3827 I/O to/from shell commands. See |gui-pty|.
3828
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003829 *'guitablabel'* *'gtl'*
3830'guitablabel' 'gtl' string (default empty)
3831 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003832 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003833 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003834 pages line. When empty and when the result is empty Vim will use a
3835 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003836
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003837 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003838 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003839 The expression will be evaluated in the |sandbox| when set from a
3840 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003841 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003842
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003843 Only used when the GUI tab pages line is displayed. 'e' must be
3844 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3845 used.
3846
Bram Moolenaar57657d82006-04-21 22:12:41 +00003847 *'guitabtooltip'* *'gtt'*
3848'guitabtooltip' 'gtt' string (default empty)
3849 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003850 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003851 When nonempty describes the text to use in a tooltip for the GUI tab
3852 pages line. When empty Vim will use a default tooltip.
3853 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003854 You can include a line break. Simplest method is to use |:let|: >
3855 :let &guitabtooltip = "line one\nline two"
3856<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003857
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858 *'helpfile'* *'hf'*
3859'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3860 (others) "$VIMRUNTIME/doc/help.txt")
3861 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862 Name of the main help file. All distributed help files should be
3863 placed together in one directory. Additionally, all "doc" directories
3864 in 'runtimepath' will be used.
3865 Environment variables are expanded |:set_env|. For example:
3866 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003867 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868 spaces and backslashes.
3869 This option cannot be set from a |modeline| or in the |sandbox|, for
3870 security reasons.
3871
3872 *'helpheight'* *'hh'*
3873'helpheight' 'hh' number (default 20)
3874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 Minimal initial height of the help window when it is opened with the
3876 ":help" command. The initial height of the help window is half of the
3877 current window, or (when the 'ea' option is on) the same as other
3878 windows. When the height is less than 'helpheight', the height is
3879 set to 'helpheight'. Set to zero to disable.
3880
3881 *'helplang'* *'hlg'*
3882'helplang' 'hlg' string (default: messages language or empty)
3883 global
3884 {only available when compiled with the |+multi_lang|
3885 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 Comma separated list of languages. Vim will use the first language
3887 for which the desired help can be found. The English help will always
3888 be used as a last resort. You can add "en" to prefer English over
3889 another language, but that will only find tags that exist in that
3890 language and not in the English help.
3891 Example: >
3892 :set helplang=de,it
3893< This will first search German, then Italian and finally English help
3894 files.
3895 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3896 try to find the tag in the current language before using this option.
3897 See |help-translated|.
3898
3899 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3900'hidden' 'hid' boolean (default off)
3901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 When off a buffer is unloaded when it is |abandon|ed. When on a
3903 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3904 displayed in another window, it does not become hidden, of course.
3905 The commands that move through the buffer list sometimes make a buffer
3906 hidden although the 'hidden' option is off: When the buffer is
3907 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003908 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003909 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 This option is set for one command with ":hide {command}" |:hide|.
3911 WARNING: It's easy to forget that you have changes in hidden buffers.
3912 Think twice when using ":q!" or ":qa!".
3913
3914 *'highlight'* *'hl'*
3915'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003916 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3917 d:Directory,e:ErrorMsg,i:IncSearch,
3918 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
3919 N:CursorLineNr,r:Question,s:StatusLine,
3920 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003921 v:Visual,V:VisualNOS,w:WarningMsg,
3922 W:WildMenu,f:Folded,F:FoldColumn,
3923 A:DiffAdd,C:DiffChange,D:DiffDelete,
3924 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003925 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003926 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003927 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3928 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003929 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003930 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932 This option can be used to set highlighting mode for various
3933 occasions. It is a comma separated list of character pairs. The
3934 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003935 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003937 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3938 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 characters from 'showbreak'
3940 |hl-Directory| d directories in CTRL-D listing and other special
3941 things in listings
3942 |hl-ErrorMsg| e error messages
3943 h (obsolete, ignored)
3944 |hl-IncSearch| i 'incsearch' highlighting
3945 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3946 |hl-MoreMsg| m |more-prompt|
3947 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003948 |hl-LineNr| n line number for ":number" and ":#" commands, and
3949 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003950 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3951 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 |hl-Question| r |hit-enter| prompt and yes/no questions
3953 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003954 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3956 |hl-VertSplit| c column used to separate vertically split windows
3957 |hl-Visual| v Visual mode
3958 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3959 Selection" Only X11 Gui's |gui-x11| and
3960 |xterm-clipboard|.
3961 |hl-WarningMsg| w warning messages
3962 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3963 |hl-Folded| f line used for closed folds
3964 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003965 |hl-DiffAdd| A added line in diff mode
3966 |hl-DiffChange| C changed line in diff mode
3967 |hl-DiffDelete| D deleted line in diff mode
3968 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003970 |hl-Conceal| - the placeholders used for concealed characters
3971 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00003972 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003973 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003974 |hl-SpellRare| R rare word |spell|
3975 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003976 |hl-Pmenu| + popup menu normal line
3977 |hl-PmenuSel| = popup menu selected line
3978 |hl-PmenuSbar| x popup menu scrollbar
3979 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980
3981 The display modes are:
3982 r reverse (termcap entry "mr" and "me")
3983 i italic (termcap entry "ZH" and "ZR")
3984 b bold (termcap entry "md" and "me")
3985 s standout (termcap entry "so" and "se")
3986 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003987 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02003988 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989 n no highlighting
3990 - no highlighting
3991 : use a highlight group
3992 The default is used for occasions that are not included.
3993 If you want to change what the display modes do, see |dos-colors|
3994 for an example.
3995 When using the ':' display mode, this must be followed by the name of
3996 a highlight group. A highlight group can be used to define any type
3997 of highlighting, including using color. See |:highlight| on how to
3998 define one. The default uses a different group for each occasion.
3999 See |highlight-default| for the default highlight groups.
4000
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004002'history' 'hi' number (Vim default: 50, Vi default: 0,
4003 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004006 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004008 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 NOTE: This option is set to the Vi default value when 'compatible' is
4010 set and to the Vim default value when 'compatible' is reset.
4011
4012 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4013'hkmap' 'hk' boolean (default off)
4014 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 {only available when compiled with the |+rightleft|
4016 feature}
4017 When on, the keyboard is mapped for the Hebrew character set.
4018 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4019 toggle this option. See |rileft.txt|.
4020 NOTE: This option is reset when 'compatible' is set.
4021
4022 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4023'hkmapp' 'hkp' boolean (default off)
4024 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 {only available when compiled with the |+rightleft|
4026 feature}
4027 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4028 This is useful if you have a non-Hebrew keyboard.
4029 See |rileft.txt|.
4030 NOTE: This option is reset when 'compatible' is set.
4031
Bram Moolenaar036986f2017-03-16 17:41:02 +01004032 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4033'hlsearch' 'hls' boolean (default off)
4034 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004035 {not available when compiled without the
4036 |+extra_search| feature}
4037 When there is a previous search pattern, highlight all its matches.
4038 The type of highlighting used can be set with the 'l' occasion in the
4039 'highlight' option. This uses the "Search" highlight group by
4040 default. Note that only the matching text is highlighted, any offsets
4041 are not applied.
4042 See also: 'incsearch' and |:match|.
4043 When you get bored looking at the highlighted matches, you can turn it
4044 off with |:nohlsearch|. This does not change the option value, as
4045 soon as you use a search command, the highlighting comes back.
4046 'redrawtime' specifies the maximum time spent on finding matches.
4047 When the search pattern can match an end-of-line, Vim will try to
4048 highlight all of the matched text. However, this depends on where the
4049 search starts. This will be the first line in the window or the first
4050 line below a closed fold. A match in a previous line which is not
4051 drawn may not continue in a newly drawn line.
4052 You can specify whether the highlight status is restored on startup
4053 with the 'h' flag in 'viminfo' |viminfo-h|.
4054 NOTE: This option is reset when 'compatible' is set.
4055
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 *'icon'* *'noicon'*
4057'icon' boolean (default off, on when title can be restored)
4058 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059 {not available when compiled without the |+title|
4060 feature}
4061 When on, the icon text of the window will be set to the value of
4062 'iconstring' (if it is not empty), or to the name of the file
4063 currently being edited. Only the last part of the name is used.
4064 Overridden by the 'iconstring' option.
4065 Only works if the terminal supports setting window icons (currently
4066 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4067 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4068 builtin termcap).
4069 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004070 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004072 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073
4074 *'iconstring'*
4075'iconstring' string (default "")
4076 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 {not available when compiled without the |+title|
4078 feature}
4079 When this option is not empty, it will be used for the icon text of
4080 the window. This happens only when the 'icon' option is on.
4081 Only works if the terminal supports setting window icon text
4082 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4083 Does not work for MS Windows.
4084 When Vim was compiled with HAVE_X11 defined, the original icon will be
4085 restored if possible |X11|.
4086 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004087 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004089 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 {not available when compiled without the |+statusline| feature}
4091
4092 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4093'ignorecase' 'ic' boolean (default off)
4094 global
4095 Ignore case in search patterns. Also used when searching in the tags
4096 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004097 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098 Can be overruled by using "\c" or "\C" in the pattern, see
4099 |/ignorecase|.
4100
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004101 *'imactivatefunc'* *'imaf'*
4102'imactivatefunc' 'imaf' string (default "")
4103 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004104 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004105 activate or deactivate the Input Method.
4106 It is not used in the GUI.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004107 The expression will be evaluated in the |sandbox| when set from a
4108 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004109
4110 Example: >
4111 function ImActivateFunc(active)
4112 if a:active
4113 ... do something
4114 else
4115 ... do something
4116 endif
4117 " return value is not used
4118 endfunction
4119 set imactivatefunc=ImActivateFunc
4120<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 *'imactivatekey'* *'imak'*
4122'imactivatekey' 'imak' string (default "")
4123 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004125 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 Specifies the key that your Input Method in X-Windows uses for
4127 activation. When this is specified correctly, vim can fully control
4128 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4129 You can't use this option to change the activation key, the option
4130 tells Vim what the key is.
4131 Format:
4132 [MODIFIER_FLAG-]KEY_STRING
4133
4134 These characters can be used for MODIFIER_FLAG (case is ignored):
4135 S Shift key
4136 L Lock key
4137 C Control key
4138 1 Mod1 key
4139 2 Mod2 key
4140 3 Mod3 key
4141 4 Mod4 key
4142 5 Mod5 key
4143 Combinations are allowed, for example "S-C-space" or "SC-space" are
4144 both shift+ctrl+space.
4145 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4146
4147 Example: >
4148 :set imactivatekey=S-space
4149< "S-space" means shift+space. This is the activation key for kinput2 +
4150 canna (Japanese), and ami (Korean).
4151
4152 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4153'imcmdline' 'imc' boolean (default off)
4154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 When set the Input Method is always on when starting to edit a command
4156 line, unless entering a search pattern (see 'imsearch' for that).
4157 Setting this option is useful when your input method allows entering
4158 English characters directly, e.g., when it's used to type accented
4159 characters with dead keys.
4160
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004161 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4163 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 When set the Input Method is never used. This is useful to disable
4165 the IM when it doesn't work properly.
4166 Currently this option is on by default for SGI/IRIX machines. This
4167 may change in later releases.
4168
4169 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004170'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 Specifies whether :lmap or an Input Method (IM) is to be used in
4173 Insert mode. Valid values:
4174 0 :lmap is off and IM is off
4175 1 :lmap is ON and IM is off
4176 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177 To always reset the option to zero when leaving Insert mode with <Esc>
4178 this can be used: >
4179 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4180< This makes :lmap and IM turn off automatically when leaving Insert
4181 mode.
4182 Note that this option changes when using CTRL-^ in Insert mode
4183 |i_CTRL-^|.
4184 The value is set to 1 when setting 'keymap' to a valid keymap name.
4185 It is also used for the argument of commands like "r" and "f".
4186 The value 0 may not work correctly with Athena and Motif with some XIM
4187 methods. Use 'imdisable' to disable XIM then.
4188
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004189 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004190 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004191 |+multi_byte_ime| or |global-ime|.
4192
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004194'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196 Specifies whether :lmap or an Input Method (IM) is to be used when
4197 entering a search pattern. Valid values:
4198 -1 the value of 'iminsert' is used, makes it look like
4199 'iminsert' is also used when typing a search pattern
4200 0 :lmap is off and IM is off
4201 1 :lmap is ON and IM is off
4202 2 :lmap is off and IM is ON
4203 Note that this option changes when using CTRL-^ in Command-line mode
4204 |c_CTRL-^|.
4205 The value is set to 1 when it is not -1 and setting the 'keymap'
4206 option to a valid keymap name.
4207 The value 0 may not work correctly with Athena and Motif with some XIM
4208 methods. Use 'imdisable' to disable XIM then.
4209
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004210 *'imstatusfunc'* *'imsf'*
4211'imstatusfunc' 'imsf' string (default "")
4212 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004213 This option specifies a function that is called to obtain the status
4214 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004215 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004216
4217 Example: >
4218 function ImStatusFunc()
4219 let is_active = ...do something
4220 return is_active ? 1 : 0
4221 endfunction
4222 set imstatusfunc=ImStatusFunc
4223<
4224 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004225 The expression will be evaluated in the |sandbox| when set from a
4226 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004227
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004228 *'imstyle'* *'imst'*
4229'imstyle' 'imst' number (default 1)
4230 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004231 {only available when compiled with |+xim| and
4232 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004233 This option specifies the input style of Input Method:
4234 0 use on-the-spot style
4235 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004236 See: |xim-input-style|
4237
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004238 For a long time on-the-spot style had been used in the GTK version of
4239 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004240 |single-repeat|, etc. Therefore over-the-spot style becomes the
4241 default now. This should work fine for most people, however if you
4242 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004243 The expression will be evaluated in the |sandbox| when set from a
4244 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004245
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246 *'include'* *'inc'*
4247'include' 'inc' string (default "^\s*#\s*include")
4248 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004249 {not available when compiled without the
4250 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004251 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004252 pattern, just like for the "/" command (See |pattern|). The default
4253 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004254 "]I", "[d", etc.
4255 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004256 comes after the matched pattern. But if "\zs" appears in the pattern
4257 then the text matched from "\zs" to the end, or until "\ze" if it
4258 appears, is used as the file name. Use this to include characters
4259 that are not in 'isfname', such as a space. You can then use
4260 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004261 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262
4263 *'includeexpr'* *'inex'*
4264'includeexpr' 'inex' string (default "")
4265 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004267 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004269 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270 :set includeexpr=substitute(v:fname,'\\.','/','g')
4271< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004272
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004274 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275 Also used for |<cfile>|.
4276
Bram Moolenaar30b65812012-07-12 22:01:11 +02004277 The expression will be evaluated in the |sandbox| when set from a
4278 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004279 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004280
4281 It is not allowed to change text or jump to another window while
4282 evaluating 'includeexpr' |textlock|.
4283
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004285'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4286 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004289 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004290 While typing a search command, show where the pattern, as it was typed
4291 so far, matches. The matched string is highlighted. If the pattern
4292 is invalid or not found, nothing is shown. The screen will be updated
4293 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004294 Also applies to the pattern in commands: >
4295 :global
4296 :lvimgrep
4297 :lvimgrepadd
4298 :smagic
4299 :snomagic
4300 :sort
4301 :substitute
4302 :vglobal
4303 :vimgrep
4304 :vimgrepadd
4305< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004306 original position when no match is found and when pressing <Esc>. You
4307 still need to finish the search command with <Enter> to move the
4308 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004309 You can use the CTRL-G and CTRL-T keys to move to the next and
4310 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004311 When compiled with the |+reltime| feature Vim only searches for about
4312 half a second. With a complicated pattern and/or a lot of text the
4313 match may not be found. This is to avoid that Vim hangs while you
4314 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004315 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004316 When 'hlsearch' is on, all matched strings are highlighted too while
4317 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004318 If you don't want to turn 'hlsearch' on, but want to highlight all
4319 matches while searching, you can turn on and off 'hlsearch' with
4320 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004321 augroup vimrc-incsearch-highlight
4322 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004323 autocmd CmdlineEnter /,\? :set hlsearch
4324 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004325 augroup END
4326<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004327 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004328 to the command line. If 'ignorecase' and 'smartcase' are set and the
4329 command line has no uppercase characters, the added character is
4330 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004331 CTRL-R CTRL-W can be used to add the word at the end of the current
4332 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 NOTE: This option is reset when 'compatible' is set.
4334
4335 *'indentexpr'* *'inde'*
4336'indentexpr' 'inde' string (default "")
4337 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 {not available when compiled without the |+cindent|
4339 or |+eval| features}
4340 Expression which is evaluated to obtain the proper indent for a line.
4341 It is used when a new line is created, for the |=| operator and
4342 in Insert mode as specified with the 'indentkeys' option.
4343 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004344 'smartindent' indenting. When 'lisp' is set, this option is
4345 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 When 'paste' is set this option is not used for indenting.
4347 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004348 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 when the expression is evaluated (but it may be moved around).
4350 The expression must return the number of spaces worth of indent. It
4351 can return "-1" to keep the current indent (this means 'autoindent' is
4352 used for the indent).
4353 Functions useful for computing the indent are |indent()|, |cindent()|
4354 and |lispindent()|.
4355 The evaluation of the expression must not have side effects! It must
4356 not change the text, jump to another window, etc. Afterwards the
4357 cursor position is always restored, thus the cursor may be moved.
4358 Normally this option would be set to call a function: >
4359 :set indentexpr=GetMyIndent()
4360< Error messages will be suppressed, unless the 'debug' option contains
4361 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004362 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004363 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364
Bram Moolenaar30b65812012-07-12 22:01:11 +02004365 The expression will be evaluated in the |sandbox| when set from a
4366 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004367 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004368
4369 It is not allowed to change text or jump to another window while
4370 evaluating 'indentexpr' |textlock|.
4371
4372
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004374'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 {not available when compiled without the |+cindent|
4377 feature}
4378 A list of keys that, when typed in Insert mode, cause reindenting of
4379 the current line. Only happens if 'indentexpr' isn't empty.
4380 The format is identical to 'cinkeys', see |indentkeys-format|.
4381 See |C-indenting| and |indent-expression|.
4382
4383 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4384'infercase' 'inf' boolean (default off)
4385 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004387 'ignorecase' is also on, the case of the match is adjusted depending
4388 on the typed text. If the typed text contains a lowercase letter
4389 where the match has an upper case letter, the completed part is made
4390 lowercase. If the typed text has no lowercase letters and the match
4391 has a lowercase letter where the typed text has an uppercase letter,
4392 and there is a letter before it, the completed part is made uppercase.
4393 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394
4395 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4396'insertmode' 'im' boolean (default off)
4397 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398 Makes Vim work in a way that Insert mode is the default mode. Useful
4399 if you want to use Vim as a modeless editor. Used for |evim|.
4400 These Insert mode commands will be useful:
4401 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004402 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004403 this is a mapping, it is executed as if 'insertmode' was off.
4404 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004406 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4407 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408
4409 These items change when 'insertmode' is set:
4410 - when starting to edit of a file, Vim goes to Insert mode.
4411 - <Esc> in Insert mode is a no-op and beeps.
4412 - <Esc> in Normal mode makes Vim go to Insert mode.
4413 - CTRL-L in Insert mode is a command, it is not inserted.
4414 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4415 However, when <Esc> is used inside a mapping, it behaves like
4416 'insertmode' was not set. This was done to be able to use the same
4417 mappings with 'insertmode' set or not set.
4418 When executing commands with |:normal| 'insertmode' is not used.
4419
4420 NOTE: This option is reset when 'compatible' is set.
4421
4422 *'isfname'* *'isf'*
4423'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4424 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4425 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4426 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4427 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4428 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4429 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430 The characters specified by this option are included in file names and
4431 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004432 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 Multi-byte characters 256 and above are always included, only the
4434 characters up to 255 are specified with this option.
4435 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004436 Think twice before adding white space to this option. Although a
4437 space may appear inside a file name, the effect will be that Vim
4438 doesn't know where a file name starts or ends when doing completion.
4439 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440
4441 Note that on systems using a backslash as path separator, Vim tries to
4442 do its best to make it work as you would expect. That is a bit
4443 tricky, since Vi originally used the backslash to escape special
4444 characters. Vim will not remove a backslash in front of a normal file
4445 name character on these systems, but it will on Unix and alikes. The
4446 '&' and '^' are not included by default, because these are special for
4447 cmd.exe.
4448
4449 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004450 Each part can be a single character number or a range. A range is two
4451 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452 decimal number between 0 and 255 or the ASCII character itself (does
4453 not work for digits). Example:
4454 "_,-,128-140,#-43" (include '_' and '-' and the range
4455 128 to 140 and '#' to 43)
4456 If a part starts with '^', the following character number or range
4457 will be excluded from the option. The option is interpreted from left
4458 to right. Put the excluded character after the range where it is
4459 included. To include '^' itself use it as the last character of the
4460 option or the end of a range. Example:
4461 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4462 If the character is '@', all characters where isalpha() returns TRUE
4463 are included. Normally these are the characters a to z and A to Z,
4464 plus accented characters. To include '@' itself use "@-@". Examples:
4465 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004466 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004467 "a-z,A-Z,@-@" All letters plus the '@' character.
4468 A comma can be included by using it where a character number is
4469 expected. Example:
4470 "48-57,,,_" Digits, comma and underscore.
4471 A comma can be excluded by prepending a '^'. Example:
4472 " -~,^,,9" All characters from space to '~', excluding
4473 comma, plus <Tab>.
4474 See |option-backslash| about including spaces and backslashes.
4475
4476 *'isident'* *'isi'*
4477'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4478 "@,48-57,_,128-167,224-235"
4479 otherwise: "@,48-57,_,192-255")
4480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481 The characters given by this option are included in identifiers.
4482 Identifiers are used in recognizing environment variables and after a
4483 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004484 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004485 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004487 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4489
4490 *'iskeyword'* *'isk'*
4491'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4492 "@,48-57,_,128-167,224-235"
4493 otherwise: "@,48-57,_,192-255"
4494 Vi default: "@,48-57,_")
4495 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004497 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004498 'isfname' for a description of the format of this option. For '@'
4499 characters above 255 check the "word" character class.
4500 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 For a help file it is set to all non-blank printable characters except
4502 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4503 command).
4504 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004505 This option also influences syntax highlighting, unless the syntax
4506 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 NOTE: This option is set to the Vi default value when 'compatible' is
4508 set and to the Vim default value when 'compatible' is reset.
4509
4510 *'isprint'* *'isp'*
4511'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4512 "@,~-255"; otherwise: "@,161-255")
4513 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 The characters given by this option are displayed directly on the
4515 screen. It is also used for "\p" in a |pattern|. The characters from
4516 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4517 even when they are not included in 'isprint' or excluded. See
4518 'isfname' for a description of the format of this option.
4519
4520 Non-printable characters are displayed with two characters:
4521 0 - 31 "^@" - "^_"
4522 32 - 126 always single characters
4523 127 "^?"
4524 128 - 159 "~@" - "~_"
4525 160 - 254 "| " - "|~"
4526 255 "~?"
4527 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4528 displayed as <xx>, with the hexadecimal value of the byte.
4529 When 'display' contains "uhex" all unprintable characters are
4530 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004531 The SpecialKey highlighting will be used for unprintable characters.
4532 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533
4534 Multi-byte characters 256 and above are always included, only the
4535 characters up to 255 are specified with this option. When a character
4536 is printable but it is not available in the current font, a
4537 replacement character will be shown.
4538 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4539 There is no option to specify these characters.
4540
4541 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4542'joinspaces' 'js' boolean (default on)
4543 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544 Insert two spaces after a '.', '?' and '!' with a join command.
4545 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4546 Otherwise only one space is inserted.
4547 NOTE: This option is set when 'compatible' is set.
4548
4549 *'key'*
4550'key' string (default "")
4551 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004552 {only available when compiled with the |+cryptv|
4553 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004555 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 Careful: Do not set the key value by hand, someone might see the typed
4557 key. Use the |:X| command. But you can make 'key' empty: >
4558 :set key=
4559< It is not possible to get the value of this option with ":set key" or
4560 "echo &key". This is to avoid showing it to someone who shouldn't
4561 know. It also means you cannot see it yourself once you have set it,
4562 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004563 You can use "&key" in an expression to detect whether encryption is
4564 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565
4566 *'keymap'* *'kmp'* *E544*
4567'keymap' 'kmp' string (default "")
4568 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 {only available when compiled with the |+keymap|
4570 feature}
4571 Name of a keyboard mapping. See |mbyte-keymap|.
4572 Setting this option to a valid keymap name has the side effect of
4573 setting 'iminsert' to one, so that the keymap becomes effective.
4574 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004575 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576
4577 *'keymodel'* *'km'*
4578'keymodel' 'km' string (default "")
4579 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 List of comma separated words, which enable special things that keys
4581 can do. These values can be used:
4582 startsel Using a shifted special key starts selection (either
4583 Select mode or Visual mode, depending on "key" being
4584 present in 'selectmode').
4585 stopsel Using a not-shifted special key stops selection.
4586 Special keys in this context are the cursor keys, <End>, <Home>,
4587 <PageUp> and <PageDown>.
4588 The 'keymodel' option is set by the |:behave| command.
4589
4590 *'keywordprg'* *'kp'*
4591'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004592 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 Program to use for the |K| command. Environment variables are
4595 expanded |:set_env|. ":help" may be used to access the Vim internal
4596 help. (Note that previously setting the global option to the empty
4597 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004598 When the first character is ":", the command is invoked as a Vim
4599 Ex command prefixed with [count].
4600 When "man", "man -s" or an Ex command is used, Vim will automatically
4601 translate a count for the "K" command and pass it as the first
4602 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 See |option-backslash| about including spaces and backslashes.
4604 Example: >
4605 :set keywordprg=man\ -s
4606< This option cannot be set from a |modeline| or in the |sandbox|, for
4607 security reasons.
4608
4609 *'langmap'* *'lmap'* *E357* *E358*
4610'langmap' 'lmap' string (default "")
4611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 {only available when compiled with the |+langmap|
4613 feature}
4614 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004615 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004616 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 care of translating these special characters to the original meaning
4618 of the key. This means you don't have to change the keyboard mode to
4619 be able to execute Normal mode commands.
4620 This is the opposite of the 'keymap' option, where characters are
4621 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004622 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004623 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004624 This option cannot be set from a |modeline| or in the |sandbox|, for
4625 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004627 Example (for Greek, in UTF-8): *greek* >
4628 :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 +00004629< Example (exchanges meaning of z and y for commands): >
4630 :set langmap=zy,yz,ZY,YZ
4631<
4632 The 'langmap' option is a list of parts, separated with commas. Each
4633 part can be in one of two forms:
4634 1. A list of pairs. Each pair is a "from" character immediately
4635 followed by the "to" character. Examples: "aA", "aAbBcC".
4636 2. A list of "from" characters, a semi-colon and a list of "to"
4637 characters. Example: "abc;ABC"
4638 Example: "aA,fgh;FGH,cCdDeE"
4639 Special characters need to be preceded with a backslash. These are
4640 ";", ',' and backslash itself.
4641
4642 This will allow you to activate vim actions without having to switch
4643 back and forth between the languages. Your language characters will
4644 be understood as normal vim English characters (according to the
4645 langmap mappings) in the following cases:
4646 o Normal/Visual mode (commands, buffer/register names, user mappings)
4647 o Insert/Replace Mode: Register names after CTRL-R
4648 o Insert/Replace Mode: Mappings
4649 Characters entered in Command-line mode will NOT be affected by
4650 this option. Note that this option can be changed at any time
4651 allowing to switch between mappings for different languages/encodings.
4652 Use a mapping to avoid having to type it each time!
4653
4654 *'langmenu'* *'lm'*
4655'langmenu' 'lm' string (default "")
4656 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657 {only available when compiled with the |+menu| and
4658 |+multi_lang| features}
4659 Language to use for menu translation. Tells which file is loaded
4660 from the "lang" directory in 'runtimepath': >
4661 "lang/menu_" . &langmenu . ".vim"
4662< (without the spaces). For example, to always use the Dutch menus, no
4663 matter what $LANG is set to: >
4664 :set langmenu=nl_NL.ISO_8859-1
4665< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004666 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667 If your $LANG is set to a non-English language but you do want to use
4668 the English menus: >
4669 :set langmenu=none
4670< This option must be set before loading menus, switching on filetype
4671 detection or syntax highlighting. Once the menus are defined setting
4672 this option has no effect. But you could do this: >
4673 :source $VIMRUNTIME/delmenu.vim
4674 :set langmenu=de_DE.ISO_8859-1
4675 :source $VIMRUNTIME/menu.vim
4676< Warning: This deletes all menus that you defined yourself!
4677
Bram Moolenaard94464e2015-11-02 15:28:18 +01004678 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004679'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004680 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004681 {only available when compiled with the |+langmap|
4682 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004683 This is just like 'langremap' but with the value inverted. It only
4684 exists for backwards compatibility. When setting 'langremap' then
4685 'langnoremap' is set to the inverted value, and the other way around.
4686
4687 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4688'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4689 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004690 {only available when compiled with the |+langmap|
4691 feature}
4692 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004693 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004694 'langmap' disables some of your mappings, try resetting this option.
4695 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004696 that works for you to avoid mappings to break.
4697
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698 *'laststatus'* *'ls'*
4699'laststatus' 'ls' number (default 1)
4700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 The value of this option influences when the last window will have a
4702 status line:
4703 0: never
4704 1: only if there are at least two windows
4705 2: always
4706 The screen looks nicer with a status line if you have several
4707 windows, but it takes another screen line. |status-line|
4708
4709 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4710'lazyredraw' 'lz' boolean (default off)
4711 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 When this option is set, the screen will not be redrawn while
4713 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004714 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 update use |:redraw|.
4716
4717 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4718'linebreak' 'lbr' boolean (default off)
4719 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004720 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004722 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 than at the last character that fits on the screen. Unlike
4724 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004725 it only affects the way the file is displayed, not its contents.
4726 If 'breakindent' is set, line is visually indented. Then, the value
4727 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004728 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 Note that <Tab> characters after an <EOL> are mostly not displayed
4730 with the right amount of white space.
4731
4732 *'lines'* *E593*
4733'lines' number (default 24 or terminal height)
4734 global
4735 Number of lines of the Vim window.
4736 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004737 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 When Vim is running in the GUI or in a resizable window, setting this
4739 option will cause the window size to be changed. When you only want
4740 to use the size for the GUI, put the command in your |gvimrc| file.
4741 Vim limits the number of lines to what fits on the screen. You can
4742 use this command to get the tallest window possible: >
4743 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004744< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004745 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004746 When you set this option and Vim is unable to change the physical
4747 number of lines of the display, the display may be messed up.
4748
4749 *'linespace'* *'lsp'*
4750'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4751 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752 {only in the GUI}
4753 Number of pixel lines inserted between characters. Useful if the font
4754 uses the full character cell height, making lines touch each other.
4755 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004756 With some fonts there can be too much room between lines (to have
4757 space for ascents and descents). Then it makes sense to set
4758 'linespace' to a negative value. This may cause display problems
4759 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760
4761 *'lisp'* *'nolisp'*
4762'lisp' boolean (default off)
4763 local to buffer
4764 {not available when compiled without the |+lispindent|
4765 feature}
4766 Lisp mode: When <Enter> is typed in insert mode set the indent for
4767 the next line to Lisp standards (well, sort of). Also happens with
4768 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4769 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4770 better. Also see 'lispwords'.
4771 The '-' character is included in keyword characters. Redefines the
4772 "=" operator to use this same indentation algorithm rather than
4773 calling an external program if 'equalprg' is empty.
4774 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775
4776 *'lispwords'* *'lw'*
4777'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004778 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004779 {not available when compiled without the |+lispindent|
4780 feature}
4781 Comma separated list of words that influence the Lisp indenting.
4782 |'lisp'|
4783
4784 *'list'* *'nolist'*
4785'list' boolean (default off)
4786 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004787 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4788 line. Useful to see the difference between tabs and spaces and for
4789 trailing blanks. Further changed by the 'listchars' option.
4790
4791 The cursor is displayed at the start of the space a Tab character
4792 occupies, not at the end as usual in Normal mode. To get this cursor
4793 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004794 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004795<
4796 Note that list mode will also affect formatting (set with 'textwidth'
4797 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 changing the way tabs are displayed.
4799
4800 *'listchars'* *'lcs'*
4801'listchars' 'lcs' string (default "eol:$")
4802 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004803 Strings to use in 'list' mode and for the |:list| command. It is a
4804 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004805 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 eol:c Character to show at the end of each line. When
4807 omitted, there is no extra character at the end of the
4808 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004809 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004810 tab:xy[z] Two or three characters to be used to show a tab.
4811 The third character is optional.
4812
4813 tab:xy The 'x' is always used, then 'y' as many times as will
4814 fit. Thus "tab:>-" displays:
4815 >
4816 >-
4817 >--
4818 etc.
4819
4820 tab:xyz The 'z' is always used, then 'x' is prepended, and
4821 then 'y' is used as many times as will fit. Thus
4822 "tab:<->" displays:
4823 >
4824 <>
4825 <->
4826 <-->
4827 etc.
4828
4829 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004830 *lcs-space*
4831 space:c Character to show for a space. When omitted, spaces
4832 are left blank.
4833 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004834 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004835 trailing spaces are blank. Overrides the "space"
4836 setting for trailing spaces.
4837 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838 extends:c Character to show in the last column, when 'wrap' is
4839 off and the line continues beyond the right of the
4840 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004841 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004842 precedes:c Character to show in the first visible column of the
4843 physical line, when there is text preceding the
4844 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004845 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004846 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004847 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004848 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004849 nbsp:c Character to show for a non-breakable space character
4850 (0xA0 (160 decimal) and U+202F). Left blank when
4851 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004853 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004854 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004855 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856
4857 Examples: >
4858 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004859 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 :set lcs=extends:>,precedes:<
4861< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004862 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004863 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864
4865 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4866'loadplugins' 'lpl' boolean (default on)
4867 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868 When on the plugin scripts are loaded when starting up |load-plugins|.
4869 This option can be reset in your |vimrc| file to disable the loading
4870 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004871 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4872 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004873
Bram Moolenaard94464e2015-11-02 15:28:18 +01004874 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004875'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004876 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004877 {only available when compiled with the |+lua/dyn|
4878 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004879 Specifies the name of the Lua shared library. The default is
4880 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004881 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004882 This option cannot be set from a |modeline| or in the |sandbox|, for
4883 security reasons.
4884
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004885 *'macatsui'* *'nomacatsui'*
4886'macatsui' boolean (default on)
4887 global
4888 {only available in Mac GUI version}
4889 This is a workaround for when drawing doesn't work properly. When set
4890 and compiled with multi-byte support ATSUI text drawing is used. When
4891 not set ATSUI text drawing is not used. Switch this option off when
4892 you experience drawing problems. In a future version the problems may
4893 be solved and this option becomes obsolete. Therefore use this method
4894 to unset it: >
4895 if exists('&macatsui')
4896 set nomacatsui
4897 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004898< Another option to check if you have drawing problems is
4899 'termencoding'.
4900
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901 *'magic'* *'nomagic'*
4902'magic' boolean (default on)
4903 global
4904 Changes the special characters that can be used in search patterns.
4905 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004906 WARNING: Switching this option off most likely breaks plugins! That
4907 is because many patterns assume it's on and will fail when it's off.
4908 Only switch it off when working with old Vi scripts. In any other
4909 situation write patterns that work when 'magic' is on. Include "\M"
4910 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911
4912 *'makeef'* *'mef'*
4913'makeef' 'mef' string (default: "")
4914 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004915 {not available when compiled without the |+quickfix|
4916 feature}
4917 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4918 and the |:grep| command.
4919 When it is empty, an internally generated temp file will be used.
4920 When "##" is included, it is replaced by a number to make the name
4921 unique. This makes sure that the ":make" command doesn't overwrite an
4922 existing file.
4923 NOT used for the ":cf" command. See 'errorfile' for that.
4924 Environment variables are expanded |:set_env|.
4925 See |option-backslash| about including spaces and backslashes.
4926 This option cannot be set from a |modeline| or in the |sandbox|, for
4927 security reasons.
4928
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004929 *'makeencoding'* *'menc'*
4930'makeencoding' 'menc' string (default "")
4931 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004932 Encoding used for reading the output of external commands. When empty,
4933 encoding is not converted.
4934 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4935 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4936 and `:laddfile`.
4937
4938 This would be mostly useful when you use MS-Windows and set 'encoding'
4939 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4940 'makeencoding' to "char" has the same effect as setting to the system
4941 locale encoding. Example: >
4942 :set encoding=utf-8
4943 :set makeencoding=char " system locale is used
4944<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 *'makeprg'* *'mp'*
4946'makeprg' 'mp' string (default "make", VMS: "MMS")
4947 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004948 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004949 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4950 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004951 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004952 Environment variables are expanded |:set_env|. See |option-backslash|
4953 about including spaces and backslashes.
4954 Note that a '|' must be escaped twice: once for ":set" and once for
4955 the interpretation of a command. When you use a filter called
4956 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 :set makeprg=gmake\ \\\|\ myfilter
4958< The placeholder "$*" can be given (even multiple times) to specify
4959 where the arguments will be included, for example: >
4960 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4961< This option cannot be set from a |modeline| or in the |sandbox|, for
4962 security reasons.
4963
4964 *'matchpairs'* *'mps'*
4965'matchpairs' 'mps' string (default "(:),{:},[:]")
4966 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004968 other.
4969 Only character pairs are allowed that are different, thus you cannot
4970 jump between two double quotes.
4971 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004972 The pairs must be separated by a comma. Example for including '<' and
4973 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004974 :set mps+=<:>
4975
4976< A more exotic example, to jump between the '=' and ';' in an
4977 assignment, useful for languages like C and Java: >
4978 :au FileType c,cpp,java set mps+==:;
4979
4980< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01004981 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982
4983 *'matchtime'* *'mat'*
4984'matchtime' 'mat' number (default 5)
4985 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986 Tenths of a second to show the matching paren, when 'showmatch' is
4987 set. Note that this is not in milliseconds, like other options that
4988 set a time. This is to be compatible with Nvi.
4989
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004990 *'maxcombine'* *'mco'*
4991'maxcombine' 'mco' number (default 2)
4992 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004993 The maximum number of combining characters supported for displaying.
4994 Only used when 'encoding' is "utf-8".
4995 The default is OK for most languages. Hebrew may require 4.
4996 Maximum value is 6.
4997 Even when this option is set to 2 you can still edit text with more
4998 combining characters, you just can't see them. Use |g8| or |ga|.
4999 See |mbyte-combining|.
5000
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 *'maxfuncdepth'* *'mfd'*
5002'maxfuncdepth' 'mfd' number (default 100)
5003 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005004 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005005 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006 Maximum depth of function calls for user functions. This normally
5007 catches endless recursion. When using a recursive function with
5008 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5009 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005010 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005011 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 See also |:function|.
5013
5014 *'maxmapdepth'* *'mmd'* *E223*
5015'maxmapdepth' 'mmd' number (default 1000)
5016 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005017 Maximum number of times a mapping is done without resulting in a
5018 character to be used. This normally catches endless mappings, like
5019 ":map x y" with ":map y x". It still does not catch ":map g wg",
5020 because the 'w' is used before the next mapping is done. See also
5021 |key-mapping|.
5022
5023 *'maxmem'* *'mm'*
5024'maxmem' 'mm' number (default between 256 to 5120 (system
5025 dependent) or half the amount of memory
5026 available)
5027 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005028 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5029 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005030 other memory to be freed.
5031 The maximum usable value is about 2000000. Use this to work without a
5032 limit.
5033 The value is ignored when 'swapfile' is off.
5034 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005036 *'maxmempattern'* *'mmp'*
5037'maxmempattern' 'mmp' number (default 1000)
5038 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005039 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005040 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005041 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005042 When Vim runs into the limit it gives an error message and mostly
5043 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005044 Running into the limit often means that the pattern is very
5045 inefficient or too complex. This may already happen with the pattern
5046 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005047 Might also happen on redraw, when syntax rules try to match a complex
5048 text structure.
5049 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5050 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005051
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 *'maxmemtot'* *'mmt'*
5053'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5054 dependent) or half the amount of memory
5055 available)
5056 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005057 Maximum amount of memory in Kbyte to use for all buffers together.
5058 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005059 without a limit.
5060 On 64 bit machines higher values might work. But hey, do you really
5061 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005062 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005063 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005064 Buffers with 'swapfile' off still count to the total amount of memory
5065 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005066 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067
5068 *'menuitems'* *'mis'*
5069'menuitems' 'mis' number (default 25)
5070 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071 {not available when compiled without the |+menu|
5072 feature}
5073 Maximum number of items to use in a menu. Used for menus that are
5074 generated from a list of items, e.g., the Buffers menu. Changing this
5075 option has no direct effect, the menu must be refreshed first.
5076
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005077 *'mkspellmem'* *'msm'*
5078'mkspellmem' 'msm' string (default "460000,2000,500")
5079 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005080 {not available when compiled without the |+syntax|
5081 feature}
5082 Parameters for |:mkspell|. This tunes when to start compressing the
5083 word tree. Compression can be slow when there are many words, but
5084 it's needed to avoid running out of memory. The amount of memory used
5085 per word depends very much on how similar the words are, that's why
5086 this tuning is complicated.
5087
5088 There are three numbers, separated by commas:
5089 {start},{inc},{added}
5090
5091 For most languages the uncompressed word tree fits in memory. {start}
5092 gives the amount of memory in Kbyte that can be used before any
5093 compression is done. It should be a bit smaller than the amount of
5094 memory that is available to Vim.
5095
5096 When going over the {start} limit the {inc} number specifies the
5097 amount of memory in Kbyte that can be allocated before another
5098 compression is done. A low number means compression is done after
5099 less words are added, which is slow. A high number means more memory
5100 will be allocated.
5101
5102 After doing compression, {added} times 1024 words can be added before
5103 the {inc} limit is ignored and compression is done when any extra
5104 amount of memory is needed. A low number means there is a smaller
5105 chance of hitting the {inc} limit, less memory is used but it's
5106 slower.
5107
5108 The languages for which these numbers are important are Italian and
5109 Hungarian. The default works for when you have about 512 Mbyte. If
5110 you have 1 Gbyte you could use: >
5111 :set mkspellmem=900000,3000,800
5112< If you have less than 512 Mbyte |:mkspell| may fail for some
5113 languages, no matter what you set 'mkspellmem' to.
5114
Bram Moolenaar07607392019-05-26 19:20:43 +02005115 This option cannot be set from a |modeline| or in the |sandbox|.
5116
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005118'modeline' 'ml' boolean (Vim default: on (off for root),
5119 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005121 If 'modeline' is on 'modelines' gives the number of lines that is
5122 checked for set commands. If 'modeline' is off or 'modelines' is zero
5123 no lines are checked. See |modeline|.
5124
5125 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5126'modelineexpr' 'mle' boolean (default: off)
5127 global
5128 When on allow some options that are an expression to be set in the
5129 modeline. Check the option for whether it is affected by
5130 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005131 This option cannot be set from a |modeline| or in the |sandbox|, for
5132 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005133
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134 *'modelines'* *'mls'*
5135'modelines' 'mls' number (default 5)
5136 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005137 If 'modeline' is on 'modelines' gives the number of lines that is
5138 checked for set commands. If 'modeline' is off or 'modelines' is zero
5139 no lines are checked. See |modeline|.
5140 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5141 set and to the Vim default value when 'compatible' is reset.
5142
5143 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005144 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005145'modifiable' 'ma' boolean (default on)
5146 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147 When off the buffer contents cannot be changed. The 'fileformat' and
5148 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005149 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005150
5151 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5152'modified' 'mod' boolean (default off)
5153 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 When on, the buffer is considered to be modified. This option is set
5155 when:
5156 1. A change was made to the text since it was last written. Using the
5157 |undo| command to go back to the original text will reset the
5158 option. But undoing changes that were made before writing the
5159 buffer will set the option again, since the text is different from
5160 when it was written.
5161 2. 'fileformat' or 'fileencoding' is different from its original
5162 value. The original value is set when the buffer is read or
5163 written. A ":set nomodified" command also resets the original
5164 values to the current values and the 'modified' option will be
5165 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005166 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005167 This option is not set when a change is made to the buffer as the
5168 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5169 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5170 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5172 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005173 Note that the text may actually be the same, e.g. 'modified' is set
5174 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175
5176 *'more'* *'nomore'*
5177'more' boolean (Vim default: on, Vi default: off)
5178 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 When on, listings pause when the whole screen is filled. You will get
5180 the |more-prompt|. When this option is off there are no pauses, the
5181 listing continues until finished.
5182 NOTE: This option is set to the Vi default value when 'compatible' is
5183 set and to the Vim default value when 'compatible' is reset.
5184
5185 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005186'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5187 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005190 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5191 sysmouse and Linux console with gpm). For using the mouse in the
5192 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005194 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005195 v Visual mode
5196 i Insert mode
5197 c Command-line mode
5198 h all previous modes when editing a help file
5199 a all previous modes
5200 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005201 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 :set mouse=a
5203< When the mouse is not enabled, the GUI will still use the mouse for
5204 modeless selection. This doesn't move the text cursor.
5205
5206 See |mouse-using|. Also see |'clipboard'|.
5207
5208 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005209 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210 the mouse buttons can still be used by keeping the shift key pressed.
5211 Also see the 'clipboard' option.
5212
5213 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5214'mousefocus' 'mousef' boolean (default off)
5215 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216 {only works in the GUI}
5217 The window that the mouse pointer is on is automatically activated.
5218 When changing the window layout or window focus in another way, the
5219 mouse pointer is moved to the window with keyboard focus. Off is the
5220 default because it makes using the pull down menus a little goofy, as
5221 a pointer transit may activate a window unintentionally.
5222
5223 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5224'mousehide' 'mh' boolean (default on)
5225 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 {only works in the GUI}
5227 When on, the mouse pointer is hidden when characters are typed.
5228 The mouse pointer is restored when the mouse is moved.
5229
5230 *'mousemodel'* *'mousem'*
5231'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233 Sets the model to use for the mouse. The name mostly specifies what
5234 the right mouse button is used for:
5235 extend Right mouse button extends a selection. This works
5236 like in an xterm.
5237 popup Right mouse button pops up a menu. The shifted left
5238 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005239 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240 popup_setpos Like "popup", but the cursor will be moved to the
5241 position where the mouse was clicked, and thus the
5242 selected operation will act upon the clicked object.
5243 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005244 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 course, that right clicking outside a selection will
5246 end Visual mode.
5247 Overview of what button does what for each model:
5248 mouse extend popup(_setpos) ~
5249 left click place cursor place cursor
5250 left drag start selection start selection
5251 shift-left search word extend selection
5252 right click extend selection popup menu (place cursor)
5253 right drag extend selection -
5254 middle click paste paste
5255
5256 In the "popup" model the right mouse button produces a pop-up menu.
5257 You need to define this first, see |popup-menu|.
5258
5259 Note that you can further refine the meaning of buttons with mappings.
5260 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5261 selection (because that's handled in the GUI code directly).
5262
5263 The 'mousemodel' option is set by the |:behave| command.
5264
5265 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005266'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5267 vs:leftright,vd:lrsizing,m:no,
5268 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005269 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270 {only available when compiled with the |+mouseshape|
5271 feature}
5272 This option tells Vim what the mouse pointer should look like in
5273 different modes. The option is a comma separated list of parts, much
5274 like used for 'guicursor'. Each part consist of a mode/location-list
5275 and an argument-list:
5276 mode-list:shape,mode-list:shape,..
5277 The mode-list is a dash separated list of these modes/locations:
5278 In a normal window: ~
5279 n Normal mode
5280 v Visual mode
5281 ve Visual mode with 'selection' "exclusive" (same as 'v',
5282 if not specified)
5283 o Operator-pending mode
5284 i Insert mode
5285 r Replace mode
5286
5287 Others: ~
5288 c appending to the command-line
5289 ci inserting in the command-line
5290 cr replacing in the command-line
5291 m at the 'Hit ENTER' or 'More' prompts
5292 ml idem, but cursor in the last line
5293 e any mode, pointer below last window
5294 s any mode, pointer on a status line
5295 sd any mode, while dragging a status line
5296 vs any mode, pointer on a vertical separator line
5297 vd any mode, while dragging a vertical separator line
5298 a everywhere
5299
5300 The shape is one of the following:
5301 avail name looks like ~
5302 w x arrow Normal mouse pointer
5303 w x blank no pointer at all (use with care!)
5304 w x beam I-beam
5305 w x updown up-down sizing arrows
5306 w x leftright left-right sizing arrows
5307 w x busy The system's usual busy pointer
5308 w x no The system's usual 'no input' pointer
5309 x udsizing indicates up-down resizing
5310 x lrsizing indicates left-right resizing
5311 x crosshair like a big thin +
5312 x hand1 black hand
5313 x hand2 white hand
5314 x pencil what you write with
5315 x question big ?
5316 x rightup-arrow arrow pointing right-up
5317 w x up-arrow arrow pointing up
5318 x <number> any X11 pointer number (see X11/cursorfont.h)
5319
5320 The "avail" column contains a 'w' if the shape is available for Win32,
5321 x for X11.
5322 Any modes not specified or shapes not available use the normal mouse
5323 pointer.
5324
5325 Example: >
5326 :set mouseshape=s:udsizing,m:no
5327< will make the mouse turn to a sizing arrow over the status lines and
5328 indicate no input when the hit-enter prompt is displayed (since
5329 clicking the mouse has no effect in this state.)
5330
5331 *'mousetime'* *'mouset'*
5332'mousetime' 'mouset' number (default 500)
5333 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5335 time in msec between two mouse clicks for the second click to be
5336 recognized as a multi click.
5337
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005338 *'mzschemedll'*
5339'mzschemedll' string (default depends on the build)
5340 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005341 {only available when compiled with the |+mzscheme/dyn|
5342 feature}
5343 Specifies the name of the MzScheme shared library. The default is
5344 DYNAMIC_MZSCH_DLL which was specified at compile time.
5345 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005346 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005347 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005348 This option cannot be set from a |modeline| or in the |sandbox|, for
5349 security reasons.
5350
5351 *'mzschemegcdll'*
5352'mzschemegcdll' string (default depends on the build)
5353 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005354 {only available when compiled with the |+mzscheme/dyn|
5355 feature}
5356 Specifies the name of the MzScheme GC shared library. The default is
5357 DYNAMIC_MZGC_DLL which was specified at compile time.
5358 The value can be equal to 'mzschemedll' if it includes the GC code.
5359 Environment variables are expanded |:set_env|.
5360 This option cannot be set from a |modeline| or in the |sandbox|, for
5361 security reasons.
5362
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005363 *'mzquantum'* *'mzq'*
5364'mzquantum' 'mzq' number (default 100)
5365 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005366 {not available when compiled without the |+mzscheme|
5367 feature}
5368 The number of milliseconds between polls for MzScheme threads.
5369 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005370 NOTE: This option is set to the Vim default value when 'compatible'
5371 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005372
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005374'nrformats' 'nf' string (default "bin,octal,hex",
5375 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005377 This defines what bases Vim will consider for numbers when using the
5378 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5379 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005380 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005381 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005382 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005383 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005385 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386 considered to be hexadecimal. Example: Using CTRL-X on
5387 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005388 bin If included, numbers starting with "0b" or "0B" will be
5389 considered to be binary. Example: Using CTRL-X on
5390 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005391 Numbers which simply begin with a digit in the range 1-9 are always
5392 considered decimal. This also happens for numbers that are not
5393 recognized as octal or hex.
5394
5395 *'number'* *'nu'* *'nonumber'* *'nonu'*
5396'number' 'nu' boolean (default off)
5397 local to window
5398 Print the line number in front of each line. When the 'n' option is
5399 excluded from 'cpoptions' a wrapped line will not use the column of
5400 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005401 The 'numberwidth' option can be used to set the room used for the line
5402 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005403 When a long, wrapped line doesn't start with the first character, '-'
5404 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005405 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5406 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005407 *number_relativenumber*
5408 The 'relativenumber' option changes the displayed number to be
5409 relative to the cursor. Together with 'number' there are these
5410 four combinations (cursor in line 3):
5411
Bram Moolenaar3848e002016-03-19 18:42:29 +01005412 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005413 'nornu' 'nornu' 'rnu' 'rnu'
5414
5415 |apple | 1 apple | 2 apple | 2 apple
5416 |pear | 2 pear | 1 pear | 1 pear
5417 |nobody | 3 nobody | 0 nobody |3 nobody
5418 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005420 *'numberwidth'* *'nuw'*
5421'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5422 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005423 {only available when compiled with the |+linebreak|
5424 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005425 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005426 when the 'number' or 'relativenumber' option is set or printing lines
5427 with a line number. Since one space is always between the number and
5428 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005429 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005430 fit the highest line number in the buffer respectively the number of
5431 rows in the window, depending on whether 'number' or 'relativenumber'
5432 is set. Thus with the Vim default of 4 there is room for a line number
5433 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005434 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005435 NOTE: This option is set to the Vi default value when 'compatible' is
5436 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005437
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005438 *'omnifunc'* *'ofu'*
5439'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005440 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005441 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005442 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005443 This option specifies a function to be used for Insert mode omni
5444 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005445 See |complete-functions| for an explanation of how the function is
5446 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005447 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005448 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005449 This option cannot be set from a |modeline| or in the |sandbox|, for
5450 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005451
5452
Bram Moolenaar02467872007-05-06 13:22:01 +00005453 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005454'opendevice' 'odev' boolean (default off)
5455 global
Bram Moolenaar043545e2006-10-10 16:44:07 +00005456 {only for MS-DOS, MS-Windows and OS/2}
5457 Enable reading and writing from devices. This may get Vim stuck on a
5458 device that can be opened but doesn't actually do the I/O. Therefore
5459 it is off by default.
5460 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5461 result in editing a device.
5462
5463
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005464 *'operatorfunc'* *'opfunc'*
5465'operatorfunc' 'opfunc' string (default: empty)
5466 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005467 This option specifies a function to be called by the |g@| operator.
5468 See |:map-operator| for more info and an example.
5469
5470 This option cannot be set from a |modeline| or in the |sandbox|, for
5471 security reasons.
5472
5473
Bram Moolenaar251e1912011-06-19 05:09:16 +02005474 *'osfiletype'* *'oft'*
5475'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005477 This option was supported on RISC OS, which has been removed.
5478
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005480 *'packpath'* *'pp'*
5481'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005482 Directories used to find packages. See |packages|.
5483
5484
Bram Moolenaar071d4272004-06-13 20:20:40 +00005485 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005486'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487 global
5488 Specifies the nroff macros that separate paragraphs. These are pairs
5489 of two letters (see |object-motions|).
5490
5491 *'paste'* *'nopaste'*
5492'paste' boolean (default off)
5493 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005494 Put Vim in Paste mode. This is useful if you want to cut or copy
5495 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 unexpected effects.
5497 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005498 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 knows about pasting and will mostly do the right thing without 'paste'
5500 being set. The same is true for a terminal where Vim handles the
5501 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005502 This option is reset when starting the GUI. Thus if you set it in
5503 your .vimrc it will work in a terminal, but not in the GUI. Setting
5504 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5505 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506 When the 'paste' option is switched on (also when it was already on):
5507 - mapping in Insert mode and Command-line mode is disabled
5508 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005510 - 'expandtab' is reset
5511 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512 - 'revins' is reset
5513 - 'ruler' is reset
5514 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005515 - 'smartindent' is reset
5516 - 'smarttab' is reset
5517 - 'softtabstop' is set to 0
5518 - 'textwidth' is set to 0
5519 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005520 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005522 - 'indentexpr'
5523 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 NOTE: When you start editing another file while the 'paste' option is
5525 on, settings from the modelines or autocommands may change the
5526 settings again, causing trouble when pasting text. You might want to
5527 set the 'paste' option again.
5528 When the 'paste' option is reset the mentioned options are restored to
5529 the value before the moment 'paste' was switched from off to on.
5530 Resetting 'paste' before ever setting it does not have any effect.
5531 Since mapping doesn't work while 'paste' is active, you need to use
5532 the 'pastetoggle' option to toggle the 'paste' option with some key.
5533
5534 *'pastetoggle'* *'pt'*
5535'pastetoggle' 'pt' string (default "")
5536 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 When non-empty, specifies the key sequence that toggles the 'paste'
5538 option. This is like specifying a mapping: >
5539 :map {keys} :set invpaste<CR>
5540< Where {keys} is the value of 'pastetoggle'.
5541 The difference is that it will work even when 'paste' is set.
5542 'pastetoggle' works in Insert mode and Normal mode, but not in
5543 Command-line mode.
5544 Mappings are checked first, thus overrule 'pastetoggle'. However,
5545 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5546 this: >
5547 :map <F10> :set paste<CR>
5548 :map <F11> :set nopaste<CR>
5549 :imap <F10> <C-O>:set paste<CR>
5550 :imap <F11> <nop>
5551 :set pastetoggle=<F11>
5552< This will make <F10> start paste mode and <F11> stop paste mode.
5553 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5554 mode everything is inserted literally, except the 'pastetoggle' key
5555 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005556 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005557
5558 *'pex'* *'patchexpr'*
5559'patchexpr' 'pex' string (default "")
5560 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005561 {not available when compiled without the |+diff|
5562 feature}
5563 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005564 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565
Bram Moolenaardbc28022014-07-26 13:40:44 +02005566 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005567'patchmode' 'pm' string (default "")
5568 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005569 When non-empty the oldest version of a file is kept. This can be used
5570 to keep the original version of a file if you are changing files in a
5571 source distribution. Only the first time that a file is written a
5572 copy of the original file will be kept. The name of the copy is the
5573 name of the original file with the string in the 'patchmode' option
5574 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005575 ".orig" or ".org". 'backupdir' must not be empty for this to work
5576 (Detail: The backup file is renamed to the patchmode file after the
5577 new file has been successfully written, that's why it must be possible
5578 to write a backup file). If there was no file to be backed up, an
5579 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 When the 'backupskip' pattern matches, a patchmode file is not made.
5581 Using 'patchmode' for compressed files appends the extension at the
5582 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5583 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005584 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005586 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587'path' 'pa' string (default on Unix: ".,/usr/include,,"
5588 on OS/2: ".,/emx/include,,"
5589 other systems: ".,,")
5590 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005592 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5593 provided that the file being searched for has a relative path (not
5594 starting with "/", "./" or "../"). The directories in the 'path'
5595 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005596 - Use commas to separate directory names: >
5597 :set path=.,/usr/local/include,/usr/include
5598< - Spaces can also be used to separate directory names (for backwards
5599 compatibility with version 3.0). To have a space in a directory
5600 name, precede it with an extra backslash, and escape the space: >
5601 :set path=.,/dir/with\\\ space
5602< - To include a comma in a directory name precede it with an extra
5603 backslash: >
5604 :set path=.,/dir/with\\,comma
5605< - To search relative to the directory of the current file, use: >
5606 :set path=.
5607< - To search in the current directory use an empty string between two
5608 commas: >
5609 :set path=,,
5610< - A directory name may end in a ':' or '/'.
5611 - Environment variables are expanded |:set_env|.
5612 - When using |netrw.vim| URLs can be used. For example, adding
5613 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005614 - Search upwards and downwards in a directory tree using "*", "**" and
5615 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005616 {not available when compiled without the |+path_extra| feature}
5617 - Careful with '\' characters, type two to get one in the option: >
5618 :set path=.,c:\\include
5619< Or just use '/' instead: >
5620 :set path=.,c:/include
5621< Don't forget "." or files won't even be found in the same directory as
5622 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005623 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005624 it is something like 256 or 1024 characters.
5625 You can check if all the include files are found, using the value of
5626 'path', see |:checkpath|.
5627 The use of |:set+=| and |:set-=| is preferred when adding or removing
5628 directories from the list. This avoids problems when a future version
5629 uses another default. To remove the current directory use: >
5630 :set path-=
5631< To add the current directory use: >
5632 :set path+=
5633< To use an environment variable, you probably need to replace the
5634 separator. Here is an example to append $INCL, in which directory
5635 names are separated with a semi-colon: >
5636 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5637< Replace the ';' with a ':' or whatever separator is used. Note that
5638 this doesn't work when $INCL contains a comma or white space.
5639
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005640 *'perldll'*
5641'perldll' string (default depends on the build)
5642 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005643 {only available when compiled with the |+perl/dyn|
5644 feature}
5645 Specifies the name of the Perl shared library. The default is
5646 DYNAMIC_PERL_DLL, which was specified at compile time.
5647 Environment variables are expanded |:set_env|.
5648 This option cannot be set from a |modeline| or in the |sandbox|, for
5649 security reasons.
5650
Bram Moolenaar071d4272004-06-13 20:20:40 +00005651 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5652'preserveindent' 'pi' boolean (default off)
5653 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654 When changing the indent of the current line, preserve as much of the
5655 indent structure as possible. Normally the indent is replaced by a
5656 series of tabs followed by spaces as required (unless |'expandtab'| is
5657 enabled, in which case only spaces are used). Enabling this option
5658 means the indent will preserve as many existing characters as possible
5659 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005660 'expandtab' does not apply to the preserved white space, a Tab remains
5661 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662 NOTE: When using ">>" multiple times the resulting indent is a mix of
5663 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005664 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665 Also see 'copyindent'.
5666 Use |:retab| to clean up white space.
5667
5668 *'previewheight'* *'pvh'*
5669'previewheight' 'pvh' number (default 12)
5670 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005671 {not available when compiled without the |+quickfix|
5672 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005674 commands. Used for |CTRL-W_}| when no count is given. Not used when
5675 'previewpopup' is set.
5676
5677 *'previewpopup'* *'pvp'*
5678'previewpopup' 'pvp' string (default empty)
5679 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005680 {not available when compiled without the |+textprop|
5681 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005682 When not empty a popup window is used for commands that would open a
5683 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005684 Not used for the insert completion info, add "popup" to
5685 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005686
5687 *'previewwindow'* *'nopreviewwindow'*
5688 *'pvw'* *'nopvw'* *E590*
5689'previewwindow' 'pvw' boolean (default off)
5690 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005691 {not available when compiled without the |+quickfix|
5692 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005693 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005694 set. It's normally not set directly, but by using one of the commands
5695 |:ptag|, |:pedit|, etc.
5696
5697 *'printdevice'* *'pdev'*
5698'printdevice' 'pdev' string (default empty)
5699 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 {only available when compiled with the |+printer|
5701 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005702 The name of the printer to be used for |:hardcopy|.
5703 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005704 This option cannot be set from a |modeline| or in the |sandbox|, for
5705 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706
Bram Moolenaar8299df92004-07-10 09:47:34 +00005707 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005708'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 {only available when compiled with the |+printer|
5711 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005712 Sets the character encoding used when printing.
5713 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005714
5715 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005716'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005718 {only available when compiled with the |+printer|
5719 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005720 Expression used to print the PostScript produced with |:hardcopy|.
5721 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005722 This option cannot be set from a |modeline| or in the |sandbox|, for
5723 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005724
Bram Moolenaar8299df92004-07-10 09:47:34 +00005725 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005726'printfont' 'pfn' string (default "courier")
5727 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005728 {only available when compiled with the |+printer|
5729 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005730 The name of the font that will be used for |:hardcopy|.
5731 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732
5733 *'printheader'* *'pheader'*
5734'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5735 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005736 {only available when compiled with the |+printer|
5737 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005738 The format of the header produced in |:hardcopy| output.
5739 See |pheader-option|.
5740
5741 *'printmbcharset'* *'pmbcs'*
5742'printmbcharset' 'pmbcs' string (default "")
5743 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005744 {only available when compiled with the |+printer|
5745 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005746 The CJK character set to be used for CJK output from |:hardcopy|.
5747 See |pmbcs-option|.
5748
5749 *'printmbfont'* *'pmbfn'*
5750'printmbfont' 'pmbfn' string (default "")
5751 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005752 {only available when compiled with the |+printer|
5753 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005754 List of font names to be used for CJK output from |:hardcopy|.
5755 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756
5757 *'printoptions'* *'popt'*
5758'printoptions' 'popt' string (default "")
5759 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005760 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005761 List of items that control the format of the output of |:hardcopy|.
5762 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005764 *'prompt'* *'noprompt'*
5765'prompt' boolean (default on)
5766 global
5767 When on a ":" prompt is used in Ex mode.
5768
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005769 *'pumheight'* *'ph'*
5770'pumheight' 'ph' number (default 0)
5771 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005772 Determines the maximum number of items to show in the popup menu for
5773 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005774 |ins-completion-menu|.
5775
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005776 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005777'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005778 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005779 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005780 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005781
Bram Moolenaard94464e2015-11-02 15:28:18 +01005782 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005783'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005784 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005785 {only available when compiled with the |+python/dyn|
5786 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005787 Specifies the name of the Python 2.x shared library. The default is
5788 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005789 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005790 This option cannot be set from a |modeline| or in the |sandbox|, for
5791 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005792
Bram Moolenaar94073162018-01-31 21:49:05 +01005793 *'pythonhome'*
5794'pythonhome' string (default "")
5795 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005796 {only available when compiled with the |+python/dyn|
5797 feature}
5798 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5799 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5800 which was specified at compile time, will be used for the Python 2.x
5801 home directory.
5802 Environment variables are expanded |:set_env|.
5803 This option cannot be set from a |modeline| or in the |sandbox|, for
5804 security reasons.
5805
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005806 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005807'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005808 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005809 {only available when compiled with the |+python3/dyn|
5810 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005811 Specifies the name of the Python 3 shared library. The default is
5812 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005813 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005814 This option cannot be set from a |modeline| or in the |sandbox|, for
5815 security reasons.
5816
Bram Moolenaar94073162018-01-31 21:49:05 +01005817 *'pythonthreehome'*
5818'pythonthreehome' string (default "")
5819 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005820 {only available when compiled with the |+python3/dyn|
5821 feature}
5822 Specifies the name of the Python 3 home directory. When
5823 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5824 PYTHON3_HOME, which was specified at compile time, will be used for
5825 the Python 3 home directory.
5826 Environment variables are expanded |:set_env|.
5827 This option cannot be set from a |modeline| or in the |sandbox|, for
5828 security reasons.
5829
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005830 *'pyxversion'* *'pyx'*
5831'pyxversion' 'pyx' number (default depends on the build)
5832 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005833 {only available when compiled with the |+python| or
5834 the |+python3| feature}
5835 Specifies the python version used for pyx* functions and commands
5836 |python_x|. The default value is as follows:
5837
5838 Compiled with Default ~
5839 |+python| and |+python3| 0
5840 only |+python| 2
5841 only |+python3| 3
5842
5843 Available values are 0, 2 and 3.
5844 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5845 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5846 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5847 to 2 if Python 2 is available.
5848 See also: |has-pythonx|
5849
5850 If Vim is compiled with only |+python| or |+python3| setting
5851 'pyxversion' has no effect. The pyx* functions and commands are
5852 always the same as the compiled version.
5853
5854 This option cannot be set from a |modeline| or in the |sandbox|, for
5855 security reasons.
5856
Bram Moolenaar677ee682005-01-27 14:41:15 +00005857 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005858'quoteescape' 'qe' string (default "\")
5859 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005860 The characters that are used to escape quotes in a string. Used for
5861 objects like a', a" and a` |a'|.
5862 When one of the characters in this option is found inside a string,
5863 the following character will be skipped. The default value makes the
5864 text "foo\"bar\\" considered to be one string.
5865
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5867'readonly' 'ro' boolean (default off)
5868 local to buffer
5869 If on, writes fail unless you use a '!'. Protects you from
5870 accidentally overwriting a file. Default on when Vim is started
5871 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005872 When using ":w!" the 'readonly' option is reset for the current
5873 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005874 When using the ":view" command the 'readonly' option is set for the
5875 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005876 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005877
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005878 *'redrawtime'* *'rdt'*
5879'redrawtime' 'rdt' number (default 2000)
5880 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005881 {only available when compiled with the |+reltime|
5882 feature}
5883 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005884 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005885 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005886 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005887 matches will be highlighted.
5888 For syntax highlighting the time applies per window. When over the
5889 limit syntax highlighting is disabled until |CTRL-L| is used.
5890 This is used to avoid that Vim hangs when using a very complicated
5891 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005892
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005893 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005894'regexpengine' 're' number (default 0)
5895 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005896 This selects the default regexp engine. |two-engines|
5897 The possible values are:
5898 0 automatic selection
5899 1 old engine
5900 2 NFA engine
5901 Note that when using the NFA engine and the pattern contains something
5902 that is not supported the pattern will not match. This is only useful
5903 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005904 Using automatic selection enables Vim to switch the engine, if the
5905 default engine becomes too costly. E.g., when the NFA engine uses too
5906 many states. This should prevent Vim from hanging on a combination of
5907 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005908
Bram Moolenaar64486672010-05-16 15:46:46 +02005909 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5910'relativenumber' 'rnu' boolean (default off)
5911 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005912 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005913 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005914 precede some vertical motion commands (e.g. j k + -) with, without
5915 having to calculate it yourself. Especially useful in combination with
5916 other commands (e.g. y d c < > gq gw =).
5917 When the 'n' option is excluded from 'cpoptions' a wrapped
5918 line will not use the column of line numbers (this is the default when
5919 'compatible' isn't set).
5920 The 'numberwidth' option can be used to set the room used for the line
5921 number.
5922 When a long, wrapped line doesn't start with the first character, '-'
5923 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005924 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5925 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005926
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005927 The number in front of the cursor line also depends on the value of
5928 'number', see |number_relativenumber| for all combinations of the two
5929 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005930
Bram Moolenaar071d4272004-06-13 20:20:40 +00005931 *'remap'* *'noremap'*
5932'remap' boolean (default on)
5933 global
5934 Allows for mappings to work recursively. If you do not want this for
5935 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005936 NOTE: To avoid portability problems with Vim scripts, always keep
5937 this option at the default "on". Only switch it off when working with
5938 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005939
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005940 *'renderoptions'* *'rop'*
5941'renderoptions' 'rop' string (default: empty)
5942 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005943 {only available when compiled with GUI and DIRECTX on
5944 MS-Windows}
5945 Select a text renderer and set its options. The options depend on the
5946 renderer.
5947
5948 Syntax: >
5949 set rop=type:{renderer}(,{name}:{value})*
5950<
5951 Currently, only one optional renderer is available.
5952
5953 render behavior ~
5954 directx Vim will draw text using DirectX (DirectWrite). It makes
5955 drawn glyphs more beautiful than default GDI.
5956 It requires 'encoding' is "utf-8", and only works on
5957 MS-Windows Vista or newer version.
5958
5959 Options:
5960 name meaning type value ~
5961 gamma gamma float 1.0 - 2.2 (maybe)
5962 contrast enhancedContrast float (unknown)
5963 level clearTypeLevel float (unknown)
5964 geom pixelGeometry int 0 - 2 (see below)
5965 renmode renderingMode int 0 - 6 (see below)
5966 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01005967 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005968
Bram Moolenaar92467d32017-12-05 13:22:16 +01005969 See this URL for detail (except for scrlines):
5970 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005971
5972 For geom: structure of a device pixel.
5973 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5974 1 - DWRITE_PIXEL_GEOMETRY_RGB
5975 2 - DWRITE_PIXEL_GEOMETRY_BGR
5976
5977 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005978 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005979
5980 For renmode: method of rendering glyphs.
5981 0 - DWRITE_RENDERING_MODE_DEFAULT
5982 1 - DWRITE_RENDERING_MODE_ALIASED
5983 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5984 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5985 4 - DWRITE_RENDERING_MODE_NATURAL
5986 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5987 6 - DWRITE_RENDERING_MODE_OUTLINE
5988
5989 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005990 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005991
5992 For taamode: antialiasing mode used for drawing text.
5993 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5994 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5995 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5996 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5997
5998 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005999 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6000
Bram Moolenaara338adc2018-01-31 20:51:47 +01006001 For scrlines:
6002 This was used for optimizing scrolling behavior, however this
6003 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006004
6005 Example: >
6006 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006007 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006008 set rop=type:directx
6009<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006010 If select a raster font (Courier, Terminal or FixedSys which
6011 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006012 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006013
6014 NOTE: It is known that some fonts and options combination
6015 causes trouble on drawing glyphs.
6016
Bram Moolenaar92467d32017-12-05 13:22:16 +01006017 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006018 special made fonts (True-Type fonts which includes only
6019 bitmap glyphs).
6020 - 'taamode:3' will not work with some vector fonts.
6021
6022 NOTE: With this option, you can display colored emoji
6023 (emoticon) in Windows 8.1 or later. To display colored emoji,
6024 there are some conditions which you should notice.
6025
6026 - If your font includes non-colored emoji already, it will
6027 be used.
6028 - If your font doesn't have emoji, the system chooses an
6029 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6030 will be used.
6031 - When this alternative font didn't have fixed width glyph,
6032 emoji might be rendered beyond the bounding box of drawing
6033 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006034
6035 Other render types are currently not supported.
6036
Bram Moolenaar071d4272004-06-13 20:20:40 +00006037 *'report'*
6038'report' number (default 2)
6039 global
6040 Threshold for reporting number of lines changed. When the number of
6041 changed lines is more than 'report' a message will be given for most
6042 ":" commands. If you want it always, set 'report' to 0.
6043 For the ":substitute" command the number of substitutions is used
6044 instead of the number of lines.
6045
6046 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6047'restorescreen' 'rs' boolean (default on)
6048 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006049 {only in Windows 95/NT console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050 When set, the screen contents is restored when exiting Vim. This also
6051 happens when executing external commands.
6052
6053 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6054 options in your .vimrc. To disable restoring:
6055 set t_ti= t_te=
6056 To enable restoring (for an xterm):
6057 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6058 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6059
6060 *'revins'* *'ri'* *'norevins'* *'nori'*
6061'revins' 'ri' boolean (default off)
6062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063 {only available when compiled with the |+rightleft|
6064 feature}
6065 Inserting characters in Insert mode will work backwards. See "typing
6066 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6067 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006068 NOTE: This option is reset when 'compatible' is set.
6069 This option is reset when 'paste' is set and restored when 'paste' is
6070 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071
6072 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6073'rightleft' 'rl' boolean (default off)
6074 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006075 {only available when compiled with the |+rightleft|
6076 feature}
6077 When on, display orientation becomes right-to-left, i.e., characters
6078 that are stored in the file appear from the right to the left.
6079 Using this option, it is possible to edit files for languages that
6080 are written from the right to the left such as Hebrew and Arabic.
6081 This option is per window, so it is possible to edit mixed files
6082 simultaneously, or to view the same file in both ways (this is
6083 useful whenever you have a mixed text file with both right-to-left
6084 and left-to-right strings so that both sets are displayed properly
6085 in different windows). Also see |rileft.txt|.
6086
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006087 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006088'rightleftcmd' 'rlc' string (default "search")
6089 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006090 {only available when compiled with the |+rightleft|
6091 feature}
6092 Each word in this option enables the command line editing to work in
6093 right-to-left mode for a group of commands:
6094
6095 search "/" and "?" commands
6096
6097 This is useful for languages such as Hebrew, Arabic and Farsi.
6098 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6099
Bram Moolenaard94464e2015-11-02 15:28:18 +01006100 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006101'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006102 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006103 {only available when compiled with the |+ruby/dyn|
6104 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006105 Specifies the name of the Ruby shared library. The default is
6106 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006107 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006108 This option cannot be set from a |modeline| or in the |sandbox|, for
6109 security reasons.
6110
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006112'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006113 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 {not available when compiled without the
6115 |+cmdline_info| feature}
6116 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006117 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118 text in the file is shown on the far right:
6119 Top first line is visible
6120 Bot last line is visible
6121 All first and last line are visible
6122 45% relative position in the file
6123 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006124 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006126 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006127 this option takes precedence over 'ruler' and 'rulerformat'
6128 If the number of characters displayed is different from the number of
6129 bytes in the text (e.g., for a TAB or a multi-byte character), both
6130 the text column (byte number) and the screen column are shown,
6131 separated with a dash.
6132 For an empty line "0-1" is shown.
6133 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006134 This option is reset when 'paste' is set and restored when 'paste' is
6135 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136 If you don't want to see the ruler all the time but want to know where
6137 you are, use "g CTRL-G" |g_CTRL-G|.
6138 NOTE: This option is reset when 'compatible' is set.
6139
6140 *'rulerformat'* *'ruf'*
6141'rulerformat' 'ruf' string (default empty)
6142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143 {not available when compiled without the |+statusline|
6144 feature}
6145 When this option is not empty, it determines the content of the ruler
6146 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006147 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006148 This option cannot be set in a modeline when 'modelineexpr' is off.
6149
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150 The default ruler width is 17 characters. To make the ruler 15
6151 characters wide, put "%15(" at the start and "%)" at the end.
6152 Example: >
6153 :set rulerformat=%15(%c%V\ %p%%%)
6154<
6155 *'runtimepath'* *'rtp'* *vimfiles*
6156'runtimepath' 'rtp' string (default:
6157 Unix: "$HOME/.vim,
6158 $VIM/vimfiles,
6159 $VIMRUNTIME,
6160 $VIM/vimfiles/after,
6161 $HOME/.vim/after"
6162 Amiga: "home:vimfiles,
6163 $VIM/vimfiles,
6164 $VIMRUNTIME,
6165 $VIM/vimfiles/after,
6166 home:vimfiles/after"
6167 PC, OS/2: "$HOME/vimfiles,
6168 $VIM/vimfiles,
6169 $VIMRUNTIME,
6170 $VIM/vimfiles/after,
6171 $HOME/vimfiles/after"
6172 Macintosh: "$VIM:vimfiles,
6173 $VIMRUNTIME,
6174 $VIM:vimfiles:after"
6175 RISC-OS: "Choices:vimfiles,
6176 $VIMRUNTIME,
6177 Choices:vimfiles/after"
6178 VMS: "sys$login:vimfiles,
6179 $VIM/vimfiles,
6180 $VIMRUNTIME,
6181 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006182 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006184 This is a list of directories which will be searched for runtime
6185 files:
6186 filetype.vim filetypes by file name |new-filetype|
6187 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006188 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189 colors/ color scheme files |:colorscheme|
6190 compiler/ compiler files |:compiler|
6191 doc/ documentation |write-local-help|
6192 ftplugin/ filetype plugins |write-filetype-plugin|
6193 indent/ indent scripts |indent-expression|
6194 keymap/ key mapping files |mbyte-keymap|
6195 lang/ menu translations |:menutrans|
6196 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006197 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006198 plugin/ plugin scripts |write-plugin|
6199 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006200 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 syntax/ syntax files |mysyntaxfile|
6202 tutor/ files for vimtutor |tutor|
6203
6204 And any other file searched for with the |:runtime| command.
6205
6206 The defaults for most systems are setup to search five locations:
6207 1. In your home directory, for your personal preferences.
6208 2. In a system-wide Vim directory, for preferences from the system
6209 administrator.
6210 3. In $VIMRUNTIME, for files distributed with Vim.
6211 *after-directory*
6212 4. In the "after" directory in the system-wide Vim directory. This is
6213 for the system administrator to overrule or add to the distributed
6214 defaults (rarely needed)
6215 5. In the "after" directory in your home directory. This is for
6216 personal preferences to overrule or add to the distributed defaults
6217 or system-wide settings (rarely needed).
6218
Bram Moolenaard0796902016-09-16 20:02:31 +02006219 More entries are added when using |packages|. If it gets very long
6220 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6221 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006222
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6224 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006225 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006226 wildcards.
6227 See |:runtime|.
6228 Example: >
6229 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6230< This will use the directory "~/vimruntime" first (containing your
6231 personal Vim runtime files), then "/mygroup/vim" (shared between a
6232 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6233 files).
6234 You probably should always include $VIMRUNTIME somewhere, to use the
6235 distributed runtime files. You can put a directory before $VIMRUNTIME
6236 to find files which replace a distributed runtime files. You can put
6237 a directory after $VIMRUNTIME to find files which add to distributed
6238 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006239 When Vim is started with |--clean| the home directory entries are not
6240 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241 This option cannot be set from a |modeline| or in the |sandbox|, for
6242 security reasons.
6243
6244 *'scroll'* *'scr'*
6245'scroll' 'scr' number (default: half the window height)
6246 local to window
6247 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6248 set to half the number of lines in the window when the window size
6249 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006250 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006251 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252
6253 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6254'scrollbind' 'scb' boolean (default off)
6255 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 See also |scroll-binding|. When this option is set, the current
6257 window scrolls as other scrollbind windows (windows that also have
6258 this option set) scroll. This option is useful for viewing the
6259 differences between two versions of a file, see 'diff'.
6260 See |'scrollopt'| for options that determine how this option should be
6261 interpreted.
6262 This option is mostly reset when splitting a window to edit another
6263 file. This means that ":split | edit file" results in two windows
6264 with scroll-binding, but ":split file" does not.
6265
6266 *'scrolljump'* *'sj'*
6267'scrolljump' 'sj' number (default 1)
6268 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269 Minimal number of lines to scroll when the cursor gets off the
6270 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6271 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006272 When set to a negative number from -1 to -100 this is used as the
6273 percentage of the window height. Thus -50 scrolls half the window
6274 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006275 NOTE: This option is set to 1 when 'compatible' is set.
6276
6277 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006278'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006279 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280 Minimal number of screen lines to keep above and below the cursor.
6281 This will make some context visible around where you are working. If
6282 you set it to a very large value (999) the cursor line will always be
6283 in the middle of the window (except at the start or end of the file or
6284 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006285 After using the local value, go back the global value with one of
6286 these two: >
6287 setlocal scrolloff<
6288 setlocal scrolloff=-1
6289< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006290 NOTE: This option is set to 0 when 'compatible' is set.
6291
6292 *'scrollopt'* *'sbo'*
6293'scrollopt' 'sbo' string (default "ver,jump")
6294 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006295 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006296 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6297 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298 The following words are available:
6299 ver Bind vertical scrolling for 'scrollbind' windows
6300 hor Bind horizontal scrolling for 'scrollbind' windows
6301 jump Applies to the offset between two windows for vertical
6302 scrolling. This offset is the difference in the first
6303 displayed line of the bound windows. When moving
6304 around in a window, another 'scrollbind' window may
6305 reach a position before the start or after the end of
6306 the buffer. The offset is not changed though, when
6307 moving back the 'scrollbind' window will try to scroll
6308 to the desired position when possible.
6309 When now making that window the current one, two
6310 things can be done with the relative offset:
6311 1. When "jump" is not included, the relative offset is
6312 adjusted for the scroll position in the new current
6313 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006314 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315 2. When "jump" is included, the other windows are
6316 scrolled to keep the same relative offset. When
6317 going back to the other window, it still uses the
6318 same relative offset.
6319 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006320 When 'diff' mode is active there always is vertical scroll binding,
6321 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322
6323 *'sections'* *'sect'*
6324'sections' 'sect' string (default "SHNHH HUnhsh")
6325 global
6326 Specifies the nroff macros that separate sections. These are pairs of
6327 two letters (See |object-motions|). The default makes a section start
6328 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6329
6330 *'secure'* *'nosecure'* *E523*
6331'secure' boolean (default off)
6332 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333 When on, ":autocmd", shell and write commands are not allowed in
6334 ".vimrc" and ".exrc" in the current directory and map commands are
6335 displayed. Switch it off only if you know that you will not run into
6336 problems, or when the 'exrc' option is off. On Unix this option is
6337 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006338 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339 'secure' at the end of your ~/.vimrc then.
6340 This option cannot be set from a |modeline| or in the |sandbox|, for
6341 security reasons.
6342
6343 *'selection'* *'sel'*
6344'selection' 'sel' string (default "inclusive")
6345 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346 This option defines the behavior of the selection. It is only used
6347 in Visual and Select mode.
6348 Possible values:
6349 value past line inclusive ~
6350 old no yes
6351 inclusive yes yes
6352 exclusive yes no
6353 "past line" means that the cursor is allowed to be positioned one
6354 character past the line.
6355 "inclusive" means that the last character of the selection is included
6356 in an operation. For example, when "x" is used to delete the
6357 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006358 When "old" is used and 'virtualedit' allows the cursor to move past
6359 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006360 Note that when "exclusive" is used and selecting from the end
6361 backwards, you cannot include the last character of a line, when
6362 starting in Normal mode and 'virtualedit' empty.
6363
6364 The 'selection' option is set by the |:behave| command.
6365
6366 *'selectmode'* *'slm'*
6367'selectmode' 'slm' string (default "")
6368 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006369 This is a comma separated list of words, which specifies when to start
6370 Select mode instead of Visual mode, when a selection is started.
6371 Possible values:
6372 mouse when using the mouse
6373 key when using shifted special keys
6374 cmd when using "v", "V" or CTRL-V
6375 See |Select-mode|.
6376 The 'selectmode' option is set by the |:behave| command.
6377
6378 *'sessionoptions'* *'ssop'*
6379'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006380 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006382 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383 feature}
6384 Changes the effect of the |:mksession| command. It is a comma
6385 separated list of words. Each word enables saving and restoring
6386 something:
6387 word save and restore ~
6388 blank empty windows
6389 buffers hidden and unloaded buffers, not just those in windows
6390 curdir the current directory
6391 folds manually created folds, opened/closed folds and local
6392 fold options
6393 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006394 and contain at least one lowercase letter. Only
6395 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006396 help the help window
6397 localoptions options and mappings local to a window or buffer (not
6398 global values for local options)
6399 options all options and mappings (also global values for local
6400 options)
6401 resize size of the Vim window: 'lines' and 'columns'
6402 sesdir the directory in which the session file is located
6403 will become the current directory (useful with
6404 projects accessed over a network from different
6405 systems)
6406 slash backslashes in file names replaced with forward
6407 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006408 tabpages all tab pages; without this only the current tab page
6409 is restored, so that you can make a session for each
6410 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006411 terminal include terminal windows where the command can be
6412 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006413 unix with Unix end-of-line format (single <NL>), even when
6414 on Windows or DOS
6415 winpos position of the whole Vim window
6416 winsize window sizes
6417
6418 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006419 When neither "curdir" nor "sesdir" is included, file names are stored
6420 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006421 "slash" and "unix" are useful on Windows when sharing session files
6422 with Unix. The Unix version of Vim cannot source dos format scripts,
6423 but the Windows version of Vim can source unix format scripts.
6424
6425 *'shell'* *'sh'* *E91*
6426'shell' 'sh' string (default $SHELL or "sh",
6427 MS-DOS and Win32: "command.com" or
6428 "cmd.exe", OS/2: "cmd")
6429 global
6430 Name of the shell to use for ! and :! commands. When changing the
6431 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6432 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006433 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006434 See |option-backslash| about including spaces and backslashes.
6435 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006436
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006438 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006439 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6440< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006441 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006443 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006445 Example with escaped space (Vim will do this when initializing the
6446 option from $SHELL): >
6447 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006448< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006449 backslashes are consumed by `:set`.
6450
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 Under MS-Windows, when the executable ends in ".com" it must be
6452 included. Thus setting the shell to "command.com" or "4dos.com"
6453 works, but "command" and "4dos" do not work for all commands (e.g.,
6454 filtering).
6455 For unknown reasons, when using "4dos.com" the current directory is
6456 changed to "C:\". To avoid this set 'shell' like this: >
6457 :set shell=command.com\ /c\ 4dos
6458< This option cannot be set from a |modeline| or in the |sandbox|, for
6459 security reasons.
6460
6461 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006462'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006463 MS-DOS and Win32, when 'shell' does not
6464 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006466 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6467 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6468 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006469 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006470 On Unix it can have more than one flag. Each white space separated
6471 part is passed as an argument to the shell command.
6472 See |option-backslash| about including spaces and backslashes.
6473 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006474 This option cannot be set from a |modeline| or in the |sandbox|, for
6475 security reasons.
6476
6477 *'shellpipe'* *'sp'*
6478'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6479 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480 {not available when compiled without the |+quickfix|
6481 feature}
6482 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006483 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 including spaces and backslashes.
6485 The name of the temporary file can be represented by "%s" if necessary
6486 (the file name is appended automatically if no %s appears in the value
6487 of this option).
6488 For the Amiga and MS-DOS the default is ">". The output is directly
6489 saved in a file and not echoed to the screen.
6490 For Unix the default it "| tee". The stdout of the compiler is saved
6491 in a file and echoed to the screen. If the 'shell' option is "csh" or
6492 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006493 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6494 default becomes "2>&1| tee". This means that stderr is also included.
6495 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6496 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006497 The initialization of this option is done after reading the ".vimrc"
6498 and the other initializations, so that when the 'shell' option is set
6499 there, the 'shellpipe' option changes automatically, unless it was
6500 explicitly set before.
6501 When 'shellpipe' is set to an empty string, no redirection of the
6502 ":make" output will be done. This is useful if you use a 'makeprg'
6503 that writes to 'makeef' by itself. If you want no piping, but do
6504 want to include the 'makeef', set 'shellpipe' to a single space.
6505 Don't forget to precede the space with a backslash: ":set sp=\ ".
6506 In the future pipes may be used for filtering and this option will
6507 become obsolete (at least for Unix).
6508 This option cannot be set from a |modeline| or in the |sandbox|, for
6509 security reasons.
6510
6511 *'shellquote'* *'shq'*
6512'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6513 contains "sh" somewhere: "\"")
6514 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515 Quoting character(s), put around the command passed to the shell, for
6516 the "!" and ":!" commands. The redirection is kept outside of the
6517 quoting. See 'shellxquote' to include the redirection. It's
6518 probably not useful to set both options.
6519 This is an empty string by default. Only known to be useful for
6520 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6521 or bash, where it should be "\"". The default is adjusted according
6522 the value of 'shell', to reduce the need to set this option by the
6523 user. See |dos-shell|.
6524 This option cannot be set from a |modeline| or in the |sandbox|, for
6525 security reasons.
6526
6527 *'shellredir'* *'srr'*
6528'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6529 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 String to be used to put the output of a filter command in a temporary
6531 file. See also |:!|. See |option-backslash| about including spaces
6532 and backslashes.
6533 The name of the temporary file can be represented by "%s" if necessary
6534 (the file name is appended automatically if no %s appears in the value
6535 of this option).
6536 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6537 or "zsh" during initializations, the default becomes ">&". If the
6538 'shell' option is "sh", "ksh" or "bash" the default becomes
6539 ">%s 2>&1". This means that stderr is also included.
6540 For Win32, the Unix checks are done and additionally "cmd" is checked
6541 for, which makes the default ">%s 2>&1". Also, the same names with
6542 ".exe" appended are checked for.
6543 The initialization of this option is done after reading the ".vimrc"
6544 and the other initializations, so that when the 'shell' option is set
6545 there, the 'shellredir' option changes automatically unless it was
6546 explicitly set before.
6547 In the future pipes may be used for filtering and this option will
6548 become obsolete (at least for Unix).
6549 This option cannot be set from a |modeline| or in the |sandbox|, for
6550 security reasons.
6551
6552 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6553'shellslash' 'ssl' boolean (default off)
6554 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006555 {only for MSDOS, MS-Windows and OS/2}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556 When set, a forward slash is used when expanding file names. This is
6557 useful when a Unix-like shell is used instead of command.com or
6558 cmd.exe. Backward slashes can still be typed, but they are changed to
6559 forward slashes by Vim.
6560 Note that setting or resetting this option has no effect for some
6561 existing file names, thus this option needs to be set before opening
6562 any file for best results. This might change in the future.
6563 'shellslash' only works when a backslash can be used as a path
6564 separator. To test if this is so use: >
6565 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006566< Also see 'completeslash'.
6567
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006568 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6569'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6570 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006571 When on, use temp files for shell commands. When off use a pipe.
6572 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006573 Currently a pipe is only supported on Unix and MS-Windows 2K and
6574 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006575 :if has("filterpipe")
6576< The advantage of using a pipe is that nobody can read the temp file
6577 and the 'shell' command does not need to support redirection.
6578 The advantage of using a temp file is that the file type and encoding
6579 can be detected.
6580 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6581 |FilterWritePost| autocommands event are not triggered when
6582 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006583 The `system()` function does not respect this option and always uses
6584 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006585 NOTE: This option is set to the Vim default value when 'compatible'
6586 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006587
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 *'shelltype'* *'st'*
6589'shelltype' 'st' number (default 0)
6590 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006591 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592 On the Amiga this option influences the way how the commands work
6593 which use a shell.
6594 0 and 1: always use the shell
6595 2 and 3: use the shell only to filter lines
6596 4 and 5: use shell only for ':sh' command
6597 When not using the shell, the command is executed directly.
6598
6599 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6600 1 and 3: use "shell cmd" to start external commands
6601
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006602 *'shellxescape'* *'sxe'*
6603'shellxescape' 'sxe' string (default: "";
6604 for MS-DOS and MS-Windows: "\"&|<>()@^")
6605 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006606 When 'shellxquote' is set to "(" then the characters listed in this
6607 option will be escaped with a '^' character. This makes it possible
6608 to execute most external commands with cmd.exe.
6609
Bram Moolenaar071d4272004-06-13 20:20:40 +00006610 *'shellxquote'* *'sxq'*
6611'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006612 for Win32, when 'shell' is cmd.exe: "("
6613 for Win32, when 'shell' contains "sh"
6614 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 for Unix, when using system(): "\"")
6616 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 Quoting character(s), put around the command passed to the shell, for
6618 the "!" and ":!" commands. Includes the redirection. See
6619 'shellquote' to exclude the redirection. It's probably not useful
6620 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006621 When the value is '(' then ')' is appended. When the value is '"('
6622 then ')"' is appended.
6623 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006624 This is an empty string by default on most systems, but is known to be
6625 useful for on Win32 version, either for cmd.exe which automatically
6626 strips off the first and last quote on a command, or 3rd-party shells
6627 such as the MKS Korn Shell or bash, where it should be "\"". The
6628 default is adjusted according the value of 'shell', to reduce the need
6629 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006630 This option cannot be set from a |modeline| or in the |sandbox|, for
6631 security reasons.
6632
6633 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6634'shiftround' 'sr' boolean (default off)
6635 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636 Round indent to multiple of 'shiftwidth'. Applies to > and <
6637 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6638 a multiple of 'shiftwidth' (this is Vi compatible).
6639 NOTE: This option is reset when 'compatible' is set.
6640
6641 *'shiftwidth'* *'sw'*
6642'shiftwidth' 'sw' number (default 8)
6643 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006644 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006645 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006646 When zero the 'ts' value will be used. Use the |shiftwidth()|
6647 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648
6649 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006650'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6651 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653 This option helps to avoid all the |hit-enter| prompts caused by file
6654 messages, for example with CTRL-G, and to avoid some other messages.
6655 It is a list of flags:
6656 flag meaning when present ~
6657 f use "(3 of 5)" instead of "(file 3 of 5)"
6658 i use "[noeol]" instead of "[Incomplete last line]"
6659 l use "999L, 888C" instead of "999 lines, 888 characters"
6660 m use "[+]" instead of "[Modified]"
6661 n use "[New]" instead of "[New File]"
6662 r use "[RO]" instead of "[readonly]"
6663 w use "[w]" instead of "written" for file write message
6664 and "[a]" instead of "appended" for ':w >> file' command
6665 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6666 "[unix format]" and "[mac]" instead of "[mac format]".
6667 a all of the above abbreviations
6668
6669 o overwrite message for writing a file with subsequent message
6670 for reading a file (useful for ":wn" or when 'autowrite' on)
6671 O message for reading a file overwrites any previous message.
6672 Also for quickfix message (e.g., ":cn").
6673 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006674 hit TOP, continuing at BOTTOM" messages; when using the search
6675 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 t truncate file message at the start if it is too long to fit
6677 on the command-line, "<" will appear in the left most column.
6678 Ignored in Ex mode.
6679 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006680 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681 Ignored in Ex mode.
6682 W don't give "written" or "[w]" when writing a file
6683 A don't give the "ATTENTION" message when an existing swap file
6684 is found.
6685 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006686 c don't give |ins-completion-menu| messages. For example,
6687 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6688 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006689 q use "recording" instead of "recording @a"
6690 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006691 was used for the command; note that this also affects messages
6692 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006693 S do not show search count message when searching, e.g.
6694 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006695
6696 This gives you the opportunity to avoid that a change between buffers
6697 requires you to hit <Enter>, but still gives as useful a message as
6698 possible for the space available. To get the whole message that you
6699 would have got with 'shm' empty, use ":file!"
6700 Useful values:
6701 shm= No abbreviation of message.
6702 shm=a Abbreviation, but no loss of information.
6703 shm=at Abbreviation, and truncate message when necessary.
6704
6705 NOTE: This option is set to the Vi default value when 'compatible' is
6706 set and to the Vim default value when 'compatible' is reset.
6707
6708 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6709'shortname' 'sn' boolean (default off)
6710 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006711 Filenames are assumed to be 8 characters plus one extension of 3
6712 characters. Multiple dots in file names are not allowed. When this
6713 option is on, dots in file names are replaced with underscores when
6714 adding an extension (".~" or ".swp"). This option is not available
6715 for MS-DOS, because then it would always be on. This option is useful
6716 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6717 or crossdos. When running the Win32 GUI version under Win32s, this
6718 option is always on by default.
6719
6720 *'showbreak'* *'sbr'* *E595*
6721'showbreak' 'sbr' string (default "")
6722 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006723 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 feature}
6725 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006726 values are "> " or "+++ ": >
6727 :set showbreak=>\
6728< Note the backslash to escape the trailing space. It's easier like
6729 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006730 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006731< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 comma (in a future version the comma might be used to separate the
6733 part that is shown at the end and at the start of a line).
6734 The characters are highlighted according to the '@' flag in
6735 'highlight'.
6736 Note that tabs after the showbreak will be displayed differently.
6737 If you want the 'showbreak' to appear in between line numbers, add the
6738 "n" flag to 'cpoptions'.
6739
6740 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006741'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6742 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006744 {not available when compiled without the
6745 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006746 Show (partial) command in the last line of the screen. Set this
6747 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006748 In Visual mode the size of the selected area is shown:
6749 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006750 If the number of bytes is different it is also displayed: "2-6"
6751 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006753 - When selecting a block, the size in screen characters:
6754 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 NOTE: This option is set to the Vi default value when 'compatible' is
6756 set and to the Vim default value when 'compatible' is reset.
6757
6758 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6759'showfulltag' 'sft' boolean (default off)
6760 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 When completing a word in insert mode (see |ins-completion|) from the
6762 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006763 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 matched a C function, you can see a template for what arguments are
6765 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006766 Note that this doesn't work well together with having "longest" in
6767 'completeopt', because the completion from the search pattern may not
6768 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769
6770 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6771'showmatch' 'sm' boolean (default off)
6772 global
6773 When a bracket is inserted, briefly jump to the matching one. The
6774 jump is only done if the match can be seen on the screen. The time to
6775 show the match can be set with 'matchtime'.
6776 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006777 seen or not).
6778 This option is reset when 'paste' is set and restored when 'paste' is
6779 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006780 When the 'm' flag is not included in 'cpoptions', typing a character
6781 will immediately move the cursor back to where it belongs.
6782 See the "sm" field in 'guicursor' for setting the cursor shape and
6783 blinking when showing the match.
6784 The 'matchpairs' option can be used to specify the characters to show
6785 matches for. 'rightleft' and 'revins' are used to look for opposite
6786 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006787 Also see the matchparen plugin for highlighting the match when moving
6788 around |pi_paren.txt|.
6789 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790
6791 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6792'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6793 global
6794 If in Insert, Replace or Visual mode put a message on the last line.
6795 Use the 'M' flag in 'highlight' to set the type of highlighting for
6796 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006797 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006798 doesn't mean XIM is really active, especially when 'imactivatekey' is
6799 not set.
6800 NOTE: This option is set to the Vi default value when 'compatible' is
6801 set and to the Vim default value when 'compatible' is reset.
6802
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006803 *'showtabline'* *'stal'*
6804'showtabline' 'stal' number (default 1)
6805 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006806 The value of this option specifies when the line with tab page labels
6807 will be displayed:
6808 0: never
6809 1: only if there are at least two tab pages
6810 2: always
6811 This is both for the GUI and non-GUI implementation of the tab pages
6812 line.
6813 See |tab-page| for more information about tab pages.
6814
Bram Moolenaar071d4272004-06-13 20:20:40 +00006815 *'sidescroll'* *'ss'*
6816'sidescroll' 'ss' number (default 0)
6817 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 The minimal number of columns to scroll horizontally. Used only when
6819 the 'wrap' option is off and the cursor is moved off of the screen.
6820 When it is zero the cursor will be put in the middle of the screen.
6821 When using a slow terminal set it to a large number or 0. When using
6822 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6823 commands.
6824
6825 *'sidescrolloff'* *'siso'*
6826'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006827 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006829 right of the cursor if 'nowrap' is set. Setting this option to a
6830 value greater than 0 while having |'sidescroll'| also at a non-zero
6831 value makes some context visible in the line you are scrolling in
6832 horizontally (except at beginning of the line). Setting this option
6833 to a large value (like 999) has the effect of keeping the cursor
6834 horizontally centered in the window, as long as one does not come too
6835 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006836 After using the local value, go back the global value with one of
6837 these two: >
6838 setlocal sidescrolloff<
6839 setlocal sidescrolloff=-1
6840< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841
6842 Example: Try this together with 'sidescroll' and 'listchars' as
6843 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006844 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845
6846 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6847 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006848<
6849 *'signcolumn'* *'scl'*
6850'signcolumn' 'scl' string (default "auto")
6851 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006852 {not available when compiled without the |+signs|
6853 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006854 Whether or not to draw the signcolumn. Valid values are:
6855 "auto" only when there is a sign to display
6856 "no" never
6857 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006858 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006859 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860
6861
6862 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6863'smartcase' 'scs' boolean (default off)
6864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006865 Override the 'ignorecase' option if the search pattern contains upper
6866 case characters. Only used when the search pattern is typed and
6867 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006868 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6870 recalling the search pattern from history and hitting <Enter>.
6871 NOTE: This option is reset when 'compatible' is set.
6872
6873 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6874'smartindent' 'si' boolean (default off)
6875 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 {not available when compiled without the
6877 |+smartindent| feature}
6878 Do smart autoindenting when starting a new line. Works for C-like
6879 programs, but can also be used for other languages. 'cindent' does
6880 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006881 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006882 setting 'si' has no effect. 'indentexpr' is a more advanced
6883 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 Normally 'autoindent' should also be on when using 'smartindent'.
6885 An indent is automatically inserted:
6886 - After a line ending in '{'.
6887 - After a line starting with a keyword from 'cinwords'.
6888 - Before a line starting with '}' (only with the "O" command).
6889 When typing '}' as the first character in a new line, that line is
6890 given the same indent as the matching '{'.
6891 When typing '#' as the first character in a new line, the indent for
6892 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006893 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6895 When using the ">>" command, lines starting with '#' are not shifted
6896 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006897 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006898 This option is reset when 'paste' is set and restored when 'paste' is
6899 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006900
6901 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6902'smarttab' 'sta' boolean (default off)
6903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006905 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6906 <BS> will delete a 'shiftwidth' worth of space at the start of the
6907 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006908 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006909 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6910 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006911 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006913 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006914 This option is reset when 'paste' is set and restored when 'paste' is
6915 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006916 NOTE: This option is reset when 'compatible' is set.
6917
6918 *'softtabstop'* *'sts'*
6919'softtabstop' 'sts' number (default 0)
6920 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006921 Number of spaces that a <Tab> counts for while performing editing
6922 operations, like inserting a <Tab> or using <BS>. It "feels" like
6923 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6924 used. This is useful to keep the 'ts' setting at its standard value
6925 of 8, while being able to edit like it is set to 'sts'. However,
6926 commands like "x" still work on the actual characters.
6927 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006928 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006929 'softtabstop' is set to 0 when the 'paste' option is set and restored
6930 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6932 spaces is minimized by using <Tab>s.
6933 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6934 set.
6935 NOTE: This option is set to 0 when 'compatible' is set.
6936
Bram Moolenaar04958cb2018-06-23 19:23:02 +02006937 If Vim is compiled with the |+vartabs| feature then the value of
6938 'softtabstop' will be ignored if |'varsofttabstop'| is set to
6939 anything other than an empty string.
6940
Bram Moolenaar217ad922005-03-20 22:37:15 +00006941 *'spell'* *'nospell'*
6942'spell' boolean (default off)
6943 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00006944 {not available when compiled without the |+syntax|
6945 feature}
6946 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006947 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006948
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006949 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006950'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006951 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006952 {not available when compiled without the |+syntax|
6953 feature}
6954 Pattern to locate the end of a sentence. The following word will be
6955 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006956 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006957 When this check is not wanted make this option empty.
6958 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006959 Be careful with special characters, see |option-backslash| about
6960 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006961 To set this option automatically depending on the language, see
6962 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006963
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006964 *'spellfile'* *'spf'*
6965'spellfile' 'spf' string (default empty)
6966 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006967 {not available when compiled without the |+syntax|
6968 feature}
6969 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006970 commands. It must end in ".{encoding}.add". You need to include the
6971 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006972 *E765*
6973 It may also be a comma separated list of names. A count before the
6974 |zg| and |zw| commands can be used to access each. This allows using
6975 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006976 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006977 you: Using the first directory in 'runtimepath' that is writable. If
6978 there is no "spell" directory yet it will be created. For the file
6979 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006980 ignoring the region.
6981 The resulting ".spl" file will be used for spell checking, it does not
6982 have to appear in 'spelllang'.
6983 Normally one file is used for all regions, but you can add the region
6984 name if you want to. However, it will then only be used when
6985 'spellfile' is set to it, for entries in 'spelllang' only files
6986 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006987 This option cannot be set from a |modeline| or in the |sandbox|, for
6988 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006989
Bram Moolenaar217ad922005-03-20 22:37:15 +00006990 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006991'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006992 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00006993 {not available when compiled without the |+syntax|
6994 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006995 A comma separated list of word list names. When the 'spell' option is
6996 on spellchecking will be done for these languages. Example: >
6997 set spelllang=en_us,nl,medical
6998< This means US English, Dutch and medical words are recognized. Words
6999 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007000 The word list name must consist of alphanumeric characters, a dash or
7001 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007002 recommended to separate the two letter language name from a
7003 specification. Thus "en-rare" is used for rare English words.
7004 A region name must come last and have the form "_xx", where "xx" is
7005 the two-letter, lower case region name. You can use more than one
7006 region by listing them: "en_us,en_ca" supports both US and Canadian
7007 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007008 Britain. (Note: currently en_au and en_nz dictionaries are older than
7009 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007010 If the name "cjk" is included East Asian characters are excluded from
7011 spell checking. This is useful when editing text that also has Asian
7012 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007013 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007014 As a special case the name of a .spl file can be given as-is. The
7015 first "_xx" in the name is removed and used as the region name
7016 (_xx is an underscore, two letters and followed by a non-letter).
7017 This is mainly for testing purposes. You must make sure the correct
7018 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007019 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007020 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7021 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007022 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007023
Bram Moolenaar98692072006-02-04 00:57:42 +00007024 If the |spellfile.vim| plugin is active and you use a language name
7025 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7026 will ask you if you want to download the file.
7027
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007028 After this option has been set successfully, Vim will source the files
7029 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007030 up to the first character that is not an ASCII letter or number and
7031 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007032
7033
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007034 *'spellsuggest'* *'sps'*
7035'spellsuggest' 'sps' string (default "best")
7036 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007037 {not available when compiled without the |+syntax|
7038 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007039 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007040 the |spellsuggest()| function. This is a comma-separated list of
7041 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007042
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007043 best Internal method that works best for English. Finds
7044 changes like "fast" and uses a bit of sound-a-like
7045 scoring to improve the ordering.
7046
7047 double Internal method that uses two methods and mixes the
7048 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007049 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007050 word. That only works when the language specifies
7051 sound folding. Can be slow and doesn't always give
7052 better results.
7053
7054 fast Internal method that only checks for simple changes:
7055 character inserts/deletes/swaps. Works well for
7056 simple typing mistakes.
7057
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007058 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007059 Not used for |spellsuggest()|. The number of
7060 suggestions is never more than the value of 'lines'
7061 minus two.
7062
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007063 file:{filename} Read file {filename}, which must have two columns,
7064 separated by a slash. The first column contains the
7065 bad word, the second column the suggested good word.
7066 Example:
7067 theribal/terrible ~
7068 Use this for common mistakes that do not appear at the
7069 top of the suggestion list with the internal methods.
7070 Lines without a slash are ignored, use this for
7071 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007072 The word in the second column must be correct,
7073 otherwise it will not be used. Add the word to an
7074 ".add" file if it is currently flagged as a spelling
7075 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007076 The file is used for all languages.
7077
7078 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7079 trouble with spaces. |v:val| holds the badly spelled
7080 word. The expression must evaluate to a List of
7081 Lists, each with a suggestion and a score.
7082 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007083 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007084 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007085 internal methods use. A lower score is better.
7086 This may invoke |spellsuggest()| if you temporarily
7087 set 'spellsuggest' to exclude the "expr:" part.
7088 Errors are silently ignored, unless you set the
7089 'verbose' option to a non-zero value.
7090
7091 Only one of "best", "double" or "fast" may be used. The others may
7092 appear several times in any order. Example: >
7093 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7094<
7095 This option cannot be set from a |modeline| or in the |sandbox|, for
7096 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007097
7098
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7100'splitbelow' 'sb' boolean (default off)
7101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102 When on, splitting a window will put the new window below the current
7103 one. |:split|
7104
7105 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7106'splitright' 'spr' boolean (default off)
7107 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108 When on, splitting a window will put the new window right of the
7109 current one. |:vsplit|
7110
7111 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7112'startofline' 'sol' boolean (default on)
7113 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007115 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007116 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007117 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118 with a linewise operator, with "%" with a count and to buffer changing
7119 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7120 only has a line number, e.g., ":25" or ":+".
7121 In case of buffer changing commands the cursor is placed at the column
7122 where it was the last time the buffer was edited.
7123 NOTE: This option is set when 'compatible' is set.
7124
Bram Moolenaar00654022011-02-25 14:42:19 +01007125 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007127 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 {not available when compiled without the |+statusline|
7129 feature}
7130 When nonempty, this option determines the content of the status line.
7131 Also see |status-line|.
7132
7133 The option consists of printf style '%' items interspersed with
7134 normal text. Each status line item is of the form:
7135 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007136 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007137 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138
Bram Moolenaar238a5642006-02-21 22:12:05 +00007139 When the option starts with "%!" then it is used as an expression,
7140 evaluated and the result is used as the option value. Example: >
7141 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007142< The *g:statusline_winid* variable will be set to the |window-ID| of the
7143 window that the status line belongs to.
7144 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007145 Note that the "%!" expression is evaluated in the context of the
7146 current window and buffer, while %{} items are evaluated in the
7147 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007148
7149 When there is error while evaluating the option then it will be made
7150 empty to avoid further errors. Otherwise screen updating would loop.
7151
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 Note that the only effect of 'ruler' when this option is set (and
7153 'laststatus' is 2) is controlling the output of |CTRL-G|.
7154
7155 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007156 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007158 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 minwid Minimum width of the item, padding as set by '-' & '0'.
7160 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007161 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 on the left for text items. Numeric items will be
7163 shifted down to maxwid-2 digits followed by '>'number
7164 where number is the amount of missing digits, much like
7165 an exponential notation.
7166 item A one letter code as described below.
7167
7168 Following is a description of the possible statusline items. The
7169 second character in "item" is the type:
7170 N for number
7171 S for string
7172 F for flags as described below
7173 - not applicable
7174
7175 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007176 f S Path to the file in the buffer, as typed or relative to current
7177 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178 F S Full path to the file in the buffer.
7179 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007180 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007181 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007182 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007183 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007184 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007186 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007188 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007189 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007190 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007191 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7192 being used: "<keymap>"
7193 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007194 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007195 B N As above, in hexadecimal.
7196 o N Byte number in file of byte under cursor, first byte is 1.
7197 Mnemonic: Offset from start of file (with one added)
7198 {not available when compiled without |+byte_offset| feature}
7199 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007200 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007201 l N Line number.
7202 L N Number of lines in buffer.
7203 c N Column number.
7204 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007205 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 p N Percentage through file in lines as in |CTRL-G|.
7207 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007208 percentage described for 'ruler'. Always 3 in length, unless
7209 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007210 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007212 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007213 Note that there is no '%' before the closing '}'. The
7214 expression cannot contain a '}' character, call a function to
7215 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216 ( - Start of item group. Can be used for setting the width and
7217 alignment of a section. Must be followed by %) somewhere.
7218 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007219 T N For 'tabline': start of tab page N label. Use %T after the last
7220 label. This information is used for mouse clicks.
7221 X N For 'tabline': start of close tab N label. Use %X after the
7222 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7223 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224 < - Where to truncate line if too long. Default is at the start.
7225 No width fields allowed.
7226 = - Separation point between left and right aligned items.
7227 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007228 # - Set highlight group. The name must follow and then a # again.
7229 Thus use %#HLname# for highlight group HLname. The same
7230 highlighting is used, also for the statusline of non-current
7231 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007233 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234 The difference between User{N} and StatusLine will be applied
7235 to StatusLineNC for the statusline of non-current windows.
7236 The number N must be between 1 and 9. See |hl-User1..9|
7237
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007238 When displaying a flag, Vim removes the leading comma, if any, when
7239 that flag comes right after plaintext. This will make a nice display
7240 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007241
Bram Moolenaar582fd852005-03-28 20:58:01 +00007242 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243 not set) and a minwid is not set for the group, the whole group will
7244 become empty. This will make a group like the following disappear
7245 completely from the statusline when none of the flags are set. >
7246 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007247< Beware that an expression is evaluated each and every time the status
7248 line is displayed.
7249 *g:actual_curbuf* *g:actual_curwin*
7250 The current buffer and current window will be set temporarily to that
7251 of the window (and buffer) whose statusline is currently being drawn.
7252 The expression will evaluate in this context. The variable
7253 "g:actual_curbuf" is set to the `bufnr()` number of the real current
7254 buffer and "g:actual_curwin" to the |window-ID| of the real current
7255 window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007256
Bram Moolenaar30b65812012-07-12 22:01:11 +02007257 The 'statusline' option will be evaluated in the |sandbox| if set from
7258 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007259 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007260
7261 It is not allowed to change text or jump to another window while
7262 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007263
7264 If the statusline is not updated when you want it (e.g., after setting
7265 a variable that's used in an expression), you can force an update by
7266 setting an option without changing its value. Example: >
7267 :let &ro = &ro
7268
7269< A result of all digits is regarded a number for display purposes.
7270 Otherwise the result is taken as flag text and applied to the rules
7271 described above.
7272
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007273 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007275 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276
7277 Examples:
7278 Emulate standard status line with 'ruler' set >
7279 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7280< Similar, but add ASCII value of char under the cursor (like "ga") >
7281 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7282< Display byte count and byte value, modified flag in red. >
7283 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7284 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7285< Display a ,GZ flag if a compressed file is loaded >
7286 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7287< In the |:autocmd|'s: >
7288 :let b:gzflag = 1
7289< And: >
7290 :unlet b:gzflag
7291< And define this function: >
7292 :function VarExists(var, val)
7293 : if exists(a:var) | return a:val | else | return '' | endif
7294 :endfunction
7295<
7296 *'suffixes'* *'su'*
7297'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7298 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007299 Files with these suffixes get a lower priority when multiple files
7300 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007301 suffixes. Spaces after the comma are ignored. A dot is also seen as
7302 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007303 separator, precede it with a backslash (see |option-backslash| about
7304 including spaces and backslashes).
7305 See 'wildignore' for completely ignoring files.
7306 The use of |:set+=| and |:set-=| is preferred when adding or removing
7307 suffixes from the list. This avoids problems when a future version
7308 uses another default.
7309
7310 *'suffixesadd'* *'sua'*
7311'suffixesadd' 'sua' string (default "")
7312 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007313 {not available when compiled without the
7314 |+file_in_path| feature}
7315 Comma separated list of suffixes, which are used when searching for a
7316 file for the "gf", "[I", etc. commands. Example: >
7317 :set suffixesadd=.java
7318<
7319 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7320'swapfile' 'swf' boolean (default on)
7321 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007322 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007323 swapfile is not wanted for a specific buffer. For example, with
7324 confidential information that even root must not be able to access.
7325 Careful: All text will be in memory:
7326 - Don't use this for big files.
7327 - Recovery will be impossible!
7328 A swapfile will only be present when |'updatecount'| is non-zero and
7329 'swapfile' is set.
7330 When 'swapfile' is reset, the swap file for the current buffer is
7331 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7332 non-zero, a swap file is immediately created.
7333 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007334 If you want to open a new buffer without creating a swap file for it,
7335 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007336 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007337
7338 This option is used together with 'bufhidden' and 'buftype' to
7339 specify special kinds of buffers. See |special-buffers|.
7340
7341 *'swapsync'* *'sws'*
7342'swapsync' 'sws' string (default "fsync")
7343 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007345 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007346 When this option is empty parts of the swap file may be in memory and
7347 not written to disk. When the system crashes you may lose more work.
7348 On Unix the system does a sync now and then without Vim asking for it,
7349 so the disadvantage of setting this option off is small. On some
7350 systems the swap file will not be written at all. For a unix system
7351 setting it to "sync" will use the sync() call instead of the default
7352 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007353 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007354
7355 *'switchbuf'* *'swb'*
7356'switchbuf' 'swb' string (default "")
7357 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007358 This option controls the behavior when switching between buffers.
7359 Possible values (comma separated list):
7360 useopen If included, jump to the first open window that
7361 contains the specified buffer (if there is one).
7362 Otherwise: Do not examine other windows.
7363 This setting is checked with |quickfix| commands, when
7364 jumping to errors (":cc", ":cn", "cp", etc.). It is
7365 also used in all buffer related split commands, for
7366 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007367 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007368 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007369 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007370 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007371 Otherwise: do not split, use current window (when used
7372 in the quickfix window: the previously used window or
7373 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007374 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007375 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007376 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007377
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007378 *'synmaxcol'* *'smc'*
7379'synmaxcol' 'smc' number (default 3000)
7380 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007381 {not available when compiled without the |+syntax|
7382 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007383 Maximum column in which to search for syntax items. In long lines the
7384 text after this column is not highlighted and following lines may not
7385 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007386 This helps to avoid very slow redrawing for an XML file that is one
7387 long line.
7388 Set to zero to remove the limit.
7389
Bram Moolenaar071d4272004-06-13 20:20:40 +00007390 *'syntax'* *'syn'*
7391'syntax' 'syn' string (default empty)
7392 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393 {not available when compiled without the |+syntax|
7394 feature}
7395 When this option is set, the syntax with this name is loaded, unless
7396 syntax highlighting has been switched off with ":syntax off".
7397 Otherwise this option does not always reflect the current syntax (the
7398 b:current_syntax variable does).
7399 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007400 not automatically recognized. Example, in an IDL file:
7401 /* vim: set syntax=idl : */ ~
7402 When a dot appears in the value then this separates two filetype
7403 names. Example:
7404 /* vim: set syntax=c.doxygen : */ ~
7405 This will use the "c" syntax first, then the "doxygen" syntax.
7406 Note that the second one must be prepared to be loaded as an addition,
7407 otherwise it will be skipped. More than one dot may appear.
7408 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007409 :set syntax=OFF
7410< To switch syntax highlighting on according to the current value of the
7411 'filetype' option: >
7412 :set syntax=ON
7413< What actually happens when setting the 'syntax' option is that the
7414 Syntax autocommand event is triggered with the value as argument.
7415 This option is not copied to another buffer, independent of the 's' or
7416 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007417 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007419 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007420'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007421 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007422 When nonempty, this option determines the content of the tab pages
7423 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007424 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007425
7426 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007427 option and only when there is no GUI tab line. When 'e' is in
7428 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007429 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007430
7431 The value is evaluated like with 'statusline'. You can use
7432 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007433 the text to be displayed. Use "%1T" for the first label, "%2T" for
7434 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007435
Bram Moolenaare12bab32019-01-08 22:02:56 +01007436 When changing something that is used in 'tabline' that does not
7437 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007438 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007439
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007440 Keep in mind that only one of the tab pages is the current one, others
7441 are invisible and you can't jump to their windows.
7442
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007443
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007444 *'tabpagemax'* *'tpm'*
7445'tabpagemax' 'tpm' number (default 10)
7446 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007447 Maximum number of tab pages to be opened by the |-p| command line
7448 argument or the ":tab all" command. |tabpage|
7449
7450
7451 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452'tabstop' 'ts' number (default 8)
7453 local to buffer
7454 Number of spaces that a <Tab> in the file counts for. Also see
7455 |:retab| command, and 'softtabstop' option.
7456
7457 Note: Setting 'tabstop' to any other value than 8 can make your file
7458 appear wrong in many places (e.g., when printing it).
7459
7460 There are four main ways to use tabs in Vim:
7461 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7462 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007463 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464 behave like a tab appears every 4 (or 3) characters.
7465 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7466 'expandtab'. This way you will always insert spaces. The
7467 formatting will never be messed up when 'tabstop' is changed.
7468 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007469 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007470 works when using Vim to edit the file.
7471 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7472 'noexpandtab'. This should then work (for initial indents only)
7473 for any tabstop setting that people use. It might be nice to have
7474 tabs after the first non-blank inserted as spaces if you do this
7475 though. Otherwise aligned comments will be wrong when 'tabstop' is
7476 changed.
7477
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007478 If Vim is compiled with the |+vartabs| feature then the value of
7479 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7480 than an empty string.
7481
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7483'tagbsearch' 'tbs' boolean (default on)
7484 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007486 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 searching makes searching for a tag a LOT faster, but a linear search
7488 will find more tags if the tags file wasn't properly sorted.
7489 Vim normally assumes that your tags files are sorted, or indicate that
7490 they are not sorted. Only when this is not the case does the
7491 'tagbsearch' option need to be switched off.
7492
7493 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007494 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495 certain files, or retry all files with a linear search. When
7496 'tagbsearch' is off, only a linear search is done.
7497
7498 Linear searching is done anyway, for one file, when Vim finds a line
7499 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007500 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501< [The whitespace before and after the '0' must be a single <Tab>]
7502
7503 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007504 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 instead of a normal tag name, a retry is done with a linear search.
7506 Tags in unsorted tags files, and matches with different case will only
7507 be found in the retry.
7508
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007509 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007510 linear search can be avoided when case is ignored. Use a value of '2'
7511 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7512 sorted with the -f switch to "sort" in most unices, as in the command:
7513 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7514 (at least 5.5) the --sort=foldcase switch can be used for this as
7515 well. Note that case must be folded to uppercase for this to work.
7516
7517 By default, tag searches are case-sensitive. Case is ignored when
7518 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7519 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007520 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7521 'tagcase' is "smart", and the pattern contains only lowercase
7522 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523
7524 When 'tagbsearch' is off, tags searching is slower when a full match
7525 exists, but faster when no full match exists. Tags in unsorted tags
7526 files may only be found with 'tagbsearch' off.
7527 When the tags file is not sorted, or sorted in a wrong way (not on
7528 ASCII byte value), 'tagbsearch' should be off, or the line given above
7529 must be included in the tags file.
7530 This option doesn't affect commands that find all matching tags (e.g.,
7531 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007533 *'tagcase'* *'tc'*
7534'tagcase' 'tc' string (default "followic")
7535 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007536 This option specifies how case is handled when searching the tags
7537 file:
7538 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007539 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007540 ignore Ignore case
7541 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007542 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007543 NOTE: This option is set to the Vi default value when 'compatible' is
7544 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007545
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007546 *'tagfunc'* *'tfu'*
7547'tagfunc' 'tfu' string (default: empty)
7548 local to buffer
7549 {not available when compiled without the |+eval|
7550 feature}
7551 This option specifies a function to be used to perform tag searches.
7552 The function gets the tag pattern and should return a List of matching
7553 tags. See |tag-function| for an explanation of how to write the
7554 function and an example.
7555
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556 *'taglength'* *'tl'*
7557'taglength' 'tl' number (default 0)
7558 global
7559 If non-zero, tags are significant up to this number of characters.
7560
7561 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7562'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7563 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007564 If on and using a tags file in another directory, file names in that
7565 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 NOTE: This option is set to the Vi default value when 'compatible' is
7567 set and to the Vim default value when 'compatible' is reset.
7568
7569 *'tags'* *'tag'* *E433*
7570'tags' 'tag' string (default "./tags,tags", when compiled with
7571 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7572 global or local to buffer |global-local|
7573 Filenames for the tag command, separated by spaces or commas. To
7574 include a space or comma in a file name, precede it with a backslash
7575 (see |option-backslash| about including spaces and backslashes).
7576 When a file name starts with "./", the '.' is replaced with the path
7577 of the current file. But only when the 'd' flag is not included in
7578 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7579 |tags-option|.
7580 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007581 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7582 find all files named "tags" below "/lib". The filename itself cannot
7583 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7584 files called "tags?". {not available when compiled without the
7585 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007586 The |tagfiles()| function can be used to get a list of the file names
7587 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7589 files are also supported. They are automatically recognized. The
7590 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7591 differences are ignored (MS-Windows). |emacs-tags|
7592 The use of |:set+=| and |:set-=| is preferred when adding or removing
7593 file names from the list. This avoids problems when a future version
7594 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595
7596 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7597'tagstack' 'tgst' boolean (default on)
7598 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 When on, the |tagstack| is used normally. When off, a ":tag" or
7600 ":tselect" command with an argument will not push the tag onto the
7601 tagstack. A following ":tag" without an argument, a ":pop" command or
7602 any other command that uses the tagstack will use the unmodified
7603 tagstack, but does change the pointer to the active entry.
7604 Resetting this option is useful when using a ":tag" command in a
7605 mapping which should not change the tagstack.
7606
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007607 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007608'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007609 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007610 {only available when compiled with the |+tcl/dyn|
7611 feature}
7612 Specifies the name of the Tcl shared library. The default is
7613 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007614 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007615 This option cannot be set from a |modeline| or in the |sandbox|, for
7616 security reasons.
7617
Bram Moolenaar071d4272004-06-13 20:20:40 +00007618 *'term'* *E529* *E530* *E531*
7619'term' string (default is $TERM, if that fails:
7620 in the GUI: "builtin_gui"
7621 on Amiga: "amiga"
7622 on BeOS: "beos-ansi"
7623 on Mac: "mac-ansi"
7624 on MiNT: "vt52"
7625 on MS-DOS: "pcterm"
7626 on OS/2: "os2ansi"
7627 on Unix: "ansi"
7628 on VMS: "ansi"
7629 on Win 32: "win32")
7630 global
7631 Name of the terminal. Used for choosing the terminal control
7632 characters. Environment variables are expanded |:set_env|.
7633 For example: >
7634 :set term=$TERM
7635< See |termcap|.
7636
7637 *'termbidi'* *'tbidi'*
7638 *'notermbidi'* *'notbidi'*
7639'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7640 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007641 {only available when compiled with the |+arabic|
7642 feature}
7643 The terminal is in charge of Bi-directionality of text (as specified
7644 by Unicode). The terminal is also expected to do the required shaping
7645 that some languages (such as Arabic) require.
7646 Setting this option implies that 'rightleft' will not be set when
7647 'arabic' is set and the value of 'arabicshape' will be ignored.
7648 Note that setting 'termbidi' has the immediate effect that
7649 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7650 This option is reset when the GUI is started.
7651 For further details see |arabic.txt|.
7652
7653 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007654'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655 Macintosh GUI: "macroman")
7656 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007657 Encoding used for the terminal. This specifies what character
7658 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007659 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007660 display). Except for the Mac when 'macatsui' is off, then
7661 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007662 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007663 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7665 Any attempts to set a different value will be rejected, and an error
7666 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007667 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668 because the Win32 system always passes Unicode characters.
7669 When empty, the same encoding is used as for the 'encoding' option.
7670 This is the normal value.
7671 Not all combinations for 'termencoding' and 'encoding' are valid. See
7672 |encoding-table|.
7673 The value for this option must be supported by internal conversions or
7674 iconv(). When this is not possible no conversion will be done and you
7675 will probably experience problems with non-ASCII characters.
7676 Example: You are working with the locale set to euc-jp (Japanese) and
7677 want to edit a UTF-8 file: >
7678 :let &termencoding = &encoding
7679 :set encoding=utf-8
7680< You need to do this when your system has no locale support for UTF-8.
7681
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007682 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007683'termguicolors' 'tgc' boolean (default off)
7684 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007685 {not available when compiled without the
7686 |+termguicolors| feature}
7687 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007688 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007689
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007690 Requires a ISO-8613-3 compatible terminal. If setting this option
7691 does not work (produces a colorless UI) reading |xterm-true-color|
7692 might help.
7693
7694 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7695 is required. Use this check to find out: >
7696 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007697< This requires Vim to be built with the |+vtp| feature.
7698
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007699 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007700 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007701
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007702 *'termwinkey'* *'twk'*
7703'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007704 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007705 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007706 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007707 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007708 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007709< The string must be one key stroke but can be multiple bytes.
7710 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007711 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007712 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007713
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007714 *'termwinscroll'* *'twsl'*
7715'termwinscroll' 'twsl' number (default 10000)
7716 local to buffer
7717 {not available when compiled without the
7718 |+terminal| feature}
7719 Number of scrollback lines to keep. When going over this limit the
7720 first 10% of the scrollback lines are deleted. This is just to reduce
7721 the memory usage. See |Terminal-Normal|.
7722
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007723 *'termwinsize'* *'tws'*
7724'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007725 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007726 Size of the |terminal| window. Format: {rows}x{columns} or
7727 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007728 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007729 - When set with a "x" (e.g., "24x80") the terminal size is not
7730 adjusted to the window size. If the window is smaller only the
7731 top-left part is displayed.
7732 - When set with a "*" (e.g., "10*50") the terminal size follows the
7733 window size, but will not be smaller than the specified rows and/or
7734 columns.
7735 - When rows is zero then use the height of the window.
7736 - When columns is zero then use the width of the window.
7737 - Using "0x0" or "0*0" is the same as empty.
7738
7739 Examples:
7740 "30x0" uses 30 rows and the current window width.
7741 "20*0" uses at least 20 rows and the current window width.
7742 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007743 Note that the command running in the terminal window may still change
7744 the size of the terminal. In that case the Vim window will be
7745 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007746
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007747 *'termwintype'* *'twt'*
7748'termwintype' 'twt' string (default "")
7749 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007750 {only available when compiled with the |terminal|
7751 feature on MS-Windows}
7752 Specify the virtual console (pty) used when opening the terminal
7753 window.
7754
7755 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007756 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007757 "winpty" use winpty, fail if not supported
7758 "conpty" use |ConPTY|, fail if not supported
7759
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007760 |ConPTY| support depends on the platform. Windows 10 October 2018
7761 Update is the first version that supports ConPTY, however it is still
7762 considered unstable. ConPTY might become stable in the next release
7763 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007764 supported then you cannot open a terminal window.
7765
Bram Moolenaar071d4272004-06-13 20:20:40 +00007766 *'terse'* *'noterse'*
7767'terse' boolean (default off)
7768 global
7769 When set: Add 's' flag to 'shortmess' option (this makes the message
7770 for a search that hits the start or end of the file not being
7771 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7772 shortens a lot of messages}
7773
7774 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7775'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7776 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007777 This option is obsolete. Use 'fileformats'.
7778 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7779 set to the default value for the current system. When 'textauto' is
7780 reset, 'fileformats' is made empty.
7781 NOTE: This option is set to the Vi default value when 'compatible' is
7782 set and to the Vim default value when 'compatible' is reset.
7783
7784 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7785'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7786 others: default off)
7787 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788 This option is obsolete. Use 'fileformat'.
7789 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7790 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7791 "unix".
7792
7793 *'textwidth'* *'tw'*
7794'textwidth' 'tw' number (default 0)
7795 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007796 Maximum width of text that is being inserted. A longer line will be
7797 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007798 this.
7799 'textwidth' is set to 0 when the 'paste' option is set and restored
7800 when 'paste' is reset.
7801 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007802 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007803 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007804 NOTE: This option is set to 0 when 'compatible' is set.
7805
7806 *'thesaurus'* *'tsr'*
7807'thesaurus' 'tsr' string (default "")
7808 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007810 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7811
7812 Each line in the file should contain words with similar meaning,
7813 separated by non-keyword characters (white space is preferred).
7814 Maximum line length is 510 bytes.
7815
Bram Moolenaard47d5222018-12-09 20:43:55 +01007816 An English word list was added to this github issue:
7817 https://github.com/vim/vim/issues/629#issuecomment-443293282
7818 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7819 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7820 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007821
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007822 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823 after a comma are ignored, otherwise spaces are included in the file
7824 name. See |option-backslash| about using backslashes.
7825 The use of |:set+=| and |:set-=| is preferred when adding or removing
7826 directories from the list. This avoids problems when a future version
7827 uses another default.
7828 Backticks cannot be used in this option for security reasons.
7829
7830 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7831'tildeop' 'top' boolean (default off)
7832 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007833 When on: The tilde command "~" behaves like an operator.
7834 NOTE: This option is reset when 'compatible' is set.
7835
7836 *'timeout'* *'to'* *'notimeout'* *'noto'*
7837'timeout' 'to' boolean (default on)
7838 global
7839 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007840'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007841 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007842 These two options together determine the behavior when part of a
7843 mapped key sequence or keyboard code has been received:
7844
7845 'timeout' 'ttimeout' action ~
7846 off off do not time out
7847 on on or off time out on :mappings and key codes
7848 off on time out on key codes
7849
7850 If both options are off, Vim will wait until either the complete
7851 mapping or key sequence has been received, or it is clear that there
7852 is no mapping or key sequence for the received characters. For
7853 example: if you have mapped "vl" and Vim has received 'v', the next
7854 character is needed to see if the 'v' is followed by an 'l'.
7855 When one of the options is on, Vim will wait for about 1 second for
7856 the next character to arrive. After that the already received
7857 characters are interpreted as single characters. The waiting time can
7858 be changed with the 'timeoutlen' option.
7859 On slow terminals or very busy systems timing out may cause
7860 malfunctioning cursor keys. If both options are off, Vim waits
7861 forever after an entered <Esc> if there are key codes that start
7862 with <Esc>. You will have to type <Esc> twice. If you do not have
7863 problems with key codes, but would like to have :mapped key
7864 sequences not timing out in 1 second, set the 'ttimeout' option and
7865 reset the 'timeout' option.
7866
7867 NOTE: 'ttimeout' is reset when 'compatible' is set.
7868
7869 *'timeoutlen'* *'tm'*
7870'timeoutlen' 'tm' number (default 1000)
7871 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007872
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007874'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876 The time in milliseconds that is waited for a key code or mapped key
7877 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7878 when part of a command has been typed.
7879 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7880 different timeout value for key codes is desired set 'ttimeoutlen' to
7881 a non-negative number.
7882
7883 ttimeoutlen mapping delay key code delay ~
7884 < 0 'timeoutlen' 'timeoutlen'
7885 >= 0 'timeoutlen' 'ttimeoutlen'
7886
7887 The timeout only happens when the 'timeout' and 'ttimeout' options
7888 tell so. A useful setting would be >
7889 :set timeout timeoutlen=3000 ttimeoutlen=100
7890< (time out on mapping after three seconds, time out on key codes after
7891 a tenth of a second).
7892
7893 *'title'* *'notitle'*
7894'title' boolean (default off, on when title can be restored)
7895 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007896 {not available when compiled without the |+title|
7897 feature}
7898 When on, the title of the window will be set to the value of
7899 'titlestring' (if it is not empty), or to:
7900 filename [+=-] (path) - VIM
7901 Where:
7902 filename the name of the file being edited
7903 - indicates the file cannot be modified, 'ma' off
7904 + indicates the file was modified
7905 = indicates the file is read-only
7906 =+ indicates the file is read-only and modified
7907 (path) is the path of the file being edited
7908 - VIM the server name |v:servername| or "VIM"
7909 Only works if the terminal supports setting window titles
7910 (currently Amiga console, Win32 console, all GUI versions and
7911 terminals with a non- empty 't_ts' option - these are Unix xterm and
7912 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7913 *X11*
7914 When Vim was compiled with HAVE_X11 defined, the original title will
7915 be restored if possible. The output of ":version" will include "+X11"
7916 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7917 works for the icon name |'icon'|.
7918 But: When Vim was started with the |-X| argument, restoring the title
7919 will not work (except in the GUI).
7920 If the title cannot be restored, it is set to the value of 'titleold'.
7921 You might want to restore the title outside of Vim then.
7922 When using an xterm from a remote machine you can use this command:
7923 rsh machine_name xterm -display $DISPLAY &
7924 then the WINDOWID environment variable should be inherited and the
7925 title of the window should change back to what it should be after
7926 exiting Vim.
7927
7928 *'titlelen'*
7929'titlelen' number (default 85)
7930 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007931 {not available when compiled without the |+title|
7932 feature}
7933 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007934 title. When the title is longer, only the end of the path name is
7935 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007936 Using a percentage makes this adapt to the width of the window. But
7937 it won't work perfectly, because the actual number of characters
7938 available also depends on the font used and other things in the title
7939 bar. When 'titlelen' is zero the full path is used. Otherwise,
7940 values from 1 to 30000 percent can be used.
7941 'titlelen' is also used for the 'titlestring' option.
7942
7943 *'titleold'*
7944'titleold' string (default "Thanks for flying Vim")
7945 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007946 {only available when compiled with the |+title|
7947 feature}
7948 This option will be used for the window title when exiting Vim if the
7949 original title cannot be restored. Only happens if 'title' is on or
7950 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007951 This option cannot be set from a |modeline| or in the |sandbox|, for
7952 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953 *'titlestring'*
7954'titlestring' string (default "")
7955 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956 {not available when compiled without the |+title|
7957 feature}
7958 When this option is not empty, it will be used for the title of the
7959 window. This happens only when the 'title' option is on.
7960 Only works if the terminal supports setting window titles (currently
7961 Amiga console, Win32 console, all GUI versions and terminals with a
7962 non-empty 't_ts' option).
7963 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007964 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007965
Bram Moolenaar071d4272004-06-13 20:20:40 +00007966 When this option contains printf-style '%' items, they will be
7967 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007968 This option cannot be set in a modeline when 'modelineexpr' is off.
7969
Bram Moolenaar071d4272004-06-13 20:20:40 +00007970 Example: >
7971 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7972 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7973< The value of 'titlelen' is used to align items in the middle or right
7974 of the available space.
7975 Some people prefer to have the file name first: >
7976 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7977< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007978 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007979 separating space only when needed.
7980 NOTE: Use of special characters in 'titlestring' may cause the display
7981 to be garbled (e.g., when it contains a CR or NL character).
7982 {not available when compiled without the |+statusline| feature}
7983
7984 *'toolbar'* *'tb'*
7985'toolbar' 'tb' string (default "icons,tooltips")
7986 global
7987 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7988 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007989 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990 possible values are:
7991 icons Toolbar buttons are shown with icons.
7992 text Toolbar buttons shown with text.
7993 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007994 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 tooltips Tooltips are active for toolbar buttons.
7996 Tooltips refer to the popup help text which appears after the mouse
7997 cursor is placed over a toolbar button for a brief moment.
7998
7999 If you want the toolbar to be shown with icons as well as text, do the
8000 following: >
8001 :set tb=icons,text
8002< Motif and Athena cannot display icons and text at the same time. They
8003 will show icons if both are requested.
8004
8005 If none of the strings specified in 'toolbar' are valid or if
8006 'toolbar' is empty, this option is ignored. If you want to disable
8007 the toolbar, you need to set the 'guioptions' option. For example: >
8008 :set guioptions-=T
8009< Also see |gui-toolbar|.
8010
8011 *'toolbariconsize'* *'tbis'*
8012'toolbariconsize' 'tbis' string (default "small")
8013 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008014 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008016 tiny Use tiny icons.
8017 small Use small icons (default).
8018 medium Use medium-sized icons.
8019 large Use large icons.
8020 huge Use even larger icons.
8021 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008023 the current theme. Common dimensions are giant=48x48, huge=32x32,
8024 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008025
8026 If 'toolbariconsize' is empty, the global default size as determined
8027 by user preferences or the current theme is used.
8028
8029 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8030'ttybuiltin' 'tbi' boolean (default on)
8031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032 When on, the builtin termcaps are searched before the external ones.
8033 When off the builtin termcaps are searched after the external ones.
8034 When this option is changed, you should set the 'term' option next for
8035 the change to take effect, for example: >
8036 :set notbi term=$TERM
8037< See also |termcap|.
8038 Rationale: The default for this option is "on", because the builtin
8039 termcap entries are generally better (many systems contain faulty
8040 xterm entries...).
8041
8042 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8043'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8044 sun-cmd, screen, rxvt, dtterm or
8045 iris-ansi; also on when running Vim in
8046 a DOS console)
8047 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 Indicates a fast terminal connection. More characters will be sent to
8049 the screen for redrawing, instead of using insert/delete line
8050 commands. Improves smoothness of redrawing when there are multiple
8051 windows and the terminal does not support a scrolling region.
8052 Also enables the extra writing of characters at the end of each screen
8053 line for lines that wrap. This helps when using copy/paste with the
8054 mouse in an xterm and other terminals.
8055
8056 *'ttymouse'* *'ttym'*
8057'ttymouse' 'ttym' string (default depends on 'term')
8058 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008059 {only in Unix and VMS, doesn't work in the GUI; not
8060 available when compiled without |+mouse|}
8061 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008062 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008063 *xterm-mouse*
8064 xterm xterm-like mouse handling. The mouse generates
8065 "<Esc>[Mscr", where "scr" is three bytes:
8066 "s" = button state
8067 "c" = column plus 33
8068 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008069 This only works up to 223 columns! See "dec",
8070 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008071 xterm2 Works like "xterm", but with the xterm reporting the
8072 mouse position while the mouse is dragged. This works
8073 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008074 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008075 work. See below for how Vim detects this
8076 automatically.
8077 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008078 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008079 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008080 for the row and column. No other mouse events are
8081 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082 *dec-mouse*
8083 dec DEC terminal mouse handling. The mouse generates a
8084 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008085 This is also available for an Xterm, if it was
8086 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008087 *jsbterm-mouse*
8088 jsbterm JSB term mouse handling.
8089 *pterm-mouse*
8090 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008091 *urxvt-mouse*
8092 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008093 The mouse works only if the terminal supports this
8094 encoding style, but it does not have 223 columns limit
8095 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008096 *sgr-mouse*
8097 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008098 mouse reporting. The mouse works even in columns
8099 beyond 223. This option is backward compatible with
8100 "xterm2" because it can also decode "xterm2" style
8101 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008102
8103 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008104 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8105 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008106 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8107 recognized, if enabled at compile time. DEC terminal mouse codes
8108 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008109 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8110 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008111 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008112 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8113 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8114 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008115 Additionally, if vim is compiled with the |+termresponse| feature and
8116 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008117 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008118 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008119 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8120 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8121 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008122 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8123 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008124 :set t_RV=
8125<
8126 *'ttyscroll'* *'tsl'*
8127'ttyscroll' 'tsl' number (default 999)
8128 global
8129 Maximum number of lines to scroll the screen. If there are more lines
8130 to scroll the window is redrawn. For terminals where scrolling is
8131 very slow and redrawing is not slow this can be set to a small number,
8132 e.g., 3, to speed up displaying.
8133
8134 *'ttytype'* *'tty'*
8135'ttytype' 'tty' string (default from $TERM)
8136 global
8137 Alias for 'term', see above.
8138
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008139 *'undodir'* *'udir'*
8140'undodir' 'udir' string (default ".")
8141 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008142 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008143 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008144 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008145 "." means using the directory of the file. The undo file name for
8146 "file.txt" is ".file.txt.un~".
8147 For other directories the file name is the full path of the edited
8148 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008149 When writing: The first directory that exists is used. "." always
8150 works, no directories after "." will be used for writing.
8151 When reading all entries are tried to find an undo file. The first
8152 undo file that exists is used. When it cannot be read an error is
8153 given, no further entry is used.
8154 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008155 This option cannot be set from a |modeline| or in the |sandbox|, for
8156 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008157
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008158 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008159'undofile' 'udf' boolean (default off)
8160 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008161 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008162 When on, Vim automatically saves undo history to an undo file when
8163 writing a buffer to a file, and restores undo history from the same
8164 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008165 The directory where the undo file is stored is specified by 'undodir'.
8166 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008167 The undo file is not read when 'undoreload' causes the buffer from
8168 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008169 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008170 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008171
Bram Moolenaar071d4272004-06-13 20:20:40 +00008172 *'undolevels'* *'ul'*
8173'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8174 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008175 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008176 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008177 is kept in memory, higher numbers will cause more memory to be used.
8178 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8180 itself: >
8181 set ul=0
8182< But you can also get Vi compatibility by including the 'u' flag in
8183 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008184 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008185 Set to -1 for no undo at all. You might want to do this only for the
8186 current buffer: >
8187 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008188< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008189
8190 The local value is set to -123456 when the global value is to be used.
8191
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008192 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008193
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008194 *'undoreload'* *'ur'*
8195'undoreload' 'ur' number (default 10000)
8196 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008197 Save the whole buffer for undo when reloading it. This applies to the
8198 ":e!" command and reloading for when the buffer changed outside of
8199 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008200 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008201 of lines is smaller than the value of this option.
8202 Set this option to zero to disable undo for a reload.
8203
8204 When saving undo for a reload, any undo file is not read.
8205
8206 Note that this causes the whole buffer to be stored in memory. Set
8207 this option to a lower value if you run out of memory.
8208
Bram Moolenaar071d4272004-06-13 20:20:40 +00008209 *'updatecount'* *'uc'*
8210'updatecount' 'uc' number (default: 200)
8211 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008212 After typing this many characters the swap file will be written to
8213 disk. When zero, no swap file will be created at all (see chapter on
8214 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8215 Vim with the "-n" option, see |startup|. When editing in readonly
8216 mode this option will be initialized to 10000.
8217 The swapfile can be disabled per buffer with |'swapfile'|.
8218 When 'updatecount' is set from zero to non-zero, swap files are
8219 created for all buffers that have 'swapfile' set. When 'updatecount'
8220 is set to zero, existing swap files are not deleted.
8221 Also see |'swapsync'|.
8222 This option has no meaning in buffers where |'buftype'| is "nofile"
8223 or "nowrite".
8224
8225 *'updatetime'* *'ut'*
8226'updatetime' 'ut' number (default 4000)
8227 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008228 If this many milliseconds nothing is typed the swap file will be
8229 written to disk (see |crash-recovery|). Also used for the
8230 |CursorHold| autocommand event.
8231
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008232 *'varsofttabstop'* *'vsts'*
8233'varsofttabstop' 'vsts' string (default "")
8234 local to buffer
8235 {only available when compiled with the |+vartabs|
8236 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008237 A list of the number of spaces that a <Tab> counts for while editing,
8238 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8239 width <Tab>s are being inserted, while in fact a mixture of spaces
8240 and <Tab>s is used. Tab widths are separated with commas, with the
8241 final value applying to all subsequent tabs.
8242
8243 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008244 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008245 to use the following: >
8246 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008247< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8248 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008249
8250 Note that the value of |'softtabstop'| will be ignored while
8251 'varsofttabstop' is set.
8252
8253 *'vartabstop'* *'vts'*
8254'vartabstop' 'vts' string (default "")
8255 local to buffer
8256 {only available when compiled with the |+vartabs|
8257 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008258 A list of the number of spaces that a <Tab> in the file counts for,
8259 separated by commas. Each value corresponds to one tab, with the
8260 final value applying to all subsequent tabs. For example: >
8261 :set vartabstop=4,20,10,8
8262< This will make the first tab 4 spaces wide, the second 20 spaces,
8263 the third 10 spaces, and all following tabs 8 spaces.
8264
8265 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8266 is set.
8267
Bram Moolenaar071d4272004-06-13 20:20:40 +00008268 *'verbose'* *'vbs'*
8269'verbose' 'vbs' number (default 0)
8270 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008271 When bigger than zero, Vim will give messages about what it is doing.
8272 Currently, these messages are given:
8273 >= 1 When the viminfo file is read or written.
8274 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008275 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008276 >= 8 Files for which a group of autocommands is executed.
8277 >= 9 Every executed autocommand.
8278 >= 12 Every executed function.
8279 >= 13 When an exception is thrown, caught, finished, or discarded.
8280 >= 14 Anything pending in a ":finally" clause.
8281 >= 15 Every executed Ex command (truncated at 200 characters).
8282
8283 This option can also be set with the "-V" argument. See |-V|.
8284 This option is also set by the |:verbose| command.
8285
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008286 When the 'verbosefile' option is set then the verbose messages are not
8287 displayed.
8288
8289 *'verbosefile'* *'vfile'*
8290'verbosefile' 'vfile' string (default empty)
8291 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008292 When not empty all messages are written in a file with this name.
8293 When the file exists messages are appended.
8294 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008295 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008296 Setting 'verbosefile' to a new value is like making it empty first.
8297 The difference with |:redir| is that verbose messages are not
8298 displayed when 'verbosefile' is set.
8299
Bram Moolenaar071d4272004-06-13 20:20:40 +00008300 *'viewdir'* *'vdir'*
8301'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8302 "$VIM/vimfiles/view",
8303 for Unix: "~/.vim/view",
8304 for Macintosh: "$VIM:vimfiles:view"
8305 for VMS: "sys$login:vimfiles/view"
8306 for RiscOS: "Choices:vimfiles/view")
8307 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008308 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008309 feature}
8310 Name of the directory where to store files for |:mkview|.
8311 This option cannot be set from a |modeline| or in the |sandbox|, for
8312 security reasons.
8313
8314 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008315'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008317 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008318 feature}
8319 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008320 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008321 word save and restore ~
8322 cursor cursor position in file and in window
8323 folds manually created folds, opened/closed folds and local
8324 fold options
8325 options options and mappings local to a window or buffer (not
8326 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008327 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008328 slash backslashes in file names replaced with forward
8329 slashes
8330 unix with Unix end-of-line format (single <NL>), even when
8331 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008332 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008333
8334 "slash" and "unix" are useful on Windows when sharing view files
8335 with Unix. The Unix version of Vim cannot source dos format scripts,
8336 but the Windows version of Vim can source unix format scripts.
8337
8338 *'viminfo'* *'vi'* *E526* *E527* *E528*
8339'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008340 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8341 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8342 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008343 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008344 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008345 feature}
8346 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008347 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8348 "NONE".
8349 The string should be a comma separated list of parameters, each
8350 consisting of a single character identifying the particular parameter,
8351 followed by a number or string which specifies the value of that
8352 parameter. If a particular character is left out, then the default
8353 value is used for that parameter. The following is a list of the
8354 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008355 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008356 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357 ! When included, save and restore global variables that start
8358 with an uppercase letter, and don't contain a lowercase
8359 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008360 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008361 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008362 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363 " Maximum number of lines saved for each register. Old name of
8364 the '<' item, with the disadvantage that you need to put a
8365 backslash before the ", otherwise it will be recognized as the
8366 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008367 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368 % When included, save and restore the buffer list. If Vim is
8369 started with a file name argument, the buffer list is not
8370 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008371 buffer list is restored from the viminfo file. Quickfix
8372 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8373 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008374 When followed by a number, the number specifies the maximum
8375 number of buffers that are stored. Without a number all
8376 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008377 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378 ' Maximum number of previously edited files for which the marks
8379 are remembered. This parameter must always be included when
8380 'viminfo' is non-empty.
8381 Including this item also means that the |jumplist| and the
8382 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008383 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008385 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 patterns are also saved. When not included, the value of
8387 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008388 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008389 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008390 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008391 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008392 < Maximum number of lines saved for each register. If zero then
8393 registers are not saved. When not included, all lines are
8394 saved. '"' is the old name for this item.
8395 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008396 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008397 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008398 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008399 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 c When included, convert the text in the viminfo file from the
8401 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008402 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008403 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008404 f Whether file marks need to be stored. If zero, file marks ('0
8405 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008406 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008408 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008409 h Disable the effect of 'hlsearch' when loading the viminfo
8410 file. When not included, it depends on whether ":nohlsearch"
8411 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008412 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008414 the 'n'. Must be at the end of the option! If the
8415 'viminfofile' option is set, that file name overrides the one
8416 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008417 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008418 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008419 r Removable media. The argument is a string (up to the next
8420 ','). This parameter can be given several times. Each
8421 specifies the start of a path for which no marks will be
8422 stored. This is to avoid removable media. For MS-DOS you
8423 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8424 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8425 ignored. Maximum length of each 'r' argument is 50
8426 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008427 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428 s Maximum size of an item in Kbyte. If zero then registers are
8429 not saved. Currently only applies to registers. The default
8430 "s10" will exclude registers with more than 10 Kbyte of text.
8431 Also see the '<' item above: line count limit.
8432
8433 Example: >
8434 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8435<
8436 '50 Marks will be remembered for the last 50 files you
8437 edited.
8438 <1000 Contents of registers (up to 1000 lines each) will be
8439 remembered.
8440 s100 Registers with more than 100 Kbyte text are skipped.
8441 :0 Command-line history will not be saved.
8442 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8443 no / Since '/' is not specified, the default will be used,
8444 that is, save all of the search history, and also the
8445 previous search and substitute patterns.
8446 no % The buffer list will not be saved nor read back.
8447 no h 'hlsearch' highlighting will be restored.
8448
8449 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8450 load the contents of the file, this is not done automatically.
8451
8452 This option cannot be set from a |modeline| or in the |sandbox|, for
8453 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008454 NOTE: This option is set to the Vim default value when 'compatible'
8455 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008456
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008457 *'viminfofile'* *'vif'*
8458'viminfofile' 'vif' string (default: "")
8459 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008460 {not available when compiled without the |+viminfo|
8461 feature}
8462 When non-empty, overrides the file name used for viminfo.
8463 When equal to "NONE" no viminfo file will be read or written.
8464 This option can be set with the |-i| command line flag. The |--clean|
8465 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008466 This option cannot be set from a |modeline| or in the |sandbox|, for
8467 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008468
Bram Moolenaar071d4272004-06-13 20:20:40 +00008469 *'virtualedit'* *'ve'*
8470'virtualedit' 've' string (default "")
8471 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008472 {not available when compiled without the
8473 |+virtualedit| feature}
8474 A comma separated list of these words:
8475 block Allow virtual editing in Visual block mode.
8476 insert Allow virtual editing in Insert mode.
8477 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008478 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008479
Bram Moolenaar071d4272004-06-13 20:20:40 +00008480 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008481 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008482 of the line. Useful for selecting a rectangle in Visual mode and
8483 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008484 "onemore" is not the same, it will only allow moving the cursor just
8485 after the last character of the line. This makes some commands more
8486 consistent. Previously the cursor was always past the end of the line
8487 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008488 break some plugins or Vim scripts. For example because |l| can move
8489 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008490 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008491 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008492 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008493 It doesn't make sense to combine "all" with "onemore", but you will
8494 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008495 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496
8497 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8498'visualbell' 'vb' boolean (default off)
8499 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008500 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008501 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008502 use: >
8503 :set vb t_vb=
8504< If you want a short flash, you can use this on many terminals: >
8505 :set vb t_vb=[?5h$<100>[?5l
8506< Here $<100> specifies the time, you can use a smaller or bigger value
8507 to get a shorter or longer flash.
8508
8509 Note: Vim will limit the bell to once per half a second. This avoids
8510 having to wait for the flashing to finish when there are lots of
8511 bells, e.g. on key repeat. This also happens without 'visualbell'
8512 set.
8513
Bram Moolenaar071d4272004-06-13 20:20:40 +00008514 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8515 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8516 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008517
8518 Note: When the GUI starts, 't_vb' is reset to its default value. You
8519 might want to set it again in your |gvimrc|.
8520
Bram Moolenaar071d4272004-06-13 20:20:40 +00008521 Does not work on the Amiga, you always get a screen flash.
8522 Also see 'errorbells'.
8523
8524 *'warn'* *'nowarn'*
8525'warn' boolean (default on)
8526 global
8527 Give a warning message when a shell command is used while the buffer
8528 has been changed.
8529
8530 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8531'weirdinvert' 'wiv' boolean (default off)
8532 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008533 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008534 It is provided for backwards compatibility with version 4.x.
8535 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8536 vice versa. Has no effect when the GUI is running.
8537
8538 *'whichwrap'* *'ww'*
8539'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8540 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008541 Allow specified keys that move the cursor left/right to move to the
8542 previous/next line when the cursor is on the first/last character in
8543 the line. Concatenate characters to allow this for these keys:
8544 char key mode ~
8545 b <BS> Normal and Visual
8546 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008547 h "h" Normal and Visual (not recommended)
8548 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008549 < <Left> Normal and Visual
8550 > <Right> Normal and Visual
8551 ~ "~" Normal
8552 [ <Left> Insert and Replace
8553 ] <Right> Insert and Replace
8554 For example: >
8555 :set ww=<,>,[,]
8556< allows wrap only when cursor keys are used.
8557 When the movement keys are used in combination with a delete or change
8558 operator, the <EOL> also counts for a character. This makes "3h"
8559 different from "3dh" when the cursor crosses the end of a line. This
8560 is also true for "x" and "X", because they do the same as "dl" and
8561 "dh". If you use this, you may also want to use the mapping
8562 ":map <BS> X" to make backspace delete the character in front of the
8563 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008564 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008565 line (not an empty line) then it will not move to the next line. This
8566 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008567 NOTE: This option is set to the Vi default value when 'compatible' is
8568 set and to the Vim default value when 'compatible' is reset.
8569
8570 *'wildchar'* *'wc'*
8571'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8572 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008573 Character you have to type to start wildcard expansion in the
8574 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008575 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008576 The character is not recognized when used inside a macro. See
8577 'wildcharm' for that.
8578 Although 'wc' is a number option, you can set it to a special key: >
8579 :set wc=<Esc>
8580< NOTE: This option is set to the Vi default value when 'compatible' is
8581 set and to the Vim default value when 'compatible' is reset.
8582
8583 *'wildcharm'* *'wcm'*
8584'wildcharm' 'wcm' number (default: none (0))
8585 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008586 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008587 recognized when used inside a macro. You can find "spare" command-line
8588 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589 you'll never actually type 'wildcharm', just use it in mappings that
8590 automatically invoke completion mode, e.g.: >
8591 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008592 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008593< Then after typing :ss you can use CTRL-P & CTRL-N.
8594
8595 *'wildignore'* *'wig'*
8596'wildignore' 'wig' string (default "")
8597 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008598 {not available when compiled without the |+wildignore|
8599 feature}
8600 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008601 patterns is ignored when expanding |wildcards|, completing file or
8602 directory names, and influences the result of |expand()|, |glob()| and
8603 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8605 Also see 'suffixes'.
8606 Example: >
8607 :set wildignore=*.o,*.obj
8608< The use of |:set+=| and |:set-=| is preferred when adding or removing
8609 a pattern from the list. This avoids problems when a future version
8610 uses another default.
8611
Bram Moolenaar94950a92010-12-02 16:01:29 +01008612
Bram Moolenaar81af9252010-12-10 20:35:50 +01008613 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008614'wildignorecase' 'wic' boolean (default off)
8615 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008616 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008617 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008618 Does not apply when the shell is used to expand wildcards, which
8619 happens when there are special characters.
8620
8621
Bram Moolenaar071d4272004-06-13 20:20:40 +00008622 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008623'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 {not available if compiled without the |+wildmenu|
8626 feature}
8627 When 'wildmenu' is on, command-line completion operates in an enhanced
8628 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8629 the possible matches are shown just above the command line, with the
8630 first match highlighted (overwriting the status line, if there is
8631 one). Keys that show the previous/next match, such as <Tab> or
8632 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8633 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8634 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008635 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008636 If there are more matches than can fit in the line, a ">" is shown on
8637 the right and/or a "<" is shown on the left. The status line scrolls
8638 as needed.
8639 The "wildmenu" mode is abandoned when a key is hit that is not used
8640 for selecting a completion.
8641 While the "wildmenu" is active the following keys have special
8642 meanings:
8643
8644 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8645 <Down> - in filename/menu name completion: move into a
8646 subdirectory or submenu.
8647 <CR> - in menu completion, when the cursor is just after a
8648 dot: move into a submenu.
8649 <Up> - in filename/menu name completion: move up into
8650 parent directory or parent menu.
8651
8652 This makes the menus accessible from the console |console-menus|.
8653
8654 If you prefer the <Left> and <Right> keys to move the cursor instead
8655 of selecting a different match, use this: >
8656 :cnoremap <Left> <Space><BS><Left>
8657 :cnoremap <Right> <Space><BS><Right>
8658<
8659 The "WildMenu" highlighting is used for displaying the current match
8660 |hl-WildMenu|.
8661
8662 *'wildmode'* *'wim'*
8663'wildmode' 'wim' string (Vim default: "full")
8664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008665 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008666 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008667 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008668 first part specifies the behavior for the first use of 'wildchar',
8669 The second part for the second use, etc.
8670 These are the possible values for each part:
8671 "" Complete only the first match.
8672 "full" Complete the next full match. After the last match,
8673 the original string is used and then the first match
8674 again.
8675 "longest" Complete till longest common string. If this doesn't
8676 result in a longer string, use the next part.
8677 "longest:full" Like "longest", but also start 'wildmenu' if it is
8678 enabled.
8679 "list" When more than one match, list all matches.
8680 "list:full" When more than one match, list all matches and
8681 complete first match.
8682 "list:longest" When more than one match, list all matches and
8683 complete till longest common string.
8684 When there is only a single match, it is fully completed in all cases.
8685
8686 Examples: >
8687 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008688< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008689 :set wildmode=longest,full
8690< Complete longest common string, then each full match >
8691 :set wildmode=list:full
8692< List all matches and complete each full match >
8693 :set wildmode=list,full
8694< List all matches without completing, then each full match >
8695 :set wildmode=longest,list
8696< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008697 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008698
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008699 *'wildoptions'* *'wop'*
8700'wildoptions' 'wop' string (default "")
8701 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008702 {not available when compiled without the |+wildignore|
8703 feature}
8704 A list of words that change how command line completion is done.
8705 Currently only one word is allowed:
8706 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008707 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008708 is displayed per line. Often used tag kinds are:
8709 d #define
8710 f function
8711 Also see |cmdline-completion|.
8712
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713 *'winaltkeys'* *'wak'*
8714'winaltkeys' 'wak' string (default "menu")
8715 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008716 {only used in Win32, Motif, GTK and Photon GUI}
8717 Some GUI versions allow the access to menu entries by using the ALT
8718 key in combination with a character that appears underlined in the
8719 menu. This conflicts with the use of the ALT key for mappings and
8720 entering special characters. This option tells what to do:
8721 no Don't use ALT keys for menus. ALT key combinations can be
8722 mapped, but there is no automatic handling. This can then be
8723 done with the |:simalt| command.
8724 yes ALT key handling is done by the windowing system. ALT key
8725 combinations cannot be mapped.
8726 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008727 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 keys can be mapped.
8729 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8730 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008731 This option is not used for <F10>; on Win32 and with GTK <F10> will
8732 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008734 *'wincolor'* *'wcr'*
8735'wincolor' 'wcr' string (default empty)
8736 local to window
8737 Highlight group name to use for this window instead of the Normal
8738 color |hl-Normal|.
8739
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008740 *'window'* *'wi'*
8741'window' 'wi' number (default screen height - 1)
8742 global
8743 Window height. Do not confuse this with the height of the Vim window,
8744 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008745 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8746 value is smaller than 'lines' minus one. The screen will scroll
8747 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008748 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8749 in a much smarter way, taking care of wrapping lines.
8750 When resizing the Vim window, the value is smaller than 1 or more than
8751 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008752
Bram Moolenaar071d4272004-06-13 20:20:40 +00008753 *'winheight'* *'wh'* *E591*
8754'winheight' 'wh' number (default 1)
8755 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008756 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008757 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008758 focus goes to a window that is smaller, its size is increased, at the
8759 cost of the height of other windows.
8760 Set 'winheight' to a small number for normal editing.
8761 Set it to 999 to make the current window fill most of the screen.
8762 Other windows will be only 'winminheight' high. This has the drawback
8763 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8764 to create only two windows, set the option after startup is done,
8765 using the |VimEnter| event: >
8766 au VimEnter * set winheight=999
8767< Minimum value is 1.
8768 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008769 height of the current window.
8770 'winheight' applies to the current window. Use 'winminheight' to set
8771 the minimal height for other windows.
8772
8773 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8774'winfixheight' 'wfh' boolean (default off)
8775 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008776 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008777 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8778 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779 The height may be changed anyway when running out of room.
8780
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008781 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8782'winfixwidth' 'wfw' boolean (default off)
8783 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008784 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008785 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008786 The width may be changed anyway when running out of room.
8787
Bram Moolenaar071d4272004-06-13 20:20:40 +00008788 *'winminheight'* *'wmh'*
8789'winminheight' 'wmh' number (default 1)
8790 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008791 The minimal height of a window, when it's not the current window.
8792 This is a hard minimum, windows will never become smaller.
8793 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8794 status bar) if necessary. They will return to at least one line when
8795 they become active (since the cursor has to have somewhere to go.)
8796 Use 'winheight' to set the minimal height of the current window.
8797 This option is only checked when making a window smaller. Don't use a
8798 large number, it will cause errors when opening more than a few
8799 windows. A value of 0 to 3 is reasonable.
8800
8801 *'winminwidth'* *'wmw'*
8802'winminwidth' 'wmw' number (default 1)
8803 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008804 The minimal width of a window, when it's not the current window.
8805 This is a hard minimum, windows will never become smaller.
8806 When set to zero, windows may be "squashed" to zero columns (i.e. just
8807 a vertical separator) if necessary. They will return to at least one
8808 line when they become active (since the cursor has to have somewhere
8809 to go.)
8810 Use 'winwidth' to set the minimal width of the current window.
8811 This option is only checked when making a window smaller. Don't use a
8812 large number, it will cause errors when opening more than a few
8813 windows. A value of 0 to 12 is reasonable.
8814
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008815 *'winptydll'*
8816'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8817 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008818 {only available when compiled with the |terminal|
8819 feature on MS-Windows}
8820 Specifies the name of the winpty shared library, used for the
8821 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008822 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008823 a fallback.
8824 Environment variables are expanded |:set_env|.
8825 This option cannot be set from a |modeline| or in the |sandbox|, for
8826 security reasons.
8827
Bram Moolenaar071d4272004-06-13 20:20:40 +00008828 *'winwidth'* *'wiw'* *E592*
8829'winwidth' 'wiw' number (default 20)
8830 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008831 Minimal number of columns for the current window. This is not a hard
8832 minimum, Vim will use fewer columns if there is not enough room. If
8833 the current window is smaller, its size is increased, at the cost of
8834 the width of other windows. Set it to 999 to make the current window
8835 always fill the screen. Set it to a small number for normal editing.
8836 The width is not adjusted after one of the commands to change the
8837 width of the current window.
8838 'winwidth' applies to the current window. Use 'winminwidth' to set
8839 the minimal width for other windows.
8840
8841 *'wrap'* *'nowrap'*
8842'wrap' boolean (default on)
8843 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008844 This option changes how text is displayed. It doesn't change the text
8845 in the buffer, see 'textwidth' for that.
8846 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008847 displaying continues on the next line. When off lines will not wrap
8848 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008849 moved to a part that is not shown, the screen will scroll
8850 horizontally.
8851 The line will be broken in the middle of a word if necessary. See
8852 'linebreak' to get the break at a word boundary.
8853 To make scrolling horizontally a bit more useful, try this: >
8854 :set sidescroll=5
8855 :set listchars+=precedes:<,extends:>
8856< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008857 This option can't be set from a |modeline| when the 'diff' option is
8858 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008859
8860 *'wrapmargin'* *'wm'*
8861'wrapmargin' 'wm' number (default 0)
8862 local to buffer
8863 Number of characters from the right window border where wrapping
8864 starts. When typing text beyond this limit, an <EOL> will be inserted
8865 and inserting continues on the next line.
8866 Options that add a margin, such as 'number' and 'foldcolumn', cause
8867 the text width to be further reduced. This is Vi compatible.
8868 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008869 This option is set to 0 when 'paste' is set and restored when 'paste'
8870 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008871 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008872
8873 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8874'wrapscan' 'ws' boolean (default on) *E384* *E385*
8875 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008876 Searches wrap around the end of the file. Also applies to |]s| and
8877 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008878
8879 *'write'* *'nowrite'*
8880'write' boolean (default on)
8881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008882 Allows writing files. When not set, writing a file is not allowed.
8883 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008884 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008885 argument. Filtering text is still possible, even though this requires
8886 writing a temporary file.
8887
8888 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8889'writeany' 'wa' boolean (default off)
8890 global
8891 Allows writing to any file with no need for "!" override.
8892
8893 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8894'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8895 otherwise)
8896 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008897 Make a backup before overwriting a file. The backup is removed after
8898 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008899 also on.
8900 WARNING: Switching this option off means that when Vim fails to write
8901 your buffer correctly and then, for whatever reason, Vim exits, you
8902 lose both the original file and what you were writing. Only reset
8903 this option if your file system is almost full and it makes the write
8904 fail (and make sure not to exit Vim until the write was successful).
8905 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008906 When the 'backupskip' pattern matches, a backup is not made anyway.
8907 NOTE: This option is set to the default value when 'compatible' is
8908 set.
8909
8910 *'writedelay'* *'wd'*
8911'writedelay' 'wd' number (default 0)
8912 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008913 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008914 screen. When non-zero, characters are sent to the terminal one by
8915 one. For MS-DOS pcterm this does not work. For debugging purposes.
8916
Bram Moolenaar91f84f62018-07-29 15:07:52 +02008917 vim:tw=78:ts=8:noet:ft=help:norl: