blob: e5ad114e20c0902c0695d2e90a25bebd5c197b9d [file] [log] [blame]
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001*options.txt* For Vim version 8.1. Last change: 2019 Aug 21
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020045:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000046
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049 current value of 'compatible'.
50:se[t] {option}&vi Reset option to its Vi default value.
51:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000052
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010053:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020054 these options are not changed:
55 all terminal options, starting with t_
56 'columns'
57 'cryptmethod'
58 'encoding'
59 'key'
60 'lines'
61 'term'
62 'ttymouse'
63 'ttytype'
64 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000065
66 *:set-args* *E487* *E521*
67:se[t] {option}={value} or
68:se[t] {option}:{value}
69 Set string or number option to {value}.
70 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010071 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000072 The old value can be inserted by typing 'wildchar' (by
73 default this is a <Tab> or CTRL-E if 'compatible' is
74 set). See |cmdline-completion|.
75 White space between {option} and '=' is allowed and
76 will be ignored. White space between '=' and {value}
77 is not allowed.
78 See |option-backslash| for using white space and
79 backslashes in {value}.
80
81:se[t] {option}+={value} *:set+=*
82 Add the {value} to a number option, or append the
83 {value} to a string option. When the option is a
84 comma separated list, a comma is added, unless the
85 value was empty.
86 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000087 are removed. When adding a flag that was already
88 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000089 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000090
91:se[t] {option}^={value} *:set^=*
92 Multiply the {value} to a number option, or prepend
93 the {value} to a string option. When the option is a
94 comma separated list, a comma is added, unless the
95 value was empty.
96 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000097
98:se[t] {option}-={value} *:set-=*
99 Subtract the {value} from a number option, or remove
100 the {value} from a string option, if it is there.
101 If the {value} is not found in a string option, there
102 is no error or warning. When the option is a comma
103 separated list, a comma is deleted, unless the option
104 becomes empty.
105 When the option is a list of flags, {value} must be
106 exactly as they appear in the option. Remove flags
107 one by one to avoid problems.
108 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109
110The {option} arguments to ":set" may be repeated. For example: >
111 :set ai nosi sw=3 ts=3
112If you make an error in one of the arguments, an error message will be given
113and the following arguments will be ignored.
114
115 *:set-verbose*
116When 'verbose' is non-zero, displaying an option value will also tell where it
117was last set. Example: >
118 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200119< shiftwidth=4 ~
120 Last set from modeline line 1 ~
121 cindent ~
122 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123This is only done when specific option values are requested, not for ":verbose
124set all" or ":verbose set" without an argument.
125When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000126When the option was set while executing a function, user command or
127autocommand, the script in which it was defined is reported.
128Note that an option may also have been set as a side effect of setting
129'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000130A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200131 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000132 Option was set in a |modeline|.
133 Last set from --cmd argument ~
134 Option was set with command line argument |--cmd| or +.
135 Last set from -c argument ~
136 Option was set with command line argument |-c|, +, |-S| or
137 |-q|.
138 Last set from environment variable ~
139 Option was set from an environment variable, $VIMINIT,
140 $GVIMINIT or $EXINIT.
141 Last set from error handler ~
142 Option was cleared when evaluating it resulted in an error.
143
Bram Moolenaardb84e452010-08-15 13:50:43 +0200144{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145
146 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000147For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148override the value from the termcap. You can then use it in a mapping. If
149the "xx" part contains special characters, use the <t_xx> form: >
150 :set <t_#4>=^[Ot
151This can also be used to translate a special code for a normal key. For
152example, if Alt-b produces <Esc>b, use this: >
153 :set <M-b>=^[b
154(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
155The advantage over a mapping is that it works in all situations.
156
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100157You can define any key codes, e.g.: >
158 :set t_xy=^[foo;
159There is no warning for using a name that isn't recognized. You can map these
160codes as you like: >
161 :map <t_xy> something
162< *E846*
163When a key code is not set, it's like it does not exist. Trying to get its
164value will result in an error: >
165 :set t_kb=
166 :set t_kb
167 E846: Key code not set: t_kb
168
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000169The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
170security reasons.
171
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000173at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174"set all" probably does not fit on the screen, causing Vim to give the
175|more-prompt|.
176
177 *option-backslash*
178To include white space in a string option value it has to be preceded with a
179backslash. To include a backslash you have to use two. Effectively this
180means that the number of backslashes in an option value is halved (rounded
181down).
182A few examples: >
183 :set tags=tags\ /usr/tags results in "tags /usr/tags"
184 :set tags=tags\\,file results in "tags\,file"
185 :set tags=tags\\\ file results in "tags\ file"
186
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000187The "|" character separates a ":set" command from a following command. To
188include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000189'titlestring' option to "hi|there": >
190 :set titlestring=hi\|there
191This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
192 :set titlestring=hi|set iconstring=there
193
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000194Similarly, the double quote character starts a comment. To include the '"' in
195the option value, use '\"' instead. This example sets the 'titlestring'
196option to 'hi "there"': >
197 :set titlestring=hi\ \"there\"
198
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000199For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000200precise: For options that expect a file name (those where environment
201variables are expanded) a backslash before a normal file name character is not
202removed. But a backslash before a special character (space, backslash, comma,
203etc.) is used like explained above.
204There is one special situation, when the value starts with "\\": >
205 :set dir=\\machine\path results in "\\machine\path"
206 :set dir=\\\\machine\\path results in "\\machine\path"
207 :set dir=\\path\\file results in "\\path\file" (wrong!)
208For the first one the start is kept, but for the second one the backslashes
209are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000210halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211result which is probably not what you want. Avoid it.
212
213 *add-option-flags* *remove-option-flags*
214 *E539* *E550* *E551* *E552*
215Some options are a list of flags. When you want to add a flag to such an
216option, without changing the existing ones, you can do it like this: >
217 :set guioptions+=a
218Remove a flag from an option like this: >
219 :set guioptions-=a
220This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000221Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000222the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
223doesn't appear.
224
225 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000226Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227environment variable exists the '$' and the following environment variable
228name is replaced with its value. If it does not exist the '$' and the name
229are not modified. Any non-id character (not a letter, digit or '_') may
230follow the environment variable name. That character and what follows is
231appended to the value of the environment variable. Examples: >
232 :set term=$TERM.new
233 :set path=/usr/$INCLUDE,$HOME/include,.
234When adding or removing a string from an option with ":set opt-=val" or ":set
235opt+=val" the expansion is done before the adding or removing.
236
237
238Handling of local options *local-options*
239
240Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100241has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242allows you to set 'list' in one window but not in another. And set
243'shiftwidth' to 3 in one buffer and 4 in another.
244
245The following explains what happens to these local options in specific
246situations. You don't really need to know all of this, since Vim mostly uses
247the option values you would expect. Unfortunately, doing what the user
248expects is a bit complicated...
249
250When splitting a window, the local options are copied to the new window. Thus
251right after the split the contents of the two windows look the same.
252
253When editing a new buffer, its local option values must be initialized. Since
254the local options of the current buffer might be specifically for that buffer,
255these are not used. Instead, for each buffer-local option there also is a
256global value, which is used for new buffers. With ":set" both the local and
257global value is changed. With "setlocal" only the local value is changed,
258thus this value is not used when editing a new buffer.
259
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200260When editing a buffer that has been edited before, the options from the window
261that was last closed are used again. If this buffer has been edited in this
262window, the values from back then are used. Otherwise the values from the
263last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264
265It's possible to set a local window option specifically for a type of buffer.
266When you edit another buffer in the same window, you don't want to keep
267using these local window options. Therefore Vim keeps a global value of the
268local window options, which is used when editing another buffer. Each window
269has its own copy of these values. Thus these are local to the window, but
270global to all buffers in the window. With this you can do: >
271 :e one
272 :set list
273 :e two
274Now the 'list' option will also be set in "two", since with the ":set list"
275command you have also set the global value. >
276 :set nolist
277 :e one
278 :setlocal list
279 :e two
280Now the 'list' option is not set, because ":set nolist" resets the global
281value, ":setlocal list" only changes the local value and ":e two" gets the
282global value. Note that if you do this next: >
283 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200284You will get back the 'list' value as it was the last time you edited "one".
285The options local to a window are remembered for each buffer. This also
286happens when the buffer is not loaded, but they are lost when the buffer is
287wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000288
289 *:setl* *:setlocal*
290:setl[ocal] ... Like ":set" but set only the value local to the
291 current buffer or window. Not all options have a
292 local value. If the option does not have a local
293 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200294 With the "all" argument: display local values for all
295 local options.
296 Without argument: Display local values for all local
297 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000298 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000299 local value. For a global/local boolean option, when
300 the global value is being used, "--" is displayed
301 before the option name.
302 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000305:setl[ocal] {option}< Set the local value of {option} to its global value by
306 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000307
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100308:se[t] {option}< For |global-local| options: Remove the local value of
309 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310
311 *:setg* *:setglobal*
312:setg[lobal] ... Like ":set" but set only the global value for a local
313 option without changing the local value.
314 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200315 With the "all" argument: display global values for all
316 local options.
317 Without argument: display global values for all local
318 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319
320For buffer-local and window-local options:
321 Command global value local value ~
322 :set option=value set set
323 :setlocal option=value - set
324:setglobal option=value set -
325 :set option? - display
326 :setlocal option? - display
327:setglobal option? display -
328
329
330Global options with a local value *global-local*
331
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000332Options are global when you mostly use one value for all buffers and windows.
333For some global options it's useful to sometimes have a different local value.
334You can set the local value with ":setlocal". That buffer or window will then
335use the local value, while other buffers and windows continue using the global
336value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337
338For example, you have two windows, both on C source code. They use the global
339'makeprg' option. If you do this in one of the two windows: >
340 :set makeprg=gmake
341then the other window will switch to the same value. There is no need to set
342the 'makeprg' option in the other C source window too.
343However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000344another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000345files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346 :setlocal makeprg=perlmake
347You can switch back to using the global value by making the local value empty: >
348 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100349This only works for a string option. For a number or boolean option you need
350to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100352Note that for non-boolean and non-number options using "<" copies the global
353value to the local value, it doesn't switch back to using the global value
354(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000355 :set path<
356This will make the local value of 'path' empty, so that the global value is
357used. Thus it does the same as: >
358 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359Note: In the future more global options can be made global-local. Using
360":setlocal" on a global option might work differently then.
361
362
363Setting the filetype
364
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200365:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366 Set the 'filetype' option to {filetype}, but only if
367 not done yet in a sequence of (nested) autocommands.
368 This is short for: >
369 :if !did_filetype()
370 : setlocal filetype={filetype}
371 :endif
372< This command is used in a filetype.vim file to avoid
373 setting the 'filetype' option twice, causing different
374 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200375
376 When the optional FALLBACK argument is present, a
377 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100378 'filetype'. This is to be used for filetype
379 detections that are just a guess. |did_filetype()|
380 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200381
Bram Moolenaard58e9292011-02-09 17:07:58 +0100382 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
384:opt[ions] Open a window for viewing and setting all options.
385 Options are grouped by function.
386 Offers short help for each option. Hit <CR> on the
387 short help to open a help window with more help for
388 the option.
389 Modify the value of the option and hit <CR> on the
390 "set" line to set the new value. For window and
391 buffer specific options, the last accessed window is
392 used to set the option value in, unless this is a help
393 window, in which case the window below help window is
394 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100395 {not available when compiled without the |+eval|
396 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397
398 *$HOME*
399Using "~" is like using "$HOME", but it is only recognized at the start of an
400option and after a space or comma.
401
402On Unix systems "~user" can be used too. It is replaced by the home directory
403of user "user". Example: >
404 :set path=~mool/include,/usr/include,.
405
406On Unix systems the form "${HOME}" can be used too. The name between {} can
407contain non-id characters then. Note that if you want to use this for the
408"gf" command, you need to add the '{' and '}' characters to 'isfname'.
409
410NOTE: expanding environment variables and "~/" is only done with the ":set"
411command, not when assigning a value to an option with ":let".
412
Bram Moolenaarc572da52017-08-27 16:52:01 +0200413 *$HOME-windows*
414On MS-Windows, if $HOME is not defined as an environment variable, then
415at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200416If $HOMEDRIVE is not set then $USERPROFILE is used.
417
418This expanded value is not exported to the environment, this matters when
419running an external command: >
420 :echo system('set | findstr ^HOME=')
421and >
422 :echo luaeval('os.getenv("HOME")')
423should echo nothing (an empty string) despite exists('$HOME') being true.
424When setting $HOME to a non-empty string it will be exported to the
425subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200426
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427
428Note the maximum length of an expanded option is limited. How much depends on
429the system, mostly it is something like 256 or 1024 characters.
430
431 *:fix* *:fixdel*
432:fix[del] Set the value of 't_kD':
433 't_kb' is 't_kD' becomes ~
434 CTRL-? CTRL-H
435 not CTRL-? CTRL-?
436
Bram Moolenaar6c60f472019-04-28 16:00:35 +0200437 (CTRL-? is 0177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438
439 If your delete key terminal code is wrong, but the
440 code for backspace is alright, you can put this in
441 your .vimrc: >
442 :fixdel
443< This works no matter what the actual code for
444 backspace is.
445
446 If the backspace key terminal code is wrong you can
447 use this: >
448 :if &term == "termname"
449 : set t_kb=^V<BS>
450 : fixdel
451 :endif
452< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000453 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454 with your terminal name.
455
456 If your <Delete> key sends a strange key sequence (not
457 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
458 :if &term == "termname"
459 : set t_kD=^V<Delete>
460 :endif
461< Where "^V" is CTRL-V and "<Delete>" is the delete key
462 (don't type eight characters!). Replace "termname"
463 with your terminal name.
464
465 *Linux-backspace*
466 Note about Linux: By default the backspace key
467 produces CTRL-?, which is wrong. You can fix it by
468 putting this line in your rc.local: >
469 echo "keycode 14 = BackSpace" | loadkeys
470<
471 *NetBSD-backspace*
472 Note about NetBSD: If your backspace doesn't produce
473 the right code, try this: >
474 xmodmap -e "keycode 22 = BackSpace"
475< If this works, add this in your .Xmodmap file: >
476 keysym 22 = BackSpace
477< You need to restart for this to take effect.
478
479==============================================================================
4802. Automatically setting options *auto-setting*
481
482Besides changing options with the ":set" command, there are three alternatives
483to set options automatically for one or more files:
484
4851. When starting Vim initializations are read from various places. See
486 |initialization|. Most of them are performed for all editing sessions,
487 and some of them depend on the directory where Vim is started.
488 You can create an initialization file with |:mkvimrc|, |:mkview| and
489 |:mksession|.
4902. If you start editing a new file, the automatic commands are executed.
491 This can be used to set options for files matching a particular pattern and
492 many other things. See |autocommand|.
4933. If you start editing a new file, and the 'modeline' option is on, a
494 number of lines at the beginning and end of the file are checked for
495 modelines. This is explained here.
496
497 *modeline* *vim:* *vi:* *ex:* *E520*
498There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200499 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200501[text] any text or empty
502{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200504[white] optional white space
505{options} a list of option settings, separated with white space
506 or ':', where each part between ':' is the argument
507 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar14b69452013-06-29 23:05:20 +0200509Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000510 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200511 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000512
513The second form (this is compatible with some versions of Vi):
514
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200515 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000516
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200517[text] any text or empty
518{white} at least one blank character (<Space> or <Tab>)
519{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
520[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200521se[t] the string "set " or "se " (note the space); When
522 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200523{options} a list of options, separated with white space, which
524 is the argument for a ":set" command
525: a colon
526[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527
Bram Moolenaar14b69452013-06-29 23:05:20 +0200528Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000529 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200530 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000531
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200532The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
533chance that a normal word like "lex:" is caught. There is one exception:
534"vi:" and "vim:" can also be at the start of the line (for compatibility with
535version 3.0). Using "ex:" at the start of the line will be ignored (this
536could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538 *modeline-local*
539The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000540buffer and window that contain the file. Although it's possible to set global
541options from a modeline, this is unusual. If you have two windows open and
542the files in it set the same global option to a different value, the result
543depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000545When editing a file that was already loaded, only the window-local options
546from the modeline are used. Thus if you manually changed a buffer-local
547option after opening the file, it won't be changed if you edit the same buffer
548in another window. But window-local options will be set.
549
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550 *modeline-version*
551If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200552number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553 vim{vers}: version {vers} or later
554 vim<{vers}: version before {vers}
555 vim={vers}: version {vers}
556 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100557{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
558For example, to use a modeline only for Vim 7.0:
559 /* vim700: set foldmethod=marker */ ~
560To use a modeline for Vim after version 7.2:
561 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562There can be no blanks between "vim" and the ":".
563
564
565The number of lines that are checked can be set with the 'modelines' option.
566If 'modeline' is off or 'modelines' is 0 no lines are checked.
567
568Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000569like:
570 /* vi:ts=4: */ ~
571will give an error message for the trailing "*/". This line is OK:
572 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573
574If an error is detected the rest of the line is skipped.
575
576If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000577backslash in front of the ':' will be removed. Example:
578 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579This sets the 'dir' option to "c:\tmp". Only a single backslash before the
580':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200581 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000583might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200584can be set. For some options a flag is set, so that when the value is used
585the |sandbox| is effective. Some options can only be set from the modeline
586when 'modelineexpr' is set (the default is off).
587
588Still, there is always a small risk that a modeline causes trouble. E.g.,
589when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
590So disable modelines before editing untrusted text. The mail ftplugin does
591this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592
593Hint: If you would like to do something else than setting an option, you could
594define an autocommand that checks the file for a specific string. For
595example: >
596 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
597And define a function SetVar() that does something with the line containing
598"VAR".
599
600==============================================================================
6013. Options summary *option-summary*
602
603In the list below all the options are mentioned with their full name and with
604an abbreviation if there is one. Both forms may be used.
605
606In this document when a boolean option is "set" that means that ":set option"
607is entered. When an option is "reset", ":set nooption" is used.
608
609For some options there are two default values: The "Vim default", which is
610used when 'compatible' is not set, and the "Vi default", which is used when
611'compatible' is set.
612
613Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000614are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615different value in each window. For example the 'list' option can be set in
616one window and reset in another for the same text, giving both types of view
617at the same time. There are a few options that are specific to a certain
618file. These can have a different value for each file or buffer. For example
619the 'textwidth' option can be 78 for a normal text file and 0 for a C
620program.
621
622 global one option for all buffers and windows
623 local to window each window has its own copy of this option
624 local to buffer each buffer has its own copy of this option
625
626When creating a new window the option values from the currently active window
627are used as a default value for the window-specific options. For the
628buffer-specific options this depends on the 's' and 'S' flags in the
629'cpoptions' option. If 's' is included (which is the default) the values for
630buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000631first entered. If 'S' is present the options are copied each time the buffer
632is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633present, the options are copied from the currently active buffer when the
634buffer is created.
635
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000636Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000637
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000638Not all options are supported in all versions. This depends on the supported
639features and sometimes on the system. A remark about this is in curly braces
640below. When an option is not supported it may still be set without getting an
641error, this is called a hidden option. You can't get the value of a hidden
642option though, it is not stored.
643
644To test if option "foo" can be used with ":set" use something like this: >
645 if exists('&foo')
646This also returns true for a hidden option. To test if option "foo" is really
647supported use something like this: >
648 if exists('+foo')
649<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650 *E355*
651A jump table for the options with a short description can be found at |Q_op|.
652
653 *'aleph'* *'al'* *aleph* *Aleph*
654'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 {only available when compiled with the |+rightleft|
657 feature}
658 The ASCII code for the first letter of the Hebrew alphabet. The
659 routine that maps the keyboard in Hebrew mode, both in Insert mode
660 (when hkmap is set) and on the command-line (when hitting CTRL-_)
661 outputs the Hebrew characters in the range [aleph..aleph+26].
662 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
663 See |rileft.txt|.
664
665 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
666'allowrevins' 'ari' boolean (default off)
667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668 {only available when compiled with the |+rightleft|
669 feature}
670 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
671 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
672 into reverse Insert mode, and don't know how to get out. See
673 'revins'.
674 NOTE: This option is reset when 'compatible' is set.
675
676 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
677'altkeymap' 'akm' boolean (default off)
678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679 {only available when compiled with the |+farsi|
680 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100681 This option was for using Farsi, which has been removed. See
682 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683
684 *'ambiwidth'* *'ambw'*
685'ambiwidth' 'ambw' string (default: "single")
686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
688 Tells Vim what to do with characters with East Asian Width Class
689 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
690 letters, Cyrillic letters).
691
692 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 expected by most users.
695 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200696 *E834* *E835*
697 The value "double" cannot be used if 'listchars' or 'fillchars'
698 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700 There are a number of CJK fonts for which the width of glyphs for
701 those characters are solely based on how many octets they take in
702 legacy/traditional CJK encodings. In those encodings, Euro,
703 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000704 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000706 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 Vim is running inside a terminal (emulators) that uses a CJK font
708 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
709 this option should be set to "double" to match the width perceived
710 by Vim with the width of glyphs in the font. Perhaps it also has
711 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
712 when the system locale is set to one of CJK locales. See Unicode
713 Standard Annex #11 (http://www.unicode.org/reports/tr11).
714
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100715 Vim may set this option automatically at startup time when Vim is
716 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200717 escape sequence to request cursor position report. The response can
718 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100719
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
721'antialias' 'anti' boolean (default: off)
722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 {only available when compiled with GUI enabled
724 on Mac OS X}
725 This option only has an effect in the GUI version of Vim on Mac OS X
726 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
727 which can be easier to read at certain sizes on certain displays.
728 Setting this option can sometimes cause problems if 'guifont' is set
729 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100730 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731
732 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
733'autochdir' 'acd' boolean (default off)
734 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200735 {only available when compiled with it, use
736 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000737 When on, Vim will change the current working directory whenever you
738 open a file, switch buffers, delete a buffer or open/close a window.
739 It will change to the directory containing the file which was opened
740 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000741 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742
743 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
744'arabic' 'arab' boolean (default off)
745 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 {only available when compiled with the |+arabic|
747 feature}
748 This option can be set to start editing Arabic text.
749 Setting this option will:
750 - Set the 'rightleft' option, unless 'termbidi' is set.
751 - Set the 'arabicshape' option, unless 'termbidi' is set.
752 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
753 between typing English and Arabic key mapping.
754 - Set the 'delcombine' option
755 Note that 'encoding' must be "utf-8" for working with Arabic text.
756
757 Resetting this option will:
758 - Reset the 'rightleft' option.
759 - Disable the use of 'keymap' (without changing its value).
760 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200761 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100762 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 Also see |arabic.txt|.
764
765 *'arabicshape'* *'arshape'*
766 *'noarabicshape'* *'noarshape'*
767'arabicshape' 'arshape' boolean (default on)
768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 {only available when compiled with the |+arabic|
770 feature}
771 When on and 'termbidi' is off, the required visual character
772 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200773 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 one which encompasses:
775 a) the changing/morphing of characters based on their location
776 within a word (initial, medial, final and stand-alone).
777 b) the enabling of the ability to compose characters
778 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100779 When disabled the display shows each character's true stand-alone
780 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 Arabic is a complex language which requires other settings, for
782 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100783 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784
785 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
786'autoindent' 'ai' boolean (default off)
787 local to buffer
788 Copy indent from current line when starting a new line (typing <CR>
789 in Insert mode or when using the "o" or "O" command). If you do not
790 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000791 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
792 to another line has the same effect, unless the 'I' flag is included
793 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000794 When autoindent is on, formatting (with the "gq" command or when you
795 reach 'textwidth' in Insert mode) uses the indentation of the first
796 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 When 'smartindent' or 'cindent' is on the indent is changed in
798 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200799 The 'autoindent' option is reset when the 'paste' option is set and
800 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801
802 *'autoread'* *'ar'* *'noautoread'* *'noar'*
803'autoread' 'ar' boolean (default off)
804 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805 When a file has been detected to have been changed outside of Vim and
806 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200807 When the file has been deleted this is not done, so you have the text
808 from before it was deleted. When it appears again then it is read.
809 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 If this option has a local value, use this command to switch back to
811 using the global value: >
812 :set autoread<
813<
814 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
815'autowrite' 'aw' boolean (default off)
816 global
817 Write the contents of the file, if it has been modified, on each
818 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000819 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
821 Note that for some commands the 'autowrite' option is not used, see
822 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200823 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200824 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825
826 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
827'autowriteall' 'awa' boolean (default off)
828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
830 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
831 Setting this option also implies that Vim behaves like 'autowrite' has
832 been set.
833
834 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200835'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 When set to "dark", Vim will try to use colors that look good on a
838 dark background. When set to "light", Vim will try to use colors that
839 look good on a light background. Any other value is illegal.
840 Vim tries to set the default value according to the terminal used.
841 This will not always be correct.
842 Setting this option does not change the background color, it tells Vim
843 what the background color looks like. For changing the background
844 color, see |:hi-normal|.
845
846 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000847 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000848 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100849 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 setting 'background' will cause the color scheme to be reloaded. If
851 the color scheme adjusts to the value of 'background' this will work.
852 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100853 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854
855 When setting 'background' to the default value with: >
856 :set background&
857< Vim will guess the value. In the GUI this should work correctly,
858 in other cases Vim might not be able to guess the right value.
859
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200860 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200861 color from the terminal. If the returned RGB value is dark/light and
862 'background' is not dark/light, 'background' will be set and the
863 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200864 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100865 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200866
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 When starting the GUI, the default value for 'background' will be
868 "light". When the value is not set in the .gvimrc, and Vim detects
869 that the background is actually quite dark, 'background' is set to
870 "dark". But this happens only AFTER the .gvimrc file has been read
871 (because the window needs to be opened to find the actual background
872 color). To get around this, force the GUI window to be opened by
873 putting a ":gui" command in the .gvimrc file, before where the value
874 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200875
876 For MS-DOS, Windows and OS/2 the default is "dark".
877 For other systems "dark" is used when 'term' is "linux",
878 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
879 background. Otherwise the default is "light".
880
Bram Moolenaarc572da52017-08-27 16:52:01 +0200881 The |:terminal| command and the |term_start()| function use the
882 'background' value to decide whether the terminal window will start
883 with a white or black background.
884
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 Normally this option would be set in the .vimrc file. Possibly
886 depending on the terminal name. Example: >
887 :if &term == "pcterm"
888 : set background=dark
889 :endif
890< When this option is set, the default settings for the highlight groups
891 will change. To use other settings, place ":highlight" commands AFTER
892 the setting of the 'background' option.
893 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
894 to select the colors for syntax highlighting. After changing this
895 option, you must load syntax.vim again to see the result. This can be
896 done with ":syntax on".
897
898 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200899'backspace' 'bs' string (default "", set to "indent,eol,start"
900 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
903 mode. This is a list of items, separated by commas. Each item allows
904 a way to backspace over something:
905 value effect ~
906 indent allow backspacing over autoindent
907 eol allow backspacing over line breaks (join lines)
908 start allow backspacing over the start of insert; CTRL-W and CTRL-U
909 stop once at the start of insert.
910
911 When the value is empty, Vi compatible backspacing is used.
912
913 For backwards compatibility with version 5.4 and earlier:
914 value effect ~
915 0 same as ":set backspace=" (Vi compatible)
916 1 same as ":set backspace=indent,eol"
917 2 same as ":set backspace=indent,eol,start"
918
919 See |:fixdel| if your <BS> or <Del> key does not do what you want.
920 NOTE: This option is set to "" when 'compatible' is set.
921
922 *'backup'* *'bk'* *'nobackup'* *'nobk'*
923'backup' 'bk' boolean (default off)
924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 Make a backup before overwriting a file. Leave it around after the
926 file has been successfully written. If you do not want to keep the
927 backup file, but you do want a backup while the file is being
928 written, reset this option and set the 'writebackup' option (this is
929 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000930 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931 |backup-table| for more explanations.
932 When the 'backupskip' pattern matches, a backup is not made anyway.
933 When 'patchmode' is set, the backup may be renamed to become the
934 oldest version of a file.
935 NOTE: This option is reset when 'compatible' is set.
936
937 *'backupcopy'* *'bkc'*
938'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200939 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940 When writing a file and a backup is made, this option tells how it's
941 done. This is a comma separated list of words.
942
943 The main values are:
944 "yes" make a copy of the file and overwrite the original one
945 "no" rename the file and write a new one
946 "auto" one of the previous, what works best
947
948 Extra values that can be combined with the ones above are:
949 "breaksymlink" always break symlinks when writing
950 "breakhardlink" always break hardlinks when writing
951
952 Making a copy and overwriting the original file:
953 - Takes extra time to copy the file.
954 + When the file has special attributes, is a (hard/symbolic) link or
955 has a resource fork, all this is preserved.
956 - When the file is a link the backup will have the name of the link,
957 not of the real file.
958
959 Renaming the file and writing a new one:
960 + It's fast.
961 - Sometimes not all attributes of the file can be copied to the new
962 file.
963 - When the file is a link the new file will not be a link.
964
965 The "auto" value is the middle way: When Vim sees that renaming file
966 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000967 the file is not a link) that is used. When problems are expected, a
968 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969
970 The "breaksymlink" and "breakhardlink" values can be used in
971 combination with any of "yes", "no" and "auto". When included, they
972 force Vim to always break either symbolic or hard links by doing
973 exactly what the "no" option does, renaming the original file to
974 become the backup and writing a new file in its place. This can be
975 useful for example in source trees where all the files are symbolic or
976 hard links and any changes should stay in the local source tree, not
977 be propagated back to the original source.
978 *crontab*
979 One situation where "no" and "auto" will cause problems: A program
980 that opens a file, invokes Vim to edit that file, and then tests if
981 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000982 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983 example.
984
985 When a copy is made, the original file is truncated and then filled
986 with the new text. This means that protection bits, owner and
987 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000988 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 group of the backup is set to the group of the original file. If this
990 fails, the protection bits for the group are made the same as for
991 others.
992
993 When the file is renamed this is the other way around: The backup has
994 the same attributes of the original file, and the newly written file
995 is owned by the current user. When the file was a (hard/symbolic)
996 link, the new file will not! That's why the "auto" value doesn't
997 rename when the file is a link. The owner and group of the newly
998 written file will be set to the same ones as the original file, but
999 the system may refuse to do this. In that case the "auto" value will
1000 again not rename the file.
1001
Bram Moolenaar036986f2017-03-16 17:41:02 +01001002 NOTE: This option is set to the Vi default value when 'compatible' is
1003 set and to the Vim default value when 'compatible' is reset.
1004
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 *'backupdir'* *'bdir'*
1006'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001007 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 for Unix: ".,~/tmp,~/")
1009 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 List of directories for the backup file, separated with commas.
1011 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001012 where this is possible. The directory must exist, Vim will not
1013 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001014 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015 impossible!). Writing may fail because of this.
1016 - A directory "." means to put the backup file in the same directory
1017 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001018 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019 put the backup file relative to where the edited file is. The
1020 leading "." is replaced with the path name of the edited file.
1021 ("." inside a directory name has no special meaning).
1022 - Spaces after the comma are ignored, other spaces are considered part
1023 of the directory name. To have a space at the start of a directory
1024 name, precede it with a backslash.
1025 - To include a comma in a directory name precede it with a backslash.
1026 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001027 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001028 the backup file name will be built from the complete path to the
1029 file with all path separators changed to percent '%' signs. This
1030 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001031 On Win32, it is also possible to end with "\\". However, When a
1032 separating comma is following, you must use "//", since "\\" will
1033 include the comma in the file name. Therefore it is recommended to
1034 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035 - Environment variables are expanded |:set_env|.
1036 - Careful with '\' characters, type one before a space, type two to
1037 get one in the option (see |option-backslash|), for example: >
1038 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1039< - For backwards compatibility with Vim version 3.0 a '>' at the start
1040 of the option is removed.
1041 See also 'backup' and 'writebackup' options.
1042 If you want to hide your backup files on Unix, consider this value: >
1043 :set backupdir=./.backup,~/.backup,.,/tmp
1044< You must create a ".backup" directory in each directory and in your
1045 home directory for this to work properly.
1046 The use of |:set+=| and |:set-=| is preferred when adding or removing
1047 directories from the list. This avoids problems when a future version
1048 uses another default.
1049 This option cannot be set from a |modeline| or in the |sandbox|, for
1050 security reasons.
1051
1052 *'backupext'* *'bex'* *E589*
1053'backupext' 'bex' string (default "~", for VMS: "_")
1054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001055 String which is appended to a file name to make the name of the
1056 backup file. The default is quite unusual, because this avoids
1057 accidentally overwriting existing files with a backup file. You might
1058 prefer using ".bak", but make sure that you don't have files with
1059 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001060 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001062 If you like to keep a lot of backups, you could use a BufWritePre
1063 autocommand to change 'backupext' just before writing the file to
1064 include a timestamp. >
1065 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1066< Use 'backupdir' to put the backup in a different directory.
1067
Bram Moolenaar071d4272004-06-13 20:20:40 +00001068 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001069'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1070 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1071 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 {not available when compiled without the |+wildignore|
1074 feature}
1075 A list of file patterns. When one of the patterns matches with the
1076 name of the file which is written, no backup file is created. Both
1077 the specified file name and the full path name of the file are used.
1078 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1079 Watch out for special characters, see |option-backslash|.
1080 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001081 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001082
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001083 WARNING: Not having a backup file means that when Vim fails to write
1084 your buffer correctly and then, for whatever reason, Vim exits, you
1085 lose both the original file and what you were writing. Only disable
1086 backups if you don't care about losing the file.
1087
Bram Moolenaar02467872007-05-06 13:22:01 +00001088 Note that environment variables are not expanded. If you want to use
1089 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001090 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001091
1092< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001093 backup would be made by renaming the original file crontab won't see
1094 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
1096 *'balloondelay'* *'bdlay'*
1097'balloondelay' 'bdlay' number (default: 600)
1098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 {only available when compiled with the |+balloon_eval|
1100 feature}
1101 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1102
1103 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1104'ballooneval' 'beval' boolean (default off)
1105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001107 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001108 Switch on the |balloon-eval| functionality for the GUI.
1109
1110 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1111 *'nobevalterm'*
1112'balloonevalterm' 'bevalterm' boolean (default off)
1113 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001114 {only available when compiled with the
1115 |+balloon_eval_term| feature}
1116 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001118 *'balloonexpr'* *'bexpr'*
1119'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001120 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001121 {only available when compiled with the |+balloon_eval|
1122 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001123 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001124 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1125 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001126
1127 v:beval_bufnr number of the buffer in which balloon is going to show
1128 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001129 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001130 v:beval_lnum line number
1131 v:beval_col column number (byte index)
1132 v:beval_text word under or after the mouse pointer
1133
Bram Moolenaar54775062019-07-31 21:07:14 +02001134 Instead of showing a balloon, which is limited to plain text, consider
1135 using a popup window, see |popup_beval_example|. A popup window can
1136 use highlighting and show a border.
1137
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001138 The evaluation of the expression must not have side effects!
1139 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001140 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001141 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001142 \', column ' . v:beval_col .
1143 \ ' of file ' . bufname(v:beval_bufnr) .
1144 \ ' on word "' . v:beval_text . '"'
1145 endfunction
1146 set bexpr=MyBalloonExpr()
1147 set ballooneval
1148<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001149 Also see |balloon_show()|, it can be used if the content of the balloon
1150 is to be fetched asynchronously. In that case evaluating
1151 'balloonexpr' should result in an empty string. If you get a balloon
1152 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001153
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001154 NOTE: The balloon is displayed only if the cursor is on a text
1155 character. If the result of evaluating 'balloonexpr' is not empty,
1156 Vim does not try to send a message to an external debugger (Netbeans
1157 or Sun Workshop).
1158
Bram Moolenaar30b65812012-07-12 22:01:11 +02001159 The expression will be evaluated in the |sandbox| when set from a
1160 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001161 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001162
1163 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001164 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001165
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001166 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001167 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001168< When they are supported "\n" characters will start a new line. If the
1169 expression evaluates to a |List| this is equal to using each List item
1170 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001171 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001172
Bram Moolenaar165bc692015-07-21 17:53:25 +02001173 *'belloff'* *'bo'*
1174'belloff' 'bo' string (default "")
1175 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001176 Specifies for which events the bell will not be rung. It is a comma
1177 separated list of items. For each item that is present, the bell
1178 will be silenced. This is most useful to specify specific events in
1179 insert mode to be silenced.
1180
1181 item meaning when present ~
1182 all All events.
1183 backspace When hitting <BS> or <Del> and deleting results in an
1184 error.
1185 cursor Fail to move around using the cursor keys or
1186 <PageUp>/<PageDown> in |Insert-mode|.
1187 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1188 |i_CTRL-X_CTRL-T|.
1189 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1190 |i_CTRL-E|.
1191 ctrlg Unknown Char after <C-G> in Insert mode.
1192 error Other Error occurred (e.g. try to join last line)
1193 (mostly used in |Normal-mode| or |Cmdline-mode|).
1194 esc hitting <Esc> in |Normal-mode|.
1195 ex In |Visual-mode|, hitting |Q| results in an error.
1196 hangul Error occurred when using hangul input.
1197 insertmode Pressing <Esc> in 'insertmode'.
1198 lang Calling the beep module for Lua/Mzscheme/TCL.
1199 mess No output available for |g<|.
1200 showmatch Error occurred for 'showmatch' function.
1201 operator Empty region error |cpo-E|.
1202 register Unknown register after <C-R> in |Insert-mode|.
1203 shell Bell from shell output |:!|.
1204 spell Error happened on spell suggest.
1205 wildmode More matches in |cmdline-completion| available
1206 (depends on the 'wildmode' setting).
1207
Bram Moolenaar036986f2017-03-16 17:41:02 +01001208 This is most useful to fine tune when in Insert mode the bell should
1209 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001210 indicate that an error occurred. It can be silenced by adding the
1211 "error" keyword.
1212
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1214'binary' 'bin' boolean (default off)
1215 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216 This option should be set before editing a binary file. You can also
1217 use the |-b| Vim argument. When this option is switched on a few
1218 options will be changed (also when it already was on):
1219 'textwidth' will be set to 0
1220 'wrapmargin' will be set to 0
1221 'modeline' will be off
1222 'expandtab' will be off
1223 Also, 'fileformat' and 'fileformats' options will not be used, the
1224 file is read and written like 'fileformat' was "unix" (a single <NL>
1225 separates lines).
1226 The 'fileencoding' and 'fileencodings' options will not be used, the
1227 file is read without conversion.
1228 NOTE: When you start editing a(nother) file while the 'bin' option is
1229 on, settings from autocommands may change the settings again (e.g.,
1230 'textwidth'), causing trouble when editing. You might want to set
1231 'bin' again when the file has been loaded.
1232 The previous values of these options are remembered and restored when
1233 'bin' is switched from on to off. Each buffer has its own set of
1234 saved option values.
1235 To edit a file with 'binary' set you can use the |++bin| argument.
1236 This avoids you have to do ":set bin", which would have effect for all
1237 files you edit.
1238 When writing a file the <EOL> for the last line is only written if
1239 there was one in the original file (normally Vim appends an <EOL> to
1240 the last line if there is none; this would make the file longer). See
1241 the 'endofline' option.
1242
1243 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1244'bioskey' 'biosk' boolean (default on)
1245 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001246 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001247 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248
1249 *'bomb'* *'nobomb'*
1250'bomb' boolean (default off)
1251 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252 When writing a file and the following conditions are met, a BOM (Byte
1253 Order Mark) is prepended to the file:
1254 - this option is on
1255 - the 'binary' option is off
1256 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1257 endian variants.
1258 Some applications use the BOM to recognize the encoding of the file.
1259 Often used for UCS-2 files on MS-Windows. For other applications it
1260 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001261 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1263 check for the presence of the BOM is done and 'bomb' set accordingly.
1264 Unless 'binary' is set, it is removed from the first line, so that you
1265 don't see it when editing. When you don't change the options, the BOM
1266 will be restored when writing the file.
1267
1268 *'breakat'* *'brk'*
1269'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1270 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001271 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272 feature}
1273 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001274 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1275 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001276
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001277 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001278'breakindent' 'bri' boolean (default off)
1279 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001280 {not available when compiled without the |+linebreak|
1281 feature}
1282 Every wrapped line will continue visually indented (same amount of
1283 space as the beginning of that line), thus preserving horizontal blocks
1284 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001285 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001286
1287 *'breakindentopt'* *'briopt'*
1288'breakindentopt' 'briopt' string (default empty)
1289 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001290 {not available when compiled without the |+linebreak|
1291 feature}
1292 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001293 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001294 min:{n} Minimum text width that will be kept after
1295 applying 'breakindent', even if the resulting
1296 text should normally be narrower. This prevents
1297 text indented almost to the right window border
1298 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001299 shift:{n} After applying 'breakindent', the wrapped line's
1300 beginning will be shifted by the given number of
1301 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001302 indentation (negative) or emphasizing the line
1303 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001304 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001305 additional indent.
1306 The default value for min is 20 and shift is 0.
1307
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001309'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001310 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001311 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001313 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001314 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315 buffer Use the directory of the related buffer.
1316 current Use the current directory.
1317 {path} Use the specified directory
1318
1319 *'bufhidden'* *'bh'*
1320'bufhidden' 'bh' string (default: "")
1321 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322 This option specifies what happens when a buffer is no longer
1323 displayed in a window:
1324 <empty> follow the global 'hidden' option
1325 hide hide the buffer (don't unload it), also when 'hidden'
1326 is not set
1327 unload unload the buffer, also when 'hidden' is set or using
1328 |:hide|
1329 delete delete the buffer from the buffer list, also when
1330 'hidden' is set or using |:hide|, like using
1331 |:bdelete|
1332 wipe wipe out the buffer from the buffer list, also when
1333 'hidden' is set or using |:hide|, like using
1334 |:bwipeout|
1335
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001336 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001337 are lost without a warning. Also, these values may break autocommands
1338 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 This option is used together with 'buftype' and 'swapfile' to specify
1340 special kinds of buffers. See |special-buffers|.
1341
1342 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1343'buflisted' 'bl' boolean (default: on)
1344 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345 When this option is set, the buffer shows up in the buffer list. If
1346 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1347 This option is reset by Vim for buffers that are only used to remember
1348 a file name or marks. Vim sets it when starting to edit a buffer.
1349 But not when moving to a buffer with ":buffer".
1350
1351 *'buftype'* *'bt'* *E382*
1352'buftype' 'bt' string (default: "")
1353 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 The value of this option specifies the type of a buffer:
1355 <empty> normal buffer
1356 nofile buffer which is not related to a file and will not be
1357 written
1358 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001359 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001360 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001361 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001362 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001363 help help buffer (you are not supposed to set this
1364 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001365 terminal buffer for a |terminal| (you are not supposed to set
1366 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001367 prompt buffer where only the last line can be edited, meant
1368 to be used by a plugin, see |prompt-buffer|
1369 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001370 popup buffer used in a popup window, see |popup|.
1371 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001372
1373 This option is used together with 'bufhidden' and 'swapfile' to
1374 specify special kinds of buffers. See |special-buffers|.
1375
1376 Be careful with changing this option, it can have many side effects!
1377
Bram Moolenaar280f1262006-01-30 00:14:18 +00001378 A "quickfix" buffer is only used for the error list and the location
1379 list. This value is set by the |:cwindow| and |:lwindow| commands and
1380 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381
1382 "nofile" and "nowrite" buffers are similar:
1383 both: The buffer is not to be written to disk, ":w" doesn't
1384 work (":w filename" does work though).
1385 both: The buffer is never considered to be |'modified'|.
1386 There is no warning when the changes will be lost, for
1387 example when you quit Vim.
1388 both: A swap file is only created when using too much memory
1389 (when 'swapfile' has been reset there is never a swap
1390 file).
1391 nofile only: The buffer name is fixed, it is not handled like a
1392 file name. It is not modified in response to a |:cd|
1393 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001394 both: When using ":e bufname" and already editing "bufname"
1395 the buffer is made empty and autocommands are
1396 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001397 *E676*
1398 "acwrite" implies that the buffer name is not related to a file, like
1399 "nofile", but it will be written. Thus, in contrast to "nofile" and
1400 "nowrite", ":w" does work and a modified buffer can't be abandoned
1401 without saving. For writing there must be matching |BufWriteCmd|,
1402 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403
1404 *'casemap'* *'cmp'*
1405'casemap' 'cmp' string (default: "internal,keepascii")
1406 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407 Specifies details about changing the case of letters. It may contain
1408 these words, separated by a comma:
1409 internal Use internal case mapping functions, the current
1410 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001411 matters when 'encoding' is a Unicode encoding,
1412 "latin1" or "iso-8859-15". When "internal" is
1413 omitted, the towupper() and towlower() system library
1414 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1416 case mapping, the current locale is not effective.
1417 This probably only matters for Turkish.
1418
1419 *'cdpath'* *'cd'* *E344* *E346*
1420'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1421 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001422 {not available when compiled without the
1423 |+file_in_path| feature}
1424 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001425 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1426 searched for has a relative path, not an absolute part starting with
1427 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428 The 'cdpath' option's value has the same form and semantics as
1429 |'path'|. Also see |file-searching|.
1430 The default value is taken from $CDPATH, with a "," prepended to look
1431 in the current directory first.
1432 If the default value taken from $CDPATH is not what you want, include
1433 a modified version of the following command in your vimrc file to
1434 override it: >
1435 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1436< This option cannot be set from a |modeline| or in the |sandbox|, for
1437 security reasons.
1438 (parts of 'cdpath' can be passed to the shell to expand file names).
1439
1440 *'cedit'*
1441'cedit' string (Vi default: "", Vim default: CTRL-F)
1442 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443 The key used in Command-line Mode to open the command-line window.
1444 The default is CTRL-F when 'compatible' is off.
1445 Only non-printable keys are allowed.
1446 The key can be specified as a single character, but it is difficult to
1447 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001448 :exe "set cedit=\<C-Y>"
1449 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450< |Nvi| also has this option, but it only uses the first character.
1451 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001452 NOTE: This option is set to the Vim default value when 'compatible'
1453 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454
1455 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1456'charconvert' 'ccv' string (default "")
1457 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001458 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001459 An expression that is used for character encoding conversion. It is
1460 evaluated when a file that is to be read or has been written has a
1461 different encoding from what is desired.
1462 'charconvert' is not used when the internal iconv() function is
1463 supported and is able to do the conversion. Using iconv() is
1464 preferred, because it is much faster.
1465 'charconvert' is not used when reading stdin |--|, because there is no
1466 file to convert from. You will have to save the text in a file first.
1467 The expression must return zero or an empty string for success,
1468 non-zero for failure.
1469 The possible encoding names encountered are in 'encoding'.
1470 Additionally, names given in 'fileencodings' and 'fileencoding' are
1471 used.
1472 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1473 is done internally by Vim, 'charconvert' is not used for this.
1474 'charconvert' is also used to convert the viminfo file, if the 'c'
1475 flag is present in 'viminfo'. Also used for Unicode conversion.
1476 Example: >
1477 set charconvert=CharConvert()
1478 fun CharConvert()
1479 system("recode "
1480 \ . v:charconvert_from . ".." . v:charconvert_to
1481 \ . " <" . v:fname_in . " >" v:fname_out)
1482 return v:shell_error
1483 endfun
1484< The related Vim variables are:
1485 v:charconvert_from name of the current encoding
1486 v:charconvert_to name of the desired encoding
1487 v:fname_in name of the input file
1488 v:fname_out name of the output file
1489 Note that v:fname_in and v:fname_out will never be the same.
1490 Note that v:charconvert_from and v:charconvert_to may be different
1491 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1492 Encryption is not done by Vim when using 'charconvert'. If you want
1493 to encrypt the file after conversion, 'charconvert' should take care
1494 of this.
1495 This option cannot be set from a |modeline| or in the |sandbox|, for
1496 security reasons.
1497
1498 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1499'cindent' 'cin' boolean (default off)
1500 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 {not available when compiled without the |+cindent|
1502 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001503 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 that trigger reindenting in insert mode and 'cinoptions' to set your
1505 preferred indent style.
1506 If 'indentexpr' is not empty, it overrules 'cindent'.
1507 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1508 the "=" operator indents using this algorithm rather than calling an
1509 external program.
1510 See |C-indenting|.
1511 When you don't like the way 'cindent' works, try the 'smartindent'
1512 option or 'indentexpr'.
1513 This option is not used when 'paste' is set.
1514 NOTE: This option is reset when 'compatible' is set.
1515
1516 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001517'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001518 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519 {not available when compiled without the |+cindent|
1520 feature}
1521 A list of keys that, when typed in Insert mode, cause reindenting of
1522 the current line. Only used if 'cindent' is on and 'indentexpr' is
1523 empty.
1524 For the format of this option see |cinkeys-format|.
1525 See |C-indenting|.
1526
1527 *'cinoptions'* *'cino'*
1528'cinoptions' 'cino' string (default "")
1529 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530 {not available when compiled without the |+cindent|
1531 feature}
1532 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1533 program. See |cinoptions-values| for the values of this option, and
1534 |C-indenting| for info on C indenting in general.
1535
1536
1537 *'cinwords'* *'cinw'*
1538'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1539 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540 {not available when compiled without both the
1541 |+cindent| and the |+smartindent| features}
1542 These keywords start an extra indent in the next line when
1543 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1544 an appropriate place (inside {}).
1545 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1546 matter, include the keyword both the uppercase and lowercase:
1547 "if,If,IF".
1548
1549 *'clipboard'* *'cb'*
1550'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1551 for X-windows, "" otherwise)
1552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553 {only in GUI versions or when the |+xterm_clipboard|
1554 feature is included}
1555 This option is a list of comma separated names.
1556 These names are recognized:
1557
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001558 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559 unnamed When included, Vim will use the clipboard register '*'
1560 for all yank, delete, change and put operations which
1561 would normally go to the unnamed register. When a
1562 register is explicitly specified, it will always be
1563 used regardless of whether "unnamed" is in 'clipboard'
1564 or not. The clipboard register can always be
1565 explicitly accessed using the "* notation. Also see
1566 |gui-clipboard|.
1567
Bram Moolenaar30b65812012-07-12 22:01:11 +02001568 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001569 unnamedplus A variant of the "unnamed" flag which uses the
1570 clipboard register '+' (|quoteplus|) instead of
1571 register '*' for all yank, delete, change and put
1572 operations which would normally go to the unnamed
1573 register. When "unnamed" is also included to the
1574 option, yank operations (but not delete, change or
1575 put) will additionally copy the text into register
1576 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001577 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001578 Availability can be checked with: >
1579 if has('unnamedplus')
1580<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001581 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582 autoselect Works like the 'a' flag in 'guioptions': If present,
1583 then whenever Visual mode is started, or the Visual
1584 area extended, Vim tries to become the owner of the
1585 windowing system's global selection or put the
1586 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001587 register "*. See |'go-a'| and |quotestar| for details.
1588 When the GUI is active, the 'a' flag in 'guioptions'
1589 is used, when the GUI is not active, this "autoselect"
1590 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591 Also applies to the modeless selection.
1592
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001593 *clipboard-autoselectplus*
1594 autoselectplus Like "autoselect" but using the + register instead of
1595 the * register. Compare to the 'P' flag in
1596 'guioptions'.
1597
1598 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 autoselectml Like "autoselect", but for the modeless selection
1600 only. Compare to the 'A' flag in 'guioptions'.
1601
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001602 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001603 html When the clipboard contains HTML, use this when
1604 pasting. When putting text on the clipboard, mark it
1605 as HTML. This works to copy rendered HTML from
1606 Firefox, paste it as raw HTML in Vim, select the HTML
1607 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001608 You probably want to add this only temporarily,
1609 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001610 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001611
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001612 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 exclude:{pattern}
1614 Defines a pattern that is matched against the name of
1615 the terminal 'term'. If there is a match, no
1616 connection will be made to the X server. This is
1617 useful in this situation:
1618 - Running Vim in a console.
1619 - $DISPLAY is set to start applications on another
1620 display.
1621 - You do not want to connect to the X server in the
1622 console, but do want this in a terminal emulator.
1623 To never connect to the X server use: >
1624 exclude:.*
1625< This has the same effect as using the |-X| argument.
1626 Note that when there is no connection to the X server
1627 the window title won't be restored and the clipboard
1628 cannot be accessed.
1629 The value of 'magic' is ignored, {pattern} is
1630 interpreted as if 'magic' was on.
1631 The rest of the option value will be used for
1632 {pattern}, this must be the last entry.
1633
1634 *'cmdheight'* *'ch'*
1635'cmdheight' 'ch' number (default 1)
1636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 Number of screen lines to use for the command-line. Helps avoiding
1638 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001639 The value of this option is stored with the tab page, so that each tab
1640 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641
1642 *'cmdwinheight'* *'cwh'*
1643'cmdwinheight' 'cwh' number (default 7)
1644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645 Number of screen lines to use for the command-line window. |cmdwin|
1646
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001647 *'colorcolumn'* *'cc'*
1648'colorcolumn' 'cc' string (default "")
1649 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001650 {not available when compiled without the |+syntax|
1651 feature}
1652 'colorcolumn' is a comma separated list of screen columns that are
1653 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1654 text. Will make screen redrawing slower.
1655 The screen column can be an absolute number, or a number preceded with
1656 '+' or '-', which is added to or subtracted from 'textwidth'. >
1657
1658 :set cc=+1 " highlight column after 'textwidth'
1659 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1660 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1661<
1662 When 'textwidth' is zero then the items with '-' and '+' are not used.
1663 A maximum of 256 columns are highlighted.
1664
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 *'columns'* *'co'* *E594*
1666'columns' 'co' number (default 80 or terminal width)
1667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001669 initialization and does not have to be set by hand. Also see
1670 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 When Vim is running in the GUI or in a resizable window, setting this
1672 option will cause the window size to be changed. When you only want
1673 to use the size for the GUI, put the command in your |gvimrc| file.
1674 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001675 number of columns of the display, the display may be messed up. For
1676 the GUI it is always possible and Vim limits the number of columns to
1677 what fits on the screen. You can use this command to get the widest
1678 window possible: >
1679 :set columns=9999
1680< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681
1682 *'comments'* *'com'* *E524* *E525*
1683'comments' 'com' string (default
1684 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1685 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 {not available when compiled without the |+comments|
1687 feature}
1688 A comma separated list of strings that can start a comment line. See
1689 |format-comments|. See |option-backslash| about using backslashes to
1690 insert a space.
1691
1692 *'commentstring'* *'cms'* *E537*
1693'commentstring' 'cms' string (default "/*%s*/")
1694 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695 {not available when compiled without the |+folding|
1696 feature}
1697 A template for a comment. The "%s" in the value is replaced with the
1698 comment text. Currently only used to add markers for folding, see
1699 |fold-marker|.
1700
1701 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001702'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001703 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705 This option has the effect of making Vim either more Vi-compatible, or
1706 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001707
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001709 other options are also changed as a side effect.
1710 NOTE: Setting or resetting this option can have a lot of unexpected
1711 effects: Mappings are interpreted in another way, undo behaves
1712 differently, etc. If you set this option in your vimrc file, you
1713 should probably put it at the very start.
1714
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715 By default this option is on and the Vi defaults are used for the
1716 options. This default was chosen for those people who want to use Vim
1717 just like Vi, and don't even (want to) know about the 'compatible'
1718 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001719 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001720 this option is switched off, and all options that have not been
1721 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001722 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001723 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001724 happen for the system-wide vimrc or gvimrc file, nor for a file given
1725 with the |-u| argument). Also see |compatible-default| and
1726 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 You can also set this option with the "-C" argument, and reset it with
1728 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001729 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730
Bram Moolenaar214641f2017-03-05 17:04:09 +01001731 When this option is set, numerous other options are set to make Vim as
1732 Vi-compatible as possible. When this option is unset, various options
1733 are set to make Vim more useful. The table below lists all the
1734 options affected.
1735 The {?} column indicates when the options are affected:
1736 + Means that the option is set to the value given in {set value} when
1737 'compatible' is set.
1738 & Means that the option is set to the value given in {set value} when
1739 'compatible' is set AND is set to its Vim default value when
1740 'compatible' is unset.
1741 - Means the option is NOT changed when setting 'compatible' but IS
1742 set to its Vim default when 'compatible' is unset.
1743 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744
Bram Moolenaar036986f2017-03-16 17:41:02 +01001745 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001746
1747 'allowrevins' + off no CTRL-_ command
1748 'antialias' + off don't use antialiased fonts
1749 'arabic' + off reset arabic-related options
1750 'arabicshape' + on correct character shapes
1751 'backspace' + "" normal backspace
1752 'backup' + off no backup file
1753 'backupcopy' & Unix: "yes" backup file is a copy
1754 else: "auto" copy or rename backup file
1755 'balloonexpr' + "" text to show in evaluation balloon
1756 'breakindent' + off don't indent when wrapping lines
1757 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1758 'cindent' + off no C code indentation
1759 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1760 'copyindent' + off don't copy indent structure
1761 'cpoptions' & (all flags) Vi-compatible flags
1762 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001763 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001764 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001765 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001766 'cscopeverbose' + off see |cscopeverbose|
1767 'delcombine' + off unicode: delete whole char combination
1768 'digraph' + off no digraphs
1769 'esckeys' & off no <Esc>-keys in Insert mode
1770 'expandtab' + off tabs not expanded to spaces
1771 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001773 'formatexpr' + "" use 'formatprg' for auto-formatting
1774 'formatoptions' & "vt" Vi compatible formatting
1775 'gdefault' + off no default 'g' flag for ":s"
1776 'history' & 0 no commandline history
1777 'hkmap' + off no Hebrew keyboard mapping
1778 'hkmapp' + off no phonetic Hebrew keyboard mapping
1779 'hlsearch' + off no highlighting of search matches
1780 'incsearch' + off no incremental searching
1781 'indentexpr' + "" no indenting by expression
1782 'insertmode' + off do not start in Insert mode
1783 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001785 'joinspaces' + on insert 2 spaces after period
1786 'modeline' & off no modelines
1787 'more' & off no pauses in listings
1788 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1789 'numberwidth' & 8 min number of columns for line number
1790 'preserveindent'+ off don't preserve current indent structure
1791 when changing it
1792 'revins' + off no reverse insert
1793 'ruler' + off no ruler
1794 'scrolljump' + 1 no jump scroll
1795 'scrolloff' + 0 no scroll offset
1796 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1797 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001798 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001799 'showcmd' & off command characters not shown
1800 'showmode' & off current mode not shown
1801 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1802 'smartcase' + off no automatic ignore case switch
1803 'smartindent' + off no smart indentation
1804 'smarttab' + off no smart tab size
1805 'softtabstop' + 0 tabs are always 'tabstop' positions
1806 'startofline' + on goto startofline with some commands
1807 'tagcase' & "followic" 'ignorecase' when searching tags file
1808 'tagrelative' & off tag file names are not relative
1809 'termguicolors' + off don't use highlight-(guifg|guibg)
1810 'textauto' & off no automatic textmode detection
1811 'textwidth' + 0 no automatic line wrap
1812 'tildeop' + off tilde is not an operator
1813 'ttimeout' + off no terminal timeout
1814 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001815 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001816 'virtualedit' + "" cursor can only be placed on characters
1817 'whichwrap' & "" left-right movements don't wrap
1818 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001820 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821
1822 *'complete'* *'cpt'* *E535*
1823'complete' 'cpt' string (default: ".,w,b,u,t,i")
1824 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 This option specifies how keyword completion |ins-completion| works
1826 when CTRL-P or CTRL-N are used. It is also used for whole-line
1827 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1828 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001829 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 w scan buffers from other windows
1831 b scan other loaded buffers that are in the buffer list
1832 u scan the unloaded buffers that are in the buffer list
1833 U scan the buffers that are not in the buffer list
1834 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001835 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 k{dict} scan the file {dict}. Several "k" flags can be given,
1837 patterns are valid too. For example: >
1838 :set cpt=k/usr/dict/*,k~/spanish
1839< s scan the files given with the 'thesaurus' option
1840 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1841 are valid too.
1842 i scan current and included files
1843 d scan current and included files for defined name or macro
1844 |i_CTRL-X_CTRL-D|
1845 ] tag completion
1846 t same as "]"
1847
1848 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1849 not executed, this may lead to unexpected completions from some files
1850 (gzipped files for example). Unloaded buffers are not scanned for
1851 whole-line completion.
1852
1853 The default is ".,w,b,u,t,i", which means to scan:
1854 1. the current buffer
1855 2. buffers in other windows
1856 3. other loaded buffers
1857 4. unloaded buffers
1858 5. tags
1859 6. included files
1860
1861 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001862 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1863 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001865 *'completefunc'* *'cfu'*
1866'completefunc' 'cfu' string (default: empty)
1867 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001868 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001869 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001870 This option specifies a function to be used for Insert mode completion
1871 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001872 See |complete-functions| for an explanation of how the function is
1873 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001874 This option cannot be set from a |modeline| or in the |sandbox|, for
1875 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001876
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001877 *'completeslash'* *'csl'*
1878'completeslash' 'csl' string (default: "")
1879 local to buffer
1880 {not in Vi} {only for MS-Windows}
1881 When this option is set it overrules 'shellslash' for completion:
1882 - When this option is set to "slash", a forward slash is used for path
1883 completion in insert mode. This is useful when editing HTML tag, or
1884 Makefile with 'noshellslash' on Windows.
1885 - When this option is set to "backslash", backslash is used. This is
1886 useful when editing a batch file with 'shellslash' set on Windows.
1887 - When this option is empty, same character is used as for
1888 'shellslash'.
1889 For Insert mode completion the buffer-local value is used. For
1890 command line completion the global value is used.
1891
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001892 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001893'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001894 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001895 A comma separated list of options for Insert mode completion
1896 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001897
1898 menu Use a popup menu to show the possible completions. The
1899 menu is only shown when there is more than one match and
1900 sufficient colors are available. |ins-completion-menu|
1901
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001902 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001903 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001904 match, e.g., what file it comes from.
1905
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001906 longest Only insert the longest common text of the matches. If
1907 the menu is displayed you can use CTRL-L to add more
1908 characters. Whether case is ignored depends on the kind
1909 of completion. For buffer text the 'ignorecase' option is
1910 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001911
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001912 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001913 completion in the preview window. Only works in
1914 combination with "menu" or "menuone".
1915
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001916 popup Show extra information about the currently selected
1917 completion in a popup window. Only works in combination
1918 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001919 See |'completepopup'| for specifying properties.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001920 {only works when compiled with the +textprop feature}
1921
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001922 noinsert Do not insert any text for a match until the user selects
1923 a match from the menu. Only works in combination with
1924 "menu" or "menuone". No effect if "longest" is present.
1925
1926 noselect Do not select a match in the menu, force the user to
1927 select one from the menu. Only works in combination with
1928 "menu" or "menuone".
1929
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001930
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001931 *'completepopup'* *'cpp'*
1932'completepopup' 'cpp' string (default empty)
1933 global
1934 {not available when compiled without the |+textprop|
1935 or |+quickfix| feature}
1936 When 'completeopt' contains "popup" then this option is used for the
1937 properties of the info popup. See |complete-popup|.
1938
1939
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001940 *'concealcursor'* *'cocu'*
1941'concealcursor' 'cocu' string (default: "")
1942 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001943 {not available when compiled without the |+conceal|
1944 feature}
1945 Sets the modes in which text in the cursor line can also be concealed.
1946 When the current mode is listed then concealing happens just like in
1947 other lines.
1948 n Normal mode
1949 v Visual mode
1950 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001951 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001952
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001953 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001954 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001955 are moving around text is concealed, but when starting to insert text
1956 or selecting a Visual area the concealed text is displayed, so that
1957 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001958 Keep in mind that the cursor position is not always where it's
1959 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001960
1961
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001962 *'conceallevel'* *'cole'*
1963'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001964 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001965 {not available when compiled without the |+conceal|
1966 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001967 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1968 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001969
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001970 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001971 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001972 1 Each block of concealed text is replaced with one
1973 character. If the syntax item does not have a custom
1974 replacement character defined (see |:syn-cchar|) the
1975 character defined in 'listchars' is used (default is a
1976 space).
1977 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001978 2 Concealed text is completely hidden unless it has a
1979 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001980 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001981 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001982
Bram Moolenaara7781e02010-07-19 20:13:22 +02001983 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001984 edit and copy the text. This can be changed with the 'concealcursor'
1985 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001986
Bram Moolenaar071d4272004-06-13 20:20:40 +00001987 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1988'confirm' 'cf' boolean (default off)
1989 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990 When 'confirm' is on, certain operations that would normally
1991 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1992 instead raise a |dialog| asking if you wish to save the current
1993 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1994 If 'confirm' is off you can still activate confirmation for one
1995 command only (this is most useful in mappings) with the |:confirm|
1996 command.
1997 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1998
1999 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2000'conskey' 'consk' boolean (default off)
2001 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002002 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003
2004 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2005'copyindent' 'ci' boolean (default off)
2006 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007 Copy the structure of the existing lines indent when autoindenting a
2008 new line. Normally the new indent is reconstructed by a series of
2009 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2010 in which case only spaces are used). Enabling this option makes the
2011 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002012 existing line. 'expandtab' has no effect on these characters, a Tab
2013 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002015 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016 Also see 'preserveindent'.
2017
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002018 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019'cpoptions' 'cpo' string (Vim default: "aABceFs",
2020 Vi default: all flags)
2021 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002023 this indicates Vi-compatible behavior. This is used for things where
2024 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025 'cpoptions' stands for "compatible-options".
2026 Commas can be added for readability.
2027 To avoid problems with flags that are added in the future, use the
2028 "+=" and "-=" feature of ":set" |add-option-flags|.
2029 NOTE: This option is set to the Vi default value when 'compatible' is
2030 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002031 NOTE: This option is set to the POSIX default value at startup when
2032 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002033 variable exists |posix|. This means Vim tries to behave like the
2034 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035
2036 contains behavior ~
2037 *cpo-a*
2038 a When included, a ":read" command with a file name
2039 argument will set the alternate file name for the
2040 current window.
2041 *cpo-A*
2042 A When included, a ":write" command with a file name
2043 argument will set the alternate file name for the
2044 current window.
2045 *cpo-b*
2046 b "\|" in a ":map" command is recognized as the end of
2047 the map command. The '\' is included in the mapping,
2048 the text after the '|' is interpreted as the next
2049 command. Use a CTRL-V instead of a backslash to
2050 include the '|' in the mapping. Applies to all
2051 mapping, abbreviation, menu and autocmd commands.
2052 See also |map_bar|.
2053 *cpo-B*
2054 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002055 abbreviations, user commands and the "to" part of the
2056 menu commands. Remove this flag to be able to use a
2057 backslash like a CTRL-V. For example, the command
2058 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059 'B' included: "\^[" (^[ is a real <Esc>)
2060 'B' excluded: "<Esc>" (5 characters)
2061 ('<' excluded in both cases)
2062 *cpo-c*
2063 c Searching continues at the end of any match at the
2064 cursor position, but not further than the start of the
2065 next line. When not present searching continues
2066 one character from the cursor position. With 'c'
2067 "abababababab" only gets three matches when repeating
2068 "/abab", without 'c' there are five matches.
2069 *cpo-C*
2070 C Do not concatenate sourced lines that start with a
2071 backslash. See |line-continuation|.
2072 *cpo-d*
2073 d Using "./" in the 'tags' option doesn't mean to use
2074 the tags file relative to the current file, but the
2075 tags file in the current directory.
2076 *cpo-D*
2077 D Can't use CTRL-K to enter a digraph after Normal mode
2078 commands with a character argument, like |r|, |f| and
2079 |t|.
2080 *cpo-e*
2081 e When executing a register with ":@r", always add a
2082 <CR> to the last line, also when the register is not
2083 linewise. If this flag is not present, the register
2084 is not linewise and the last line does not end in a
2085 <CR>, then the last line is put on the command-line
2086 and can be edited before hitting <CR>.
2087 *cpo-E*
2088 E It is an error when using "y", "d", "c", "g~", "gu" or
2089 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002090 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091 This makes "y0" fail in the first column.
2092 *cpo-f*
2093 f When included, a ":read" command with a file name
2094 argument will set the file name for the current buffer,
2095 if the current buffer doesn't have a file name yet.
2096 *cpo-F*
2097 F When included, a ":write" command with a file name
2098 argument will set the file name for the current
2099 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002100 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101 *cpo-g*
2102 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002103 *cpo-H*
2104 H When using "I" on a line with only blanks, insert
2105 before the last blank. Without this flag insert after
2106 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107 *cpo-i*
2108 i When included, interrupting the reading of a file will
2109 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002110 *cpo-I*
2111 I When moving the cursor up or down just after inserting
2112 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002113 *cpo-j*
2114 j When joining lines, only add two spaces after a '.',
2115 not after '!' or '?'. Also see 'joinspaces'.
2116 *cpo-J*
2117 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002118 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002119 white space.
2120 *cpo-k*
2121 k Disable the recognition of raw key codes in
2122 mappings, abbreviations, and the "to" part of menu
2123 commands. For example, if <Key> sends ^[OA (where ^[
2124 is <Esc>), the command ":map X ^[OA" results in X
2125 being mapped to:
2126 'k' included: "^[OA" (3 characters)
2127 'k' excluded: "<Key>" (one key code)
2128 Also see the '<' flag below.
2129 *cpo-K*
2130 K Don't wait for a key code to complete when it is
2131 halfway a mapping. This breaks mapping <F1><F1> when
2132 only part of the second <F1> has been read. It
2133 enables cancelling the mapping by typing <F1><Esc>.
2134 *cpo-l*
2135 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002136 literally, only "\]", "\^", "\-" and "\\" are special.
2137 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2139 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002140 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002141 *cpo-L*
2142 L When the 'list' option is set, 'wrapmargin',
2143 'textwidth', 'softtabstop' and Virtual Replace mode
2144 (see |gR|) count a <Tab> as two characters, instead of
2145 the normal behavior of a <Tab>.
2146 *cpo-m*
2147 m When included, a showmatch will always wait half a
2148 second. When not included, a showmatch will wait half
2149 a second or until a character is typed. |'showmatch'|
2150 *cpo-M*
2151 M When excluded, "%" matching will take backslashes into
2152 account. Thus in "( \( )" and "\( ( \)" the outer
2153 parenthesis match. When included "%" ignores
2154 backslashes, which is Vi compatible.
2155 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002156 n When included, the column used for 'number' and
2157 'relativenumber' will also be used for text of wrapped
2158 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159 *cpo-o*
2160 o Line offset to search command is not remembered for
2161 next search.
2162 *cpo-O*
2163 O Don't complain if a file is being overwritten, even
2164 when it didn't exist when editing it. This is a
2165 protection against a file unexpectedly created by
2166 someone else. Vi didn't complain about this.
2167 *cpo-p*
2168 p Vi compatible Lisp indenting. When not present, a
2169 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002170 *cpo-P*
2171 P When included, a ":write" command that appends to a
2172 file will set the file name for the current buffer, if
2173 the current buffer doesn't have a file name yet and
2174 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002175 *cpo-q*
2176 q When joining multiple lines leave the cursor at the
2177 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 *cpo-r*
2179 r Redo ("." command) uses "/" to repeat a search
2180 command, instead of the actually used search string.
2181 *cpo-R*
2182 R Remove marks from filtered lines. Without this flag
2183 marks are kept like |:keepmarks| was used.
2184 *cpo-s*
2185 s Set buffer options when entering the buffer for the
2186 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002187 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002188 set when the buffer is created.
2189 *cpo-S*
2190 S Set buffer options always when entering a buffer
2191 (except 'readonly', 'fileformat', 'filetype' and
2192 'syntax'). This is the (most) Vi compatible setting.
2193 The options are set to the values in the current
2194 buffer. When you change an option and go to another
2195 buffer, the value is copied. Effectively makes the
2196 buffer options global to all buffers.
2197
2198 's' 'S' copy buffer options
2199 no no when buffer created
2200 yes no when buffer first entered (default)
2201 X yes each time when buffer entered (vi comp.)
2202 *cpo-t*
2203 t Search pattern for the tag command is remembered for
2204 "n" command. Otherwise Vim only puts the pattern in
2205 the history for search pattern, but doesn't change the
2206 last used search pattern.
2207 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002208 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 *cpo-v*
2210 v Backspaced characters remain visible on the screen in
2211 Insert mode. Without this flag the characters are
2212 erased from the screen right away. With this flag the
2213 screen newly typed text overwrites backspaced
2214 characters.
2215 *cpo-w*
2216 w When using "cw" on a blank character, only change one
2217 character and not all blanks until the start of the
2218 next word.
2219 *cpo-W*
2220 W Don't overwrite a readonly file. When omitted, ":w!"
2221 overwrites a readonly file, if possible.
2222 *cpo-x*
2223 x <Esc> on the command-line executes the command-line.
2224 The default in Vim is to abandon the command-line,
2225 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002226 *cpo-X*
2227 X When using a count with "R" the replaced text is
2228 deleted only once. Also when repeating "R" with "."
2229 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002231 y A yank command can be redone with ".". Think twice if
2232 you really want to use this, it may break some
2233 plugins, since most people expect "." to only repeat a
2234 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002235 *cpo-Z*
2236 Z When using "w!" while the 'readonly' option is set,
2237 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002238 *cpo-!*
2239 ! When redoing a filter command, use the last used
2240 external command, whatever it was. Otherwise the last
2241 used -filter- command is used.
2242 *cpo-$*
2243 $ When making a change to one line, don't redisplay the
2244 line, but put a '$' at the end of the changed text.
2245 The changed text will be overwritten when you type the
2246 new text. The line is redisplayed if you type any
2247 command that moves the cursor from the insertion
2248 point.
2249 *cpo-%*
2250 % Vi-compatible matching is done for the "%" command.
2251 Does not recognize "#if", "#endif", etc.
2252 Does not recognize "/*" and "*/".
2253 Parens inside single and double quotes are also
2254 counted, causing a string that contains a paren to
2255 disturb the matching. For example, in a line like
2256 "if (strcmp("foo(", s))" the first paren does not
2257 match the last one. When this flag is not included,
2258 parens inside single and double quotes are treated
2259 specially. When matching a paren outside of quotes,
2260 everything inside quotes is ignored. When matching a
2261 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002262 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002263 This flag is also used for other features, such as
2264 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002265 *cpo--*
2266 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002267 it would go above the first line or below the last
2268 line. Without it the cursor moves to the first or
2269 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002270 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002271 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002272 *cpo-+*
2273 + When included, a ":write file" command will reset the
2274 'modified' flag of the buffer, even though the buffer
2275 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002276 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002277 * Use ":*" in the same way as ":@". When not included,
2278 ":*" is an alias for ":'<,'>", select the Visual area.
2279 *cpo-<*
2280 < Disable the recognition of special key codes in |<>|
2281 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002282 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002283 ":map X <Tab>" results in X being mapped to:
2284 '<' included: "<Tab>" (5 characters)
2285 '<' excluded: "^I" (^I is a real <Tab>)
2286 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002287 *cpo->*
2288 > When appending to a register, put a line break before
2289 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002290 *cpo-;*
2291 ; When using |,| or |;| to repeat the last |t| search
2292 and the cursor is right in front of the searched
2293 character, the cursor won't move. When not included,
2294 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002295 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002296
2297 POSIX flags. These are not included in the Vi default value, except
2298 when $VIM_POSIX was set on startup. |posix|
2299
2300 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002301 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002302 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002303 *cpo-&*
2304 & When ":preserve" was used keep the swap file when
2305 exiting normally while this buffer is still loaded.
2306 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002307 *cpo-\*
2308 \ Backslash in a [] range in a search pattern is taken
2309 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002310 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2311 '\' excluded: "/[ \-]" finds <Space> and '-'
2312 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002313 *cpo-/*
2314 / When "%" is used as the replacement string in a |:s|
2315 command, use the previous replacement string. |:s%|
2316 *cpo-{*
2317 { The |{| and |}| commands also stop at a "{" character
2318 at the start of a line.
2319 *cpo-.*
2320 . The ":chdir" and ":cd" commands fail if the current
2321 buffer is modified, unless ! is used. Vim doesn't
2322 need this, since it remembers the full path of an
2323 opened file.
2324 *cpo-bar*
2325 | The value of the $LINES and $COLUMNS environment
2326 variables overrule the terminal size values obtained
2327 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002328
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002330 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002331'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002332 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002333 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002334 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002335 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002336 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002337 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002338 blowfish Blowfish method. Medium strong encryption but it has
2339 an implementation flaw. Requires Vim 7.3 or later,
2340 files can NOT be read by Vim 7.2 and older. This adds
2341 a "seed" to the file, every time you write the file
2342 the encrypted bytes will be different.
2343 *blowfish2*
2344 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002345 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002346 and older. This adds a "seed" to the file, every time
2347 you write the file the encrypted bytes will be
2348 different. The whole undo file is encrypted, not just
2349 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002350
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002351 You should use "blowfish2", also to re-encrypt older files.
2352
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002353 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002354 to the detected method of the file being read. Thus if you write it
2355 without changing 'cryptmethod' the same method will be used.
2356 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002357 explicitly write it, you don't get a warning unless there are other
2358 modifications. Also see |:X|.
2359
2360 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002361 the value "blowfish2". When setting the local value to an empty
2362 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002363
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002364 When a new encryption method is added in a later version of Vim, and
2365 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002366 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002367
2368
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369 *'cscopepathcomp'* *'cspc'*
2370'cscopepathcomp' 'cspc' number (default 0)
2371 global
2372 {not available when compiled without the |+cscope|
2373 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002374 Determines how many components of the path to show in a list of tags.
2375 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002376 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002377
2378 *'cscopeprg'* *'csprg'*
2379'cscopeprg' 'csprg' string (default "cscope")
2380 global
2381 {not available when compiled without the |+cscope|
2382 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383 Specifies the command to execute cscope. See |cscopeprg|.
2384 This option cannot be set from a |modeline| or in the |sandbox|, for
2385 security reasons.
2386
2387 *'cscopequickfix'* *'csqf'*
2388'cscopequickfix' 'csqf' string (default "")
2389 global
2390 {not available when compiled without the |+cscope|
2391 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 Specifies whether to use quickfix window to show cscope results.
2393 See |cscopequickfix|.
2394
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002395 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002396'cscoperelative' 'csre' boolean (default off)
2397 global
2398 {not available when compiled without the |+cscope|
2399 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002400 In the absence of a prefix (-P) for cscope. setting this option enables
2401 to use the basename of cscope.out path as the prefix.
2402 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002403 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002404
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2406'cscopetag' 'cst' boolean (default off)
2407 global
2408 {not available when compiled without the |+cscope|
2409 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 Use cscope for tag commands. See |cscope-options|.
2411 NOTE: This option is reset when 'compatible' is set.
2412
2413 *'cscopetagorder'* *'csto'*
2414'cscopetagorder' 'csto' number (default 0)
2415 global
2416 {not available when compiled without the |+cscope|
2417 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002418 Determines the order in which ":cstag" performs a search. See
2419 |cscopetagorder|.
2420 NOTE: This option is set to 0 when 'compatible' is set.
2421
2422 *'cscopeverbose'* *'csverb'*
2423 *'nocscopeverbose'* *'nocsverb'*
2424'cscopeverbose' 'csverb' boolean (default off)
2425 global
2426 {not available when compiled without the |+cscope|
2427 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428 Give messages when adding a cscope database. See |cscopeverbose|.
2429 NOTE: This option is reset when 'compatible' is set.
2430
Bram Moolenaar860cae12010-06-05 23:22:07 +02002431 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2432'cursorbind' 'crb' boolean (default off)
2433 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002434 When this option is set, as the cursor in the current
2435 window moves other cursorbound windows (windows that also have
2436 this option set) move their cursors to the corresponding line and
2437 column. This option is useful for viewing the
2438 differences between two versions of a file (see 'diff'); in diff mode,
2439 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002440 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002441
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002442
2443 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2444'cursorcolumn' 'cuc' boolean (default off)
2445 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002446 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002447 feature}
2448 Highlight the screen column of the cursor with CursorColumn
2449 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2450 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002451 If you only want the highlighting in the current window you can use
2452 these autocommands: >
2453 au WinLeave * set nocursorline nocursorcolumn
2454 au WinEnter * set cursorline cursorcolumn
2455<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002456
2457 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2458'cursorline' 'cul' boolean (default off)
2459 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002460 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002461 feature}
2462 Highlight the screen line of the cursor with CursorLine
2463 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2464 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002465 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002466 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002467
2468
Bram Moolenaar071d4272004-06-13 20:20:40 +00002469 *'debug'*
2470'debug' string (default "")
2471 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002472 These values can be used:
2473 msg Error messages that would otherwise be omitted will be given
2474 anyway.
2475 throw Error messages that would otherwise be omitted will be given
2476 anyway and also throw an exception and set |v:errmsg|.
2477 beep A message will be given when otherwise only a beep would be
2478 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002479 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002480 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2481 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002482
2483 *'define'* *'def'*
2484'define' 'def' string (default "^\s*#\s*define")
2485 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002486 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487 pattern, just like for the "/" command. This option is used for the
2488 commands like "[i" and "[d" |include-search|. The 'isident' option is
2489 used to recognize the defined name after the match:
2490 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2491 See |option-backslash| about inserting backslashes to include a space
2492 or backslash.
2493 The default value is for C programs. For C++ this value would be
2494 useful, to include const type declarations: >
2495 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002496< You can also use "\ze" just before the name and continue the pattern
2497 to check what is following. E.g. for Javascript, if a function is
2498 defined with "func_name = function(args)": >
2499 ^\s*\ze\i\+\s*=\s*function(
2500< If the function is defined with "func_name : function() {...": >
2501 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002502< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002503 To avoid that use `:let` with a single quote string: >
2504 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002505<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002506
2507 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2508'delcombine' 'deco' boolean (default off)
2509 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510 If editing Unicode and this option is set, backspace and Normal mode
2511 "x" delete each combining character on its own. When it is off (the
2512 default) the character along with its combining characters are
2513 deleted.
2514 Note: When 'delcombine' is set "xx" may work different from "2x"!
2515
2516 This is useful for Arabic, Hebrew and many other languages where one
2517 may have combining characters overtop of base characters, and want
2518 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002519 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520
2521 *'dictionary'* *'dict'*
2522'dictionary' 'dict' string (default "")
2523 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524 List of file names, separated by commas, that are used to lookup words
2525 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2526 contain a list of words. This can be one word per line, or several
2527 words per line, separated by non-keyword characters (white space is
2528 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002529
2530 When this option is empty or an entry "spell" is present, and spell
2531 checking is enabled, words in the word lists for the currently active
2532 'spelllang' are used. See |spell|.
2533
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002534 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535 after a comma are ignored, otherwise spaces are included in the file
2536 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002537 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538 Where to find a list of words?
2539 - On FreeBSD, there is the file "/usr/share/dict/words".
2540 - In the Simtel archive, look in the "msdos/linguist" directory.
2541 - In "miscfiles" of the GNU collection.
2542 The use of |:set+=| and |:set-=| is preferred when adding or removing
2543 directories from the list. This avoids problems when a future version
2544 uses another default.
2545 Backticks cannot be used in this option for security reasons.
2546
2547 *'diff'* *'nodiff'*
2548'diff' boolean (default off)
2549 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 {not available when compiled without the |+diff|
2551 feature}
2552 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002553 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002554
2555 *'dex'* *'diffexpr'*
2556'diffexpr' 'dex' string (default "")
2557 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558 {not available when compiled without the |+diff|
2559 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002560 Expression which is evaluated to obtain a diff file (either ed-style
2561 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562 This option cannot be set from a |modeline| or in the |sandbox|, for
2563 security reasons.
2564
2565 *'dip'* *'diffopt'*
Bram Moolenaarc93262b2018-09-10 21:15:40 +02002566'diffopt' 'dip' string (default "internal,filler")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002568 {not available when compiled without the |+diff|
2569 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002570 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 All are optional. Items must be separated by a comma.
2572
2573 filler Show filler lines, to keep the text
2574 synchronized with a window that has inserted
2575 lines at the same position. Mostly useful
2576 when windows are side-by-side and 'scrollbind'
2577 is set.
2578
2579 context:{n} Use a context of {n} lines between a change
2580 and a fold that contains unchanged lines.
2581 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002582 When using zero the context is actually one,
2583 since folds require a line in between, also
2584 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585 See |fold-diff|.
2586
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002587 iblank Ignore changes where lines are all blank. Adds
2588 the "-B" flag to the "diff" command if
2589 'diffexpr' is empty. Check the documentation
2590 of the "diff" command for what this does
2591 exactly.
2592 NOTE: the diff windows will get out of sync,
2593 because no differences between blank lines are
2594 taken into account.
2595
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 icase Ignore changes in case of text. "a" and "A"
2597 are considered the same. Adds the "-i" flag
2598 to the "diff" command if 'diffexpr' is empty.
2599
2600 iwhite Ignore changes in amount of white space. Adds
2601 the "-b" flag to the "diff" command if
2602 'diffexpr' is empty. Check the documentation
2603 of the "diff" command for what this does
2604 exactly. It should ignore adding trailing
2605 white space, but not leading white space.
2606
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002607 iwhiteall Ignore all white space changes. Adds
2608 the "-w" flag to the "diff" command if
2609 'diffexpr' is empty. Check the documentation
2610 of the "diff" command for what this does
2611 exactly.
2612
2613 iwhiteeol Ignore white space changes at end of line.
2614 Adds the "-Z" flag to the "diff" command if
2615 'diffexpr' is empty. Check the documentation
2616 of the "diff" command for what this does
2617 exactly.
2618
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002619 horizontal Start diff mode with horizontal splits (unless
2620 explicitly specified otherwise).
2621
2622 vertical Start diff mode with vertical splits (unless
2623 explicitly specified otherwise).
2624
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002625 hiddenoff Do not use diff mode for a buffer when it
2626 becomes hidden.
2627
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002628 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2629 starting diff mode. Without this 2 is used.
2630
Bram Moolenaare828b762018-09-10 17:51:58 +02002631 internal Use the internal diff library. This is
2632 ignored when 'diffexpr' is set. *E960*
2633 When running out of memory when writing a
2634 buffer this item will be ignored for diffs
2635 involving that buffer. Set the 'verbose'
2636 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637
Bram Moolenaare828b762018-09-10 17:51:58 +02002638 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002639 Use the indent heuristic for the internal
2640 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002641
2642 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002643 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002644 algorithms are:
2645 myers the default algorithm
2646 minimal spend extra time to generate the
2647 smallest possible diff
2648 patience patience diff algorithm
2649 histogram histogram diff algorithm
2650
2651 Examples: >
2652 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002654 :set diffopt=internal,filler,foldcolumn:3
2655 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656<
2657 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2658'digraph' 'dg' boolean (default off)
2659 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002660 {not available when compiled without the |+digraphs|
2661 feature}
2662 Enable the entering of digraphs in Insert mode with {char1} <BS>
2663 {char2}. See |digraphs|.
2664 NOTE: This option is reset when 'compatible' is set.
2665
2666 *'directory'* *'dir'*
2667'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002668 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002669 for Unix: ".,~/tmp,/var/tmp,/tmp")
2670 global
2671 List of directory names for the swap file, separated with commas.
2672 - The swap file will be created in the first directory where this is
2673 possible.
2674 - Empty means that no swap file will be used (recovery is
2675 impossible!).
2676 - A directory "." means to put the swap file in the same directory as
2677 the edited file. On Unix, a dot is prepended to the file name, so
2678 it doesn't show in a directory listing. On MS-Windows the "hidden"
2679 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002680 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 put the swap file relative to where the edited file is. The leading
2682 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002683 - For Unix and Win32, if a directory ends in two path separators "//",
2684 the swap file name will be built from the complete path to the file
2685 with all path separators substituted to percent '%' signs. This will
2686 ensure file name uniqueness in the preserve directory.
2687 On Win32, it is also possible to end with "\\". However, When a
2688 separating comma is following, you must use "//", since "\\" will
2689 include the comma in the file name. Therefore it is recommended to
2690 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691 - Spaces after the comma are ignored, other spaces are considered part
2692 of the directory name. To have a space at the start of a directory
2693 name, precede it with a backslash.
2694 - To include a comma in a directory name precede it with a backslash.
2695 - A directory name may end in an ':' or '/'.
2696 - Environment variables are expanded |:set_env|.
2697 - Careful with '\' characters, type one before a space, type two to
2698 get one in the option (see |option-backslash|), for example: >
2699 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2700< - For backwards compatibility with Vim version 3.0 a '>' at the start
2701 of the option is removed.
2702 Using "." first in the list is recommended. This means that editing
2703 the same file twice will result in a warning. Using "/tmp" on Unix is
2704 discouraged: When the system crashes you lose the swap file.
2705 "/var/tmp" is often not cleared when rebooting, thus is a better
2706 choice than "/tmp". But it can contain a lot of files, your swap
2707 files get lost in the crowd. That is why a "tmp" directory in your
2708 home directory is tried first.
2709 The use of |:set+=| and |:set-=| is preferred when adding or removing
2710 directories from the list. This avoids problems when a future version
2711 uses another default.
2712 This option cannot be set from a |modeline| or in the |sandbox|, for
2713 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714
2715 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002716'display' 'dy' string (default "", set to "truncate" in
2717 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002719 Change the way text is displayed. This is comma separated list of
2720 flags:
2721 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002722 in a window will be displayed. "@@@" is put in the
2723 last columns of the last screen line to indicate the
2724 rest of the line is not displayed.
2725 truncate Like "lastline", but "@@@" is displayed in the first
2726 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 uhex Show unprintable characters hexadecimal as <xx>
2728 instead of using ^C and ~C.
2729
Bram Moolenaard0796902016-09-16 20:02:31 +02002730 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002731 doesn't fit is replaced with "@" lines.
2732
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 *'eadirection'* *'ead'*
2734'eadirection' 'ead' string (default "both")
2735 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 Tells when the 'equalalways' option applies:
2737 ver vertically, width of windows is not affected
2738 hor horizontally, height of windows is not affected
2739 both width and height of windows is affected
2740
2741 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2742'edcompatible' 'ed' boolean (default off)
2743 global
2744 Makes the 'g' and 'c' flags of the ":substitute" command to be
2745 toggled each time the flag is given. See |complex-change|. See
2746 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002747 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748
Bram Moolenaar03413f42016-04-12 21:07:15 +02002749 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002750'emoji' 'emo' boolean (default: on)
2751 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002752 When on all Unicode emoji characters are considered to be full width.
2753
2754
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755 *'encoding'* *'enc'* *E543*
2756'encoding' 'enc' string (default: "latin1" or value from $LANG)
2757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758 Sets the character encoding used inside Vim. It applies to text in
2759 the buffers, registers, Strings in expressions, text stored in the
2760 viminfo file, etc. It sets the kind of characters which Vim can work
2761 with. See |encoding-names| for the possible values.
2762
2763 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002764 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002766 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767
Bram Moolenaar865242e2010-07-14 21:12:05 +02002768 This option cannot be set from a |modeline|. It would most likely
2769 corrupt the text.
2770
Bram Moolenaar3df01732017-02-17 22:47:16 +01002771 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2772 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 'encoding', "utf-8" is the natural choice for the environment and
2774 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002775 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776 versions, and to avoid changing the encoding of newly created files
2777 without your knowledge (in case 'fileencodings' is empty).
2778
2779 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002780 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781 iconv() or as specified with 'charconvert'.
2782
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002783 If you need to know whether 'encoding' is a multi-byte encoding, you
2784 can use: >
2785 if has("multi_byte_encoding")
2786<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787 Normally 'encoding' will be equal to your current locale. This will
2788 be the default if Vim recognizes your environment settings. If
2789 'encoding' is not set to the current locale, 'termencoding' must be
2790 set to convert typed and displayed text. See |encoding-table|.
2791
2792 When you set this option, it fires the |EncodingChanged| autocommand
2793 event so that you can set up fonts if necessary.
2794
2795 When the option is set, the value is converted to lowercase. Thus
2796 you can set it with uppercase values too. Underscores are translated
2797 to '-' signs.
2798 When the encoding is recognized, it is changed to the standard name.
2799 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2800 "iso-8859-2" and "utf8" becomes "utf-8".
2801
2802 Note: "latin1" is also used when the encoding could not be detected.
2803 This only works when editing files in the same encoding! When the
2804 actual character set is not latin1, make sure 'fileencoding' and
2805 'fileencodings' are empty. When conversion is needed, switch to using
2806 utf-8.
2807
2808 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2809 You don't notice this while editing, but it does matter for the
2810 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2811 setting 'encoding' to one of these values instead of utf-8 only has
2812 effect for encoding used for files when 'fileencoding' is empty.
2813
Bram Moolenaar661b1822005-07-28 22:36:45 +00002814 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2815 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816
2817 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2818'endofline' 'eol' boolean (default on)
2819 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002821 is on, or 'fixeol' option is off, no <EOL> will be written for the
2822 last line in the file. This option is automatically set or reset when
2823 starting to edit a new file, depending on whether file has an <EOL>
2824 for the last line in the file. Normally you don't have to set or
2825 reset this option.
2826 When 'binary' is off and 'fixeol' is on the value is not used when
2827 writing the file. When 'binary' is on or 'fixeol' is off it is used
2828 to remember the presence of a <EOL> for the last line in the file, so
2829 that when you write the file the situation from the original file can
2830 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831
2832 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2833'equalalways' 'ea' boolean (default on)
2834 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002835 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002836 splitting or closing a window. This also happens the moment the
2837 option is switched on. When off, splitting a window will reduce the
2838 size of the current window and leave the other windows the same. When
2839 closing a window the extra lines are given to the window next to it
2840 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841 When mixing vertically and horizontally split windows, a minimal size
2842 is computed and some windows may be larger if there is room. The
2843 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002844 Changing the height and width of a window can be avoided by setting
2845 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002846 If a window size is specified when creating a new window sizes are
2847 currently not equalized (it's complicated, but may be implemented in
2848 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849
2850 *'equalprg'* *'ep'*
2851'equalprg' 'ep' string (default "")
2852 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002854 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002855 or 'indentexpr'. When Vim was compiled without internal formatting,
2856 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002857 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858 about including spaces and backslashes.
2859 This option cannot be set from a |modeline| or in the |sandbox|, for
2860 security reasons.
2861
2862 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2863'errorbells' 'eb' boolean (default off)
2864 global
2865 Ring the bell (beep or screen flash) for error messages. This only
2866 makes a difference for error messages, the bell will be used always
2867 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002868 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002869 screen flash or do nothing. See 'belloff' to finetune when to ring the
2870 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871
2872 *'errorfile'* *'ef'*
2873'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2874 others: "errors.err")
2875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 {not available when compiled without the |+quickfix|
2877 feature}
2878 Name of the errorfile for the QuickFix mode (see |:cf|).
2879 When the "-q" command-line argument is used, 'errorfile' is set to the
2880 following argument. See |-q|.
2881 NOT used for the ":make" command. See 'makeef' for that.
2882 Environment variables are expanded |:set_env|.
2883 See |option-backslash| about including spaces and backslashes.
2884 This option cannot be set from a |modeline| or in the |sandbox|, for
2885 security reasons.
2886
2887 *'errorformat'* *'efm'*
2888'errorformat' 'efm' string (default is very long)
2889 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890 {not available when compiled without the |+quickfix|
2891 feature}
2892 Scanf-like description of the format for the lines in the error file
2893 (see |errorformat|).
2894
2895 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2896'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2897 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 Function keys that start with an <Esc> are recognized in Insert
2899 mode. When this option is off, the cursor and function keys cannot be
2900 used in Insert mode if they start with an <Esc>. The advantage of
2901 this is that the single <Esc> is recognized immediately, instead of
2902 after one second. Instead of resetting this option, you might want to
2903 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2904 when 'esckeys' is off, you can still map anything, but the cursor keys
2905 won't work by default.
2906 NOTE: This option is set to the Vi default value when 'compatible' is
2907 set and to the Vim default value when 'compatible' is reset.
2908
2909 *'eventignore'* *'ei'*
2910'eventignore' 'ei' string (default "")
2911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002913 When set to "all" or when "all" is one of the items, all autocommand
2914 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915 Otherwise this is a comma separated list of event names. Example: >
2916 :set ei=WinEnter,WinLeave
2917<
2918 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2919'expandtab' 'et' boolean (default off)
2920 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002922 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2924 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002925 This option is reset when the 'paste' option is set and restored when
2926 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927 NOTE: This option is reset when 'compatible' is set.
2928
2929 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2930'exrc' 'ex' boolean (default off)
2931 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002932 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002933 directory.
2934
2935 Setting this option is a potential security leak. E.g., consider
2936 unpacking a package or fetching files from github, a .vimrc in there
2937 might be a trojan horse. BETTER NOT SET THIS OPTION!
2938 Instead, define an autocommand in your .vimrc to set options for a
2939 matching directory.
2940
2941 If you do switch this option on you should also consider setting the
2942 'secure' option (see |initialization|).
2943 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 This option cannot be set from a |modeline| or in the |sandbox|, for
2945 security reasons.
2946
2947 *'fileencoding'* *'fenc'* *E213*
2948'fileencoding' 'fenc' string (default: "")
2949 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002951
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002953 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 When 'fileencoding' is empty, the same value as 'encoding' will be
2955 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002956 No error will be given when the value is set, only when it is used,
2957 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002958 Conversion will also be done when 'encoding' and 'fileencoding' are
2959 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2960 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002962 'encoding' is "utf-8" or another Unicode encoding, conversion
2963 is most likely done in a way that the reverse conversion
2964 results in the same text. When 'encoding' is not "utf-8" some
2965 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002966
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 See 'encoding' for the possible values. Additionally, values may be
2968 specified that can be handled by the converter, see
2969 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002970
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 When reading a file 'fileencoding' will be set from 'fileencodings'.
2972 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002973 'fileencoding', use the |++enc| argument. One exception: when
2974 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002975 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002976
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2978 When the option is set, the value is converted to lowercase. Thus
2979 you can set it with uppercase values too. '_' characters are
2980 replaced with '-'. If a name is recognized from the list for
2981 'encoding', it is replaced by the standard name. For example
2982 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002983
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 When this option is set, after starting to edit a file, the 'modified'
2985 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002986
2987 Keep in mind that changing 'fenc' from a modeline happens
2988 AFTER the text has been read, thus it applies to when the file will be
2989 written. If you do set 'fenc' in a modeline, you might want to set
2990 'nomodified' to avoid not being able to ":q".
2991
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 This option can not be changed when 'modifiable' is off.
2993
2994 *'fe'*
2995 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002996 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997 old short name was 'fe', which is no longer used.
2998
2999 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003000'fileencodings' 'fencs' string (default: "ucs-bom",
3001 "ucs-bom,utf-8,default,latin1" when
3002 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 This is a list of character encodings considered when starting to edit
3005 an existing file. When a file is read, Vim tries to use the first
3006 mentioned character encoding. If an error is detected, the next one
3007 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003008 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 an empty string, which means the value of 'encoding' is used.
3010 WARNING: Conversion can cause loss of information! When
3011 'encoding' is "utf-8" (or one of the other Unicode variants)
3012 conversion is most likely done in a way that the reverse
3013 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003014 "utf-8" some non-ASCII characters may be lost! You can use
3015 the |++bad| argument to specify what is done with characters
3016 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 For an empty file or a file with only ASCII characters most encodings
3018 will work and the first entry of 'fileencodings' will be used (except
3019 "ucs-bom", which requires the BOM to be present). If you prefer
3020 another encoding use an BufReadPost autocommand event to test if your
3021 preferred encoding is to be used. Example: >
3022 au BufReadPost * if search('\S', 'w') == 0 |
3023 \ set fenc=iso-2022-jp | endif
3024< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3025 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003026 When the |++enc| argument is used then the value of 'fileencodings' is
3027 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003028 Note that 'fileencodings' is not used for a new file, the global value
3029 of 'fileencoding' is used instead. You can set it with: >
3030 :setglobal fenc=iso-8859-2
3031< This means that a non-existing file may get a different encoding than
3032 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 The special value "ucs-bom" can be used to check for a Unicode BOM
3034 (Byte Order Mark) at the start of the file. It must not be preceded
3035 by "utf-8" or another Unicode encoding for this to work properly.
3036 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3037 because Vim cannot detect an error, thus the encoding is always
3038 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003039 The special value "default" can be used for the encoding from the
3040 environment. This is the default value for 'encoding'. It is useful
3041 when 'encoding' is set to "utf-8" and your environment uses a
3042 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003043 When 'encoding' is "utf-8" and a file contains an illegal byte
3044 sequence it won't be recognized as UTF-8. You can use the |8g8|
3045 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 WRONG VALUES: WHAT'S WRONG:
3047 latin1,utf-8 "latin1" will always be used
3048 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3049 file
3050 cp1250,latin1 "cp1250" will always be used
3051 If 'fileencodings' is empty, 'fileencoding' is not modified.
3052 See 'fileencoding' for the possible values.
3053 Setting this option does not have an effect until the next time a file
3054 is read.
3055
3056 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003057'fileformat' 'ff' string (MS-Windows default: "dos",
3058 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003059 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 This gives the <EOL> of the current buffer, which is used for
3061 reading/writing the buffer from/to a file:
3062 dos <CR> <NL>
3063 unix <NL>
3064 mac <CR>
3065 When "dos" is used, CTRL-Z at the end of a file is ignored.
3066 See |file-formats| and |file-read|.
3067 For the character encoding of the file see 'fileencoding'.
3068 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003069 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070 This option is set automatically when starting to edit a file and
3071 'fileformats' is not empty and 'binary' is off.
3072 When this option is set, after starting to edit a file, the 'modified'
3073 option is set, because the file would be different when written.
3074 This option can not be changed when 'modifiable' is off.
3075 For backwards compatibility: When this option is set to "dos",
3076 'textmode' is set, otherwise 'textmode' is reset.
3077
3078 *'fileformats'* *'ffs'*
3079'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003080 Vim+Vi MS-Windows: "dos,unix",
3081 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082 Vi Cygwin: "unix,dos",
3083 Vi others: "")
3084 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 This gives the end-of-line (<EOL>) formats that will be tried when
3086 starting to edit a new buffer and when reading a file into an existing
3087 buffer:
3088 - When empty, the format defined with 'fileformat' will be used
3089 always. It is not set automatically.
3090 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003091 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003092 'fileformats' name will be used when a file is read into an existing
3093 buffer, no matter what 'fileformat' for that buffer is set to.
3094 - When more than one name is present, separated by commas, automatic
3095 <EOL> detection will be done when reading a file. When starting to
3096 edit a file, a check is done for the <EOL>:
3097 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3098 'fileformat' is set to "dos".
3099 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003100 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003102 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3103 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003104 This means that "mac" is only chosen when:
3105 "unix" is not present or no <NL> is found in the file, and
3106 "dos" is not present or no <CR><NL> is found in the file.
3107 Except: if "unix" was chosen, but there is a <CR> before
3108 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003109 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 4. If 'fileformat' is still not set, the first name from
3111 'fileformats' is used.
3112 When reading a file into an existing buffer, the same is done, but
3113 this happens like 'fileformat' has been set appropriately for that
3114 file only, the option is not changed.
3115 When 'binary' is set, the value of 'fileformats' is not used.
3116
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003117 When Vim starts up with an empty buffer the first item is used. You
3118 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003119
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3121 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3122 done:
3123 - When 'fileformats' is empty, there is no automatic detection. Dos
3124 format will be used.
3125 - When 'fileformats' is set to one or more names, automatic detection
3126 is done. This is based on the first <NL> in the file: If there is a
3127 <CR> in front of it, Dos format is used, otherwise Unix format is
3128 used.
3129 Also see |file-formats|.
3130 For backwards compatibility: When this option is set to an empty
3131 string or one format (no comma is included), 'textauto' is reset,
3132 otherwise 'textauto' is set.
3133 NOTE: This option is set to the Vi default value when 'compatible' is
3134 set and to the Vim default value when 'compatible' is reset.
3135
Bram Moolenaarbf884932013-04-05 22:26:15 +02003136 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3137'fileignorecase' 'fic' boolean (default on for systems where case in file
3138 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003139 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003140 When set case is ignored when using file names and directories.
3141 See 'wildignorecase' for only ignoring case when doing completion.
3142
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 *'filetype'* *'ft'*
3144'filetype' 'ft' string (default: "")
3145 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 When this option is set, the FileType autocommand event is triggered.
3147 All autocommands that match with the value of this option will be
3148 executed. Thus the value of 'filetype' is used in place of the file
3149 name.
3150 Otherwise this option does not always reflect the current file type.
3151 This option is normally set when the file type is detected. To enable
3152 this use the ":filetype on" command. |:filetype|
3153 Setting this option to a different value is most useful in a modeline,
3154 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003155 Example, for in an IDL file:
3156 /* vim: set filetype=idl : */ ~
3157 |FileType| |filetypes|
3158 When a dot appears in the value then this separates two filetype
3159 names. Example:
3160 /* vim: set filetype=c.doxygen : */ ~
3161 This will use the "c" filetype first, then the "doxygen" filetype.
3162 This works both for filetype plugins and for syntax files. More than
3163 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 This option is not copied to another buffer, independent of the 's' or
3165 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003166 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167
3168 *'fillchars'* *'fcs'*
3169'fillchars' 'fcs' string (default "vert:|,fold:-")
3170 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003171 {not available when compiled without the |+folding|
3172 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 Characters to fill the statuslines and vertical separators.
3174 It is a comma separated list of items:
3175
3176 item default Used for ~
3177 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003178 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 vert:c '|' vertical separators |:vsplit|
3180 fold:c '-' filling 'foldtext'
3181 diff:c '-' deleted lines of the 'diff' option
3182
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003183 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003184 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 otherwise.
3186
3187 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003188 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189< This is similar to the default, except that these characters will also
3190 be used when there is highlighting.
3191
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003192 for "stl" and "stlnc" only single-byte values are supported.
3193
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 The highlighting used for these items:
3195 item highlight group ~
3196 stl:c StatusLine |hl-StatusLine|
3197 stlnc:c StatusLineNC |hl-StatusLineNC|
3198 vert:c VertSplit |hl-VertSplit|
3199 fold:c Folded |hl-Folded|
3200 diff:c DiffDelete |hl-DiffDelete|
3201
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003202 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3203'fixendofline' 'fixeol' boolean (default on)
3204 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003205 When writing a file and this option is on, <EOL> at the end of file
3206 will be restored if missing. Turn this option off if you want to
3207 preserve the situation from the original file.
3208 When the 'binary' option is set the value of this option doesn't
3209 matter.
3210 See the 'endofline' option.
3211
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3213'fkmap' 'fk' boolean (default off) *E198*
3214 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 {only available when compiled with the |+rightleft|
3216 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003217 This option was for using Farsi, which has been removed. See
3218 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219
3220 *'foldclose'* *'fcl'*
3221'foldclose' 'fcl' string (default "")
3222 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 {not available when compiled without the |+folding|
3224 feature}
3225 When set to "all", a fold is closed when the cursor isn't in it and
3226 its level is higher than 'foldlevel'. Useful if you want folds to
3227 automatically close when moving out of them.
3228
3229 *'foldcolumn'* *'fdc'*
3230'foldcolumn' 'fdc' number (default 0)
3231 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 {not available when compiled without the |+folding|
3233 feature}
3234 When non-zero, a column with the specified width is shown at the side
3235 of the window which indicates open and closed folds. The maximum
3236 value is 12.
3237 See |folding|.
3238
3239 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3240'foldenable' 'fen' boolean (default on)
3241 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 {not available when compiled without the |+folding|
3243 feature}
3244 When off, all folds are open. This option can be used to quickly
3245 switch between showing all text unfolded and viewing the text with
3246 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003247 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 'foldenable' is off.
3249 This option is set by commands that create a new fold or close a fold.
3250 See |folding|.
3251
3252 *'foldexpr'* *'fde'*
3253'foldexpr' 'fde' string (default: "0")
3254 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003256 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003258 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003259
Bram Moolenaar30b65812012-07-12 22:01:11 +02003260 The expression will be evaluated in the |sandbox| if set from a
3261 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003262 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003263 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003264
3265 It is not allowed to change text or jump to another window while
3266 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267
3268 *'foldignore'* *'fdi'*
3269'foldignore' 'fdi' string (default: "#")
3270 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 {not available when compiled without the |+folding|
3272 feature}
3273 Used only when 'foldmethod' is "indent". Lines starting with
3274 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003275 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 The default "#" works well for C programs. See |fold-indent|.
3277
3278 *'foldlevel'* *'fdl'*
3279'foldlevel' 'fdl' number (default: 0)
3280 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 {not available when compiled without the |+folding|
3282 feature}
3283 Sets the fold level: Folds with a higher level will be closed.
3284 Setting this option to zero will close all folds. Higher numbers will
3285 close fewer folds.
3286 This option is set by commands like |zm|, |zM| and |zR|.
3287 See |fold-foldlevel|.
3288
3289 *'foldlevelstart'* *'fdls'*
3290'foldlevelstart' 'fdls' number (default: -1)
3291 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292 {not available when compiled without the |+folding|
3293 feature}
3294 Sets 'foldlevel' when starting to edit another buffer in a window.
3295 Useful to always start editing with all folds closed (value zero),
3296 some folds closed (one) or no folds closed (99).
3297 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003298 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 ignores this option and closes all folds.
3300 It is also done before BufReadPre autocommands, to allow an autocmd to
3301 overrule the 'foldlevel' value for specific files.
3302 When the value is negative, it is not used.
3303
3304 *'foldmarker'* *'fmr'* *E536*
3305'foldmarker' 'fmr' string (default: "{{{,}}}")
3306 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 {not available when compiled without the |+folding|
3308 feature}
3309 The start and end marker used when 'foldmethod' is "marker". There
3310 must be one comma, which separates the start and end marker. The
3311 marker is a literal string (a regular expression would be too slow).
3312 See |fold-marker|.
3313
3314 *'foldmethod'* *'fdm'*
3315'foldmethod' 'fdm' string (default: "manual")
3316 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 {not available when compiled without the |+folding|
3318 feature}
3319 The kind of folding used for the current window. Possible values:
3320 |fold-manual| manual Folds are created manually.
3321 |fold-indent| indent Lines with equal indent form a fold.
3322 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3323 |fold-marker| marker Markers are used to specify folds.
3324 |fold-syntax| syntax Syntax highlighting items specify folds.
3325 |fold-diff| diff Fold text that is not changed.
3326
3327 *'foldminlines'* *'fml'*
3328'foldminlines' 'fml' number (default: 1)
3329 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 {not available when compiled without the |+folding|
3331 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003332 Sets the number of screen lines above which a fold can be displayed
3333 closed. Also for manually closed folds. With the default value of
3334 one a fold can only be closed if it takes up two or more screen lines.
3335 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003336 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 "zc" to close a fold, which is displayed open because it's smaller
3338 than 'foldminlines', a following "zc" may close a containing fold.
3339
3340 *'foldnestmax'* *'fdn'*
3341'foldnestmax' 'fdn' number (default: 20)
3342 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343 {not available when compiled without the |+folding|
3344 feature}
3345 Sets the maximum nesting of folds for the "indent" and "syntax"
3346 methods. This avoids that too many folds will be created. Using more
3347 than 20 doesn't work, because the internal limit is 20.
3348
3349 *'foldopen'* *'fdo'*
3350'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3351 search,tag,undo")
3352 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 {not available when compiled without the |+folding|
3354 feature}
3355 Specifies for which type of commands folds will be opened, if the
3356 command moves the cursor into a closed fold. It is a comma separated
3357 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003358 NOTE: When the command is part of a mapping this option is not used.
3359 Add the |zv| command to the mapping to get the same effect.
3360 (rationale: the mapping may want to control opening folds itself)
3361
Bram Moolenaar071d4272004-06-13 20:20:40 +00003362 item commands ~
3363 all any
3364 block "(", "{", "[[", "[{", etc.
3365 hor horizontal movements: "l", "w", "fx", etc.
3366 insert any command in Insert mode
3367 jump far jumps: "G", "gg", etc.
3368 mark jumping to a mark: "'m", CTRL-O, etc.
3369 percent "%"
3370 quickfix ":cn", ":crew", ":make", etc.
3371 search search for a pattern: "/", "n", "*", "gd", etc.
3372 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003373 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 tag jumping to a tag: ":ta", CTRL-T, etc.
3375 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 When a movement command is used for an operator (e.g., "dl" or "y%")
3377 this option is not used. This means the operator will include the
3378 whole closed fold.
3379 Note that vertical movements are not here, because it would make it
3380 very difficult to move onto a closed fold.
3381 In insert mode the folds containing the cursor will always be open
3382 when text is inserted.
3383 To close folds you can re-apply 'foldlevel' with the |zx| command or
3384 set the 'foldclose' option to "all".
3385
3386 *'foldtext'* *'fdt'*
3387'foldtext' 'fdt' string (default: "foldtext()")
3388 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389 {not available when compiled without the |+folding|
3390 feature}
3391 An expression which is used to specify the text displayed for a closed
3392 fold. See |fold-foldtext|.
3393
Bram Moolenaar30b65812012-07-12 22:01:11 +02003394 The expression will be evaluated in the |sandbox| if set from a
3395 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003396 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003397
3398 It is not allowed to change text or jump to another window while
3399 evaluating 'foldtext' |textlock|.
3400
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003401 *'formatexpr'* *'fex'*
3402'formatexpr' 'fex' string (default "")
3403 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003404 {not available when compiled without the |+eval|
3405 feature}
3406 Expression which is evaluated to format a range of lines for the |gq|
3407 operator or automatic formatting (see 'formatoptions'). When this
3408 option is empty 'formatprg' is used.
3409
3410 The |v:lnum| variable holds the first line to be formatted.
3411 The |v:count| variable holds the number of lines to be formatted.
3412 The |v:char| variable holds the character that is going to be
3413 inserted if the expression is being evaluated due to
3414 automatic formatting. This can be empty. Don't insert
3415 it yet!
3416
3417 Example: >
3418 :set formatexpr=mylang#Format()
3419< This will invoke the mylang#Format() function in the
3420 autoload/mylang.vim file in 'runtimepath'. |autoload|
3421
3422 The expression is also evaluated when 'textwidth' is set and adding
3423 text beyond that limit. This happens under the same conditions as
3424 when internal formatting is used. Make sure the cursor is kept in the
3425 same spot relative to the text then! The |mode()| function will
3426 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003427
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003428 When the expression evaluates to non-zero Vim will fall back to using
3429 the internal format mechanism.
3430
3431 The expression will be evaluated in the |sandbox| when set from a
3432 modeline, see |sandbox-option|. That stops the option from working,
3433 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003434 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003435 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003436
Bram Moolenaar86b68352004-12-27 21:59:20 +00003437 *'formatlistpat'* *'flp'*
3438'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3439 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003440 A pattern that is used to recognize a list header. This is used for
3441 the "n" flag in 'formatoptions'.
3442 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003443 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003444 while still checking more characters. There must be a character
3445 following the pattern, when it matches the whole line it is handled
3446 like there is no match.
3447 The default recognizes a number, followed by an optional punctuation
3448 character and white space.
3449
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003450 *'formatoptions'* *'fo'*
3451'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3452 local to buffer
3453 This is a sequence of letters which describes how automatic
3454 formatting is to be done. See |fo-table|. When the 'paste' option is
3455 on, no formatting is done (like 'formatoptions' is empty). Commas can
3456 be inserted for readability.
3457 To avoid problems with flags that are added in the future, use the
3458 "+=" and "-=" feature of ":set" |add-option-flags|.
3459 NOTE: This option is set to the Vi default value when 'compatible' is
3460 set and to the Vim default value when 'compatible' is reset.
3461
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462 *'formatprg'* *'fp'*
3463'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003464 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003466 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003468 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003469 If the 'formatexpr' option is not empty it will be used instead.
3470 Otherwise, if 'formatprg' option is an empty string, the internal
3471 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003472 Environment variables are expanded |:set_env|. See |option-backslash|
3473 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003474 This option cannot be set from a |modeline| or in the |sandbox|, for
3475 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476
Bram Moolenaard94464e2015-11-02 15:28:18 +01003477 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003478'fsync' 'fs' boolean (default on)
3479 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003480 When on, the library function fsync() will be called after writing a
3481 file. This will flush a file to disk, ensuring that it is safely
3482 written even on filesystems which do metadata-only journaling. This
3483 will force the harddrive to spin up on Linux systems running in laptop
3484 mode, so it may be undesirable in some situations. Be warned that
3485 turning this off increases the chances of data loss after a crash. On
3486 systems without an fsync() implementation, this variable is always
3487 off.
3488 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003489 'fsync' also applies to |writefile()|, unless a flag is used to
3490 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003491 This option cannot be set from a |modeline| or in the |sandbox|, for
3492 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003493
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3495'gdefault' 'gd' boolean (default off)
3496 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 When on, the ":substitute" flag 'g' is default on. This means that
3498 all matches in a line are substituted instead of one. When a 'g' flag
3499 is given to a ":substitute" command, this will toggle the substitution
3500 of all or one match. See |complex-change|.
3501
3502 command 'gdefault' on 'gdefault' off ~
3503 :s/// subst. all subst. one
3504 :s///g subst. one subst. all
3505 :s///gg subst. all subst. one
3506
3507 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003508 DEPRECATED: Setting this option may break plugins that are not aware
3509 of this option. Also, many users get confused that adding the /g flag
3510 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511
3512 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003513'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 Format to recognize for the ":grep" command output.
3516 This is a scanf-like string that uses the same format as the
3517 'errorformat' option: see |errorformat|.
3518
3519 *'grepprg'* *'gp'*
3520'grepprg' 'gp' string (default "grep -n ",
3521 Unix: "grep -n $* /dev/null",
3522 Win32: "findstr /n" or "grep -n",
3523 VMS: "SEARCH/NUMBERS ")
3524 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003525 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 and '#' characters, which are expanded like when used in a command-
3527 line. The placeholder "$*" is allowed to specify where the arguments
3528 will be included. Environment variables are expanded |:set_env|. See
3529 |option-backslash| about including spaces and backslashes.
3530 When your "grep" accepts the "-H" argument, use this to make ":grep"
3531 also work well with a single file: >
3532 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003533< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003534 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3535 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003536 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537 apply equally to 'grepprg'.
3538 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3539 otherwise it's "grep -n".
3540 This option cannot be set from a |modeline| or in the |sandbox|, for
3541 security reasons.
3542
3543 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3544'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3545 ve:ver35-Cursor,
3546 o:hor50-Cursor,
3547 i-ci:ver25-Cursor/lCursor,
3548 r-cr:hor20-Cursor/lCursor,
3549 sm:block-Cursor
3550 -blinkwait175-blinkoff150-blinkon175",
3551 for MS-DOS and Win32 console:
3552 "n-v-c:block,o:hor50,i-ci:hor15,
3553 r-cr:hor30,sm:block")
3554 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 {only available when compiled with GUI enabled, and
3556 for MS-DOS and Win32 console}
3557 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003558 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559 the height of the cursor can be changed. This can be done by
3560 specifying a block cursor, or a percentage for a vertical or
3561 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003562 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3563 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003565 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 mode-list and an argument-list:
3567 mode-list:argument-list,mode-list:argument-list,..
3568 The mode-list is a dash separated list of these modes:
3569 n Normal mode
3570 v Visual mode
3571 ve Visual mode with 'selection' "exclusive" (same as 'v',
3572 if not specified)
3573 o Operator-pending mode
3574 i Insert mode
3575 r Replace mode
3576 c Command-line Normal (append) mode
3577 ci Command-line Insert mode
3578 cr Command-line Replace mode
3579 sm showmatch in Insert mode
3580 a all modes
3581 The argument-list is a dash separated list of these arguments:
3582 hor{N} horizontal bar, {N} percent of the character height
3583 ver{N} vertical bar, {N} percent of the character width
3584 block block cursor, fills the whole character
3585 [only one of the above three should be present]
3586 blinkwait{N} *cursor-blinking*
3587 blinkon{N}
3588 blinkoff{N}
3589 blink times for cursor: blinkwait is the delay before
3590 the cursor starts blinking, blinkon is the time that
3591 the cursor is shown and blinkoff is the time that the
3592 cursor is not shown. The times are in msec. When one
3593 of the numbers is zero, there is no blinking. The
3594 default is: "blinkwait700-blinkon400-blinkoff250".
3595 These numbers are used for a missing entry. This
3596 means that blinking is enabled by default. To switch
3597 blinking off you can use "blinkon0". The cursor only
3598 blinks when Vim is waiting for input, not while
3599 executing a command.
3600 To make the cursor blink in an xterm, see
3601 |xterm-blink|.
3602 {group-name}
3603 a highlight group name, that sets the color and font
3604 for the cursor
3605 {group-name}/{group-name}
3606 Two highlight group names, the first is used when
3607 no language mappings are used, the other when they
3608 are. |language-mapping|
3609
3610 Examples of parts:
3611 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3612 block cursor with colors from the "nCursor"
3613 highlight group
3614 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3615 In Insert and Command-line Insert mode, use a
3616 30% vertical bar cursor with colors from the
3617 "iCursor" highlight group. Blink a bit
3618 faster.
3619
3620 The 'a' mode is different. It will set the given argument-list for
3621 all modes. It does not reset anything to defaults. This can be used
3622 to do a common setting for all modes. For example, to switch off
3623 blinking: "a:blinkon0"
3624
3625 Examples of cursor highlighting: >
3626 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3627 :highlight Cursor gui=NONE guifg=bg guibg=fg
3628<
3629 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003630 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631'guifont' 'gfn' string (default "")
3632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633 {only available when compiled with GUI enabled}
3634 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003635 In its simplest form the value is just one font name.
3636 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637
3638 *'guifontset'* *'gfs'*
3639 *E250* *E252* *E234* *E597* *E598*
3640'guifontset' 'gfs' string (default "")
3641 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 {only available when compiled with GUI enabled and
3643 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003644 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 When not empty, specifies two (or more) fonts to be used. The first
3646 one for normal English, the second one for your special language. See
3647 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003648
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3650'guifontwide' 'gfw' string (default "")
3651 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652 {only available when compiled with GUI enabled}
3653 When not empty, specifies a comma-separated list of fonts to be used
3654 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003655 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003656
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657 *'guiheadroom'* *'ghr'*
3658'guiheadroom' 'ghr' number (default 50)
3659 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003660 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 The number of pixels subtracted from the screen height when fitting
3662 the GUI window on the screen. Set this before the GUI is started,
3663 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003664 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 lines will be left for window decorations and other items on the
3666 screen. Set it to a negative value to allow windows taller than the
3667 screen.
3668
3669 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003670'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3671 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003672 "aegimrLtT" (GTK, Motif and Athena),
3673 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003676 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 sequence of letters which describes what components and options of the
3678 GUI should be used.
3679 To avoid problems with flags that are added in the future, use the
3680 "+=" and "-=" feature of ":set" |add-option-flags|.
3681
Bram Moolenaar13568252018-03-16 20:46:58 +01003682 Valid characters are as follows:
3683 *'go-!'*
3684 '!' External commands are executed in a terminal window. Without
3685 this flag the MS-Windows GUI will open a console window to
3686 execute the command. The Unix GUI will simulate a dumb
3687 terminal to list the command output.
3688 The terminal window will be positioned at the bottom, and grow
3689 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003690 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 'a' Autoselect: If present, then whenever VISUAL mode is started,
3692 or the Visual area extended, Vim tries to become the owner of
3693 the windowing system's global selection. This means that the
3694 Visually highlighted text is available for pasting into other
3695 applications as well as into Vim itself. When the Visual mode
3696 ends, possibly due to an operation on the text, or when an
3697 application wants to paste the selection, the highlighted text
3698 is automatically yanked into the "* selection register.
3699 Thus the selection is still available for pasting into other
3700 applications after the VISUAL mode has ended.
3701 If not present, then Vim won't become the owner of the
3702 windowing system's global selection unless explicitly told to
3703 by a yank or delete operation for the "* register.
3704 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003705 *'go-P'*
3706 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003707 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003708 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003709 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 applies to the modeless selection.
3711
3712 'guioptions' autoselect Visual autoselect modeless ~
3713 "" - -
3714 "a" yes yes
3715 "A" - yes
3716 "aA" yes yes
3717
Bram Moolenaar02467872007-05-06 13:22:01 +00003718 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 'c' Use console dialogs instead of popup dialogs for simple
3720 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003721 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003722 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003723 'guitablabel' can be used to change the text in the labels.
3724 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003725 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003726 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003727 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728 'f' Foreground: Don't use fork() to detach the GUI from the shell
3729 where it was started. Use this for programs that wait for the
3730 editor to finish (e.g., an e-mail program). Alternatively you
3731 can use "gvim -f" or ":gui -f" to start the GUI in the
3732 foreground. |gui-fork|
3733 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003734 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003735 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3737 corner of the window. It's black&white on non-GTK, because of
3738 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003739 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003741 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003742 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003744 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003746 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003747 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 'g' Grey menu items: Make menu items that are not active grey. If
3749 'g' is not included inactive menu items are not shown at all.
3750 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003751 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 't' Include tearoff menu items. Currently only works for Win32,
3753 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003754 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003755 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003756 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003757 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003759 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 'R' Right-hand scrollbar is present when there is a vertically
3761 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003762 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003764 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 'L' Left-hand scrollbar is present when there is a vertically
3766 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003767 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3769 the longest visible line, or on the cursor line if the 'h'
3770 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003771 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 'h' Limit horizontal scrollbar size to the length of the cursor
3773 line. Reduces computations. |gui-horiz-scroll|
3774
3775 And yes, you may even have scrollbars on the left AND the right if
3776 you really want to :-). See |gui-scrollbars| for more information.
3777
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003778 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 'v' Use a vertical button layout for dialogs. When not included,
3780 a horizontal layout is preferred, but when it doesn't fit a
3781 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003782 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 'p' Use Pointer callbacks for X11 GUI. This is required for some
3784 window managers. If the cursor is not blinking or hollow at
3785 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003786 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003788 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003789 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003790 *'go-k'*
3791 'k' Keep the GUI window size when adding/removing a scrollbar, or
3792 toolbar, tabline, etc. Instead, the behavior is similar to
3793 when the window is maximized and will adjust 'lines' and
3794 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003795 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003796 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003797
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 *'guipty'* *'noguipty'*
3799'guipty' boolean (default on)
3800 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801 {only available when compiled with GUI enabled}
3802 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3803 I/O to/from shell commands. See |gui-pty|.
3804
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003805 *'guitablabel'* *'gtl'*
3806'guitablabel' 'gtl' string (default empty)
3807 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003808 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003809 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003810 pages line. When empty and when the result is empty Vim will use a
3811 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003812
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003813 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003814 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003815 The expression will be evaluated in the |sandbox| when set from a
3816 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003817 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003818
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003819 Only used when the GUI tab pages line is displayed. 'e' must be
3820 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3821 used.
3822
Bram Moolenaar57657d82006-04-21 22:12:41 +00003823 *'guitabtooltip'* *'gtt'*
3824'guitabtooltip' 'gtt' string (default empty)
3825 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003826 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003827 When nonempty describes the text to use in a tooltip for the GUI tab
3828 pages line. When empty Vim will use a default tooltip.
3829 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003830 You can include a line break. Simplest method is to use |:let|: >
3831 :let &guitabtooltip = "line one\nline two"
3832<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003833
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 *'helpfile'* *'hf'*
3835'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3836 (others) "$VIMRUNTIME/doc/help.txt")
3837 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 Name of the main help file. All distributed help files should be
3839 placed together in one directory. Additionally, all "doc" directories
3840 in 'runtimepath' will be used.
3841 Environment variables are expanded |:set_env|. For example:
3842 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003843 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844 spaces and backslashes.
3845 This option cannot be set from a |modeline| or in the |sandbox|, for
3846 security reasons.
3847
3848 *'helpheight'* *'hh'*
3849'helpheight' 'hh' number (default 20)
3850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 Minimal initial height of the help window when it is opened with the
3852 ":help" command. The initial height of the help window is half of the
3853 current window, or (when the 'ea' option is on) the same as other
3854 windows. When the height is less than 'helpheight', the height is
3855 set to 'helpheight'. Set to zero to disable.
3856
3857 *'helplang'* *'hlg'*
3858'helplang' 'hlg' string (default: messages language or empty)
3859 global
3860 {only available when compiled with the |+multi_lang|
3861 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862 Comma separated list of languages. Vim will use the first language
3863 for which the desired help can be found. The English help will always
3864 be used as a last resort. You can add "en" to prefer English over
3865 another language, but that will only find tags that exist in that
3866 language and not in the English help.
3867 Example: >
3868 :set helplang=de,it
3869< This will first search German, then Italian and finally English help
3870 files.
3871 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3872 try to find the tag in the current language before using this option.
3873 See |help-translated|.
3874
3875 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3876'hidden' 'hid' boolean (default off)
3877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 When off a buffer is unloaded when it is |abandon|ed. When on a
3879 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3880 displayed in another window, it does not become hidden, of course.
3881 The commands that move through the buffer list sometimes make a buffer
3882 hidden although the 'hidden' option is off: When the buffer is
3883 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003884 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003885 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 This option is set for one command with ":hide {command}" |:hide|.
3887 WARNING: It's easy to forget that you have changes in hidden buffers.
3888 Think twice when using ":q!" or ":qa!".
3889
3890 *'highlight'* *'hl'*
3891'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003892 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3893 d:Directory,e:ErrorMsg,i:IncSearch,
3894 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
3895 N:CursorLineNr,r:Question,s:StatusLine,
3896 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003897 v:Visual,V:VisualNOS,w:WarningMsg,
3898 W:WildMenu,f:Folded,F:FoldColumn,
3899 A:DiffAdd,C:DiffChange,D:DiffDelete,
3900 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003901 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003902 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003903 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3904 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003905 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003906 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 This option can be used to set highlighting mode for various
3909 occasions. It is a comma separated list of character pairs. The
3910 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003911 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003913 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3914 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 characters from 'showbreak'
3916 |hl-Directory| d directories in CTRL-D listing and other special
3917 things in listings
3918 |hl-ErrorMsg| e error messages
3919 h (obsolete, ignored)
3920 |hl-IncSearch| i 'incsearch' highlighting
3921 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3922 |hl-MoreMsg| m |more-prompt|
3923 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003924 |hl-LineNr| n line number for ":number" and ":#" commands, and
3925 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003926 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3927 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003928 |hl-Question| r |hit-enter| prompt and yes/no questions
3929 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003930 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3932 |hl-VertSplit| c column used to separate vertically split windows
3933 |hl-Visual| v Visual mode
3934 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3935 Selection" Only X11 Gui's |gui-x11| and
3936 |xterm-clipboard|.
3937 |hl-WarningMsg| w warning messages
3938 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3939 |hl-Folded| f line used for closed folds
3940 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003941 |hl-DiffAdd| A added line in diff mode
3942 |hl-DiffChange| C changed line in diff mode
3943 |hl-DiffDelete| D deleted line in diff mode
3944 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003946 |hl-Conceal| - the placeholders used for concealed characters
3947 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00003948 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003949 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003950 |hl-SpellRare| R rare word |spell|
3951 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003952 |hl-Pmenu| + popup menu normal line
3953 |hl-PmenuSel| = popup menu selected line
3954 |hl-PmenuSbar| x popup menu scrollbar
3955 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956
3957 The display modes are:
3958 r reverse (termcap entry "mr" and "me")
3959 i italic (termcap entry "ZH" and "ZR")
3960 b bold (termcap entry "md" and "me")
3961 s standout (termcap entry "so" and "se")
3962 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003963 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02003964 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 n no highlighting
3966 - no highlighting
3967 : use a highlight group
3968 The default is used for occasions that are not included.
3969 If you want to change what the display modes do, see |dos-colors|
3970 for an example.
3971 When using the ':' display mode, this must be followed by the name of
3972 a highlight group. A highlight group can be used to define any type
3973 of highlighting, including using color. See |:highlight| on how to
3974 define one. The default uses a different group for each occasion.
3975 See |highlight-default| for the default highlight groups.
3976
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003978'history' 'hi' number (Vim default: 50, Vi default: 0,
3979 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003982 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003984 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 NOTE: This option is set to the Vi default value when 'compatible' is
3986 set and to the Vim default value when 'compatible' is reset.
3987
3988 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3989'hkmap' 'hk' boolean (default off)
3990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 {only available when compiled with the |+rightleft|
3992 feature}
3993 When on, the keyboard is mapped for the Hebrew character set.
3994 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3995 toggle this option. See |rileft.txt|.
3996 NOTE: This option is reset when 'compatible' is set.
3997
3998 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3999'hkmapp' 'hkp' boolean (default off)
4000 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 {only available when compiled with the |+rightleft|
4002 feature}
4003 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4004 This is useful if you have a non-Hebrew keyboard.
4005 See |rileft.txt|.
4006 NOTE: This option is reset when 'compatible' is set.
4007
Bram Moolenaar036986f2017-03-16 17:41:02 +01004008 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4009'hlsearch' 'hls' boolean (default off)
4010 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004011 {not available when compiled without the
4012 |+extra_search| feature}
4013 When there is a previous search pattern, highlight all its matches.
4014 The type of highlighting used can be set with the 'l' occasion in the
4015 'highlight' option. This uses the "Search" highlight group by
4016 default. Note that only the matching text is highlighted, any offsets
4017 are not applied.
4018 See also: 'incsearch' and |:match|.
4019 When you get bored looking at the highlighted matches, you can turn it
4020 off with |:nohlsearch|. This does not change the option value, as
4021 soon as you use a search command, the highlighting comes back.
4022 'redrawtime' specifies the maximum time spent on finding matches.
4023 When the search pattern can match an end-of-line, Vim will try to
4024 highlight all of the matched text. However, this depends on where the
4025 search starts. This will be the first line in the window or the first
4026 line below a closed fold. A match in a previous line which is not
4027 drawn may not continue in a newly drawn line.
4028 You can specify whether the highlight status is restored on startup
4029 with the 'h' flag in 'viminfo' |viminfo-h|.
4030 NOTE: This option is reset when 'compatible' is set.
4031
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 *'icon'* *'noicon'*
4033'icon' boolean (default off, on when title can be restored)
4034 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 {not available when compiled without the |+title|
4036 feature}
4037 When on, the icon text of the window will be set to the value of
4038 'iconstring' (if it is not empty), or to the name of the file
4039 currently being edited. Only the last part of the name is used.
4040 Overridden by the 'iconstring' option.
4041 Only works if the terminal supports setting window icons (currently
4042 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4043 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4044 builtin termcap).
4045 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004046 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004048 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004049
4050 *'iconstring'*
4051'iconstring' string (default "")
4052 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 {not available when compiled without the |+title|
4054 feature}
4055 When this option is not empty, it will be used for the icon text of
4056 the window. This happens only when the 'icon' option is on.
4057 Only works if the terminal supports setting window icon text
4058 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4059 Does not work for MS Windows.
4060 When Vim was compiled with HAVE_X11 defined, the original icon will be
4061 restored if possible |X11|.
4062 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004063 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004064 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004065 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 {not available when compiled without the |+statusline| feature}
4067
4068 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4069'ignorecase' 'ic' boolean (default off)
4070 global
4071 Ignore case in search patterns. Also used when searching in the tags
4072 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004073 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004074 Can be overruled by using "\c" or "\C" in the pattern, see
4075 |/ignorecase|.
4076
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004077 *'imactivatefunc'* *'imaf'*
4078'imactivatefunc' 'imaf' string (default "")
4079 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004080 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004081 activate or deactivate the Input Method.
4082 It is not used in the GUI.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004083 The expression will be evaluated in the |sandbox| when set from a
4084 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004085
4086 Example: >
4087 function ImActivateFunc(active)
4088 if a:active
4089 ... do something
4090 else
4091 ... do something
4092 endif
4093 " return value is not used
4094 endfunction
4095 set imactivatefunc=ImActivateFunc
4096<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 *'imactivatekey'* *'imak'*
4098'imactivatekey' 'imak' string (default "")
4099 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004101 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 Specifies the key that your Input Method in X-Windows uses for
4103 activation. When this is specified correctly, vim can fully control
4104 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4105 You can't use this option to change the activation key, the option
4106 tells Vim what the key is.
4107 Format:
4108 [MODIFIER_FLAG-]KEY_STRING
4109
4110 These characters can be used for MODIFIER_FLAG (case is ignored):
4111 S Shift key
4112 L Lock key
4113 C Control key
4114 1 Mod1 key
4115 2 Mod2 key
4116 3 Mod3 key
4117 4 Mod4 key
4118 5 Mod5 key
4119 Combinations are allowed, for example "S-C-space" or "SC-space" are
4120 both shift+ctrl+space.
4121 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4122
4123 Example: >
4124 :set imactivatekey=S-space
4125< "S-space" means shift+space. This is the activation key for kinput2 +
4126 canna (Japanese), and ami (Korean).
4127
4128 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4129'imcmdline' 'imc' boolean (default off)
4130 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 When set the Input Method is always on when starting to edit a command
4132 line, unless entering a search pattern (see 'imsearch' for that).
4133 Setting this option is useful when your input method allows entering
4134 English characters directly, e.g., when it's used to type accented
4135 characters with dead keys.
4136
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004137 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4139 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140 When set the Input Method is never used. This is useful to disable
4141 the IM when it doesn't work properly.
4142 Currently this option is on by default for SGI/IRIX machines. This
4143 may change in later releases.
4144
4145 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004146'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 Specifies whether :lmap or an Input Method (IM) is to be used in
4149 Insert mode. Valid values:
4150 0 :lmap is off and IM is off
4151 1 :lmap is ON and IM is off
4152 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 To always reset the option to zero when leaving Insert mode with <Esc>
4154 this can be used: >
4155 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4156< This makes :lmap and IM turn off automatically when leaving Insert
4157 mode.
4158 Note that this option changes when using CTRL-^ in Insert mode
4159 |i_CTRL-^|.
4160 The value is set to 1 when setting 'keymap' to a valid keymap name.
4161 It is also used for the argument of commands like "r" and "f".
4162 The value 0 may not work correctly with Athena and Motif with some XIM
4163 methods. Use 'imdisable' to disable XIM then.
4164
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004165 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004166 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004167 |+multi_byte_ime| or |global-ime|.
4168
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004170'imsearch' 'ims' number (default -1)
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 when
4173 entering a search pattern. Valid values:
4174 -1 the value of 'iminsert' is used, makes it look like
4175 'iminsert' is also used when typing a search pattern
4176 0 :lmap is off and IM is off
4177 1 :lmap is ON and IM is off
4178 2 :lmap is off and IM is ON
4179 Note that this option changes when using CTRL-^ in Command-line mode
4180 |c_CTRL-^|.
4181 The value is set to 1 when it is not -1 and setting the 'keymap'
4182 option to a valid keymap name.
4183 The value 0 may not work correctly with Athena and Motif with some XIM
4184 methods. Use 'imdisable' to disable XIM then.
4185
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004186 *'imstatusfunc'* *'imsf'*
4187'imstatusfunc' 'imsf' string (default "")
4188 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004189 This option specifies a function that is called to obtain the status
4190 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004191 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004192
4193 Example: >
4194 function ImStatusFunc()
4195 let is_active = ...do something
4196 return is_active ? 1 : 0
4197 endfunction
4198 set imstatusfunc=ImStatusFunc
4199<
4200 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004201 The expression will be evaluated in the |sandbox| when set from a
4202 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004203
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004204 *'imstyle'* *'imst'*
4205'imstyle' 'imst' number (default 1)
4206 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004207 {only available when compiled with |+xim| and
4208 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004209 This option specifies the input style of Input Method:
4210 0 use on-the-spot style
4211 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004212 See: |xim-input-style|
4213
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004214 For a long time on-the-spot style had been used in the GTK version of
4215 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004216 |single-repeat|, etc. Therefore over-the-spot style becomes the
4217 default now. This should work fine for most people, however if you
4218 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004219 The expression will be evaluated in the |sandbox| when set from a
4220 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004221
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 *'include'* *'inc'*
4223'include' 'inc' string (default "^\s*#\s*include")
4224 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 {not available when compiled without the
4226 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004227 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228 pattern, just like for the "/" command (See |pattern|). The default
4229 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004230 "]I", "[d", etc.
4231 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004232 comes after the matched pattern. But if "\zs" appears in the pattern
4233 then the text matched from "\zs" to the end, or until "\ze" if it
4234 appears, is used as the file name. Use this to include characters
4235 that are not in 'isfname', such as a space. You can then use
4236 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004237 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238
4239 *'includeexpr'* *'inex'*
4240'includeexpr' 'inex' string (default "")
4241 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004242 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004243 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004245 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246 :set includeexpr=substitute(v:fname,'\\.','/','g')
4247< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004248
Bram Moolenaar071d4272004-06-13 20:20:40 +00004249 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004250 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251 Also used for |<cfile>|.
4252
Bram Moolenaar30b65812012-07-12 22:01:11 +02004253 The expression will be evaluated in the |sandbox| when set from a
4254 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004255 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004256
4257 It is not allowed to change text or jump to another window while
4258 evaluating 'includeexpr' |textlock|.
4259
Bram Moolenaar071d4272004-06-13 20:20:40 +00004260 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004261'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4262 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004265 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004266 While typing a search command, show where the pattern, as it was typed
4267 so far, matches. The matched string is highlighted. If the pattern
4268 is invalid or not found, nothing is shown. The screen will be updated
4269 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004270 Also applies to the pattern in commands: >
4271 :global
4272 :lvimgrep
4273 :lvimgrepadd
4274 :smagic
4275 :snomagic
4276 :sort
4277 :substitute
4278 :vglobal
4279 :vimgrep
4280 :vimgrepadd
4281< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004282 original position when no match is found and when pressing <Esc>. You
4283 still need to finish the search command with <Enter> to move the
4284 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004285 You can use the CTRL-G and CTRL-T keys to move to the next and
4286 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004287 When compiled with the |+reltime| feature Vim only searches for about
4288 half a second. With a complicated pattern and/or a lot of text the
4289 match may not be found. This is to avoid that Vim hangs while you
4290 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004291 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004292 When 'hlsearch' is on, all matched strings are highlighted too while
4293 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004294 If you don't want to turn 'hlsearch' on, but want to highlight all
4295 matches while searching, you can turn on and off 'hlsearch' with
4296 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004297 augroup vimrc-incsearch-highlight
4298 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004299 autocmd CmdlineEnter /,\? :set hlsearch
4300 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004301 augroup END
4302<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004303 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004304 to the command line. If 'ignorecase' and 'smartcase' are set and the
4305 command line has no uppercase characters, the added character is
4306 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004307 CTRL-R CTRL-W can be used to add the word at the end of the current
4308 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309 NOTE: This option is reset when 'compatible' is set.
4310
4311 *'indentexpr'* *'inde'*
4312'indentexpr' 'inde' string (default "")
4313 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 {not available when compiled without the |+cindent|
4315 or |+eval| features}
4316 Expression which is evaluated to obtain the proper indent for a line.
4317 It is used when a new line is created, for the |=| operator and
4318 in Insert mode as specified with the 'indentkeys' option.
4319 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004320 'smartindent' indenting. When 'lisp' is set, this option is
4321 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 When 'paste' is set this option is not used for indenting.
4323 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004324 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325 when the expression is evaluated (but it may be moved around).
4326 The expression must return the number of spaces worth of indent. It
4327 can return "-1" to keep the current indent (this means 'autoindent' is
4328 used for the indent).
4329 Functions useful for computing the indent are |indent()|, |cindent()|
4330 and |lispindent()|.
4331 The evaluation of the expression must not have side effects! It must
4332 not change the text, jump to another window, etc. Afterwards the
4333 cursor position is always restored, thus the cursor may be moved.
4334 Normally this option would be set to call a function: >
4335 :set indentexpr=GetMyIndent()
4336< Error messages will be suppressed, unless the 'debug' option contains
4337 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004338 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004339 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340
Bram Moolenaar30b65812012-07-12 22:01:11 +02004341 The expression will be evaluated in the |sandbox| when set from a
4342 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004343 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004344
4345 It is not allowed to change text or jump to another window while
4346 evaluating 'indentexpr' |textlock|.
4347
4348
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004350'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 {not available when compiled without the |+cindent|
4353 feature}
4354 A list of keys that, when typed in Insert mode, cause reindenting of
4355 the current line. Only happens if 'indentexpr' isn't empty.
4356 The format is identical to 'cinkeys', see |indentkeys-format|.
4357 See |C-indenting| and |indent-expression|.
4358
4359 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4360'infercase' 'inf' boolean (default off)
4361 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004363 'ignorecase' is also on, the case of the match is adjusted depending
4364 on the typed text. If the typed text contains a lowercase letter
4365 where the match has an upper case letter, the completed part is made
4366 lowercase. If the typed text has no lowercase letters and the match
4367 has a lowercase letter where the typed text has an uppercase letter,
4368 and there is a letter before it, the completed part is made uppercase.
4369 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370
4371 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4372'insertmode' 'im' boolean (default off)
4373 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 Makes Vim work in a way that Insert mode is the default mode. Useful
4375 if you want to use Vim as a modeless editor. Used for |evim|.
4376 These Insert mode commands will be useful:
4377 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004378 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 this is a mapping, it is executed as if 'insertmode' was off.
4380 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004382 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4383 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384
4385 These items change when 'insertmode' is set:
4386 - when starting to edit of a file, Vim goes to Insert mode.
4387 - <Esc> in Insert mode is a no-op and beeps.
4388 - <Esc> in Normal mode makes Vim go to Insert mode.
4389 - CTRL-L in Insert mode is a command, it is not inserted.
4390 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4391 However, when <Esc> is used inside a mapping, it behaves like
4392 'insertmode' was not set. This was done to be able to use the same
4393 mappings with 'insertmode' set or not set.
4394 When executing commands with |:normal| 'insertmode' is not used.
4395
4396 NOTE: This option is reset when 'compatible' is set.
4397
4398 *'isfname'* *'isf'*
4399'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4400 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4401 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4402 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4403 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4404 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4405 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 The characters specified by this option are included in file names and
4407 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004408 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409 Multi-byte characters 256 and above are always included, only the
4410 characters up to 255 are specified with this option.
4411 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004412 Think twice before adding white space to this option. Although a
4413 space may appear inside a file name, the effect will be that Vim
4414 doesn't know where a file name starts or ends when doing completion.
4415 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416
4417 Note that on systems using a backslash as path separator, Vim tries to
4418 do its best to make it work as you would expect. That is a bit
4419 tricky, since Vi originally used the backslash to escape special
4420 characters. Vim will not remove a backslash in front of a normal file
4421 name character on these systems, but it will on Unix and alikes. The
4422 '&' and '^' are not included by default, because these are special for
4423 cmd.exe.
4424
4425 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004426 Each part can be a single character number or a range. A range is two
4427 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 decimal number between 0 and 255 or the ASCII character itself (does
4429 not work for digits). Example:
4430 "_,-,128-140,#-43" (include '_' and '-' and the range
4431 128 to 140 and '#' to 43)
4432 If a part starts with '^', the following character number or range
4433 will be excluded from the option. The option is interpreted from left
4434 to right. Put the excluded character after the range where it is
4435 included. To include '^' itself use it as the last character of the
4436 option or the end of a range. Example:
4437 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4438 If the character is '@', all characters where isalpha() returns TRUE
4439 are included. Normally these are the characters a to z and A to Z,
4440 plus accented characters. To include '@' itself use "@-@". Examples:
4441 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004442 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 "a-z,A-Z,@-@" All letters plus the '@' character.
4444 A comma can be included by using it where a character number is
4445 expected. Example:
4446 "48-57,,,_" Digits, comma and underscore.
4447 A comma can be excluded by prepending a '^'. Example:
4448 " -~,^,,9" All characters from space to '~', excluding
4449 comma, plus <Tab>.
4450 See |option-backslash| about including spaces and backslashes.
4451
4452 *'isident'* *'isi'*
4453'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4454 "@,48-57,_,128-167,224-235"
4455 otherwise: "@,48-57,_,192-255")
4456 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 The characters given by this option are included in identifiers.
4458 Identifiers are used in recognizing environment variables and after a
4459 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004460 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004461 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004463 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4465
4466 *'iskeyword'* *'isk'*
4467'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4468 "@,48-57,_,128-167,224-235"
4469 otherwise: "@,48-57,_,192-255"
4470 Vi default: "@,48-57,_")
4471 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004473 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004474 'isfname' for a description of the format of this option. For '@'
4475 characters above 255 check the "word" character class.
4476 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 For a help file it is set to all non-blank printable characters except
4478 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4479 command).
4480 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004481 This option also influences syntax highlighting, unless the syntax
4482 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483 NOTE: This option is set to the Vi default value when 'compatible' is
4484 set and to the Vim default value when 'compatible' is reset.
4485
4486 *'isprint'* *'isp'*
4487'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4488 "@,~-255"; otherwise: "@,161-255")
4489 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 The characters given by this option are displayed directly on the
4491 screen. It is also used for "\p" in a |pattern|. The characters from
4492 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4493 even when they are not included in 'isprint' or excluded. See
4494 'isfname' for a description of the format of this option.
4495
4496 Non-printable characters are displayed with two characters:
4497 0 - 31 "^@" - "^_"
4498 32 - 126 always single characters
4499 127 "^?"
4500 128 - 159 "~@" - "~_"
4501 160 - 254 "| " - "|~"
4502 255 "~?"
4503 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4504 displayed as <xx>, with the hexadecimal value of the byte.
4505 When 'display' contains "uhex" all unprintable characters are
4506 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004507 The SpecialKey highlighting will be used for unprintable characters.
4508 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509
4510 Multi-byte characters 256 and above are always included, only the
4511 characters up to 255 are specified with this option. When a character
4512 is printable but it is not available in the current font, a
4513 replacement character will be shown.
4514 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4515 There is no option to specify these characters.
4516
4517 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4518'joinspaces' 'js' boolean (default on)
4519 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 Insert two spaces after a '.', '?' and '!' with a join command.
4521 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4522 Otherwise only one space is inserted.
4523 NOTE: This option is set when 'compatible' is set.
4524
4525 *'key'*
4526'key' string (default "")
4527 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004528 {only available when compiled with the |+cryptv|
4529 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004531 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532 Careful: Do not set the key value by hand, someone might see the typed
4533 key. Use the |:X| command. But you can make 'key' empty: >
4534 :set key=
4535< It is not possible to get the value of this option with ":set key" or
4536 "echo &key". This is to avoid showing it to someone who shouldn't
4537 know. It also means you cannot see it yourself once you have set it,
4538 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004539 You can use "&key" in an expression to detect whether encryption is
4540 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541
4542 *'keymap'* *'kmp'* *E544*
4543'keymap' 'kmp' string (default "")
4544 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545 {only available when compiled with the |+keymap|
4546 feature}
4547 Name of a keyboard mapping. See |mbyte-keymap|.
4548 Setting this option to a valid keymap name has the side effect of
4549 setting 'iminsert' to one, so that the keymap becomes effective.
4550 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004551 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552
4553 *'keymodel'* *'km'*
4554'keymodel' 'km' string (default "")
4555 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 List of comma separated words, which enable special things that keys
4557 can do. These values can be used:
4558 startsel Using a shifted special key starts selection (either
4559 Select mode or Visual mode, depending on "key" being
4560 present in 'selectmode').
4561 stopsel Using a not-shifted special key stops selection.
4562 Special keys in this context are the cursor keys, <End>, <Home>,
4563 <PageUp> and <PageDown>.
4564 The 'keymodel' option is set by the |:behave| command.
4565
4566 *'keywordprg'* *'kp'*
4567'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004568 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 Program to use for the |K| command. Environment variables are
4571 expanded |:set_env|. ":help" may be used to access the Vim internal
4572 help. (Note that previously setting the global option to the empty
4573 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004574 When the first character is ":", the command is invoked as a Vim
4575 Ex command prefixed with [count].
4576 When "man", "man -s" or an Ex command is used, Vim will automatically
4577 translate a count for the "K" command and pass it as the first
4578 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 See |option-backslash| about including spaces and backslashes.
4580 Example: >
4581 :set keywordprg=man\ -s
4582< This option cannot be set from a |modeline| or in the |sandbox|, for
4583 security reasons.
4584
4585 *'langmap'* *'lmap'* *E357* *E358*
4586'langmap' 'lmap' string (default "")
4587 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 {only available when compiled with the |+langmap|
4589 feature}
4590 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004591 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004592 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 care of translating these special characters to the original meaning
4594 of the key. This means you don't have to change the keyboard mode to
4595 be able to execute Normal mode commands.
4596 This is the opposite of the 'keymap' option, where characters are
4597 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004598 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004599 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004600 This option cannot be set from a |modeline| or in the |sandbox|, for
4601 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004603 Example (for Greek, in UTF-8): *greek* >
4604 :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 +00004605< Example (exchanges meaning of z and y for commands): >
4606 :set langmap=zy,yz,ZY,YZ
4607<
4608 The 'langmap' option is a list of parts, separated with commas. Each
4609 part can be in one of two forms:
4610 1. A list of pairs. Each pair is a "from" character immediately
4611 followed by the "to" character. Examples: "aA", "aAbBcC".
4612 2. A list of "from" characters, a semi-colon and a list of "to"
4613 characters. Example: "abc;ABC"
4614 Example: "aA,fgh;FGH,cCdDeE"
4615 Special characters need to be preceded with a backslash. These are
4616 ";", ',' and backslash itself.
4617
4618 This will allow you to activate vim actions without having to switch
4619 back and forth between the languages. Your language characters will
4620 be understood as normal vim English characters (according to the
4621 langmap mappings) in the following cases:
4622 o Normal/Visual mode (commands, buffer/register names, user mappings)
4623 o Insert/Replace Mode: Register names after CTRL-R
4624 o Insert/Replace Mode: Mappings
4625 Characters entered in Command-line mode will NOT be affected by
4626 this option. Note that this option can be changed at any time
4627 allowing to switch between mappings for different languages/encodings.
4628 Use a mapping to avoid having to type it each time!
4629
4630 *'langmenu'* *'lm'*
4631'langmenu' 'lm' string (default "")
4632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 {only available when compiled with the |+menu| and
4634 |+multi_lang| features}
4635 Language to use for menu translation. Tells which file is loaded
4636 from the "lang" directory in 'runtimepath': >
4637 "lang/menu_" . &langmenu . ".vim"
4638< (without the spaces). For example, to always use the Dutch menus, no
4639 matter what $LANG is set to: >
4640 :set langmenu=nl_NL.ISO_8859-1
4641< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004642 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 If your $LANG is set to a non-English language but you do want to use
4644 the English menus: >
4645 :set langmenu=none
4646< This option must be set before loading menus, switching on filetype
4647 detection or syntax highlighting. Once the menus are defined setting
4648 this option has no effect. But you could do this: >
4649 :source $VIMRUNTIME/delmenu.vim
4650 :set langmenu=de_DE.ISO_8859-1
4651 :source $VIMRUNTIME/menu.vim
4652< Warning: This deletes all menus that you defined yourself!
4653
Bram Moolenaard94464e2015-11-02 15:28:18 +01004654 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004655'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004656 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004657 {only available when compiled with the |+langmap|
4658 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004659 This is just like 'langremap' but with the value inverted. It only
4660 exists for backwards compatibility. When setting 'langremap' then
4661 'langnoremap' is set to the inverted value, and the other way around.
4662
4663 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4664'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4665 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004666 {only available when compiled with the |+langmap|
4667 feature}
4668 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004669 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004670 'langmap' disables some of your mappings, try resetting this option.
4671 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004672 that works for you to avoid mappings to break.
4673
Bram Moolenaar071d4272004-06-13 20:20:40 +00004674 *'laststatus'* *'ls'*
4675'laststatus' 'ls' number (default 1)
4676 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677 The value of this option influences when the last window will have a
4678 status line:
4679 0: never
4680 1: only if there are at least two windows
4681 2: always
4682 The screen looks nicer with a status line if you have several
4683 windows, but it takes another screen line. |status-line|
4684
4685 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4686'lazyredraw' 'lz' boolean (default off)
4687 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 When this option is set, the screen will not be redrawn while
4689 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004690 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004691 update use |:redraw|.
4692
4693 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4694'linebreak' 'lbr' boolean (default off)
4695 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004696 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004698 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004699 than at the last character that fits on the screen. Unlike
4700 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004701 it only affects the way the file is displayed, not its contents.
4702 If 'breakindent' is set, line is visually indented. Then, the value
4703 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004704 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 Note that <Tab> characters after an <EOL> are mostly not displayed
4706 with the right amount of white space.
4707
4708 *'lines'* *E593*
4709'lines' number (default 24 or terminal height)
4710 global
4711 Number of lines of the Vim window.
4712 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004713 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714 When Vim is running in the GUI or in a resizable window, setting this
4715 option will cause the window size to be changed. When you only want
4716 to use the size for the GUI, put the command in your |gvimrc| file.
4717 Vim limits the number of lines to what fits on the screen. You can
4718 use this command to get the tallest window possible: >
4719 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004720< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004721 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722 When you set this option and Vim is unable to change the physical
4723 number of lines of the display, the display may be messed up.
4724
4725 *'linespace'* *'lsp'*
4726'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4727 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728 {only in the GUI}
4729 Number of pixel lines inserted between characters. Useful if the font
4730 uses the full character cell height, making lines touch each other.
4731 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004732 With some fonts there can be too much room between lines (to have
4733 space for ascents and descents). Then it makes sense to set
4734 'linespace' to a negative value. This may cause display problems
4735 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736
4737 *'lisp'* *'nolisp'*
4738'lisp' boolean (default off)
4739 local to buffer
4740 {not available when compiled without the |+lispindent|
4741 feature}
4742 Lisp mode: When <Enter> is typed in insert mode set the indent for
4743 the next line to Lisp standards (well, sort of). Also happens with
4744 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4745 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4746 better. Also see 'lispwords'.
4747 The '-' character is included in keyword characters. Redefines the
4748 "=" operator to use this same indentation algorithm rather than
4749 calling an external program if 'equalprg' is empty.
4750 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751
4752 *'lispwords'* *'lw'*
4753'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004754 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755 {not available when compiled without the |+lispindent|
4756 feature}
4757 Comma separated list of words that influence the Lisp indenting.
4758 |'lisp'|
4759
4760 *'list'* *'nolist'*
4761'list' boolean (default off)
4762 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004763 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4764 line. Useful to see the difference between tabs and spaces and for
4765 trailing blanks. Further changed by the 'listchars' option.
4766
4767 The cursor is displayed at the start of the space a Tab character
4768 occupies, not at the end as usual in Normal mode. To get this cursor
4769 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004770 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004771<
4772 Note that list mode will also affect formatting (set with 'textwidth'
4773 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774 changing the way tabs are displayed.
4775
4776 *'listchars'* *'lcs'*
4777'listchars' 'lcs' string (default "eol:$")
4778 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004779 Strings to use in 'list' mode and for the |:list| command. It is a
4780 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004781 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782 eol:c Character to show at the end of each line. When
4783 omitted, there is no extra character at the end of the
4784 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004785 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004786 tab:xy[z] Two or three characters to be used to show a tab.
4787 The third character is optional.
4788
4789 tab:xy The 'x' is always used, then 'y' as many times as will
4790 fit. Thus "tab:>-" displays:
4791 >
4792 >-
4793 >--
4794 etc.
4795
4796 tab:xyz The 'z' is always used, then 'x' is prepended, and
4797 then 'y' is used as many times as will fit. Thus
4798 "tab:<->" displays:
4799 >
4800 <>
4801 <->
4802 <-->
4803 etc.
4804
4805 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004806 *lcs-space*
4807 space:c Character to show for a space. When omitted, spaces
4808 are left blank.
4809 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004810 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004811 trailing spaces are blank. Overrides the "space"
4812 setting for trailing spaces.
4813 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814 extends:c Character to show in the last column, when 'wrap' is
4815 off and the line continues beyond the right of the
4816 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004817 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004818 precedes:c Character to show in the first column, when 'wrap'
4819 is off and there is text preceding the character
4820 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004821 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004822 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004823 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004824 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004825 nbsp:c Character to show for a non-breakable space character
4826 (0xA0 (160 decimal) and U+202F). Left blank when
4827 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004829 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004831 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832
4833 Examples: >
4834 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004835 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836 :set lcs=extends:>,precedes:<
4837< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004838 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004839 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840
4841 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4842'loadplugins' 'lpl' boolean (default on)
4843 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844 When on the plugin scripts are loaded when starting up |load-plugins|.
4845 This option can be reset in your |vimrc| file to disable the loading
4846 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004847 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4848 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849
Bram Moolenaard94464e2015-11-02 15:28:18 +01004850 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004851'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004852 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004853 {only available when compiled with the |+lua/dyn|
4854 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004855 Specifies the name of the Lua shared library. The default is
4856 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004857 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004858 This option cannot be set from a |modeline| or in the |sandbox|, for
4859 security reasons.
4860
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004861 *'macatsui'* *'nomacatsui'*
4862'macatsui' boolean (default on)
4863 global
4864 {only available in Mac GUI version}
4865 This is a workaround for when drawing doesn't work properly. When set
4866 and compiled with multi-byte support ATSUI text drawing is used. When
4867 not set ATSUI text drawing is not used. Switch this option off when
4868 you experience drawing problems. In a future version the problems may
4869 be solved and this option becomes obsolete. Therefore use this method
4870 to unset it: >
4871 if exists('&macatsui')
4872 set nomacatsui
4873 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004874< Another option to check if you have drawing problems is
4875 'termencoding'.
4876
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 *'magic'* *'nomagic'*
4878'magic' boolean (default on)
4879 global
4880 Changes the special characters that can be used in search patterns.
4881 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004882 WARNING: Switching this option off most likely breaks plugins! That
4883 is because many patterns assume it's on and will fail when it's off.
4884 Only switch it off when working with old Vi scripts. In any other
4885 situation write patterns that work when 'magic' is on. Include "\M"
4886 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004887
4888 *'makeef'* *'mef'*
4889'makeef' 'mef' string (default: "")
4890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 {not available when compiled without the |+quickfix|
4892 feature}
4893 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4894 and the |:grep| command.
4895 When it is empty, an internally generated temp file will be used.
4896 When "##" is included, it is replaced by a number to make the name
4897 unique. This makes sure that the ":make" command doesn't overwrite an
4898 existing file.
4899 NOT used for the ":cf" command. See 'errorfile' for that.
4900 Environment variables are expanded |:set_env|.
4901 See |option-backslash| about including spaces and backslashes.
4902 This option cannot be set from a |modeline| or in the |sandbox|, for
4903 security reasons.
4904
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004905 *'makeencoding'* *'menc'*
4906'makeencoding' 'menc' string (default "")
4907 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004908 Encoding used for reading the output of external commands. When empty,
4909 encoding is not converted.
4910 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4911 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4912 and `:laddfile`.
4913
4914 This would be mostly useful when you use MS-Windows and set 'encoding'
4915 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4916 'makeencoding' to "char" has the same effect as setting to the system
4917 locale encoding. Example: >
4918 :set encoding=utf-8
4919 :set makeencoding=char " system locale is used
4920<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921 *'makeprg'* *'mp'*
4922'makeprg' 'mp' string (default "make", VMS: "MMS")
4923 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004924 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004925 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4926 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004927 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004928 Environment variables are expanded |:set_env|. See |option-backslash|
4929 about including spaces and backslashes.
4930 Note that a '|' must be escaped twice: once for ":set" and once for
4931 the interpretation of a command. When you use a filter called
4932 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004933 :set makeprg=gmake\ \\\|\ myfilter
4934< The placeholder "$*" can be given (even multiple times) to specify
4935 where the arguments will be included, for example: >
4936 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4937< This option cannot be set from a |modeline| or in the |sandbox|, for
4938 security reasons.
4939
4940 *'matchpairs'* *'mps'*
4941'matchpairs' 'mps' string (default "(:),{:},[:]")
4942 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004944 other.
4945 Only character pairs are allowed that are different, thus you cannot
4946 jump between two double quotes.
4947 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004948 The pairs must be separated by a comma. Example for including '<' and
4949 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 :set mps+=<:>
4951
4952< A more exotic example, to jump between the '=' and ';' in an
4953 assignment, useful for languages like C and Java: >
4954 :au FileType c,cpp,java set mps+==:;
4955
4956< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01004957 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958
4959 *'matchtime'* *'mat'*
4960'matchtime' 'mat' number (default 5)
4961 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962 Tenths of a second to show the matching paren, when 'showmatch' is
4963 set. Note that this is not in milliseconds, like other options that
4964 set a time. This is to be compatible with Nvi.
4965
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004966 *'maxcombine'* *'mco'*
4967'maxcombine' 'mco' number (default 2)
4968 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004969 The maximum number of combining characters supported for displaying.
4970 Only used when 'encoding' is "utf-8".
4971 The default is OK for most languages. Hebrew may require 4.
4972 Maximum value is 6.
4973 Even when this option is set to 2 you can still edit text with more
4974 combining characters, you just can't see them. Use |g8| or |ga|.
4975 See |mbyte-combining|.
4976
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977 *'maxfuncdepth'* *'mfd'*
4978'maxfuncdepth' 'mfd' number (default 100)
4979 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02004980 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004981 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 Maximum depth of function calls for user functions. This normally
4983 catches endless recursion. When using a recursive function with
4984 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4985 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01004986 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02004987 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 See also |:function|.
4989
4990 *'maxmapdepth'* *'mmd'* *E223*
4991'maxmapdepth' 'mmd' number (default 1000)
4992 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 Maximum number of times a mapping is done without resulting in a
4994 character to be used. This normally catches endless mappings, like
4995 ":map x y" with ":map y x". It still does not catch ":map g wg",
4996 because the 'w' is used before the next mapping is done. See also
4997 |key-mapping|.
4998
4999 *'maxmem'* *'mm'*
5000'maxmem' 'mm' number (default between 256 to 5120 (system
5001 dependent) or half the amount of memory
5002 available)
5003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5005 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005006 other memory to be freed.
5007 The maximum usable value is about 2000000. Use this to work without a
5008 limit.
5009 The value is ignored when 'swapfile' is off.
5010 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005012 *'maxmempattern'* *'mmp'*
5013'maxmempattern' 'mmp' number (default 1000)
5014 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005015 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005016 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005017 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005018 When Vim runs into the limit it gives an error message and mostly
5019 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005020 Running into the limit often means that the pattern is very
5021 inefficient or too complex. This may already happen with the pattern
5022 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005023 Might also happen on redraw, when syntax rules try to match a complex
5024 text structure.
5025 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5026 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005027
Bram Moolenaar071d4272004-06-13 20:20:40 +00005028 *'maxmemtot'* *'mmt'*
5029'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5030 dependent) or half the amount of memory
5031 available)
5032 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005033 Maximum amount of memory in Kbyte to use for all buffers together.
5034 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005035 without a limit.
5036 On 64 bit machines higher values might work. But hey, do you really
5037 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005038 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005039 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005040 Buffers with 'swapfile' off still count to the total amount of memory
5041 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005042 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043
5044 *'menuitems'* *'mis'*
5045'menuitems' 'mis' number (default 25)
5046 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047 {not available when compiled without the |+menu|
5048 feature}
5049 Maximum number of items to use in a menu. Used for menus that are
5050 generated from a list of items, e.g., the Buffers menu. Changing this
5051 option has no direct effect, the menu must be refreshed first.
5052
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005053 *'mkspellmem'* *'msm'*
5054'mkspellmem' 'msm' string (default "460000,2000,500")
5055 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005056 {not available when compiled without the |+syntax|
5057 feature}
5058 Parameters for |:mkspell|. This tunes when to start compressing the
5059 word tree. Compression can be slow when there are many words, but
5060 it's needed to avoid running out of memory. The amount of memory used
5061 per word depends very much on how similar the words are, that's why
5062 this tuning is complicated.
5063
5064 There are three numbers, separated by commas:
5065 {start},{inc},{added}
5066
5067 For most languages the uncompressed word tree fits in memory. {start}
5068 gives the amount of memory in Kbyte that can be used before any
5069 compression is done. It should be a bit smaller than the amount of
5070 memory that is available to Vim.
5071
5072 When going over the {start} limit the {inc} number specifies the
5073 amount of memory in Kbyte that can be allocated before another
5074 compression is done. A low number means compression is done after
5075 less words are added, which is slow. A high number means more memory
5076 will be allocated.
5077
5078 After doing compression, {added} times 1024 words can be added before
5079 the {inc} limit is ignored and compression is done when any extra
5080 amount of memory is needed. A low number means there is a smaller
5081 chance of hitting the {inc} limit, less memory is used but it's
5082 slower.
5083
5084 The languages for which these numbers are important are Italian and
5085 Hungarian. The default works for when you have about 512 Mbyte. If
5086 you have 1 Gbyte you could use: >
5087 :set mkspellmem=900000,3000,800
5088< If you have less than 512 Mbyte |:mkspell| may fail for some
5089 languages, no matter what you set 'mkspellmem' to.
5090
Bram Moolenaar07607392019-05-26 19:20:43 +02005091 This option cannot be set from a |modeline| or in the |sandbox|.
5092
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005094'modeline' 'ml' boolean (Vim default: on (off for root),
5095 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005097 If 'modeline' is on 'modelines' gives the number of lines that is
5098 checked for set commands. If 'modeline' is off or 'modelines' is zero
5099 no lines are checked. See |modeline|.
5100
5101 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5102'modelineexpr' 'mle' boolean (default: off)
5103 global
5104 When on allow some options that are an expression to be set in the
5105 modeline. Check the option for whether it is affected by
5106 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005107 This option cannot be set from a |modeline| or in the |sandbox|, for
5108 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005109
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 *'modelines'* *'mls'*
5111'modelines' 'mls' number (default 5)
5112 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113 If 'modeline' is on 'modelines' gives the number of lines that is
5114 checked for set commands. If 'modeline' is off or 'modelines' is zero
5115 no lines are checked. See |modeline|.
5116 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5117 set and to the Vim default value when 'compatible' is reset.
5118
5119 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005120 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121'modifiable' 'ma' boolean (default on)
5122 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123 When off the buffer contents cannot be changed. The 'fileformat' and
5124 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005125 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126
5127 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5128'modified' 'mod' boolean (default off)
5129 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005130 When on, the buffer is considered to be modified. This option is set
5131 when:
5132 1. A change was made to the text since it was last written. Using the
5133 |undo| command to go back to the original text will reset the
5134 option. But undoing changes that were made before writing the
5135 buffer will set the option again, since the text is different from
5136 when it was written.
5137 2. 'fileformat' or 'fileencoding' is different from its original
5138 value. The original value is set when the buffer is read or
5139 written. A ":set nomodified" command also resets the original
5140 values to the current values and the 'modified' option will be
5141 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005142 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005143 This option is not set when a change is made to the buffer as the
5144 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5145 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5146 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5148 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005149 Note that the text may actually be the same, e.g. 'modified' is set
5150 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151
5152 *'more'* *'nomore'*
5153'more' boolean (Vim default: on, Vi default: off)
5154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 When on, listings pause when the whole screen is filled. You will get
5156 the |more-prompt|. When this option is off there are no pauses, the
5157 listing continues until finished.
5158 NOTE: This option is set to the Vi default value when 'compatible' is
5159 set and to the Vim default value when 'compatible' is reset.
5160
5161 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005162'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5163 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005166 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5167 sysmouse and Linux console with gpm). For using the mouse in the
5168 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005170 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 v Visual mode
5172 i Insert mode
5173 c Command-line mode
5174 h all previous modes when editing a help file
5175 a all previous modes
5176 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005177 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178 :set mouse=a
5179< When the mouse is not enabled, the GUI will still use the mouse for
5180 modeless selection. This doesn't move the text cursor.
5181
5182 See |mouse-using|. Also see |'clipboard'|.
5183
5184 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005185 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 the mouse buttons can still be used by keeping the shift key pressed.
5187 Also see the 'clipboard' option.
5188
5189 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5190'mousefocus' 'mousef' boolean (default off)
5191 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192 {only works in the GUI}
5193 The window that the mouse pointer is on is automatically activated.
5194 When changing the window layout or window focus in another way, the
5195 mouse pointer is moved to the window with keyboard focus. Off is the
5196 default because it makes using the pull down menus a little goofy, as
5197 a pointer transit may activate a window unintentionally.
5198
5199 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5200'mousehide' 'mh' boolean (default on)
5201 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 {only works in the GUI}
5203 When on, the mouse pointer is hidden when characters are typed.
5204 The mouse pointer is restored when the mouse is moved.
5205
5206 *'mousemodel'* *'mousem'*
5207'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5208 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 Sets the model to use for the mouse. The name mostly specifies what
5210 the right mouse button is used for:
5211 extend Right mouse button extends a selection. This works
5212 like in an xterm.
5213 popup Right mouse button pops up a menu. The shifted left
5214 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005215 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216 popup_setpos Like "popup", but the cursor will be moved to the
5217 position where the mouse was clicked, and thus the
5218 selected operation will act upon the clicked object.
5219 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005220 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 course, that right clicking outside a selection will
5222 end Visual mode.
5223 Overview of what button does what for each model:
5224 mouse extend popup(_setpos) ~
5225 left click place cursor place cursor
5226 left drag start selection start selection
5227 shift-left search word extend selection
5228 right click extend selection popup menu (place cursor)
5229 right drag extend selection -
5230 middle click paste paste
5231
5232 In the "popup" model the right mouse button produces a pop-up menu.
5233 You need to define this first, see |popup-menu|.
5234
5235 Note that you can further refine the meaning of buttons with mappings.
5236 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5237 selection (because that's handled in the GUI code directly).
5238
5239 The 'mousemodel' option is set by the |:behave| command.
5240
5241 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005242'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5243 vs:leftright,vd:lrsizing,m:no,
5244 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005246 {only available when compiled with the |+mouseshape|
5247 feature}
5248 This option tells Vim what the mouse pointer should look like in
5249 different modes. The option is a comma separated list of parts, much
5250 like used for 'guicursor'. Each part consist of a mode/location-list
5251 and an argument-list:
5252 mode-list:shape,mode-list:shape,..
5253 The mode-list is a dash separated list of these modes/locations:
5254 In a normal window: ~
5255 n Normal mode
5256 v Visual mode
5257 ve Visual mode with 'selection' "exclusive" (same as 'v',
5258 if not specified)
5259 o Operator-pending mode
5260 i Insert mode
5261 r Replace mode
5262
5263 Others: ~
5264 c appending to the command-line
5265 ci inserting in the command-line
5266 cr replacing in the command-line
5267 m at the 'Hit ENTER' or 'More' prompts
5268 ml idem, but cursor in the last line
5269 e any mode, pointer below last window
5270 s any mode, pointer on a status line
5271 sd any mode, while dragging a status line
5272 vs any mode, pointer on a vertical separator line
5273 vd any mode, while dragging a vertical separator line
5274 a everywhere
5275
5276 The shape is one of the following:
5277 avail name looks like ~
5278 w x arrow Normal mouse pointer
5279 w x blank no pointer at all (use with care!)
5280 w x beam I-beam
5281 w x updown up-down sizing arrows
5282 w x leftright left-right sizing arrows
5283 w x busy The system's usual busy pointer
5284 w x no The system's usual 'no input' pointer
5285 x udsizing indicates up-down resizing
5286 x lrsizing indicates left-right resizing
5287 x crosshair like a big thin +
5288 x hand1 black hand
5289 x hand2 white hand
5290 x pencil what you write with
5291 x question big ?
5292 x rightup-arrow arrow pointing right-up
5293 w x up-arrow arrow pointing up
5294 x <number> any X11 pointer number (see X11/cursorfont.h)
5295
5296 The "avail" column contains a 'w' if the shape is available for Win32,
5297 x for X11.
5298 Any modes not specified or shapes not available use the normal mouse
5299 pointer.
5300
5301 Example: >
5302 :set mouseshape=s:udsizing,m:no
5303< will make the mouse turn to a sizing arrow over the status lines and
5304 indicate no input when the hit-enter prompt is displayed (since
5305 clicking the mouse has no effect in this state.)
5306
5307 *'mousetime'* *'mouset'*
5308'mousetime' 'mouset' number (default 500)
5309 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5311 time in msec between two mouse clicks for the second click to be
5312 recognized as a multi click.
5313
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005314 *'mzschemedll'*
5315'mzschemedll' string (default depends on the build)
5316 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005317 {only available when compiled with the |+mzscheme/dyn|
5318 feature}
5319 Specifies the name of the MzScheme shared library. The default is
5320 DYNAMIC_MZSCH_DLL which was specified at compile time.
5321 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005322 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005323 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005324 This option cannot be set from a |modeline| or in the |sandbox|, for
5325 security reasons.
5326
5327 *'mzschemegcdll'*
5328'mzschemegcdll' string (default depends on the build)
5329 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005330 {only available when compiled with the |+mzscheme/dyn|
5331 feature}
5332 Specifies the name of the MzScheme GC shared library. The default is
5333 DYNAMIC_MZGC_DLL which was specified at compile time.
5334 The value can be equal to 'mzschemedll' if it includes the GC code.
5335 Environment variables are expanded |:set_env|.
5336 This option cannot be set from a |modeline| or in the |sandbox|, for
5337 security reasons.
5338
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005339 *'mzquantum'* *'mzq'*
5340'mzquantum' 'mzq' number (default 100)
5341 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005342 {not available when compiled without the |+mzscheme|
5343 feature}
5344 The number of milliseconds between polls for MzScheme threads.
5345 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005346 NOTE: This option is set to the Vim default value when 'compatible'
5347 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005348
Bram Moolenaar071d4272004-06-13 20:20:40 +00005349 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005350'nrformats' 'nf' string (default "bin,octal,hex",
5351 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005352 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005353 This defines what bases Vim will consider for numbers when using the
5354 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5355 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005356 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005358 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005359 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005361 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362 considered to be hexadecimal. Example: Using CTRL-X on
5363 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005364 bin If included, numbers starting with "0b" or "0B" will be
5365 considered to be binary. Example: Using CTRL-X on
5366 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367 Numbers which simply begin with a digit in the range 1-9 are always
5368 considered decimal. This also happens for numbers that are not
5369 recognized as octal or hex.
5370
5371 *'number'* *'nu'* *'nonumber'* *'nonu'*
5372'number' 'nu' boolean (default off)
5373 local to window
5374 Print the line number in front of each line. When the 'n' option is
5375 excluded from 'cpoptions' a wrapped line will not use the column of
5376 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005377 The 'numberwidth' option can be used to set the room used for the line
5378 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379 When a long, wrapped line doesn't start with the first character, '-'
5380 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005381 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5382 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005383 *number_relativenumber*
5384 The 'relativenumber' option changes the displayed number to be
5385 relative to the cursor. Together with 'number' there are these
5386 four combinations (cursor in line 3):
5387
Bram Moolenaar3848e002016-03-19 18:42:29 +01005388 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005389 'nornu' 'nornu' 'rnu' 'rnu'
5390
5391 |apple | 1 apple | 2 apple | 2 apple
5392 |pear | 2 pear | 1 pear | 1 pear
5393 |nobody | 3 nobody | 0 nobody |3 nobody
5394 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005396 *'numberwidth'* *'nuw'*
5397'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5398 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005399 {only available when compiled with the |+linebreak|
5400 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005401 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005402 when the 'number' or 'relativenumber' option is set or printing lines
5403 with a line number. Since one space is always between the number and
5404 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005405 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005406 fit the highest line number in the buffer respectively the number of
5407 rows in the window, depending on whether 'number' or 'relativenumber'
5408 is set. Thus with the Vim default of 4 there is room for a line number
5409 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005410 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005411 NOTE: This option is set to the Vi default value when 'compatible' is
5412 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005413
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005414 *'omnifunc'* *'ofu'*
5415'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005416 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005417 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005418 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005419 This option specifies a function to be used for Insert mode omni
5420 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005421 See |complete-functions| for an explanation of how the function is
5422 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005423 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005424 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005425 This option cannot be set from a |modeline| or in the |sandbox|, for
5426 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005427
5428
Bram Moolenaar02467872007-05-06 13:22:01 +00005429 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005430'opendevice' 'odev' boolean (default off)
5431 global
Bram Moolenaar043545e2006-10-10 16:44:07 +00005432 {only for MS-DOS, MS-Windows and OS/2}
5433 Enable reading and writing from devices. This may get Vim stuck on a
5434 device that can be opened but doesn't actually do the I/O. Therefore
5435 it is off by default.
5436 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5437 result in editing a device.
5438
5439
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005440 *'operatorfunc'* *'opfunc'*
5441'operatorfunc' 'opfunc' string (default: empty)
5442 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005443 This option specifies a function to be called by the |g@| operator.
5444 See |:map-operator| for more info and an example.
5445
5446 This option cannot be set from a |modeline| or in the |sandbox|, for
5447 security reasons.
5448
5449
Bram Moolenaar251e1912011-06-19 05:09:16 +02005450 *'osfiletype'* *'oft'*
5451'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005453 This option was supported on RISC OS, which has been removed.
5454
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005456 *'packpath'* *'pp'*
5457'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005458 Directories used to find packages. See |packages|.
5459
5460
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005462'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005463 global
5464 Specifies the nroff macros that separate paragraphs. These are pairs
5465 of two letters (see |object-motions|).
5466
5467 *'paste'* *'nopaste'*
5468'paste' boolean (default off)
5469 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005470 Put Vim in Paste mode. This is useful if you want to cut or copy
5471 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005472 unexpected effects.
5473 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005474 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005475 knows about pasting and will mostly do the right thing without 'paste'
5476 being set. The same is true for a terminal where Vim handles the
5477 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005478 This option is reset when starting the GUI. Thus if you set it in
5479 your .vimrc it will work in a terminal, but not in the GUI. Setting
5480 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5481 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482 When the 'paste' option is switched on (also when it was already on):
5483 - mapping in Insert mode and Command-line mode is disabled
5484 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005485 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005486 - 'expandtab' is reset
5487 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488 - 'revins' is reset
5489 - 'ruler' is reset
5490 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005491 - 'smartindent' is reset
5492 - 'smarttab' is reset
5493 - 'softtabstop' is set to 0
5494 - 'textwidth' is set to 0
5495 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005497 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005498 - 'indentexpr'
5499 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005500 NOTE: When you start editing another file while the 'paste' option is
5501 on, settings from the modelines or autocommands may change the
5502 settings again, causing trouble when pasting text. You might want to
5503 set the 'paste' option again.
5504 When the 'paste' option is reset the mentioned options are restored to
5505 the value before the moment 'paste' was switched from off to on.
5506 Resetting 'paste' before ever setting it does not have any effect.
5507 Since mapping doesn't work while 'paste' is active, you need to use
5508 the 'pastetoggle' option to toggle the 'paste' option with some key.
5509
5510 *'pastetoggle'* *'pt'*
5511'pastetoggle' 'pt' string (default "")
5512 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513 When non-empty, specifies the key sequence that toggles the 'paste'
5514 option. This is like specifying a mapping: >
5515 :map {keys} :set invpaste<CR>
5516< Where {keys} is the value of 'pastetoggle'.
5517 The difference is that it will work even when 'paste' is set.
5518 'pastetoggle' works in Insert mode and Normal mode, but not in
5519 Command-line mode.
5520 Mappings are checked first, thus overrule 'pastetoggle'. However,
5521 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5522 this: >
5523 :map <F10> :set paste<CR>
5524 :map <F11> :set nopaste<CR>
5525 :imap <F10> <C-O>:set paste<CR>
5526 :imap <F11> <nop>
5527 :set pastetoggle=<F11>
5528< This will make <F10> start paste mode and <F11> stop paste mode.
5529 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5530 mode everything is inserted literally, except the 'pastetoggle' key
5531 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005532 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533
5534 *'pex'* *'patchexpr'*
5535'patchexpr' 'pex' string (default "")
5536 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 {not available when compiled without the |+diff|
5538 feature}
5539 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005540 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005541
Bram Moolenaardbc28022014-07-26 13:40:44 +02005542 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543'patchmode' 'pm' string (default "")
5544 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005545 When non-empty the oldest version of a file is kept. This can be used
5546 to keep the original version of a file if you are changing files in a
5547 source distribution. Only the first time that a file is written a
5548 copy of the original file will be kept. The name of the copy is the
5549 name of the original file with the string in the 'patchmode' option
5550 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005551 ".orig" or ".org". 'backupdir' must not be empty for this to work
5552 (Detail: The backup file is renamed to the patchmode file after the
5553 new file has been successfully written, that's why it must be possible
5554 to write a backup file). If there was no file to be backed up, an
5555 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 When the 'backupskip' pattern matches, a patchmode file is not made.
5557 Using 'patchmode' for compressed files appends the extension at the
5558 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5559 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005560 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005561
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005562 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005563'path' 'pa' string (default on Unix: ".,/usr/include,,"
5564 on OS/2: ".,/emx/include,,"
5565 other systems: ".,,")
5566 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005567 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005568 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5569 provided that the file being searched for has a relative path (not
5570 starting with "/", "./" or "../"). The directories in the 'path'
5571 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572 - Use commas to separate directory names: >
5573 :set path=.,/usr/local/include,/usr/include
5574< - Spaces can also be used to separate directory names (for backwards
5575 compatibility with version 3.0). To have a space in a directory
5576 name, precede it with an extra backslash, and escape the space: >
5577 :set path=.,/dir/with\\\ space
5578< - To include a comma in a directory name precede it with an extra
5579 backslash: >
5580 :set path=.,/dir/with\\,comma
5581< - To search relative to the directory of the current file, use: >
5582 :set path=.
5583< - To search in the current directory use an empty string between two
5584 commas: >
5585 :set path=,,
5586< - A directory name may end in a ':' or '/'.
5587 - Environment variables are expanded |:set_env|.
5588 - When using |netrw.vim| URLs can be used. For example, adding
5589 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005590 - Search upwards and downwards in a directory tree using "*", "**" and
5591 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005592 {not available when compiled without the |+path_extra| feature}
5593 - Careful with '\' characters, type two to get one in the option: >
5594 :set path=.,c:\\include
5595< Or just use '/' instead: >
5596 :set path=.,c:/include
5597< Don't forget "." or files won't even be found in the same directory as
5598 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005599 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600 it is something like 256 or 1024 characters.
5601 You can check if all the include files are found, using the value of
5602 'path', see |:checkpath|.
5603 The use of |:set+=| and |:set-=| is preferred when adding or removing
5604 directories from the list. This avoids problems when a future version
5605 uses another default. To remove the current directory use: >
5606 :set path-=
5607< To add the current directory use: >
5608 :set path+=
5609< To use an environment variable, you probably need to replace the
5610 separator. Here is an example to append $INCL, in which directory
5611 names are separated with a semi-colon: >
5612 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5613< Replace the ';' with a ':' or whatever separator is used. Note that
5614 this doesn't work when $INCL contains a comma or white space.
5615
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005616 *'perldll'*
5617'perldll' string (default depends on the build)
5618 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005619 {only available when compiled with the |+perl/dyn|
5620 feature}
5621 Specifies the name of the Perl shared library. The default is
5622 DYNAMIC_PERL_DLL, which was specified at compile time.
5623 Environment variables are expanded |:set_env|.
5624 This option cannot be set from a |modeline| or in the |sandbox|, for
5625 security reasons.
5626
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5628'preserveindent' 'pi' boolean (default off)
5629 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 When changing the indent of the current line, preserve as much of the
5631 indent structure as possible. Normally the indent is replaced by a
5632 series of tabs followed by spaces as required (unless |'expandtab'| is
5633 enabled, in which case only spaces are used). Enabling this option
5634 means the indent will preserve as many existing characters as possible
5635 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005636 'expandtab' does not apply to the preserved white space, a Tab remains
5637 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638 NOTE: When using ">>" multiple times the resulting indent is a mix of
5639 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005640 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005641 Also see 'copyindent'.
5642 Use |:retab| to clean up white space.
5643
5644 *'previewheight'* *'pvh'*
5645'previewheight' 'pvh' number (default 12)
5646 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005647 {not available when compiled without the |+quickfix|
5648 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005650 commands. Used for |CTRL-W_}| when no count is given. Not used when
5651 'previewpopup' is set.
5652
5653 *'previewpopup'* *'pvp'*
5654'previewpopup' 'pvp' string (default empty)
5655 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005656 {not available when compiled without the |+textprop|
5657 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005658 When not empty a popup window is used for commands that would open a
5659 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005660 Not used for the insert completion info, add "popup" to
5661 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662
5663 *'previewwindow'* *'nopreviewwindow'*
5664 *'pvw'* *'nopvw'* *E590*
5665'previewwindow' 'pvw' boolean (default off)
5666 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005667 {not available when compiled without the |+quickfix|
5668 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005669 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005670 set. It's normally not set directly, but by using one of the commands
5671 |:ptag|, |:pedit|, etc.
5672
5673 *'printdevice'* *'pdev'*
5674'printdevice' 'pdev' string (default empty)
5675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 {only available when compiled with the |+printer|
5677 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005678 The name of the printer to be used for |:hardcopy|.
5679 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005680 This option cannot be set from a |modeline| or in the |sandbox|, for
5681 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005682
Bram Moolenaar8299df92004-07-10 09:47:34 +00005683 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005684'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005686 {only available when compiled with the |+printer|
5687 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005688 Sets the character encoding used when printing.
5689 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005690
5691 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005692'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005694 {only available when compiled with the |+printer|
5695 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005696 Expression used to print the PostScript produced with |:hardcopy|.
5697 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005698 This option cannot be set from a |modeline| or in the |sandbox|, for
5699 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700
Bram Moolenaar8299df92004-07-10 09:47:34 +00005701 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005702'printfont' 'pfn' string (default "courier")
5703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 {only available when compiled with the |+printer|
5705 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005706 The name of the font that will be used for |:hardcopy|.
5707 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708
5709 *'printheader'* *'pheader'*
5710'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5711 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712 {only available when compiled with the |+printer|
5713 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005714 The format of the header produced in |:hardcopy| output.
5715 See |pheader-option|.
5716
5717 *'printmbcharset'* *'pmbcs'*
5718'printmbcharset' 'pmbcs' string (default "")
5719 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005720 {only available when compiled with the |+printer|
5721 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005722 The CJK character set to be used for CJK output from |:hardcopy|.
5723 See |pmbcs-option|.
5724
5725 *'printmbfont'* *'pmbfn'*
5726'printmbfont' 'pmbfn' string (default "")
5727 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005728 {only available when compiled with the |+printer|
5729 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005730 List of font names to be used for CJK output from |:hardcopy|.
5731 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732
5733 *'printoptions'* *'popt'*
5734'printoptions' 'popt' string (default "")
5735 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005736 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005737 List of items that control the format of the output of |:hardcopy|.
5738 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005740 *'prompt'* *'noprompt'*
5741'prompt' boolean (default on)
5742 global
5743 When on a ":" prompt is used in Ex mode.
5744
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005745 *'pumheight'* *'ph'*
5746'pumheight' 'ph' number (default 0)
5747 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005748 Determines the maximum number of items to show in the popup menu for
5749 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005750 |ins-completion-menu|.
5751
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005752 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005753'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005754 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005755 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005756 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005757
Bram Moolenaard94464e2015-11-02 15:28:18 +01005758 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005759'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005760 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005761 {only available when compiled with the |+python/dyn|
5762 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005763 Specifies the name of the Python 2.x shared library. The default is
5764 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005765 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005766 This option cannot be set from a |modeline| or in the |sandbox|, for
5767 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005768
Bram Moolenaar94073162018-01-31 21:49:05 +01005769 *'pythonhome'*
5770'pythonhome' string (default "")
5771 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005772 {only available when compiled with the |+python/dyn|
5773 feature}
5774 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5775 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5776 which was specified at compile time, will be used for the Python 2.x
5777 home directory.
5778 Environment variables are expanded |:set_env|.
5779 This option cannot be set from a |modeline| or in the |sandbox|, for
5780 security reasons.
5781
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005782 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005783'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005784 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005785 {only available when compiled with the |+python3/dyn|
5786 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005787 Specifies the name of the Python 3 shared library. The default is
5788 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005789 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005790 This option cannot be set from a |modeline| or in the |sandbox|, for
5791 security reasons.
5792
Bram Moolenaar94073162018-01-31 21:49:05 +01005793 *'pythonthreehome'*
5794'pythonthreehome' string (default "")
5795 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005796 {only available when compiled with the |+python3/dyn|
5797 feature}
5798 Specifies the name of the Python 3 home directory. When
5799 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5800 PYTHON3_HOME, which was specified at compile time, will be used for
5801 the Python 3 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 Moolenaarf42dd3c2017-01-28 16:06:38 +01005806 *'pyxversion'* *'pyx'*
5807'pyxversion' 'pyx' number (default depends on the build)
5808 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005809 {only available when compiled with the |+python| or
5810 the |+python3| feature}
5811 Specifies the python version used for pyx* functions and commands
5812 |python_x|. The default value is as follows:
5813
5814 Compiled with Default ~
5815 |+python| and |+python3| 0
5816 only |+python| 2
5817 only |+python3| 3
5818
5819 Available values are 0, 2 and 3.
5820 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5821 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5822 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5823 to 2 if Python 2 is available.
5824 See also: |has-pythonx|
5825
5826 If Vim is compiled with only |+python| or |+python3| setting
5827 'pyxversion' has no effect. The pyx* functions and commands are
5828 always the same as the compiled version.
5829
5830 This option cannot be set from a |modeline| or in the |sandbox|, for
5831 security reasons.
5832
Bram Moolenaar677ee682005-01-27 14:41:15 +00005833 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005834'quoteescape' 'qe' string (default "\")
5835 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005836 The characters that are used to escape quotes in a string. Used for
5837 objects like a', a" and a` |a'|.
5838 When one of the characters in this option is found inside a string,
5839 the following character will be skipped. The default value makes the
5840 text "foo\"bar\\" considered to be one string.
5841
Bram Moolenaar071d4272004-06-13 20:20:40 +00005842 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5843'readonly' 'ro' boolean (default off)
5844 local to buffer
5845 If on, writes fail unless you use a '!'. Protects you from
5846 accidentally overwriting a file. Default on when Vim is started
5847 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005848 When using ":w!" the 'readonly' option is reset for the current
5849 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005850 When using the ":view" command the 'readonly' option is set for the
5851 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005852 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005853
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005854 *'redrawtime'* *'rdt'*
5855'redrawtime' 'rdt' number (default 2000)
5856 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005857 {only available when compiled with the |+reltime|
5858 feature}
5859 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005860 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005861 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005862 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005863 matches will be highlighted.
5864 For syntax highlighting the time applies per window. When over the
5865 limit syntax highlighting is disabled until |CTRL-L| is used.
5866 This is used to avoid that Vim hangs when using a very complicated
5867 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005868
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005869 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005870'regexpengine' 're' number (default 0)
5871 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005872 This selects the default regexp engine. |two-engines|
5873 The possible values are:
5874 0 automatic selection
5875 1 old engine
5876 2 NFA engine
5877 Note that when using the NFA engine and the pattern contains something
5878 that is not supported the pattern will not match. This is only useful
5879 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005880 Using automatic selection enables Vim to switch the engine, if the
5881 default engine becomes too costly. E.g., when the NFA engine uses too
5882 many states. This should prevent Vim from hanging on a combination of
5883 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005884
Bram Moolenaar64486672010-05-16 15:46:46 +02005885 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5886'relativenumber' 'rnu' boolean (default off)
5887 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005888 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005889 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005890 precede some vertical motion commands (e.g. j k + -) with, without
5891 having to calculate it yourself. Especially useful in combination with
5892 other commands (e.g. y d c < > gq gw =).
5893 When the 'n' option is excluded from 'cpoptions' a wrapped
5894 line will not use the column of line numbers (this is the default when
5895 'compatible' isn't set).
5896 The 'numberwidth' option can be used to set the room used for the line
5897 number.
5898 When a long, wrapped line doesn't start with the first character, '-'
5899 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005900 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5901 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005902
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005903 The number in front of the cursor line also depends on the value of
5904 'number', see |number_relativenumber| for all combinations of the two
5905 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005906
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 *'remap'* *'noremap'*
5908'remap' boolean (default on)
5909 global
5910 Allows for mappings to work recursively. If you do not want this for
5911 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005912 NOTE: To avoid portability problems with Vim scripts, always keep
5913 this option at the default "on". Only switch it off when working with
5914 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005915
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005916 *'renderoptions'* *'rop'*
5917'renderoptions' 'rop' string (default: empty)
5918 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005919 {only available when compiled with GUI and DIRECTX on
5920 MS-Windows}
5921 Select a text renderer and set its options. The options depend on the
5922 renderer.
5923
5924 Syntax: >
5925 set rop=type:{renderer}(,{name}:{value})*
5926<
5927 Currently, only one optional renderer is available.
5928
5929 render behavior ~
5930 directx Vim will draw text using DirectX (DirectWrite). It makes
5931 drawn glyphs more beautiful than default GDI.
5932 It requires 'encoding' is "utf-8", and only works on
5933 MS-Windows Vista or newer version.
5934
5935 Options:
5936 name meaning type value ~
5937 gamma gamma float 1.0 - 2.2 (maybe)
5938 contrast enhancedContrast float (unknown)
5939 level clearTypeLevel float (unknown)
5940 geom pixelGeometry int 0 - 2 (see below)
5941 renmode renderingMode int 0 - 6 (see below)
5942 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01005943 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005944
Bram Moolenaar92467d32017-12-05 13:22:16 +01005945 See this URL for detail (except for scrlines):
5946 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005947
5948 For geom: structure of a device pixel.
5949 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5950 1 - DWRITE_PIXEL_GEOMETRY_RGB
5951 2 - DWRITE_PIXEL_GEOMETRY_BGR
5952
5953 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005954 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005955
5956 For renmode: method of rendering glyphs.
5957 0 - DWRITE_RENDERING_MODE_DEFAULT
5958 1 - DWRITE_RENDERING_MODE_ALIASED
5959 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5960 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5961 4 - DWRITE_RENDERING_MODE_NATURAL
5962 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5963 6 - DWRITE_RENDERING_MODE_OUTLINE
5964
5965 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005966 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005967
5968 For taamode: antialiasing mode used for drawing text.
5969 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5970 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5971 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5972 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5973
5974 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005975 https://msdn.microsoft.com/en-us/library/dd368170.aspx
5976
Bram Moolenaara338adc2018-01-31 20:51:47 +01005977 For scrlines:
5978 This was used for optimizing scrolling behavior, however this
5979 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005980
5981 Example: >
5982 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005983 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005984 set rop=type:directx
5985<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005986 If select a raster font (Courier, Terminal or FixedSys which
5987 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01005988 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005989
5990 NOTE: It is known that some fonts and options combination
5991 causes trouble on drawing glyphs.
5992
Bram Moolenaar92467d32017-12-05 13:22:16 +01005993 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005994 special made fonts (True-Type fonts which includes only
5995 bitmap glyphs).
5996 - 'taamode:3' will not work with some vector fonts.
5997
5998 NOTE: With this option, you can display colored emoji
5999 (emoticon) in Windows 8.1 or later. To display colored emoji,
6000 there are some conditions which you should notice.
6001
6002 - If your font includes non-colored emoji already, it will
6003 be used.
6004 - If your font doesn't have emoji, the system chooses an
6005 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6006 will be used.
6007 - When this alternative font didn't have fixed width glyph,
6008 emoji might be rendered beyond the bounding box of drawing
6009 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006010
6011 Other render types are currently not supported.
6012
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 *'report'*
6014'report' number (default 2)
6015 global
6016 Threshold for reporting number of lines changed. When the number of
6017 changed lines is more than 'report' a message will be given for most
6018 ":" commands. If you want it always, set 'report' to 0.
6019 For the ":substitute" command the number of substitutions is used
6020 instead of the number of lines.
6021
6022 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6023'restorescreen' 'rs' boolean (default on)
6024 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006025 {only in Windows 95/NT console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006026 When set, the screen contents is restored when exiting Vim. This also
6027 happens when executing external commands.
6028
6029 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6030 options in your .vimrc. To disable restoring:
6031 set t_ti= t_te=
6032 To enable restoring (for an xterm):
6033 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6034 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6035
6036 *'revins'* *'ri'* *'norevins'* *'nori'*
6037'revins' 'ri' boolean (default off)
6038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 {only available when compiled with the |+rightleft|
6040 feature}
6041 Inserting characters in Insert mode will work backwards. See "typing
6042 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6043 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006044 NOTE: This option is reset when 'compatible' is set.
6045 This option is reset when 'paste' is set and restored when 'paste' is
6046 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006047
6048 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6049'rightleft' 'rl' boolean (default off)
6050 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051 {only available when compiled with the |+rightleft|
6052 feature}
6053 When on, display orientation becomes right-to-left, i.e., characters
6054 that are stored in the file appear from the right to the left.
6055 Using this option, it is possible to edit files for languages that
6056 are written from the right to the left such as Hebrew and Arabic.
6057 This option is per window, so it is possible to edit mixed files
6058 simultaneously, or to view the same file in both ways (this is
6059 useful whenever you have a mixed text file with both right-to-left
6060 and left-to-right strings so that both sets are displayed properly
6061 in different windows). Also see |rileft.txt|.
6062
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006063 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006064'rightleftcmd' 'rlc' string (default "search")
6065 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 {only available when compiled with the |+rightleft|
6067 feature}
6068 Each word in this option enables the command line editing to work in
6069 right-to-left mode for a group of commands:
6070
6071 search "/" and "?" commands
6072
6073 This is useful for languages such as Hebrew, Arabic and Farsi.
6074 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6075
Bram Moolenaard94464e2015-11-02 15:28:18 +01006076 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006077'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006078 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006079 {only available when compiled with the |+ruby/dyn|
6080 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006081 Specifies the name of the Ruby shared library. The default is
6082 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006083 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006084 This option cannot be set from a |modeline| or in the |sandbox|, for
6085 security reasons.
6086
Bram Moolenaar071d4272004-06-13 20:20:40 +00006087 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006088'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006090 {not available when compiled without the
6091 |+cmdline_info| feature}
6092 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006093 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094 text in the file is shown on the far right:
6095 Top first line is visible
6096 Bot last line is visible
6097 All first and last line are visible
6098 45% relative position in the file
6099 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006100 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006102 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 this option takes precedence over 'ruler' and 'rulerformat'
6104 If the number of characters displayed is different from the number of
6105 bytes in the text (e.g., for a TAB or a multi-byte character), both
6106 the text column (byte number) and the screen column are shown,
6107 separated with a dash.
6108 For an empty line "0-1" is shown.
6109 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006110 This option is reset when 'paste' is set and restored when 'paste' is
6111 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006112 If you don't want to see the ruler all the time but want to know where
6113 you are, use "g CTRL-G" |g_CTRL-G|.
6114 NOTE: This option is reset when 'compatible' is set.
6115
6116 *'rulerformat'* *'ruf'*
6117'rulerformat' 'ruf' string (default empty)
6118 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119 {not available when compiled without the |+statusline|
6120 feature}
6121 When this option is not empty, it determines the content of the ruler
6122 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006123 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006124 This option cannot be set in a modeline when 'modelineexpr' is off.
6125
Bram Moolenaar071d4272004-06-13 20:20:40 +00006126 The default ruler width is 17 characters. To make the ruler 15
6127 characters wide, put "%15(" at the start and "%)" at the end.
6128 Example: >
6129 :set rulerformat=%15(%c%V\ %p%%%)
6130<
6131 *'runtimepath'* *'rtp'* *vimfiles*
6132'runtimepath' 'rtp' string (default:
6133 Unix: "$HOME/.vim,
6134 $VIM/vimfiles,
6135 $VIMRUNTIME,
6136 $VIM/vimfiles/after,
6137 $HOME/.vim/after"
6138 Amiga: "home:vimfiles,
6139 $VIM/vimfiles,
6140 $VIMRUNTIME,
6141 $VIM/vimfiles/after,
6142 home:vimfiles/after"
6143 PC, OS/2: "$HOME/vimfiles,
6144 $VIM/vimfiles,
6145 $VIMRUNTIME,
6146 $VIM/vimfiles/after,
6147 $HOME/vimfiles/after"
6148 Macintosh: "$VIM:vimfiles,
6149 $VIMRUNTIME,
6150 $VIM:vimfiles:after"
6151 RISC-OS: "Choices:vimfiles,
6152 $VIMRUNTIME,
6153 Choices:vimfiles/after"
6154 VMS: "sys$login:vimfiles,
6155 $VIM/vimfiles,
6156 $VIMRUNTIME,
6157 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006158 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006160 This is a list of directories which will be searched for runtime
6161 files:
6162 filetype.vim filetypes by file name |new-filetype|
6163 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006164 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006165 colors/ color scheme files |:colorscheme|
6166 compiler/ compiler files |:compiler|
6167 doc/ documentation |write-local-help|
6168 ftplugin/ filetype plugins |write-filetype-plugin|
6169 indent/ indent scripts |indent-expression|
6170 keymap/ key mapping files |mbyte-keymap|
6171 lang/ menu translations |:menutrans|
6172 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006173 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 plugin/ plugin scripts |write-plugin|
6175 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006176 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006177 syntax/ syntax files |mysyntaxfile|
6178 tutor/ files for vimtutor |tutor|
6179
6180 And any other file searched for with the |:runtime| command.
6181
6182 The defaults for most systems are setup to search five locations:
6183 1. In your home directory, for your personal preferences.
6184 2. In a system-wide Vim directory, for preferences from the system
6185 administrator.
6186 3. In $VIMRUNTIME, for files distributed with Vim.
6187 *after-directory*
6188 4. In the "after" directory in the system-wide Vim directory. This is
6189 for the system administrator to overrule or add to the distributed
6190 defaults (rarely needed)
6191 5. In the "after" directory in your home directory. This is for
6192 personal preferences to overrule or add to the distributed defaults
6193 or system-wide settings (rarely needed).
6194
Bram Moolenaard0796902016-09-16 20:02:31 +02006195 More entries are added when using |packages|. If it gets very long
6196 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6197 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006198
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6200 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006201 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202 wildcards.
6203 See |:runtime|.
6204 Example: >
6205 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6206< This will use the directory "~/vimruntime" first (containing your
6207 personal Vim runtime files), then "/mygroup/vim" (shared between a
6208 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6209 files).
6210 You probably should always include $VIMRUNTIME somewhere, to use the
6211 distributed runtime files. You can put a directory before $VIMRUNTIME
6212 to find files which replace a distributed runtime files. You can put
6213 a directory after $VIMRUNTIME to find files which add to distributed
6214 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006215 When Vim is started with |--clean| the home directory entries are not
6216 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217 This option cannot be set from a |modeline| or in the |sandbox|, for
6218 security reasons.
6219
6220 *'scroll'* *'scr'*
6221'scroll' 'scr' number (default: half the window height)
6222 local to window
6223 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6224 set to half the number of lines in the window when the window size
6225 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006226 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006227 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006228
6229 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6230'scrollbind' 'scb' boolean (default off)
6231 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232 See also |scroll-binding|. When this option is set, the current
6233 window scrolls as other scrollbind windows (windows that also have
6234 this option set) scroll. This option is useful for viewing the
6235 differences between two versions of a file, see 'diff'.
6236 See |'scrollopt'| for options that determine how this option should be
6237 interpreted.
6238 This option is mostly reset when splitting a window to edit another
6239 file. This means that ":split | edit file" results in two windows
6240 with scroll-binding, but ":split file" does not.
6241
6242 *'scrolljump'* *'sj'*
6243'scrolljump' 'sj' number (default 1)
6244 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006245 Minimal number of lines to scroll when the cursor gets off the
6246 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6247 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006248 When set to a negative number from -1 to -100 this is used as the
6249 percentage of the window height. Thus -50 scrolls half the window
6250 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 NOTE: This option is set to 1 when 'compatible' is set.
6252
6253 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006254'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006255 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 Minimal number of screen lines to keep above and below the cursor.
6257 This will make some context visible around where you are working. If
6258 you set it to a very large value (999) the cursor line will always be
6259 in the middle of the window (except at the start or end of the file or
6260 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006261 After using the local value, go back the global value with one of
6262 these two: >
6263 setlocal scrolloff<
6264 setlocal scrolloff=-1
6265< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 NOTE: This option is set to 0 when 'compatible' is set.
6267
6268 *'scrollopt'* *'sbo'*
6269'scrollopt' 'sbo' string (default "ver,jump")
6270 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006272 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6273 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006274 The following words are available:
6275 ver Bind vertical scrolling for 'scrollbind' windows
6276 hor Bind horizontal scrolling for 'scrollbind' windows
6277 jump Applies to the offset between two windows for vertical
6278 scrolling. This offset is the difference in the first
6279 displayed line of the bound windows. When moving
6280 around in a window, another 'scrollbind' window may
6281 reach a position before the start or after the end of
6282 the buffer. The offset is not changed though, when
6283 moving back the 'scrollbind' window will try to scroll
6284 to the desired position when possible.
6285 When now making that window the current one, two
6286 things can be done with the relative offset:
6287 1. When "jump" is not included, the relative offset is
6288 adjusted for the scroll position in the new current
6289 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006290 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006291 2. When "jump" is included, the other windows are
6292 scrolled to keep the same relative offset. When
6293 going back to the other window, it still uses the
6294 same relative offset.
6295 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006296 When 'diff' mode is active there always is vertical scroll binding,
6297 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298
6299 *'sections'* *'sect'*
6300'sections' 'sect' string (default "SHNHH HUnhsh")
6301 global
6302 Specifies the nroff macros that separate sections. These are pairs of
6303 two letters (See |object-motions|). The default makes a section start
6304 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6305
6306 *'secure'* *'nosecure'* *E523*
6307'secure' boolean (default off)
6308 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006309 When on, ":autocmd", shell and write commands are not allowed in
6310 ".vimrc" and ".exrc" in the current directory and map commands are
6311 displayed. Switch it off only if you know that you will not run into
6312 problems, or when the 'exrc' option is off. On Unix this option is
6313 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006314 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315 'secure' at the end of your ~/.vimrc then.
6316 This option cannot be set from a |modeline| or in the |sandbox|, for
6317 security reasons.
6318
6319 *'selection'* *'sel'*
6320'selection' 'sel' string (default "inclusive")
6321 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322 This option defines the behavior of the selection. It is only used
6323 in Visual and Select mode.
6324 Possible values:
6325 value past line inclusive ~
6326 old no yes
6327 inclusive yes yes
6328 exclusive yes no
6329 "past line" means that the cursor is allowed to be positioned one
6330 character past the line.
6331 "inclusive" means that the last character of the selection is included
6332 in an operation. For example, when "x" is used to delete the
6333 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006334 When "old" is used and 'virtualedit' allows the cursor to move past
6335 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 Note that when "exclusive" is used and selecting from the end
6337 backwards, you cannot include the last character of a line, when
6338 starting in Normal mode and 'virtualedit' empty.
6339
6340 The 'selection' option is set by the |:behave| command.
6341
6342 *'selectmode'* *'slm'*
6343'selectmode' 'slm' string (default "")
6344 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 This is a comma separated list of words, which specifies when to start
6346 Select mode instead of Visual mode, when a selection is started.
6347 Possible values:
6348 mouse when using the mouse
6349 key when using shifted special keys
6350 cmd when using "v", "V" or CTRL-V
6351 See |Select-mode|.
6352 The 'selectmode' option is set by the |:behave| command.
6353
6354 *'sessionoptions'* *'ssop'*
6355'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006356 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006358 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 feature}
6360 Changes the effect of the |:mksession| command. It is a comma
6361 separated list of words. Each word enables saving and restoring
6362 something:
6363 word save and restore ~
6364 blank empty windows
6365 buffers hidden and unloaded buffers, not just those in windows
6366 curdir the current directory
6367 folds manually created folds, opened/closed folds and local
6368 fold options
6369 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006370 and contain at least one lowercase letter. Only
6371 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 help the help window
6373 localoptions options and mappings local to a window or buffer (not
6374 global values for local options)
6375 options all options and mappings (also global values for local
6376 options)
6377 resize size of the Vim window: 'lines' and 'columns'
6378 sesdir the directory in which the session file is located
6379 will become the current directory (useful with
6380 projects accessed over a network from different
6381 systems)
6382 slash backslashes in file names replaced with forward
6383 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006384 tabpages all tab pages; without this only the current tab page
6385 is restored, so that you can make a session for each
6386 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006387 terminal include terminal windows where the command can be
6388 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006389 unix with Unix end-of-line format (single <NL>), even when
6390 on Windows or DOS
6391 winpos position of the whole Vim window
6392 winsize window sizes
6393
6394 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006395 When neither "curdir" nor "sesdir" is included, file names are stored
6396 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397 "slash" and "unix" are useful on Windows when sharing session files
6398 with Unix. The Unix version of Vim cannot source dos format scripts,
6399 but the Windows version of Vim can source unix format scripts.
6400
6401 *'shell'* *'sh'* *E91*
6402'shell' 'sh' string (default $SHELL or "sh",
6403 MS-DOS and Win32: "command.com" or
6404 "cmd.exe", OS/2: "cmd")
6405 global
6406 Name of the shell to use for ! and :! commands. When changing the
6407 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6408 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006409 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 See |option-backslash| about including spaces and backslashes.
6411 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006412
Bram Moolenaar071d4272004-06-13 20:20:40 +00006413 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006414 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6416< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006417 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006419 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006421 Example with escaped space (Vim will do this when initializing the
6422 option from $SHELL): >
6423 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006424< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006425 backslashes are consumed by `:set`.
6426
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427 Under MS-Windows, when the executable ends in ".com" it must be
6428 included. Thus setting the shell to "command.com" or "4dos.com"
6429 works, but "command" and "4dos" do not work for all commands (e.g.,
6430 filtering).
6431 For unknown reasons, when using "4dos.com" the current directory is
6432 changed to "C:\". To avoid this set 'shell' like this: >
6433 :set shell=command.com\ /c\ 4dos
6434< This option cannot be set from a |modeline| or in the |sandbox|, for
6435 security reasons.
6436
6437 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006438'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006439 MS-DOS and Win32, when 'shell' does not
6440 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6443 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6444 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006445 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006446 On Unix it can have more than one flag. Each white space separated
6447 part is passed as an argument to the shell command.
6448 See |option-backslash| about including spaces and backslashes.
6449 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 This option cannot be set from a |modeline| or in the |sandbox|, for
6451 security reasons.
6452
6453 *'shellpipe'* *'sp'*
6454'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6455 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456 {not available when compiled without the |+quickfix|
6457 feature}
6458 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006459 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006460 including spaces and backslashes.
6461 The name of the temporary file can be represented by "%s" if necessary
6462 (the file name is appended automatically if no %s appears in the value
6463 of this option).
6464 For the Amiga and MS-DOS the default is ">". The output is directly
6465 saved in a file and not echoed to the screen.
6466 For Unix the default it "| tee". The stdout of the compiler is saved
6467 in a file and echoed to the screen. If the 'shell' option is "csh" or
6468 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006469 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6470 default becomes "2>&1| tee". This means that stderr is also included.
6471 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6472 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 The initialization of this option is done after reading the ".vimrc"
6474 and the other initializations, so that when the 'shell' option is set
6475 there, the 'shellpipe' option changes automatically, unless it was
6476 explicitly set before.
6477 When 'shellpipe' is set to an empty string, no redirection of the
6478 ":make" output will be done. This is useful if you use a 'makeprg'
6479 that writes to 'makeef' by itself. If you want no piping, but do
6480 want to include the 'makeef', set 'shellpipe' to a single space.
6481 Don't forget to precede the space with a backslash: ":set sp=\ ".
6482 In the future pipes may be used for filtering and this option will
6483 become obsolete (at least for Unix).
6484 This option cannot be set from a |modeline| or in the |sandbox|, for
6485 security reasons.
6486
6487 *'shellquote'* *'shq'*
6488'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6489 contains "sh" somewhere: "\"")
6490 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491 Quoting character(s), put around the command passed to the shell, for
6492 the "!" and ":!" commands. The redirection is kept outside of the
6493 quoting. See 'shellxquote' to include the redirection. It's
6494 probably not useful to set both options.
6495 This is an empty string by default. Only known to be useful for
6496 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6497 or bash, where it should be "\"". The default is adjusted according
6498 the value of 'shell', to reduce the need to set this option by the
6499 user. See |dos-shell|.
6500 This option cannot be set from a |modeline| or in the |sandbox|, for
6501 security reasons.
6502
6503 *'shellredir'* *'srr'*
6504'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6505 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 String to be used to put the output of a filter command in a temporary
6507 file. See also |:!|. See |option-backslash| about including spaces
6508 and backslashes.
6509 The name of the temporary file can be represented by "%s" if necessary
6510 (the file name is appended automatically if no %s appears in the value
6511 of this option).
6512 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6513 or "zsh" during initializations, the default becomes ">&". If the
6514 'shell' option is "sh", "ksh" or "bash" the default becomes
6515 ">%s 2>&1". This means that stderr is also included.
6516 For Win32, the Unix checks are done and additionally "cmd" is checked
6517 for, which makes the default ">%s 2>&1". Also, the same names with
6518 ".exe" appended are checked for.
6519 The initialization of this option is done after reading the ".vimrc"
6520 and the other initializations, so that when the 'shell' option is set
6521 there, the 'shellredir' option changes automatically unless it was
6522 explicitly set before.
6523 In the future pipes may be used for filtering and this option will
6524 become obsolete (at least for Unix).
6525 This option cannot be set from a |modeline| or in the |sandbox|, for
6526 security reasons.
6527
6528 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6529'shellslash' 'ssl' boolean (default off)
6530 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006531 {only for MSDOS, MS-Windows and OS/2}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 When set, a forward slash is used when expanding file names. This is
6533 useful when a Unix-like shell is used instead of command.com or
6534 cmd.exe. Backward slashes can still be typed, but they are changed to
6535 forward slashes by Vim.
6536 Note that setting or resetting this option has no effect for some
6537 existing file names, thus this option needs to be set before opening
6538 any file for best results. This might change in the future.
6539 'shellslash' only works when a backslash can be used as a path
6540 separator. To test if this is so use: >
6541 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006542< Also see 'completeslash'.
6543
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006544 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6545'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6546 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006547 When on, use temp files for shell commands. When off use a pipe.
6548 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006549 Currently a pipe is only supported on Unix and MS-Windows 2K and
6550 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006551 :if has("filterpipe")
6552< The advantage of using a pipe is that nobody can read the temp file
6553 and the 'shell' command does not need to support redirection.
6554 The advantage of using a temp file is that the file type and encoding
6555 can be detected.
6556 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6557 |FilterWritePost| autocommands event are not triggered when
6558 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006559 The `system()` function does not respect this option and always uses
6560 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006561 NOTE: This option is set to the Vim default value when 'compatible'
6562 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006563
Bram Moolenaar071d4272004-06-13 20:20:40 +00006564 *'shelltype'* *'st'*
6565'shelltype' 'st' number (default 0)
6566 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006567 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 On the Amiga this option influences the way how the commands work
6569 which use a shell.
6570 0 and 1: always use the shell
6571 2 and 3: use the shell only to filter lines
6572 4 and 5: use shell only for ':sh' command
6573 When not using the shell, the command is executed directly.
6574
6575 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6576 1 and 3: use "shell cmd" to start external commands
6577
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006578 *'shellxescape'* *'sxe'*
6579'shellxescape' 'sxe' string (default: "";
6580 for MS-DOS and MS-Windows: "\"&|<>()@^")
6581 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006582 When 'shellxquote' is set to "(" then the characters listed in this
6583 option will be escaped with a '^' character. This makes it possible
6584 to execute most external commands with cmd.exe.
6585
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 *'shellxquote'* *'sxq'*
6587'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006588 for Win32, when 'shell' is cmd.exe: "("
6589 for Win32, when 'shell' contains "sh"
6590 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006591 for Unix, when using system(): "\"")
6592 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006593 Quoting character(s), put around the command passed to the shell, for
6594 the "!" and ":!" commands. Includes the redirection. See
6595 'shellquote' to exclude the redirection. It's probably not useful
6596 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006597 When the value is '(' then ')' is appended. When the value is '"('
6598 then ')"' is appended.
6599 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006600 This is an empty string by default on most systems, but is known to be
6601 useful for on Win32 version, either for cmd.exe which automatically
6602 strips off the first and last quote on a command, or 3rd-party shells
6603 such as the MKS Korn Shell or bash, where it should be "\"". The
6604 default is adjusted according the value of 'shell', to reduce the need
6605 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006606 This option cannot be set from a |modeline| or in the |sandbox|, for
6607 security reasons.
6608
6609 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6610'shiftround' 'sr' boolean (default off)
6611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006612 Round indent to multiple of 'shiftwidth'. Applies to > and <
6613 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6614 a multiple of 'shiftwidth' (this is Vi compatible).
6615 NOTE: This option is reset when 'compatible' is set.
6616
6617 *'shiftwidth'* *'sw'*
6618'shiftwidth' 'sw' number (default 8)
6619 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006620 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006621 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006622 When zero the 'ts' value will be used. Use the |shiftwidth()|
6623 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006624
6625 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006626'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6627 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006628 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 This option helps to avoid all the |hit-enter| prompts caused by file
6630 messages, for example with CTRL-G, and to avoid some other messages.
6631 It is a list of flags:
6632 flag meaning when present ~
6633 f use "(3 of 5)" instead of "(file 3 of 5)"
6634 i use "[noeol]" instead of "[Incomplete last line]"
6635 l use "999L, 888C" instead of "999 lines, 888 characters"
6636 m use "[+]" instead of "[Modified]"
6637 n use "[New]" instead of "[New File]"
6638 r use "[RO]" instead of "[readonly]"
6639 w use "[w]" instead of "written" for file write message
6640 and "[a]" instead of "appended" for ':w >> file' command
6641 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6642 "[unix format]" and "[mac]" instead of "[mac format]".
6643 a all of the above abbreviations
6644
6645 o overwrite message for writing a file with subsequent message
6646 for reading a file (useful for ":wn" or when 'autowrite' on)
6647 O message for reading a file overwrites any previous message.
6648 Also for quickfix message (e.g., ":cn").
6649 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006650 hit TOP, continuing at BOTTOM" messages; when using the search
6651 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 t truncate file message at the start if it is too long to fit
6653 on the command-line, "<" will appear in the left most column.
6654 Ignored in Ex mode.
6655 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006656 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 Ignored in Ex mode.
6658 W don't give "written" or "[w]" when writing a file
6659 A don't give the "ATTENTION" message when an existing swap file
6660 is found.
6661 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006662 c don't give |ins-completion-menu| messages. For example,
6663 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6664 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006665 q use "recording" instead of "recording @a"
6666 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006667 was used for the command; note that this also affects messages
6668 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006669 S do not show search count message when searching, e.g.
6670 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671
6672 This gives you the opportunity to avoid that a change between buffers
6673 requires you to hit <Enter>, but still gives as useful a message as
6674 possible for the space available. To get the whole message that you
6675 would have got with 'shm' empty, use ":file!"
6676 Useful values:
6677 shm= No abbreviation of message.
6678 shm=a Abbreviation, but no loss of information.
6679 shm=at Abbreviation, and truncate message when necessary.
6680
6681 NOTE: This option is set to the Vi default value when 'compatible' is
6682 set and to the Vim default value when 'compatible' is reset.
6683
6684 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6685'shortname' 'sn' boolean (default off)
6686 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 Filenames are assumed to be 8 characters plus one extension of 3
6688 characters. Multiple dots in file names are not allowed. When this
6689 option is on, dots in file names are replaced with underscores when
6690 adding an extension (".~" or ".swp"). This option is not available
6691 for MS-DOS, because then it would always be on. This option is useful
6692 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6693 or crossdos. When running the Win32 GUI version under Win32s, this
6694 option is always on by default.
6695
6696 *'showbreak'* *'sbr'* *E595*
6697'showbreak' 'sbr' string (default "")
6698 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006699 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006700 feature}
6701 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006702 values are "> " or "+++ ": >
6703 :set showbreak=>\
6704< Note the backslash to escape the trailing space. It's easier like
6705 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006706 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006707< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 comma (in a future version the comma might be used to separate the
6709 part that is shown at the end and at the start of a line).
6710 The characters are highlighted according to the '@' flag in
6711 'highlight'.
6712 Note that tabs after the showbreak will be displayed differently.
6713 If you want the 'showbreak' to appear in between line numbers, add the
6714 "n" flag to 'cpoptions'.
6715
6716 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006717'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6718 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 {not available when compiled without the
6721 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006722 Show (partial) command in the last line of the screen. Set this
6723 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 In Visual mode the size of the selected area is shown:
6725 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006726 If the number of bytes is different it is also displayed: "2-6"
6727 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006729 - When selecting a block, the size in screen characters:
6730 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006731 NOTE: This option is set to the Vi default value when 'compatible' is
6732 set and to the Vim default value when 'compatible' is reset.
6733
6734 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6735'showfulltag' 'sft' boolean (default off)
6736 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006737 When completing a word in insert mode (see |ins-completion|) from the
6738 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006739 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 matched a C function, you can see a template for what arguments are
6741 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006742 Note that this doesn't work well together with having "longest" in
6743 'completeopt', because the completion from the search pattern may not
6744 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006745
6746 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6747'showmatch' 'sm' boolean (default off)
6748 global
6749 When a bracket is inserted, briefly jump to the matching one. The
6750 jump is only done if the match can be seen on the screen. The time to
6751 show the match can be set with 'matchtime'.
6752 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006753 seen or not).
6754 This option is reset when 'paste' is set and restored when 'paste' is
6755 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006756 When the 'm' flag is not included in 'cpoptions', typing a character
6757 will immediately move the cursor back to where it belongs.
6758 See the "sm" field in 'guicursor' for setting the cursor shape and
6759 blinking when showing the match.
6760 The 'matchpairs' option can be used to specify the characters to show
6761 matches for. 'rightleft' and 'revins' are used to look for opposite
6762 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006763 Also see the matchparen plugin for highlighting the match when moving
6764 around |pi_paren.txt|.
6765 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766
6767 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6768'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6769 global
6770 If in Insert, Replace or Visual mode put a message on the last line.
6771 Use the 'M' flag in 'highlight' to set the type of highlighting for
6772 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006773 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006774 doesn't mean XIM is really active, especially when 'imactivatekey' is
6775 not set.
6776 NOTE: This option is set to the Vi default value when 'compatible' is
6777 set and to the Vim default value when 'compatible' is reset.
6778
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006779 *'showtabline'* *'stal'*
6780'showtabline' 'stal' number (default 1)
6781 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006782 The value of this option specifies when the line with tab page labels
6783 will be displayed:
6784 0: never
6785 1: only if there are at least two tab pages
6786 2: always
6787 This is both for the GUI and non-GUI implementation of the tab pages
6788 line.
6789 See |tab-page| for more information about tab pages.
6790
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791 *'sidescroll'* *'ss'*
6792'sidescroll' 'ss' number (default 0)
6793 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794 The minimal number of columns to scroll horizontally. Used only when
6795 the 'wrap' option is off and the cursor is moved off of the screen.
6796 When it is zero the cursor will be put in the middle of the screen.
6797 When using a slow terminal set it to a large number or 0. When using
6798 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6799 commands.
6800
6801 *'sidescrolloff'* *'siso'*
6802'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006803 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006804 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006805 right of the cursor if 'nowrap' is set. Setting this option to a
6806 value greater than 0 while having |'sidescroll'| also at a non-zero
6807 value makes some context visible in the line you are scrolling in
6808 horizontally (except at beginning of the line). Setting this option
6809 to a large value (like 999) has the effect of keeping the cursor
6810 horizontally centered in the window, as long as one does not come too
6811 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006812 After using the local value, go back the global value with one of
6813 these two: >
6814 setlocal sidescrolloff<
6815 setlocal sidescrolloff=-1
6816< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817
6818 Example: Try this together with 'sidescroll' and 'listchars' as
6819 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006820 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821
6822 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6823 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006824<
6825 *'signcolumn'* *'scl'*
6826'signcolumn' 'scl' string (default "auto")
6827 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006828 {not available when compiled without the |+signs|
6829 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006830 Whether or not to draw the signcolumn. Valid values are:
6831 "auto" only when there is a sign to display
6832 "no" never
6833 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006834 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006835 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836
6837
6838 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6839'smartcase' 'scs' boolean (default off)
6840 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841 Override the 'ignorecase' option if the search pattern contains upper
6842 case characters. Only used when the search pattern is typed and
6843 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006844 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6846 recalling the search pattern from history and hitting <Enter>.
6847 NOTE: This option is reset when 'compatible' is set.
6848
6849 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6850'smartindent' 'si' boolean (default off)
6851 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852 {not available when compiled without the
6853 |+smartindent| feature}
6854 Do smart autoindenting when starting a new line. Works for C-like
6855 programs, but can also be used for other languages. 'cindent' does
6856 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006857 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006858 setting 'si' has no effect. 'indentexpr' is a more advanced
6859 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 Normally 'autoindent' should also be on when using 'smartindent'.
6861 An indent is automatically inserted:
6862 - After a line ending in '{'.
6863 - After a line starting with a keyword from 'cinwords'.
6864 - Before a line starting with '}' (only with the "O" command).
6865 When typing '}' as the first character in a new line, that line is
6866 given the same indent as the matching '{'.
6867 When typing '#' as the first character in a new line, the indent for
6868 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006869 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006870 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6871 When using the ">>" command, lines starting with '#' are not shifted
6872 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006873 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006874 This option is reset when 'paste' is set and restored when 'paste' is
6875 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876
6877 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6878'smarttab' 'sta' boolean (default off)
6879 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006881 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6882 <BS> will delete a 'shiftwidth' worth of space at the start of the
6883 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006884 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006885 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6886 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006887 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006889 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006890 This option is reset when 'paste' is set and restored when 'paste' is
6891 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 NOTE: This option is reset when 'compatible' is set.
6893
6894 *'softtabstop'* *'sts'*
6895'softtabstop' 'sts' number (default 0)
6896 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006897 Number of spaces that a <Tab> counts for while performing editing
6898 operations, like inserting a <Tab> or using <BS>. It "feels" like
6899 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6900 used. This is useful to keep the 'ts' setting at its standard value
6901 of 8, while being able to edit like it is set to 'sts'. However,
6902 commands like "x" still work on the actual characters.
6903 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006904 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006905 'softtabstop' is set to 0 when the 'paste' option is set and restored
6906 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6908 spaces is minimized by using <Tab>s.
6909 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6910 set.
6911 NOTE: This option is set to 0 when 'compatible' is set.
6912
Bram Moolenaar04958cb2018-06-23 19:23:02 +02006913 If Vim is compiled with the |+vartabs| feature then the value of
6914 'softtabstop' will be ignored if |'varsofttabstop'| is set to
6915 anything other than an empty string.
6916
Bram Moolenaar217ad922005-03-20 22:37:15 +00006917 *'spell'* *'nospell'*
6918'spell' boolean (default off)
6919 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00006920 {not available when compiled without the |+syntax|
6921 feature}
6922 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006923 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006924
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006925 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006926'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006927 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006928 {not available when compiled without the |+syntax|
6929 feature}
6930 Pattern to locate the end of a sentence. The following word will be
6931 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006932 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006933 When this check is not wanted make this option empty.
6934 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006935 Be careful with special characters, see |option-backslash| about
6936 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006937 To set this option automatically depending on the language, see
6938 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006939
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006940 *'spellfile'* *'spf'*
6941'spellfile' 'spf' string (default empty)
6942 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006943 {not available when compiled without the |+syntax|
6944 feature}
6945 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006946 commands. It must end in ".{encoding}.add". You need to include the
6947 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006948 *E765*
6949 It may also be a comma separated list of names. A count before the
6950 |zg| and |zw| commands can be used to access each. This allows using
6951 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006952 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006953 you: Using the first directory in 'runtimepath' that is writable. If
6954 there is no "spell" directory yet it will be created. For the file
6955 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006956 ignoring the region.
6957 The resulting ".spl" file will be used for spell checking, it does not
6958 have to appear in 'spelllang'.
6959 Normally one file is used for all regions, but you can add the region
6960 name if you want to. However, it will then only be used when
6961 'spellfile' is set to it, for entries in 'spelllang' only files
6962 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006963 This option cannot be set from a |modeline| or in the |sandbox|, for
6964 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006965
Bram Moolenaar217ad922005-03-20 22:37:15 +00006966 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006967'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006968 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00006969 {not available when compiled without the |+syntax|
6970 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006971 A comma separated list of word list names. When the 'spell' option is
6972 on spellchecking will be done for these languages. Example: >
6973 set spelllang=en_us,nl,medical
6974< This means US English, Dutch and medical words are recognized. Words
6975 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02006976 The word list name must consist of alphanumeric characters, a dash or
6977 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00006978 recommended to separate the two letter language name from a
6979 specification. Thus "en-rare" is used for rare English words.
6980 A region name must come last and have the form "_xx", where "xx" is
6981 the two-letter, lower case region name. You can use more than one
6982 region by listing them: "en_us,en_ca" supports both US and Canadian
6983 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01006984 Britain. (Note: currently en_au and en_nz dictionaries are older than
6985 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006986 If the name "cjk" is included East Asian characters are excluded from
6987 spell checking. This is useful when editing text that also has Asian
6988 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006989 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006990 As a special case the name of a .spl file can be given as-is. The
6991 first "_xx" in the name is removed and used as the region name
6992 (_xx is an underscore, two letters and followed by a non-letter).
6993 This is mainly for testing purposes. You must make sure the correct
6994 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006995 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006996 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6997 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006998 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006999
Bram Moolenaar98692072006-02-04 00:57:42 +00007000 If the |spellfile.vim| plugin is active and you use a language name
7001 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7002 will ask you if you want to download the file.
7003
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007004 After this option has been set successfully, Vim will source the files
7005 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007006 up to the first character that is not an ASCII letter or number and
7007 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007008
7009
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007010 *'spellsuggest'* *'sps'*
7011'spellsuggest' 'sps' string (default "best")
7012 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007013 {not available when compiled without the |+syntax|
7014 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007015 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007016 the |spellsuggest()| function. This is a comma-separated list of
7017 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007018
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007019 best Internal method that works best for English. Finds
7020 changes like "fast" and uses a bit of sound-a-like
7021 scoring to improve the ordering.
7022
7023 double Internal method that uses two methods and mixes the
7024 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007025 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007026 word. That only works when the language specifies
7027 sound folding. Can be slow and doesn't always give
7028 better results.
7029
7030 fast Internal method that only checks for simple changes:
7031 character inserts/deletes/swaps. Works well for
7032 simple typing mistakes.
7033
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007034 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007035 Not used for |spellsuggest()|. The number of
7036 suggestions is never more than the value of 'lines'
7037 minus two.
7038
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007039 file:{filename} Read file {filename}, which must have two columns,
7040 separated by a slash. The first column contains the
7041 bad word, the second column the suggested good word.
7042 Example:
7043 theribal/terrible ~
7044 Use this for common mistakes that do not appear at the
7045 top of the suggestion list with the internal methods.
7046 Lines without a slash are ignored, use this for
7047 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007048 The word in the second column must be correct,
7049 otherwise it will not be used. Add the word to an
7050 ".add" file if it is currently flagged as a spelling
7051 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007052 The file is used for all languages.
7053
7054 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7055 trouble with spaces. |v:val| holds the badly spelled
7056 word. The expression must evaluate to a List of
7057 Lists, each with a suggestion and a score.
7058 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007059 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007060 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007061 internal methods use. A lower score is better.
7062 This may invoke |spellsuggest()| if you temporarily
7063 set 'spellsuggest' to exclude the "expr:" part.
7064 Errors are silently ignored, unless you set the
7065 'verbose' option to a non-zero value.
7066
7067 Only one of "best", "double" or "fast" may be used. The others may
7068 appear several times in any order. Example: >
7069 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7070<
7071 This option cannot be set from a |modeline| or in the |sandbox|, for
7072 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007073
7074
Bram Moolenaar071d4272004-06-13 20:20:40 +00007075 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7076'splitbelow' 'sb' boolean (default off)
7077 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 When on, splitting a window will put the new window below the current
7079 one. |:split|
7080
7081 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7082'splitright' 'spr' boolean (default off)
7083 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 When on, splitting a window will put the new window right of the
7085 current one. |:vsplit|
7086
7087 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7088'startofline' 'sol' boolean (default on)
7089 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007091 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007092 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007093 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094 with a linewise operator, with "%" with a count and to buffer changing
7095 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7096 only has a line number, e.g., ":25" or ":+".
7097 In case of buffer changing commands the cursor is placed at the column
7098 where it was the last time the buffer was edited.
7099 NOTE: This option is set when 'compatible' is set.
7100
Bram Moolenaar00654022011-02-25 14:42:19 +01007101 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007103 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007104 {not available when compiled without the |+statusline|
7105 feature}
7106 When nonempty, this option determines the content of the status line.
7107 Also see |status-line|.
7108
7109 The option consists of printf style '%' items interspersed with
7110 normal text. Each status line item is of the form:
7111 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007112 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007113 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114
Bram Moolenaar238a5642006-02-21 22:12:05 +00007115 When the option starts with "%!" then it is used as an expression,
7116 evaluated and the result is used as the option value. Example: >
7117 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007118< The *g:statusline_winid* variable will be set to the |window-ID| of the
7119 window that the status line belongs to.
7120 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007121 Note that the "%!" expression is evaluated in the context of the
7122 current window and buffer, while %{} items are evaluated in the
7123 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007124
7125 When there is error while evaluating the option then it will be made
7126 empty to avoid further errors. Otherwise screen updating would loop.
7127
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 Note that the only effect of 'ruler' when this option is set (and
7129 'laststatus' is 2) is controlling the output of |CTRL-G|.
7130
7131 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007132 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007134 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007135 minwid Minimum width of the item, padding as set by '-' & '0'.
7136 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007137 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 on the left for text items. Numeric items will be
7139 shifted down to maxwid-2 digits followed by '>'number
7140 where number is the amount of missing digits, much like
7141 an exponential notation.
7142 item A one letter code as described below.
7143
7144 Following is a description of the possible statusline items. The
7145 second character in "item" is the type:
7146 N for number
7147 S for string
7148 F for flags as described below
7149 - not applicable
7150
7151 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007152 f S Path to the file in the buffer, as typed or relative to current
7153 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154 F S Full path to the file in the buffer.
7155 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007156 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007158 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007160 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007161 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007162 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007164 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007166 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007167 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7168 being used: "<keymap>"
7169 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007170 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007171 B N As above, in hexadecimal.
7172 o N Byte number in file of byte under cursor, first byte is 1.
7173 Mnemonic: Offset from start of file (with one added)
7174 {not available when compiled without |+byte_offset| feature}
7175 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007176 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 l N Line number.
7178 L N Number of lines in buffer.
7179 c N Column number.
7180 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007181 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 p N Percentage through file in lines as in |CTRL-G|.
7183 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007184 percentage described for 'ruler'. Always 3 in length, unless
7185 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007186 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007188 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007189 Note that there is no '%' before the closing '}'. The
7190 expression cannot contain a '}' character, call a function to
7191 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007192 ( - Start of item group. Can be used for setting the width and
7193 alignment of a section. Must be followed by %) somewhere.
7194 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007195 T N For 'tabline': start of tab page N label. Use %T after the last
7196 label. This information is used for mouse clicks.
7197 X N For 'tabline': start of close tab N label. Use %X after the
7198 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7199 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 < - Where to truncate line if too long. Default is at the start.
7201 No width fields allowed.
7202 = - Separation point between left and right aligned items.
7203 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007204 # - Set highlight group. The name must follow and then a # again.
7205 Thus use %#HLname# for highlight group HLname. The same
7206 highlighting is used, also for the statusline of non-current
7207 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007209 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 The difference between User{N} and StatusLine will be applied
7211 to StatusLineNC for the statusline of non-current windows.
7212 The number N must be between 1 and 9. See |hl-User1..9|
7213
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007214 When displaying a flag, Vim removes the leading comma, if any, when
7215 that flag comes right after plaintext. This will make a nice display
7216 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217
Bram Moolenaar582fd852005-03-28 20:58:01 +00007218 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219 not set) and a minwid is not set for the group, the whole group will
7220 become empty. This will make a group like the following disappear
7221 completely from the statusline when none of the flags are set. >
7222 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007223< Beware that an expression is evaluated each and every time the status
7224 line is displayed.
7225 *g:actual_curbuf* *g:actual_curwin*
7226 The current buffer and current window will be set temporarily to that
7227 of the window (and buffer) whose statusline is currently being drawn.
7228 The expression will evaluate in this context. The variable
7229 "g:actual_curbuf" is set to the `bufnr()` number of the real current
7230 buffer and "g:actual_curwin" to the |window-ID| of the real current
7231 window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007232
Bram Moolenaar30b65812012-07-12 22:01:11 +02007233 The 'statusline' option will be evaluated in the |sandbox| if set from
7234 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007235 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007236
7237 It is not allowed to change text or jump to another window while
7238 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239
7240 If the statusline is not updated when you want it (e.g., after setting
7241 a variable that's used in an expression), you can force an update by
7242 setting an option without changing its value. Example: >
7243 :let &ro = &ro
7244
7245< A result of all digits is regarded a number for display purposes.
7246 Otherwise the result is taken as flag text and applied to the rules
7247 described above.
7248
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007249 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007250 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007251 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252
7253 Examples:
7254 Emulate standard status line with 'ruler' set >
7255 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7256< Similar, but add ASCII value of char under the cursor (like "ga") >
7257 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7258< Display byte count and byte value, modified flag in red. >
7259 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7260 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7261< Display a ,GZ flag if a compressed file is loaded >
7262 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7263< In the |:autocmd|'s: >
7264 :let b:gzflag = 1
7265< And: >
7266 :unlet b:gzflag
7267< And define this function: >
7268 :function VarExists(var, val)
7269 : if exists(a:var) | return a:val | else | return '' | endif
7270 :endfunction
7271<
7272 *'suffixes'* *'su'*
7273'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 Files with these suffixes get a lower priority when multiple files
7276 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007277 suffixes. Spaces after the comma are ignored. A dot is also seen as
7278 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 separator, precede it with a backslash (see |option-backslash| about
7280 including spaces and backslashes).
7281 See 'wildignore' for completely ignoring files.
7282 The use of |:set+=| and |:set-=| is preferred when adding or removing
7283 suffixes from the list. This avoids problems when a future version
7284 uses another default.
7285
7286 *'suffixesadd'* *'sua'*
7287'suffixesadd' 'sua' string (default "")
7288 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007289 {not available when compiled without the
7290 |+file_in_path| feature}
7291 Comma separated list of suffixes, which are used when searching for a
7292 file for the "gf", "[I", etc. commands. Example: >
7293 :set suffixesadd=.java
7294<
7295 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7296'swapfile' 'swf' boolean (default on)
7297 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007298 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007299 swapfile is not wanted for a specific buffer. For example, with
7300 confidential information that even root must not be able to access.
7301 Careful: All text will be in memory:
7302 - Don't use this for big files.
7303 - Recovery will be impossible!
7304 A swapfile will only be present when |'updatecount'| is non-zero and
7305 'swapfile' is set.
7306 When 'swapfile' is reset, the swap file for the current buffer is
7307 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7308 non-zero, a swap file is immediately created.
7309 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007310 If you want to open a new buffer without creating a swap file for it,
7311 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007312 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007313
7314 This option is used together with 'bufhidden' and 'buftype' to
7315 specify special kinds of buffers. See |special-buffers|.
7316
7317 *'swapsync'* *'sws'*
7318'swapsync' 'sws' string (default "fsync")
7319 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007321 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007322 When this option is empty parts of the swap file may be in memory and
7323 not written to disk. When the system crashes you may lose more work.
7324 On Unix the system does a sync now and then without Vim asking for it,
7325 so the disadvantage of setting this option off is small. On some
7326 systems the swap file will not be written at all. For a unix system
7327 setting it to "sync" will use the sync() call instead of the default
7328 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007329 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330
7331 *'switchbuf'* *'swb'*
7332'switchbuf' 'swb' string (default "")
7333 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007334 This option controls the behavior when switching between buffers.
7335 Possible values (comma separated list):
7336 useopen If included, jump to the first open window that
7337 contains the specified buffer (if there is one).
7338 Otherwise: Do not examine other windows.
7339 This setting is checked with |quickfix| commands, when
7340 jumping to errors (":cc", ":cn", "cp", etc.). It is
7341 also used in all buffer related split commands, for
7342 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007343 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007344 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007346 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007347 Otherwise: do not split, use current window (when used
7348 in the quickfix window: the previously used window or
7349 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007350 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007351 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007352 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007353
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007354 *'synmaxcol'* *'smc'*
7355'synmaxcol' 'smc' number (default 3000)
7356 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007357 {not available when compiled without the |+syntax|
7358 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007359 Maximum column in which to search for syntax items. In long lines the
7360 text after this column is not highlighted and following lines may not
7361 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007362 This helps to avoid very slow redrawing for an XML file that is one
7363 long line.
7364 Set to zero to remove the limit.
7365
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 *'syntax'* *'syn'*
7367'syntax' 'syn' string (default empty)
7368 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007369 {not available when compiled without the |+syntax|
7370 feature}
7371 When this option is set, the syntax with this name is loaded, unless
7372 syntax highlighting has been switched off with ":syntax off".
7373 Otherwise this option does not always reflect the current syntax (the
7374 b:current_syntax variable does).
7375 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007376 not automatically recognized. Example, in an IDL file:
7377 /* vim: set syntax=idl : */ ~
7378 When a dot appears in the value then this separates two filetype
7379 names. Example:
7380 /* vim: set syntax=c.doxygen : */ ~
7381 This will use the "c" syntax first, then the "doxygen" syntax.
7382 Note that the second one must be prepared to be loaded as an addition,
7383 otherwise it will be skipped. More than one dot may appear.
7384 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385 :set syntax=OFF
7386< To switch syntax highlighting on according to the current value of the
7387 'filetype' option: >
7388 :set syntax=ON
7389< What actually happens when setting the 'syntax' option is that the
7390 Syntax autocommand event is triggered with the value as argument.
7391 This option is not copied to another buffer, independent of the 's' or
7392 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007393 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007395 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007396'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007397 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007398 When nonempty, this option determines the content of the tab pages
7399 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007400 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007401
7402 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007403 option and only when there is no GUI tab line. When 'e' is in
7404 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007405 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007406
7407 The value is evaluated like with 'statusline'. You can use
7408 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007409 the text to be displayed. Use "%1T" for the first label, "%2T" for
7410 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007411
Bram Moolenaare12bab32019-01-08 22:02:56 +01007412 When changing something that is used in 'tabline' that does not
7413 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007414 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007415
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007416 Keep in mind that only one of the tab pages is the current one, others
7417 are invisible and you can't jump to their windows.
7418
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007419
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007420 *'tabpagemax'* *'tpm'*
7421'tabpagemax' 'tpm' number (default 10)
7422 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007423 Maximum number of tab pages to be opened by the |-p| command line
7424 argument or the ":tab all" command. |tabpage|
7425
7426
7427 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428'tabstop' 'ts' number (default 8)
7429 local to buffer
7430 Number of spaces that a <Tab> in the file counts for. Also see
7431 |:retab| command, and 'softtabstop' option.
7432
7433 Note: Setting 'tabstop' to any other value than 8 can make your file
7434 appear wrong in many places (e.g., when printing it).
7435
7436 There are four main ways to use tabs in Vim:
7437 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7438 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007439 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440 behave like a tab appears every 4 (or 3) characters.
7441 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7442 'expandtab'. This way you will always insert spaces. The
7443 formatting will never be messed up when 'tabstop' is changed.
7444 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007445 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446 works when using Vim to edit the file.
7447 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7448 'noexpandtab'. This should then work (for initial indents only)
7449 for any tabstop setting that people use. It might be nice to have
7450 tabs after the first non-blank inserted as spaces if you do this
7451 though. Otherwise aligned comments will be wrong when 'tabstop' is
7452 changed.
7453
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007454 If Vim is compiled with the |+vartabs| feature then the value of
7455 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7456 than an empty string.
7457
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7459'tagbsearch' 'tbs' boolean (default on)
7460 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007462 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463 searching makes searching for a tag a LOT faster, but a linear search
7464 will find more tags if the tags file wasn't properly sorted.
7465 Vim normally assumes that your tags files are sorted, or indicate that
7466 they are not sorted. Only when this is not the case does the
7467 'tagbsearch' option need to be switched off.
7468
7469 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007470 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 certain files, or retry all files with a linear search. When
7472 'tagbsearch' is off, only a linear search is done.
7473
7474 Linear searching is done anyway, for one file, when Vim finds a line
7475 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007476 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477< [The whitespace before and after the '0' must be a single <Tab>]
7478
7479 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007480 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 instead of a normal tag name, a retry is done with a linear search.
7482 Tags in unsorted tags files, and matches with different case will only
7483 be found in the retry.
7484
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007485 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007486 linear search can be avoided when case is ignored. Use a value of '2'
7487 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7488 sorted with the -f switch to "sort" in most unices, as in the command:
7489 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7490 (at least 5.5) the --sort=foldcase switch can be used for this as
7491 well. Note that case must be folded to uppercase for this to work.
7492
7493 By default, tag searches are case-sensitive. Case is ignored when
7494 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7495 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007496 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7497 'tagcase' is "smart", and the pattern contains only lowercase
7498 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007499
7500 When 'tagbsearch' is off, tags searching is slower when a full match
7501 exists, but faster when no full match exists. Tags in unsorted tags
7502 files may only be found with 'tagbsearch' off.
7503 When the tags file is not sorted, or sorted in a wrong way (not on
7504 ASCII byte value), 'tagbsearch' should be off, or the line given above
7505 must be included in the tags file.
7506 This option doesn't affect commands that find all matching tags (e.g.,
7507 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007509 *'tagcase'* *'tc'*
7510'tagcase' 'tc' string (default "followic")
7511 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007512 This option specifies how case is handled when searching the tags
7513 file:
7514 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007515 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007516 ignore Ignore case
7517 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007518 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007519 NOTE: This option is set to the Vi default value when 'compatible' is
7520 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007521
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007522 *'tagfunc'* *'tfu'*
7523'tagfunc' 'tfu' string (default: empty)
7524 local to buffer
7525 {not available when compiled without the |+eval|
7526 feature}
7527 This option specifies a function to be used to perform tag searches.
7528 The function gets the tag pattern and should return a List of matching
7529 tags. See |tag-function| for an explanation of how to write the
7530 function and an example.
7531
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532 *'taglength'* *'tl'*
7533'taglength' 'tl' number (default 0)
7534 global
7535 If non-zero, tags are significant up to this number of characters.
7536
7537 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7538'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7539 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007540 If on and using a tags file in another directory, file names in that
7541 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542 NOTE: This option is set to the Vi default value when 'compatible' is
7543 set and to the Vim default value when 'compatible' is reset.
7544
7545 *'tags'* *'tag'* *E433*
7546'tags' 'tag' string (default "./tags,tags", when compiled with
7547 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7548 global or local to buffer |global-local|
7549 Filenames for the tag command, separated by spaces or commas. To
7550 include a space or comma in a file name, precede it with a backslash
7551 (see |option-backslash| about including spaces and backslashes).
7552 When a file name starts with "./", the '.' is replaced with the path
7553 of the current file. But only when the 'd' flag is not included in
7554 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7555 |tags-option|.
7556 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007557 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7558 find all files named "tags" below "/lib". The filename itself cannot
7559 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7560 files called "tags?". {not available when compiled without the
7561 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007562 The |tagfiles()| function can be used to get a list of the file names
7563 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7565 files are also supported. They are automatically recognized. The
7566 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7567 differences are ignored (MS-Windows). |emacs-tags|
7568 The use of |:set+=| and |:set-=| is preferred when adding or removing
7569 file names from the list. This avoids problems when a future version
7570 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007571
7572 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7573'tagstack' 'tgst' boolean (default on)
7574 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575 When on, the |tagstack| is used normally. When off, a ":tag" or
7576 ":tselect" command with an argument will not push the tag onto the
7577 tagstack. A following ":tag" without an argument, a ":pop" command or
7578 any other command that uses the tagstack will use the unmodified
7579 tagstack, but does change the pointer to the active entry.
7580 Resetting this option is useful when using a ":tag" command in a
7581 mapping which should not change the tagstack.
7582
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007583 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007584'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007585 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007586 {only available when compiled with the |+tcl/dyn|
7587 feature}
7588 Specifies the name of the Tcl shared library. The default is
7589 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007590 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007591 This option cannot be set from a |modeline| or in the |sandbox|, for
7592 security reasons.
7593
Bram Moolenaar071d4272004-06-13 20:20:40 +00007594 *'term'* *E529* *E530* *E531*
7595'term' string (default is $TERM, if that fails:
7596 in the GUI: "builtin_gui"
7597 on Amiga: "amiga"
7598 on BeOS: "beos-ansi"
7599 on Mac: "mac-ansi"
7600 on MiNT: "vt52"
7601 on MS-DOS: "pcterm"
7602 on OS/2: "os2ansi"
7603 on Unix: "ansi"
7604 on VMS: "ansi"
7605 on Win 32: "win32")
7606 global
7607 Name of the terminal. Used for choosing the terminal control
7608 characters. Environment variables are expanded |:set_env|.
7609 For example: >
7610 :set term=$TERM
7611< See |termcap|.
7612
7613 *'termbidi'* *'tbidi'*
7614 *'notermbidi'* *'notbidi'*
7615'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7616 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007617 {only available when compiled with the |+arabic|
7618 feature}
7619 The terminal is in charge of Bi-directionality of text (as specified
7620 by Unicode). The terminal is also expected to do the required shaping
7621 that some languages (such as Arabic) require.
7622 Setting this option implies that 'rightleft' will not be set when
7623 'arabic' is set and the value of 'arabicshape' will be ignored.
7624 Note that setting 'termbidi' has the immediate effect that
7625 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7626 This option is reset when the GUI is started.
7627 For further details see |arabic.txt|.
7628
7629 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007630'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007631 Macintosh GUI: "macroman")
7632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 Encoding used for the terminal. This specifies what character
7634 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007635 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007636 display). Except for the Mac when 'macatsui' is off, then
7637 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007638 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007639 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7641 Any attempts to set a different value will be rejected, and an error
7642 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007643 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644 because the Win32 system always passes Unicode characters.
7645 When empty, the same encoding is used as for the 'encoding' option.
7646 This is the normal value.
7647 Not all combinations for 'termencoding' and 'encoding' are valid. See
7648 |encoding-table|.
7649 The value for this option must be supported by internal conversions or
7650 iconv(). When this is not possible no conversion will be done and you
7651 will probably experience problems with non-ASCII characters.
7652 Example: You are working with the locale set to euc-jp (Japanese) and
7653 want to edit a UTF-8 file: >
7654 :let &termencoding = &encoding
7655 :set encoding=utf-8
7656< You need to do this when your system has no locale support for UTF-8.
7657
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007658 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007659'termguicolors' 'tgc' boolean (default off)
7660 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007661 {not available when compiled without the
7662 |+termguicolors| feature}
7663 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007664 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007665
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007666 Requires a ISO-8613-3 compatible terminal. If setting this option
7667 does not work (produces a colorless UI) reading |xterm-true-color|
7668 might help.
7669
7670 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7671 is required. Use this check to find out: >
7672 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007673< This requires Vim to be built with the |+vtp| feature.
7674
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007675 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007676 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007677
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007678 *'termwinkey'* *'twk'*
7679'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007680 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007681 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007682 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007683 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007684 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007685< The string must be one key stroke but can be multiple bytes.
7686 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007687 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007688 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007689
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007690 *'termwinscroll'* *'twsl'*
7691'termwinscroll' 'twsl' number (default 10000)
7692 local to buffer
7693 {not available when compiled without the
7694 |+terminal| feature}
7695 Number of scrollback lines to keep. When going over this limit the
7696 first 10% of the scrollback lines are deleted. This is just to reduce
7697 the memory usage. See |Terminal-Normal|.
7698
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007699 *'termwinsize'* *'tws'*
7700'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007701 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007702 Size of the |terminal| window. Format: {rows}x{columns} or
7703 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007704 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007705 - When set with a "x" (e.g., "24x80") the terminal size is not
7706 adjusted to the window size. If the window is smaller only the
7707 top-left part is displayed.
7708 - When set with a "*" (e.g., "10*50") the terminal size follows the
7709 window size, but will not be smaller than the specified rows and/or
7710 columns.
7711 - When rows is zero then use the height of the window.
7712 - When columns is zero then use the width of the window.
7713 - Using "0x0" or "0*0" is the same as empty.
7714
7715 Examples:
7716 "30x0" uses 30 rows and the current window width.
7717 "20*0" uses at least 20 rows and the current window width.
7718 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007719 Note that the command running in the terminal window may still change
7720 the size of the terminal. In that case the Vim window will be
7721 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007722
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007723 *'termwintype'* *'twt'*
7724'termwintype' 'twt' string (default "")
7725 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007726 {only available when compiled with the |terminal|
7727 feature on MS-Windows}
7728 Specify the virtual console (pty) used when opening the terminal
7729 window.
7730
7731 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007732 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007733 "winpty" use winpty, fail if not supported
7734 "conpty" use |ConPTY|, fail if not supported
7735
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007736 |ConPTY| support depends on the platform. Windows 10 October 2018
7737 Update is the first version that supports ConPTY, however it is still
7738 considered unstable. ConPTY might become stable in the next release
7739 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007740 supported then you cannot open a terminal window.
7741
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742 *'terse'* *'noterse'*
7743'terse' boolean (default off)
7744 global
7745 When set: Add 's' flag to 'shortmess' option (this makes the message
7746 for a search that hits the start or end of the file not being
7747 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7748 shortens a lot of messages}
7749
7750 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7751'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753 This option is obsolete. Use 'fileformats'.
7754 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7755 set to the default value for the current system. When 'textauto' is
7756 reset, 'fileformats' is made empty.
7757 NOTE: This option is set to the Vi default value when 'compatible' is
7758 set and to the Vim default value when 'compatible' is reset.
7759
7760 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7761'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7762 others: default off)
7763 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007764 This option is obsolete. Use 'fileformat'.
7765 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7766 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7767 "unix".
7768
7769 *'textwidth'* *'tw'*
7770'textwidth' 'tw' number (default 0)
7771 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007772 Maximum width of text that is being inserted. A longer line will be
7773 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007774 this.
7775 'textwidth' is set to 0 when the 'paste' option is set and restored
7776 when 'paste' is reset.
7777 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007778 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007779 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007780 NOTE: This option is set to 0 when 'compatible' is set.
7781
7782 *'thesaurus'* *'tsr'*
7783'thesaurus' 'tsr' string (default "")
7784 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007785 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007786 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7787
7788 Each line in the file should contain words with similar meaning,
7789 separated by non-keyword characters (white space is preferred).
7790 Maximum line length is 510 bytes.
7791
Bram Moolenaard47d5222018-12-09 20:43:55 +01007792 An English word list was added to this github issue:
7793 https://github.com/vim/vim/issues/629#issuecomment-443293282
7794 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7795 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7796 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007797
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007798 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799 after a comma are ignored, otherwise spaces are included in the file
7800 name. See |option-backslash| about using backslashes.
7801 The use of |:set+=| and |:set-=| is preferred when adding or removing
7802 directories from the list. This avoids problems when a future version
7803 uses another default.
7804 Backticks cannot be used in this option for security reasons.
7805
7806 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7807'tildeop' 'top' boolean (default off)
7808 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809 When on: The tilde command "~" behaves like an operator.
7810 NOTE: This option is reset when 'compatible' is set.
7811
7812 *'timeout'* *'to'* *'notimeout'* *'noto'*
7813'timeout' 'to' boolean (default on)
7814 global
7815 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007816'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007817 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007818 These two options together determine the behavior when part of a
7819 mapped key sequence or keyboard code has been received:
7820
7821 'timeout' 'ttimeout' action ~
7822 off off do not time out
7823 on on or off time out on :mappings and key codes
7824 off on time out on key codes
7825
7826 If both options are off, Vim will wait until either the complete
7827 mapping or key sequence has been received, or it is clear that there
7828 is no mapping or key sequence for the received characters. For
7829 example: if you have mapped "vl" and Vim has received 'v', the next
7830 character is needed to see if the 'v' is followed by an 'l'.
7831 When one of the options is on, Vim will wait for about 1 second for
7832 the next character to arrive. After that the already received
7833 characters are interpreted as single characters. The waiting time can
7834 be changed with the 'timeoutlen' option.
7835 On slow terminals or very busy systems timing out may cause
7836 malfunctioning cursor keys. If both options are off, Vim waits
7837 forever after an entered <Esc> if there are key codes that start
7838 with <Esc>. You will have to type <Esc> twice. If you do not have
7839 problems with key codes, but would like to have :mapped key
7840 sequences not timing out in 1 second, set the 'ttimeout' option and
7841 reset the 'timeout' option.
7842
7843 NOTE: 'ttimeout' is reset when 'compatible' is set.
7844
7845 *'timeoutlen'* *'tm'*
7846'timeoutlen' 'tm' number (default 1000)
7847 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007848
Bram Moolenaar071d4272004-06-13 20:20:40 +00007849 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007850'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007852 The time in milliseconds that is waited for a key code or mapped key
7853 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7854 when part of a command has been typed.
7855 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7856 different timeout value for key codes is desired set 'ttimeoutlen' to
7857 a non-negative number.
7858
7859 ttimeoutlen mapping delay key code delay ~
7860 < 0 'timeoutlen' 'timeoutlen'
7861 >= 0 'timeoutlen' 'ttimeoutlen'
7862
7863 The timeout only happens when the 'timeout' and 'ttimeout' options
7864 tell so. A useful setting would be >
7865 :set timeout timeoutlen=3000 ttimeoutlen=100
7866< (time out on mapping after three seconds, time out on key codes after
7867 a tenth of a second).
7868
7869 *'title'* *'notitle'*
7870'title' boolean (default off, on when title can be restored)
7871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872 {not available when compiled without the |+title|
7873 feature}
7874 When on, the title of the window will be set to the value of
7875 'titlestring' (if it is not empty), or to:
7876 filename [+=-] (path) - VIM
7877 Where:
7878 filename the name of the file being edited
7879 - indicates the file cannot be modified, 'ma' off
7880 + indicates the file was modified
7881 = indicates the file is read-only
7882 =+ indicates the file is read-only and modified
7883 (path) is the path of the file being edited
7884 - VIM the server name |v:servername| or "VIM"
7885 Only works if the terminal supports setting window titles
7886 (currently Amiga console, Win32 console, all GUI versions and
7887 terminals with a non- empty 't_ts' option - these are Unix xterm and
7888 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7889 *X11*
7890 When Vim was compiled with HAVE_X11 defined, the original title will
7891 be restored if possible. The output of ":version" will include "+X11"
7892 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7893 works for the icon name |'icon'|.
7894 But: When Vim was started with the |-X| argument, restoring the title
7895 will not work (except in the GUI).
7896 If the title cannot be restored, it is set to the value of 'titleold'.
7897 You might want to restore the title outside of Vim then.
7898 When using an xterm from a remote machine you can use this command:
7899 rsh machine_name xterm -display $DISPLAY &
7900 then the WINDOWID environment variable should be inherited and the
7901 title of the window should change back to what it should be after
7902 exiting Vim.
7903
7904 *'titlelen'*
7905'titlelen' number (default 85)
7906 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907 {not available when compiled without the |+title|
7908 feature}
7909 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007910 title. When the title is longer, only the end of the path name is
7911 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007912 Using a percentage makes this adapt to the width of the window. But
7913 it won't work perfectly, because the actual number of characters
7914 available also depends on the font used and other things in the title
7915 bar. When 'titlelen' is zero the full path is used. Otherwise,
7916 values from 1 to 30000 percent can be used.
7917 'titlelen' is also used for the 'titlestring' option.
7918
7919 *'titleold'*
7920'titleold' string (default "Thanks for flying Vim")
7921 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922 {only available when compiled with the |+title|
7923 feature}
7924 This option will be used for the window title when exiting Vim if the
7925 original title cannot be restored. Only happens if 'title' is on or
7926 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007927 This option cannot be set from a |modeline| or in the |sandbox|, for
7928 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929 *'titlestring'*
7930'titlestring' string (default "")
7931 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007932 {not available when compiled without the |+title|
7933 feature}
7934 When this option is not empty, it will be used for the title of the
7935 window. This happens only when the 'title' option is on.
7936 Only works if the terminal supports setting window titles (currently
7937 Amiga console, Win32 console, all GUI versions and terminals with a
7938 non-empty 't_ts' option).
7939 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007940 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007941
Bram Moolenaar071d4272004-06-13 20:20:40 +00007942 When this option contains printf-style '%' items, they will be
7943 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007944 This option cannot be set in a modeline when 'modelineexpr' is off.
7945
Bram Moolenaar071d4272004-06-13 20:20:40 +00007946 Example: >
7947 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7948 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7949< The value of 'titlelen' is used to align items in the middle or right
7950 of the available space.
7951 Some people prefer to have the file name first: >
7952 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7953< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007954 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007955 separating space only when needed.
7956 NOTE: Use of special characters in 'titlestring' may cause the display
7957 to be garbled (e.g., when it contains a CR or NL character).
7958 {not available when compiled without the |+statusline| feature}
7959
7960 *'toolbar'* *'tb'*
7961'toolbar' 'tb' string (default "icons,tooltips")
7962 global
7963 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7964 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007965 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007966 possible values are:
7967 icons Toolbar buttons are shown with icons.
7968 text Toolbar buttons shown with text.
7969 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007970 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971 tooltips Tooltips are active for toolbar buttons.
7972 Tooltips refer to the popup help text which appears after the mouse
7973 cursor is placed over a toolbar button for a brief moment.
7974
7975 If you want the toolbar to be shown with icons as well as text, do the
7976 following: >
7977 :set tb=icons,text
7978< Motif and Athena cannot display icons and text at the same time. They
7979 will show icons if both are requested.
7980
7981 If none of the strings specified in 'toolbar' are valid or if
7982 'toolbar' is empty, this option is ignored. If you want to disable
7983 the toolbar, you need to set the 'guioptions' option. For example: >
7984 :set guioptions-=T
7985< Also see |gui-toolbar|.
7986
7987 *'toolbariconsize'* *'tbis'*
7988'toolbariconsize' 'tbis' string (default "small")
7989 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01007990 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007991 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007992 tiny Use tiny icons.
7993 small Use small icons (default).
7994 medium Use medium-sized icons.
7995 large Use large icons.
7996 huge Use even larger icons.
7997 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007998 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007999 the current theme. Common dimensions are giant=48x48, huge=32x32,
8000 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001
8002 If 'toolbariconsize' is empty, the global default size as determined
8003 by user preferences or the current theme is used.
8004
8005 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8006'ttybuiltin' 'tbi' boolean (default on)
8007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008 When on, the builtin termcaps are searched before the external ones.
8009 When off the builtin termcaps are searched after the external ones.
8010 When this option is changed, you should set the 'term' option next for
8011 the change to take effect, for example: >
8012 :set notbi term=$TERM
8013< See also |termcap|.
8014 Rationale: The default for this option is "on", because the builtin
8015 termcap entries are generally better (many systems contain faulty
8016 xterm entries...).
8017
8018 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8019'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8020 sun-cmd, screen, rxvt, dtterm or
8021 iris-ansi; also on when running Vim in
8022 a DOS console)
8023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024 Indicates a fast terminal connection. More characters will be sent to
8025 the screen for redrawing, instead of using insert/delete line
8026 commands. Improves smoothness of redrawing when there are multiple
8027 windows and the terminal does not support a scrolling region.
8028 Also enables the extra writing of characters at the end of each screen
8029 line for lines that wrap. This helps when using copy/paste with the
8030 mouse in an xterm and other terminals.
8031
8032 *'ttymouse'* *'ttym'*
8033'ttymouse' 'ttym' string (default depends on 'term')
8034 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 {only in Unix and VMS, doesn't work in the GUI; not
8036 available when compiled without |+mouse|}
8037 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008038 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 *xterm-mouse*
8040 xterm xterm-like mouse handling. The mouse generates
8041 "<Esc>[Mscr", where "scr" is three bytes:
8042 "s" = button state
8043 "c" = column plus 33
8044 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008045 This only works up to 223 columns! See "dec",
8046 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047 xterm2 Works like "xterm", but with the xterm reporting the
8048 mouse position while the mouse is dragged. This works
8049 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008050 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008051 work. See below for how Vim detects this
8052 automatically.
8053 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008054 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008056 for the row and column. No other mouse events are
8057 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058 *dec-mouse*
8059 dec DEC terminal mouse handling. The mouse generates a
8060 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008061 This is also available for an Xterm, if it was
8062 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008063 *jsbterm-mouse*
8064 jsbterm JSB term mouse handling.
8065 *pterm-mouse*
8066 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008067 *urxvt-mouse*
8068 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008069 The mouse works only if the terminal supports this
8070 encoding style, but it does not have 223 columns limit
8071 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008072 *sgr-mouse*
8073 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008074 mouse reporting. The mouse works even in columns
8075 beyond 223. This option is backward compatible with
8076 "xterm2" because it can also decode "xterm2" style
8077 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078
8079 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008080 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8081 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8083 recognized, if enabled at compile time. DEC terminal mouse codes
8084 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008085 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8086 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008087 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008088 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8089 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8090 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008091 Additionally, if vim is compiled with the |+termresponse| feature and
8092 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008093 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008094 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008095 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8096 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8097 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008098 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8099 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008100 :set t_RV=
8101<
8102 *'ttyscroll'* *'tsl'*
8103'ttyscroll' 'tsl' number (default 999)
8104 global
8105 Maximum number of lines to scroll the screen. If there are more lines
8106 to scroll the window is redrawn. For terminals where scrolling is
8107 very slow and redrawing is not slow this can be set to a small number,
8108 e.g., 3, to speed up displaying.
8109
8110 *'ttytype'* *'tty'*
8111'ttytype' 'tty' string (default from $TERM)
8112 global
8113 Alias for 'term', see above.
8114
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008115 *'undodir'* *'udir'*
8116'undodir' 'udir' string (default ".")
8117 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008118 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008119 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008120 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008121 "." means using the directory of the file. The undo file name for
8122 "file.txt" is ".file.txt.un~".
8123 For other directories the file name is the full path of the edited
8124 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008125 When writing: The first directory that exists is used. "." always
8126 works, no directories after "." will be used for writing.
8127 When reading all entries are tried to find an undo file. The first
8128 undo file that exists is used. When it cannot be read an error is
8129 given, no further entry is used.
8130 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008131 This option cannot be set from a |modeline| or in the |sandbox|, for
8132 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008133
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008134 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008135'undofile' 'udf' boolean (default off)
8136 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008137 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008138 When on, Vim automatically saves undo history to an undo file when
8139 writing a buffer to a file, and restores undo history from the same
8140 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008141 The directory where the undo file is stored is specified by 'undodir'.
8142 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008143 The undo file is not read when 'undoreload' causes the buffer from
8144 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008145 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008146 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008147
Bram Moolenaar071d4272004-06-13 20:20:40 +00008148 *'undolevels'* *'ul'*
8149'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8150 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008151 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008152 Maximum number of changes that can be undone. Since undo information
8153 is kept in memory, higher numbers will cause more memory to be used
8154 (nevertheless, a single change can use an unlimited amount of memory).
8155 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8156 itself: >
8157 set ul=0
8158< But you can also get Vi compatibility by including the 'u' flag in
8159 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008160 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008161 Set to -1 for no undo at all. You might want to do this only for the
8162 current buffer: >
8163 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008164< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008165
8166 The local value is set to -123456 when the global value is to be used.
8167
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008168 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008169
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008170 *'undoreload'* *'ur'*
8171'undoreload' 'ur' number (default 10000)
8172 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008173 Save the whole buffer for undo when reloading it. This applies to the
8174 ":e!" command and reloading for when the buffer changed outside of
8175 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008176 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008177 of lines is smaller than the value of this option.
8178 Set this option to zero to disable undo for a reload.
8179
8180 When saving undo for a reload, any undo file is not read.
8181
8182 Note that this causes the whole buffer to be stored in memory. Set
8183 this option to a lower value if you run out of memory.
8184
Bram Moolenaar071d4272004-06-13 20:20:40 +00008185 *'updatecount'* *'uc'*
8186'updatecount' 'uc' number (default: 200)
8187 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008188 After typing this many characters the swap file will be written to
8189 disk. When zero, no swap file will be created at all (see chapter on
8190 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8191 Vim with the "-n" option, see |startup|. When editing in readonly
8192 mode this option will be initialized to 10000.
8193 The swapfile can be disabled per buffer with |'swapfile'|.
8194 When 'updatecount' is set from zero to non-zero, swap files are
8195 created for all buffers that have 'swapfile' set. When 'updatecount'
8196 is set to zero, existing swap files are not deleted.
8197 Also see |'swapsync'|.
8198 This option has no meaning in buffers where |'buftype'| is "nofile"
8199 or "nowrite".
8200
8201 *'updatetime'* *'ut'*
8202'updatetime' 'ut' number (default 4000)
8203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008204 If this many milliseconds nothing is typed the swap file will be
8205 written to disk (see |crash-recovery|). Also used for the
8206 |CursorHold| autocommand event.
8207
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008208 *'varsofttabstop'* *'vsts'*
8209'varsofttabstop' 'vsts' string (default "")
8210 local to buffer
8211 {only available when compiled with the |+vartabs|
8212 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008213 A list of the number of spaces that a <Tab> counts for while editing,
8214 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8215 width <Tab>s are being inserted, while in fact a mixture of spaces
8216 and <Tab>s is used. Tab widths are separated with commas, with the
8217 final value applying to all subsequent tabs.
8218
8219 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008220 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008221 to use the following: >
8222 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008223< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8224 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008225
8226 Note that the value of |'softtabstop'| will be ignored while
8227 'varsofttabstop' is set.
8228
8229 *'vartabstop'* *'vts'*
8230'vartabstop' 'vts' string (default "")
8231 local to buffer
8232 {only available when compiled with the |+vartabs|
8233 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008234 A list of the number of spaces that a <Tab> in the file counts for,
8235 separated by commas. Each value corresponds to one tab, with the
8236 final value applying to all subsequent tabs. For example: >
8237 :set vartabstop=4,20,10,8
8238< This will make the first tab 4 spaces wide, the second 20 spaces,
8239 the third 10 spaces, and all following tabs 8 spaces.
8240
8241 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8242 is set.
8243
Bram Moolenaar071d4272004-06-13 20:20:40 +00008244 *'verbose'* *'vbs'*
8245'verbose' 'vbs' number (default 0)
8246 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008247 When bigger than zero, Vim will give messages about what it is doing.
8248 Currently, these messages are given:
8249 >= 1 When the viminfo file is read or written.
8250 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008251 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008252 >= 8 Files for which a group of autocommands is executed.
8253 >= 9 Every executed autocommand.
8254 >= 12 Every executed function.
8255 >= 13 When an exception is thrown, caught, finished, or discarded.
8256 >= 14 Anything pending in a ":finally" clause.
8257 >= 15 Every executed Ex command (truncated at 200 characters).
8258
8259 This option can also be set with the "-V" argument. See |-V|.
8260 This option is also set by the |:verbose| command.
8261
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008262 When the 'verbosefile' option is set then the verbose messages are not
8263 displayed.
8264
8265 *'verbosefile'* *'vfile'*
8266'verbosefile' 'vfile' string (default empty)
8267 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008268 When not empty all messages are written in a file with this name.
8269 When the file exists messages are appended.
8270 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008271 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008272 Setting 'verbosefile' to a new value is like making it empty first.
8273 The difference with |:redir| is that verbose messages are not
8274 displayed when 'verbosefile' is set.
8275
Bram Moolenaar071d4272004-06-13 20:20:40 +00008276 *'viewdir'* *'vdir'*
8277'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8278 "$VIM/vimfiles/view",
8279 for Unix: "~/.vim/view",
8280 for Macintosh: "$VIM:vimfiles:view"
8281 for VMS: "sys$login:vimfiles/view"
8282 for RiscOS: "Choices:vimfiles/view")
8283 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008284 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008285 feature}
8286 Name of the directory where to store files for |:mkview|.
8287 This option cannot be set from a |modeline| or in the |sandbox|, for
8288 security reasons.
8289
8290 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008291'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008292 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008293 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008294 feature}
8295 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008296 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008297 word save and restore ~
8298 cursor cursor position in file and in window
8299 folds manually created folds, opened/closed folds and local
8300 fold options
8301 options options and mappings local to a window or buffer (not
8302 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008303 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008304 slash backslashes in file names replaced with forward
8305 slashes
8306 unix with Unix end-of-line format (single <NL>), even when
8307 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008308 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008309
8310 "slash" and "unix" are useful on Windows when sharing view files
8311 with Unix. The Unix version of Vim cannot source dos format scripts,
8312 but the Windows version of Vim can source unix format scripts.
8313
8314 *'viminfo'* *'vi'* *E526* *E527* *E528*
8315'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008316 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8317 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8318 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008320 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008321 feature}
8322 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008323 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8324 "NONE".
8325 The string should be a comma separated list of parameters, each
8326 consisting of a single character identifying the particular parameter,
8327 followed by a number or string which specifies the value of that
8328 parameter. If a particular character is left out, then the default
8329 value is used for that parameter. The following is a list of the
8330 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008331 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008332 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008333 ! When included, save and restore global variables that start
8334 with an uppercase letter, and don't contain a lowercase
8335 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008336 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008337 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008338 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008339 " Maximum number of lines saved for each register. Old name of
8340 the '<' item, with the disadvantage that you need to put a
8341 backslash before the ", otherwise it will be recognized as the
8342 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008343 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008344 % When included, save and restore the buffer list. If Vim is
8345 started with a file name argument, the buffer list is not
8346 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008347 buffer list is restored from the viminfo file. Quickfix
8348 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8349 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008350 When followed by a number, the number specifies the maximum
8351 number of buffers that are stored. Without a number all
8352 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008353 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354 ' Maximum number of previously edited files for which the marks
8355 are remembered. This parameter must always be included when
8356 'viminfo' is non-empty.
8357 Including this item also means that the |jumplist| and the
8358 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008359 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008361 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362 patterns are also saved. When not included, the value of
8363 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008364 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008366 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008367 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368 < Maximum number of lines saved for each register. If zero then
8369 registers are not saved. When not included, all lines are
8370 saved. '"' is the old name for this item.
8371 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008372 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008373 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008374 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008375 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008376 c When included, convert the text in the viminfo file from the
8377 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008378 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008379 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008380 f Whether file marks need to be stored. If zero, file marks ('0
8381 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008382 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008383 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008384 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008385 h Disable the effect of 'hlsearch' when loading the viminfo
8386 file. When not included, it depends on whether ":nohlsearch"
8387 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008388 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008389 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008390 the 'n'. Must be at the end of the option! If the
8391 'viminfofile' option is set, that file name overrides the one
8392 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008393 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008394 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008395 r Removable media. The argument is a string (up to the next
8396 ','). This parameter can be given several times. Each
8397 specifies the start of a path for which no marks will be
8398 stored. This is to avoid removable media. For MS-DOS you
8399 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8400 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8401 ignored. Maximum length of each 'r' argument is 50
8402 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008403 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008404 s Maximum size of an item in Kbyte. If zero then registers are
8405 not saved. Currently only applies to registers. The default
8406 "s10" will exclude registers with more than 10 Kbyte of text.
8407 Also see the '<' item above: line count limit.
8408
8409 Example: >
8410 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8411<
8412 '50 Marks will be remembered for the last 50 files you
8413 edited.
8414 <1000 Contents of registers (up to 1000 lines each) will be
8415 remembered.
8416 s100 Registers with more than 100 Kbyte text are skipped.
8417 :0 Command-line history will not be saved.
8418 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8419 no / Since '/' is not specified, the default will be used,
8420 that is, save all of the search history, and also the
8421 previous search and substitute patterns.
8422 no % The buffer list will not be saved nor read back.
8423 no h 'hlsearch' highlighting will be restored.
8424
8425 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8426 load the contents of the file, this is not done automatically.
8427
8428 This option cannot be set from a |modeline| or in the |sandbox|, for
8429 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008430 NOTE: This option is set to the Vim default value when 'compatible'
8431 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008432
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008433 *'viminfofile'* *'vif'*
8434'viminfofile' 'vif' string (default: "")
8435 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008436 {not available when compiled without the |+viminfo|
8437 feature}
8438 When non-empty, overrides the file name used for viminfo.
8439 When equal to "NONE" no viminfo file will be read or written.
8440 This option can be set with the |-i| command line flag. The |--clean|
8441 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008442 This option cannot be set from a |modeline| or in the |sandbox|, for
8443 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008444
Bram Moolenaar071d4272004-06-13 20:20:40 +00008445 *'virtualedit'* *'ve'*
8446'virtualedit' 've' string (default "")
8447 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008448 {not available when compiled without the
8449 |+virtualedit| feature}
8450 A comma separated list of these words:
8451 block Allow virtual editing in Visual block mode.
8452 insert Allow virtual editing in Insert mode.
8453 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008454 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008455
Bram Moolenaar071d4272004-06-13 20:20:40 +00008456 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008457 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 of the line. Useful for selecting a rectangle in Visual mode and
8459 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008460 "onemore" is not the same, it will only allow moving the cursor just
8461 after the last character of the line. This makes some commands more
8462 consistent. Previously the cursor was always past the end of the line
8463 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008464 break some plugins or Vim scripts. For example because |l| can move
8465 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008466 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008467 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008468 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008469 It doesn't make sense to combine "all" with "onemore", but you will
8470 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008471 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008472
8473 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8474'visualbell' 'vb' boolean (default off)
8475 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008476 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008477 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008478 use: >
8479 :set vb t_vb=
8480< If you want a short flash, you can use this on many terminals: >
8481 :set vb t_vb=[?5h$<100>[?5l
8482< Here $<100> specifies the time, you can use a smaller or bigger value
8483 to get a shorter or longer flash.
8484
8485 Note: Vim will limit the bell to once per half a second. This avoids
8486 having to wait for the flashing to finish when there are lots of
8487 bells, e.g. on key repeat. This also happens without 'visualbell'
8488 set.
8489
Bram Moolenaar071d4272004-06-13 20:20:40 +00008490 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8491 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8492 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008493
8494 Note: When the GUI starts, 't_vb' is reset to its default value. You
8495 might want to set it again in your |gvimrc|.
8496
Bram Moolenaar071d4272004-06-13 20:20:40 +00008497 Does not work on the Amiga, you always get a screen flash.
8498 Also see 'errorbells'.
8499
8500 *'warn'* *'nowarn'*
8501'warn' boolean (default on)
8502 global
8503 Give a warning message when a shell command is used while the buffer
8504 has been changed.
8505
8506 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8507'weirdinvert' 'wiv' boolean (default off)
8508 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008509 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008510 It is provided for backwards compatibility with version 4.x.
8511 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8512 vice versa. Has no effect when the GUI is running.
8513
8514 *'whichwrap'* *'ww'*
8515'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008517 Allow specified keys that move the cursor left/right to move to the
8518 previous/next line when the cursor is on the first/last character in
8519 the line. Concatenate characters to allow this for these keys:
8520 char key mode ~
8521 b <BS> Normal and Visual
8522 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008523 h "h" Normal and Visual (not recommended)
8524 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008525 < <Left> Normal and Visual
8526 > <Right> Normal and Visual
8527 ~ "~" Normal
8528 [ <Left> Insert and Replace
8529 ] <Right> Insert and Replace
8530 For example: >
8531 :set ww=<,>,[,]
8532< allows wrap only when cursor keys are used.
8533 When the movement keys are used in combination with a delete or change
8534 operator, the <EOL> also counts for a character. This makes "3h"
8535 different from "3dh" when the cursor crosses the end of a line. This
8536 is also true for "x" and "X", because they do the same as "dl" and
8537 "dh". If you use this, you may also want to use the mapping
8538 ":map <BS> X" to make backspace delete the character in front of the
8539 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008540 When 'l' is included and it is used after an operator at the end of a
8541 line then it will not move to the next line. This makes "dl", "cl",
8542 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008543 NOTE: This option is set to the Vi default value when 'compatible' is
8544 set and to the Vim default value when 'compatible' is reset.
8545
8546 *'wildchar'* *'wc'*
8547'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8548 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008549 Character you have to type to start wildcard expansion in the
8550 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008551 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008552 The character is not recognized when used inside a macro. See
8553 'wildcharm' for that.
8554 Although 'wc' is a number option, you can set it to a special key: >
8555 :set wc=<Esc>
8556< NOTE: This option is set to the Vi default value when 'compatible' is
8557 set and to the Vim default value when 'compatible' is reset.
8558
8559 *'wildcharm'* *'wcm'*
8560'wildcharm' 'wcm' number (default: none (0))
8561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008562 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008563 recognized when used inside a macro. You can find "spare" command-line
8564 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008565 you'll never actually type 'wildcharm', just use it in mappings that
8566 automatically invoke completion mode, e.g.: >
8567 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008568 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008569< Then after typing :ss you can use CTRL-P & CTRL-N.
8570
8571 *'wildignore'* *'wig'*
8572'wildignore' 'wig' string (default "")
8573 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008574 {not available when compiled without the |+wildignore|
8575 feature}
8576 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008577 patterns is ignored when expanding |wildcards|, completing file or
8578 directory names, and influences the result of |expand()|, |glob()| and
8579 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008580 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8581 Also see 'suffixes'.
8582 Example: >
8583 :set wildignore=*.o,*.obj
8584< The use of |:set+=| and |:set-=| is preferred when adding or removing
8585 a pattern from the list. This avoids problems when a future version
8586 uses another default.
8587
Bram Moolenaar94950a92010-12-02 16:01:29 +01008588
Bram Moolenaar81af9252010-12-10 20:35:50 +01008589 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008590'wildignorecase' 'wic' boolean (default off)
8591 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008592 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008593 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008594 Does not apply when the shell is used to expand wildcards, which
8595 happens when there are special characters.
8596
8597
Bram Moolenaar071d4272004-06-13 20:20:40 +00008598 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008599'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008600 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 {not available if compiled without the |+wildmenu|
8602 feature}
8603 When 'wildmenu' is on, command-line completion operates in an enhanced
8604 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8605 the possible matches are shown just above the command line, with the
8606 first match highlighted (overwriting the status line, if there is
8607 one). Keys that show the previous/next match, such as <Tab> or
8608 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8609 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8610 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008611 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008612 If there are more matches than can fit in the line, a ">" is shown on
8613 the right and/or a "<" is shown on the left. The status line scrolls
8614 as needed.
8615 The "wildmenu" mode is abandoned when a key is hit that is not used
8616 for selecting a completion.
8617 While the "wildmenu" is active the following keys have special
8618 meanings:
8619
8620 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8621 <Down> - in filename/menu name completion: move into a
8622 subdirectory or submenu.
8623 <CR> - in menu completion, when the cursor is just after a
8624 dot: move into a submenu.
8625 <Up> - in filename/menu name completion: move up into
8626 parent directory or parent menu.
8627
8628 This makes the menus accessible from the console |console-menus|.
8629
8630 If you prefer the <Left> and <Right> keys to move the cursor instead
8631 of selecting a different match, use this: >
8632 :cnoremap <Left> <Space><BS><Left>
8633 :cnoremap <Right> <Space><BS><Right>
8634<
8635 The "WildMenu" highlighting is used for displaying the current match
8636 |hl-WildMenu|.
8637
8638 *'wildmode'* *'wim'*
8639'wildmode' 'wim' string (Vim default: "full")
8640 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008641 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008642 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008643 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008644 first part specifies the behavior for the first use of 'wildchar',
8645 The second part for the second use, etc.
8646 These are the possible values for each part:
8647 "" Complete only the first match.
8648 "full" Complete the next full match. After the last match,
8649 the original string is used and then the first match
8650 again.
8651 "longest" Complete till longest common string. If this doesn't
8652 result in a longer string, use the next part.
8653 "longest:full" Like "longest", but also start 'wildmenu' if it is
8654 enabled.
8655 "list" When more than one match, list all matches.
8656 "list:full" When more than one match, list all matches and
8657 complete first match.
8658 "list:longest" When more than one match, list all matches and
8659 complete till longest common string.
8660 When there is only a single match, it is fully completed in all cases.
8661
8662 Examples: >
8663 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008664< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008665 :set wildmode=longest,full
8666< Complete longest common string, then each full match >
8667 :set wildmode=list:full
8668< List all matches and complete each full match >
8669 :set wildmode=list,full
8670< List all matches without completing, then each full match >
8671 :set wildmode=longest,list
8672< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008673 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008674
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008675 *'wildoptions'* *'wop'*
8676'wildoptions' 'wop' string (default "")
8677 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008678 {not available when compiled without the |+wildignore|
8679 feature}
8680 A list of words that change how command line completion is done.
8681 Currently only one word is allowed:
8682 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008683 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008684 is displayed per line. Often used tag kinds are:
8685 d #define
8686 f function
8687 Also see |cmdline-completion|.
8688
Bram Moolenaar071d4272004-06-13 20:20:40 +00008689 *'winaltkeys'* *'wak'*
8690'winaltkeys' 'wak' string (default "menu")
8691 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008692 {only used in Win32, Motif, GTK and Photon GUI}
8693 Some GUI versions allow the access to menu entries by using the ALT
8694 key in combination with a character that appears underlined in the
8695 menu. This conflicts with the use of the ALT key for mappings and
8696 entering special characters. This option tells what to do:
8697 no Don't use ALT keys for menus. ALT key combinations can be
8698 mapped, but there is no automatic handling. This can then be
8699 done with the |:simalt| command.
8700 yes ALT key handling is done by the windowing system. ALT key
8701 combinations cannot be mapped.
8702 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008703 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008704 keys can be mapped.
8705 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8706 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008707 This option is not used for <F10>; on Win32 and with GTK <F10> will
8708 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008710 *'wincolor'* *'wcr'*
8711'wincolor' 'wcr' string (default empty)
8712 local to window
8713 Highlight group name to use for this window instead of the Normal
8714 color |hl-Normal|.
8715
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008716 *'window'* *'wi'*
8717'window' 'wi' number (default screen height - 1)
8718 global
8719 Window height. Do not confuse this with the height of the Vim window,
8720 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008721 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8722 value is smaller than 'lines' minus one. The screen will scroll
8723 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008724 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8725 in a much smarter way, taking care of wrapping lines.
8726 When resizing the Vim window, the value is smaller than 1 or more than
8727 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008728
Bram Moolenaar071d4272004-06-13 20:20:40 +00008729 *'winheight'* *'wh'* *E591*
8730'winheight' 'wh' number (default 1)
8731 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008733 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008734 focus goes to a window that is smaller, its size is increased, at the
8735 cost of the height of other windows.
8736 Set 'winheight' to a small number for normal editing.
8737 Set it to 999 to make the current window fill most of the screen.
8738 Other windows will be only 'winminheight' high. This has the drawback
8739 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8740 to create only two windows, set the option after startup is done,
8741 using the |VimEnter| event: >
8742 au VimEnter * set winheight=999
8743< Minimum value is 1.
8744 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 height of the current window.
8746 'winheight' applies to the current window. Use 'winminheight' to set
8747 the minimal height for other windows.
8748
8749 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8750'winfixheight' 'wfh' boolean (default off)
8751 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008752 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008753 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8754 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008755 The height may be changed anyway when running out of room.
8756
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008757 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8758'winfixwidth' 'wfw' boolean (default off)
8759 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008760 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008761 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008762 The width may be changed anyway when running out of room.
8763
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764 *'winminheight'* *'wmh'*
8765'winminheight' 'wmh' number (default 1)
8766 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008767 The minimal height of a window, when it's not the current window.
8768 This is a hard minimum, windows will never become smaller.
8769 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8770 status bar) if necessary. They will return to at least one line when
8771 they become active (since the cursor has to have somewhere to go.)
8772 Use 'winheight' to set the minimal height of the current window.
8773 This option is only checked when making a window smaller. Don't use a
8774 large number, it will cause errors when opening more than a few
8775 windows. A value of 0 to 3 is reasonable.
8776
8777 *'winminwidth'* *'wmw'*
8778'winminwidth' 'wmw' number (default 1)
8779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008780 The minimal width of a window, when it's not the current window.
8781 This is a hard minimum, windows will never become smaller.
8782 When set to zero, windows may be "squashed" to zero columns (i.e. just
8783 a vertical separator) if necessary. They will return to at least one
8784 line when they become active (since the cursor has to have somewhere
8785 to go.)
8786 Use 'winwidth' to set the minimal width of the current window.
8787 This option is only checked when making a window smaller. Don't use a
8788 large number, it will cause errors when opening more than a few
8789 windows. A value of 0 to 12 is reasonable.
8790
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008791 *'winptydll'*
8792'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8793 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008794 {only available when compiled with the |terminal|
8795 feature on MS-Windows}
8796 Specifies the name of the winpty shared library, used for the
8797 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008798 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008799 a fallback.
8800 Environment variables are expanded |:set_env|.
8801 This option cannot be set from a |modeline| or in the |sandbox|, for
8802 security reasons.
8803
Bram Moolenaar071d4272004-06-13 20:20:40 +00008804 *'winwidth'* *'wiw'* *E592*
8805'winwidth' 'wiw' number (default 20)
8806 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008807 Minimal number of columns for the current window. This is not a hard
8808 minimum, Vim will use fewer columns if there is not enough room. If
8809 the current window is smaller, its size is increased, at the cost of
8810 the width of other windows. Set it to 999 to make the current window
8811 always fill the screen. Set it to a small number for normal editing.
8812 The width is not adjusted after one of the commands to change the
8813 width of the current window.
8814 'winwidth' applies to the current window. Use 'winminwidth' to set
8815 the minimal width for other windows.
8816
8817 *'wrap'* *'nowrap'*
8818'wrap' boolean (default on)
8819 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008820 This option changes how text is displayed. It doesn't change the text
8821 in the buffer, see 'textwidth' for that.
8822 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008823 displaying continues on the next line. When off lines will not wrap
8824 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008825 moved to a part that is not shown, the screen will scroll
8826 horizontally.
8827 The line will be broken in the middle of a word if necessary. See
8828 'linebreak' to get the break at a word boundary.
8829 To make scrolling horizontally a bit more useful, try this: >
8830 :set sidescroll=5
8831 :set listchars+=precedes:<,extends:>
8832< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008833 This option can't be set from a |modeline| when the 'diff' option is
8834 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008835
8836 *'wrapmargin'* *'wm'*
8837'wrapmargin' 'wm' number (default 0)
8838 local to buffer
8839 Number of characters from the right window border where wrapping
8840 starts. When typing text beyond this limit, an <EOL> will be inserted
8841 and inserting continues on the next line.
8842 Options that add a margin, such as 'number' and 'foldcolumn', cause
8843 the text width to be further reduced. This is Vi compatible.
8844 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008845 This option is set to 0 when 'paste' is set and restored when 'paste'
8846 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008847 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008848
8849 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8850'wrapscan' 'ws' boolean (default on) *E384* *E385*
8851 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008852 Searches wrap around the end of the file. Also applies to |]s| and
8853 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854
8855 *'write'* *'nowrite'*
8856'write' boolean (default on)
8857 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008858 Allows writing files. When not set, writing a file is not allowed.
8859 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008860 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008861 argument. Filtering text is still possible, even though this requires
8862 writing a temporary file.
8863
8864 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8865'writeany' 'wa' boolean (default off)
8866 global
8867 Allows writing to any file with no need for "!" override.
8868
8869 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8870'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8871 otherwise)
8872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008873 Make a backup before overwriting a file. The backup is removed after
8874 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008875 also on.
8876 WARNING: Switching this option off means that when Vim fails to write
8877 your buffer correctly and then, for whatever reason, Vim exits, you
8878 lose both the original file and what you were writing. Only reset
8879 this option if your file system is almost full and it makes the write
8880 fail (and make sure not to exit Vim until the write was successful).
8881 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008882 When the 'backupskip' pattern matches, a backup is not made anyway.
8883 NOTE: This option is set to the default value when 'compatible' is
8884 set.
8885
8886 *'writedelay'* *'wd'*
8887'writedelay' 'wd' number (default 0)
8888 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008889 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008890 screen. When non-zero, characters are sent to the terminal one by
8891 one. For MS-DOS pcterm this does not work. For debugging purposes.
8892
Bram Moolenaar91f84f62018-07-29 15:07:52 +02008893 vim:tw=78:ts=8:noet:ft=help:norl: