blob: c17842f3cdb50e86e8ea8188725dfe3eb96a6cab [file] [log] [blame]
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001*options.txt* For Vim version 8.1. Last change: 2019 May 05
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 "\\:".
581
582No 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
584can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000585|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000586causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
587are wrapped unexpectedly. So disable modelines before editing untrusted text.
588The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589
590Hint: If you would like to do something else than setting an option, you could
591define an autocommand that checks the file for a specific string. For
592example: >
593 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
594And define a function SetVar() that does something with the line containing
595"VAR".
596
597==============================================================================
5983. Options summary *option-summary*
599
600In the list below all the options are mentioned with their full name and with
601an abbreviation if there is one. Both forms may be used.
602
603In this document when a boolean option is "set" that means that ":set option"
604is entered. When an option is "reset", ":set nooption" is used.
605
606For some options there are two default values: The "Vim default", which is
607used when 'compatible' is not set, and the "Vi default", which is used when
608'compatible' is set.
609
610Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000611are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612different value in each window. For example the 'list' option can be set in
613one window and reset in another for the same text, giving both types of view
614at the same time. There are a few options that are specific to a certain
615file. These can have a different value for each file or buffer. For example
616the 'textwidth' option can be 78 for a normal text file and 0 for a C
617program.
618
619 global one option for all buffers and windows
620 local to window each window has its own copy of this option
621 local to buffer each buffer has its own copy of this option
622
623When creating a new window the option values from the currently active window
624are used as a default value for the window-specific options. For the
625buffer-specific options this depends on the 's' and 'S' flags in the
626'cpoptions' option. If 's' is included (which is the default) the values for
627buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000628first entered. If 'S' is present the options are copied each time the buffer
629is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630present, the options are copied from the currently active buffer when the
631buffer is created.
632
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000633Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000634
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000635Not all options are supported in all versions. This depends on the supported
636features and sometimes on the system. A remark about this is in curly braces
637below. When an option is not supported it may still be set without getting an
638error, this is called a hidden option. You can't get the value of a hidden
639option though, it is not stored.
640
641To test if option "foo" can be used with ":set" use something like this: >
642 if exists('&foo')
643This also returns true for a hidden option. To test if option "foo" is really
644supported use something like this: >
645 if exists('+foo')
646<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000647 *E355*
648A jump table for the options with a short description can be found at |Q_op|.
649
650 *'aleph'* *'al'* *aleph* *Aleph*
651'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
652 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653 {only available when compiled with the |+rightleft|
654 feature}
655 The ASCII code for the first letter of the Hebrew alphabet. The
656 routine that maps the keyboard in Hebrew mode, both in Insert mode
657 (when hkmap is set) and on the command-line (when hitting CTRL-_)
658 outputs the Hebrew characters in the range [aleph..aleph+26].
659 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
660 See |rileft.txt|.
661
662 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
663'allowrevins' 'ari' boolean (default off)
664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665 {only available when compiled with the |+rightleft|
666 feature}
667 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
668 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
669 into reverse Insert mode, and don't know how to get out. See
670 'revins'.
671 NOTE: This option is reset when 'compatible' is set.
672
673 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
674'altkeymap' 'akm' boolean (default off)
675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 {only available when compiled with the |+farsi|
677 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100678 This option was for using Farsi, which has been removed. See
679 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680
681 *'ambiwidth'* *'ambw'*
682'ambiwidth' 'ambw' string (default: "single")
683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
685 Tells Vim what to do with characters with East Asian Width Class
686 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
687 letters, Cyrillic letters).
688
689 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000690 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691 expected by most users.
692 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200693 *E834* *E835*
694 The value "double" cannot be used if 'listchars' or 'fillchars'
695 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696
697 There are a number of CJK fonts for which the width of glyphs for
698 those characters are solely based on how many octets they take in
699 legacy/traditional CJK encodings. In those encodings, Euro,
700 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000701 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000702 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000703 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000704 Vim is running inside a terminal (emulators) that uses a CJK font
705 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
706 this option should be set to "double" to match the width perceived
707 by Vim with the width of glyphs in the font. Perhaps it also has
708 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
709 when the system locale is set to one of CJK locales. See Unicode
710 Standard Annex #11 (http://www.unicode.org/reports/tr11).
711
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100712 Vim may set this option automatically at startup time when Vim is
713 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200714 escape sequence to request cursor position report. The response can
715 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100716
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
718'antialias' 'anti' boolean (default: off)
719 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 {only available when compiled with GUI enabled
721 on Mac OS X}
722 This option only has an effect in the GUI version of Vim on Mac OS X
723 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
724 which can be easier to read at certain sizes on certain displays.
725 Setting this option can sometimes cause problems if 'guifont' is set
726 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100727 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728
729 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
730'autochdir' 'acd' boolean (default off)
731 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200732 {only available when compiled with it, use
733 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000734 When on, Vim will change the current working directory whenever you
735 open a file, switch buffers, delete a buffer or open/close a window.
736 It will change to the directory containing the file which was opened
737 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000738 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739
740 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
741'arabic' 'arab' boolean (default off)
742 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743 {only available when compiled with the |+arabic|
744 feature}
745 This option can be set to start editing Arabic text.
746 Setting this option will:
747 - Set the 'rightleft' option, unless 'termbidi' is set.
748 - Set the 'arabicshape' option, unless 'termbidi' is set.
749 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
750 between typing English and Arabic key mapping.
751 - Set the 'delcombine' option
752 Note that 'encoding' must be "utf-8" for working with Arabic text.
753
754 Resetting this option will:
755 - Reset the 'rightleft' option.
756 - Disable the use of 'keymap' (without changing its value).
757 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200758 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100759 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760 Also see |arabic.txt|.
761
762 *'arabicshape'* *'arshape'*
763 *'noarabicshape'* *'noarshape'*
764'arabicshape' 'arshape' boolean (default on)
765 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766 {only available when compiled with the |+arabic|
767 feature}
768 When on and 'termbidi' is off, the required visual character
769 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200770 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771 one which encompasses:
772 a) the changing/morphing of characters based on their location
773 within a word (initial, medial, final and stand-alone).
774 b) the enabling of the ability to compose characters
775 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100776 When disabled the display shows each character's true stand-alone
777 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778 Arabic is a complex language which requires other settings, for
779 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100780 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781
782 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
783'autoindent' 'ai' boolean (default off)
784 local to buffer
785 Copy indent from current line when starting a new line (typing <CR>
786 in Insert mode or when using the "o" or "O" command). If you do not
787 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000788 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
789 to another line has the same effect, unless the 'I' flag is included
790 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000791 When autoindent is on, formatting (with the "gq" command or when you
792 reach 'textwidth' in Insert mode) uses the indentation of the first
793 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794 When 'smartindent' or 'cindent' is on the indent is changed in
795 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200796 The 'autoindent' option is reset when the 'paste' option is set and
797 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798 {small difference from Vi: After the indent is deleted when typing
799 <Esc> or <CR>, the cursor position when moving up or down is after the
800 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
801
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
1124 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001125
1126 v:beval_bufnr number of the buffer in which balloon is going to show
1127 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001128 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001129 v:beval_lnum line number
1130 v:beval_col column number (byte index)
1131 v:beval_text word under or after the mouse pointer
1132
1133 The evaluation of the expression must not have side effects!
1134 Example: >
1135 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001136 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001137 \', column ' . v:beval_col .
1138 \ ' of file ' . bufname(v:beval_bufnr) .
1139 \ ' on word "' . v:beval_text . '"'
1140 endfunction
1141 set bexpr=MyBalloonExpr()
1142 set ballooneval
1143<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001144 Also see |balloon_show()|, can be used if the content of the balloon
1145 is to be fetched asynchronously.
1146
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001147 NOTE: The balloon is displayed only if the cursor is on a text
1148 character. If the result of evaluating 'balloonexpr' is not empty,
1149 Vim does not try to send a message to an external debugger (Netbeans
1150 or Sun Workshop).
1151
Bram Moolenaar30b65812012-07-12 22:01:11 +02001152 The expression will be evaluated in the |sandbox| when set from a
1153 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001154
1155 It is not allowed to change text or jump to another window while
1156 evaluating 'balloonexpr' |textlock|.
1157
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001158 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001159 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001160< When they are supported "\n" characters will start a new line. If the
1161 expression evaluates to a |List| this is equal to using each List item
1162 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001163 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001164
Bram Moolenaar165bc692015-07-21 17:53:25 +02001165 *'belloff'* *'bo'*
1166'belloff' 'bo' string (default "")
1167 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001168 Specifies for which events the bell will not be rung. It is a comma
1169 separated list of items. For each item that is present, the bell
1170 will be silenced. This is most useful to specify specific events in
1171 insert mode to be silenced.
1172
1173 item meaning when present ~
1174 all All events.
1175 backspace When hitting <BS> or <Del> and deleting results in an
1176 error.
1177 cursor Fail to move around using the cursor keys or
1178 <PageUp>/<PageDown> in |Insert-mode|.
1179 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1180 |i_CTRL-X_CTRL-T|.
1181 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1182 |i_CTRL-E|.
1183 ctrlg Unknown Char after <C-G> in Insert mode.
1184 error Other Error occurred (e.g. try to join last line)
1185 (mostly used in |Normal-mode| or |Cmdline-mode|).
1186 esc hitting <Esc> in |Normal-mode|.
1187 ex In |Visual-mode|, hitting |Q| results in an error.
1188 hangul Error occurred when using hangul input.
1189 insertmode Pressing <Esc> in 'insertmode'.
1190 lang Calling the beep module for Lua/Mzscheme/TCL.
1191 mess No output available for |g<|.
1192 showmatch Error occurred for 'showmatch' function.
1193 operator Empty region error |cpo-E|.
1194 register Unknown register after <C-R> in |Insert-mode|.
1195 shell Bell from shell output |:!|.
1196 spell Error happened on spell suggest.
1197 wildmode More matches in |cmdline-completion| available
1198 (depends on the 'wildmode' setting).
1199
Bram Moolenaar036986f2017-03-16 17:41:02 +01001200 This is most useful to fine tune when in Insert mode the bell should
1201 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001202 indicate that an error occurred. It can be silenced by adding the
1203 "error" keyword.
1204
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1206'binary' 'bin' boolean (default off)
1207 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001208 This option should be set before editing a binary file. You can also
1209 use the |-b| Vim argument. When this option is switched on a few
1210 options will be changed (also when it already was on):
1211 'textwidth' will be set to 0
1212 'wrapmargin' will be set to 0
1213 'modeline' will be off
1214 'expandtab' will be off
1215 Also, 'fileformat' and 'fileformats' options will not be used, the
1216 file is read and written like 'fileformat' was "unix" (a single <NL>
1217 separates lines).
1218 The 'fileencoding' and 'fileencodings' options will not be used, the
1219 file is read without conversion.
1220 NOTE: When you start editing a(nother) file while the 'bin' option is
1221 on, settings from autocommands may change the settings again (e.g.,
1222 'textwidth'), causing trouble when editing. You might want to set
1223 'bin' again when the file has been loaded.
1224 The previous values of these options are remembered and restored when
1225 'bin' is switched from on to off. Each buffer has its own set of
1226 saved option values.
1227 To edit a file with 'binary' set you can use the |++bin| argument.
1228 This avoids you have to do ":set bin", which would have effect for all
1229 files you edit.
1230 When writing a file the <EOL> for the last line is only written if
1231 there was one in the original file (normally Vim appends an <EOL> to
1232 the last line if there is none; this would make the file longer). See
1233 the 'endofline' option.
1234
1235 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1236'bioskey' 'biosk' boolean (default on)
1237 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001238 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001239 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240
1241 *'bomb'* *'nobomb'*
1242'bomb' boolean (default off)
1243 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244 When writing a file and the following conditions are met, a BOM (Byte
1245 Order Mark) is prepended to the file:
1246 - this option is on
1247 - the 'binary' option is off
1248 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1249 endian variants.
1250 Some applications use the BOM to recognize the encoding of the file.
1251 Often used for UCS-2 files on MS-Windows. For other applications it
1252 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001253 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001254 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1255 check for the presence of the BOM is done and 'bomb' set accordingly.
1256 Unless 'binary' is set, it is removed from the first line, so that you
1257 don't see it when editing. When you don't change the options, the BOM
1258 will be restored when writing the file.
1259
1260 *'breakat'* *'brk'*
1261'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1262 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001263 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001264 feature}
1265 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001266 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1267 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001269 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001270'breakindent' 'bri' boolean (default off)
1271 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001272 {not available when compiled without the |+linebreak|
1273 feature}
1274 Every wrapped line will continue visually indented (same amount of
1275 space as the beginning of that line), thus preserving horizontal blocks
1276 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001277 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001278
1279 *'breakindentopt'* *'briopt'*
1280'breakindentopt' 'briopt' string (default empty)
1281 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001282 {not available when compiled without the |+linebreak|
1283 feature}
1284 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001285 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001286 min:{n} Minimum text width that will be kept after
1287 applying 'breakindent', even if the resulting
1288 text should normally be narrower. This prevents
1289 text indented almost to the right window border
1290 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001291 shift:{n} After applying 'breakindent', the wrapped line's
1292 beginning will be shifted by the given number of
1293 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001294 indentation (negative) or emphasizing the line
1295 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001296 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001297 additional indent.
1298 The default value for min is 20 and shift is 0.
1299
Bram Moolenaar071d4272004-06-13 20:20:40 +00001300 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001301'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001302 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001303 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001305 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001306 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307 buffer Use the directory of the related buffer.
1308 current Use the current directory.
1309 {path} Use the specified directory
1310
1311 *'bufhidden'* *'bh'*
1312'bufhidden' 'bh' string (default: "")
1313 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 This option specifies what happens when a buffer is no longer
1315 displayed in a window:
1316 <empty> follow the global 'hidden' option
1317 hide hide the buffer (don't unload it), also when 'hidden'
1318 is not set
1319 unload unload the buffer, also when 'hidden' is set or using
1320 |:hide|
1321 delete delete the buffer from the buffer list, also when
1322 'hidden' is set or using |:hide|, like using
1323 |:bdelete|
1324 wipe wipe out the buffer from the buffer list, also when
1325 'hidden' is set or using |:hide|, like using
1326 |:bwipeout|
1327
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001328 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001329 are lost without a warning. Also, these values may break autocommands
1330 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331 This option is used together with 'buftype' and 'swapfile' to specify
1332 special kinds of buffers. See |special-buffers|.
1333
1334 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1335'buflisted' 'bl' boolean (default: on)
1336 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001337 When this option is set, the buffer shows up in the buffer list. If
1338 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1339 This option is reset by Vim for buffers that are only used to remember
1340 a file name or marks. Vim sets it when starting to edit a buffer.
1341 But not when moving to a buffer with ":buffer".
1342
1343 *'buftype'* *'bt'* *E382*
1344'buftype' 'bt' string (default: "")
1345 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346 The value of this option specifies the type of a buffer:
1347 <empty> normal buffer
1348 nofile buffer which is not related to a file and will not be
1349 written
1350 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001351 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001352 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001353 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001354 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355 help help buffer (you are not supposed to set this
1356 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001357 terminal buffer for a |terminal| (you are not supposed to set
1358 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001359 prompt buffer where only the last line can be edited, meant
1360 to be used by a plugin, see |prompt-buffer|
1361 {only when compiled with the |+channel| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362
1363 This option is used together with 'bufhidden' and 'swapfile' to
1364 specify special kinds of buffers. See |special-buffers|.
1365
1366 Be careful with changing this option, it can have many side effects!
1367
Bram Moolenaar280f1262006-01-30 00:14:18 +00001368 A "quickfix" buffer is only used for the error list and the location
1369 list. This value is set by the |:cwindow| and |:lwindow| commands and
1370 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001371
1372 "nofile" and "nowrite" buffers are similar:
1373 both: The buffer is not to be written to disk, ":w" doesn't
1374 work (":w filename" does work though).
1375 both: The buffer is never considered to be |'modified'|.
1376 There is no warning when the changes will be lost, for
1377 example when you quit Vim.
1378 both: A swap file is only created when using too much memory
1379 (when 'swapfile' has been reset there is never a swap
1380 file).
1381 nofile only: The buffer name is fixed, it is not handled like a
1382 file name. It is not modified in response to a |:cd|
1383 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001384 both: When using ":e bufname" and already editing "bufname"
1385 the buffer is made empty and autocommands are
1386 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001387 *E676*
1388 "acwrite" implies that the buffer name is not related to a file, like
1389 "nofile", but it will be written. Thus, in contrast to "nofile" and
1390 "nowrite", ":w" does work and a modified buffer can't be abandoned
1391 without saving. For writing there must be matching |BufWriteCmd|,
1392 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001393
1394 *'casemap'* *'cmp'*
1395'casemap' 'cmp' string (default: "internal,keepascii")
1396 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397 Specifies details about changing the case of letters. It may contain
1398 these words, separated by a comma:
1399 internal Use internal case mapping functions, the current
1400 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001401 matters when 'encoding' is a Unicode encoding,
1402 "latin1" or "iso-8859-15". When "internal" is
1403 omitted, the towupper() and towlower() system library
1404 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1406 case mapping, the current locale is not effective.
1407 This probably only matters for Turkish.
1408
1409 *'cdpath'* *'cd'* *E344* *E346*
1410'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1411 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412 {not available when compiled without the
1413 |+file_in_path| feature}
1414 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001415 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1416 searched for has a relative path, not an absolute part starting with
1417 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001418 The 'cdpath' option's value has the same form and semantics as
1419 |'path'|. Also see |file-searching|.
1420 The default value is taken from $CDPATH, with a "," prepended to look
1421 in the current directory first.
1422 If the default value taken from $CDPATH is not what you want, include
1423 a modified version of the following command in your vimrc file to
1424 override it: >
1425 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1426< This option cannot be set from a |modeline| or in the |sandbox|, for
1427 security reasons.
1428 (parts of 'cdpath' can be passed to the shell to expand file names).
1429
1430 *'cedit'*
1431'cedit' string (Vi default: "", Vim default: CTRL-F)
1432 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433 {not available when compiled without the |+vertsplit|
1434 feature}
1435 The key used in Command-line Mode to open the command-line window.
1436 The default is CTRL-F when 'compatible' is off.
1437 Only non-printable keys are allowed.
1438 The key can be specified as a single character, but it is difficult to
1439 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001440 :exe "set cedit=\<C-Y>"
1441 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001442< |Nvi| also has this option, but it only uses the first character.
1443 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001444 NOTE: This option is set to the Vim default value when 'compatible'
1445 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446
1447 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1448'charconvert' 'ccv' string (default "")
1449 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001450 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001451 An expression that is used for character encoding conversion. It is
1452 evaluated when a file that is to be read or has been written has a
1453 different encoding from what is desired.
1454 'charconvert' is not used when the internal iconv() function is
1455 supported and is able to do the conversion. Using iconv() is
1456 preferred, because it is much faster.
1457 'charconvert' is not used when reading stdin |--|, because there is no
1458 file to convert from. You will have to save the text in a file first.
1459 The expression must return zero or an empty string for success,
1460 non-zero for failure.
1461 The possible encoding names encountered are in 'encoding'.
1462 Additionally, names given in 'fileencodings' and 'fileencoding' are
1463 used.
1464 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1465 is done internally by Vim, 'charconvert' is not used for this.
1466 'charconvert' is also used to convert the viminfo file, if the 'c'
1467 flag is present in 'viminfo'. Also used for Unicode conversion.
1468 Example: >
1469 set charconvert=CharConvert()
1470 fun CharConvert()
1471 system("recode "
1472 \ . v:charconvert_from . ".." . v:charconvert_to
1473 \ . " <" . v:fname_in . " >" v:fname_out)
1474 return v:shell_error
1475 endfun
1476< The related Vim variables are:
1477 v:charconvert_from name of the current encoding
1478 v:charconvert_to name of the desired encoding
1479 v:fname_in name of the input file
1480 v:fname_out name of the output file
1481 Note that v:fname_in and v:fname_out will never be the same.
1482 Note that v:charconvert_from and v:charconvert_to may be different
1483 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1484 Encryption is not done by Vim when using 'charconvert'. If you want
1485 to encrypt the file after conversion, 'charconvert' should take care
1486 of this.
1487 This option cannot be set from a |modeline| or in the |sandbox|, for
1488 security reasons.
1489
1490 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1491'cindent' 'cin' boolean (default off)
1492 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001493 {not available when compiled without the |+cindent|
1494 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001495 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001496 that trigger reindenting in insert mode and 'cinoptions' to set your
1497 preferred indent style.
1498 If 'indentexpr' is not empty, it overrules 'cindent'.
1499 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1500 the "=" operator indents using this algorithm rather than calling an
1501 external program.
1502 See |C-indenting|.
1503 When you don't like the way 'cindent' works, try the 'smartindent'
1504 option or 'indentexpr'.
1505 This option is not used when 'paste' is set.
1506 NOTE: This option is reset when 'compatible' is set.
1507
1508 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001509'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001510 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511 {not available when compiled without the |+cindent|
1512 feature}
1513 A list of keys that, when typed in Insert mode, cause reindenting of
1514 the current line. Only used if 'cindent' is on and 'indentexpr' is
1515 empty.
1516 For the format of this option see |cinkeys-format|.
1517 See |C-indenting|.
1518
1519 *'cinoptions'* *'cino'*
1520'cinoptions' 'cino' string (default "")
1521 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001522 {not available when compiled without the |+cindent|
1523 feature}
1524 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1525 program. See |cinoptions-values| for the values of this option, and
1526 |C-indenting| for info on C indenting in general.
1527
1528
1529 *'cinwords'* *'cinw'*
1530'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1531 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532 {not available when compiled without both the
1533 |+cindent| and the |+smartindent| features}
1534 These keywords start an extra indent in the next line when
1535 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1536 an appropriate place (inside {}).
1537 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1538 matter, include the keyword both the uppercase and lowercase:
1539 "if,If,IF".
1540
1541 *'clipboard'* *'cb'*
1542'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1543 for X-windows, "" otherwise)
1544 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545 {only in GUI versions or when the |+xterm_clipboard|
1546 feature is included}
1547 This option is a list of comma separated names.
1548 These names are recognized:
1549
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001550 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001551 unnamed When included, Vim will use the clipboard register '*'
1552 for all yank, delete, change and put operations which
1553 would normally go to the unnamed register. When a
1554 register is explicitly specified, it will always be
1555 used regardless of whether "unnamed" is in 'clipboard'
1556 or not. The clipboard register can always be
1557 explicitly accessed using the "* notation. Also see
1558 |gui-clipboard|.
1559
Bram Moolenaar30b65812012-07-12 22:01:11 +02001560 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001561 unnamedplus A variant of the "unnamed" flag which uses the
1562 clipboard register '+' (|quoteplus|) instead of
1563 register '*' for all yank, delete, change and put
1564 operations which would normally go to the unnamed
1565 register. When "unnamed" is also included to the
1566 option, yank operations (but not delete, change or
1567 put) will additionally copy the text into register
1568 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001569 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001570 Availability can be checked with: >
1571 if has('unnamedplus')
1572<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001573 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001574 autoselect Works like the 'a' flag in 'guioptions': If present,
1575 then whenever Visual mode is started, or the Visual
1576 area extended, Vim tries to become the owner of the
1577 windowing system's global selection or put the
1578 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001579 register "*. See |'go-a'| and |quotestar| for details.
1580 When the GUI is active, the 'a' flag in 'guioptions'
1581 is used, when the GUI is not active, this "autoselect"
1582 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583 Also applies to the modeless selection.
1584
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001585 *clipboard-autoselectplus*
1586 autoselectplus Like "autoselect" but using the + register instead of
1587 the * register. Compare to the 'P' flag in
1588 'guioptions'.
1589
1590 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591 autoselectml Like "autoselect", but for the modeless selection
1592 only. Compare to the 'A' flag in 'guioptions'.
1593
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001594 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001595 html When the clipboard contains HTML, use this when
1596 pasting. When putting text on the clipboard, mark it
1597 as HTML. This works to copy rendered HTML from
1598 Firefox, paste it as raw HTML in Vim, select the HTML
1599 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001600 You probably want to add this only temporarily,
1601 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001602 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001603
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001604 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 exclude:{pattern}
1606 Defines a pattern that is matched against the name of
1607 the terminal 'term'. If there is a match, no
1608 connection will be made to the X server. This is
1609 useful in this situation:
1610 - Running Vim in a console.
1611 - $DISPLAY is set to start applications on another
1612 display.
1613 - You do not want to connect to the X server in the
1614 console, but do want this in a terminal emulator.
1615 To never connect to the X server use: >
1616 exclude:.*
1617< This has the same effect as using the |-X| argument.
1618 Note that when there is no connection to the X server
1619 the window title won't be restored and the clipboard
1620 cannot be accessed.
1621 The value of 'magic' is ignored, {pattern} is
1622 interpreted as if 'magic' was on.
1623 The rest of the option value will be used for
1624 {pattern}, this must be the last entry.
1625
1626 *'cmdheight'* *'ch'*
1627'cmdheight' 'ch' number (default 1)
1628 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629 Number of screen lines to use for the command-line. Helps avoiding
1630 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001631 The value of this option is stored with the tab page, so that each tab
1632 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633
1634 *'cmdwinheight'* *'cwh'*
1635'cmdwinheight' 'cwh' number (default 7)
1636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 {not available when compiled without the |+vertsplit|
1638 feature}
1639 Number of screen lines to use for the command-line window. |cmdwin|
1640
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001641 *'colorcolumn'* *'cc'*
1642'colorcolumn' 'cc' string (default "")
1643 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001644 {not available when compiled without the |+syntax|
1645 feature}
1646 'colorcolumn' is a comma separated list of screen columns that are
1647 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1648 text. Will make screen redrawing slower.
1649 The screen column can be an absolute number, or a number preceded with
1650 '+' or '-', which is added to or subtracted from 'textwidth'. >
1651
1652 :set cc=+1 " highlight column after 'textwidth'
1653 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1654 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1655<
1656 When 'textwidth' is zero then the items with '-' and '+' are not used.
1657 A maximum of 256 columns are highlighted.
1658
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659 *'columns'* *'co'* *E594*
1660'columns' 'co' number (default 80 or terminal width)
1661 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001662 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001663 initialization and does not have to be set by hand. Also see
1664 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 When Vim is running in the GUI or in a resizable window, setting this
1666 option will cause the window size to be changed. When you only want
1667 to use the size for the GUI, put the command in your |gvimrc| file.
1668 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001669 number of columns of the display, the display may be messed up. For
1670 the GUI it is always possible and Vim limits the number of columns to
1671 what fits on the screen. You can use this command to get the widest
1672 window possible: >
1673 :set columns=9999
1674< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675
1676 *'comments'* *'com'* *E524* *E525*
1677'comments' 'com' string (default
1678 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1679 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001680 {not available when compiled without the |+comments|
1681 feature}
1682 A comma separated list of strings that can start a comment line. See
1683 |format-comments|. See |option-backslash| about using backslashes to
1684 insert a space.
1685
1686 *'commentstring'* *'cms'* *E537*
1687'commentstring' 'cms' string (default "/*%s*/")
1688 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689 {not available when compiled without the |+folding|
1690 feature}
1691 A template for a comment. The "%s" in the value is replaced with the
1692 comment text. Currently only used to add markers for folding, see
1693 |fold-marker|.
1694
1695 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001696'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001697 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001698 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699 This option has the effect of making Vim either more Vi-compatible, or
1700 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001701
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001703 other options are also changed as a side effect.
1704 NOTE: Setting or resetting this option can have a lot of unexpected
1705 effects: Mappings are interpreted in another way, undo behaves
1706 differently, etc. If you set this option in your vimrc file, you
1707 should probably put it at the very start.
1708
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 By default this option is on and the Vi defaults are used for the
1710 options. This default was chosen for those people who want to use Vim
1711 just like Vi, and don't even (want to) know about the 'compatible'
1712 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001713 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001714 this option is switched off, and all options that have not been
1715 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001716 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001717 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001718 happen for the system-wide vimrc or gvimrc file, nor for a file given
1719 with the |-u| argument). Also see |compatible-default| and
1720 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 You can also set this option with the "-C" argument, and reset it with
1722 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001723 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724
Bram Moolenaar214641f2017-03-05 17:04:09 +01001725 When this option is set, numerous other options are set to make Vim as
1726 Vi-compatible as possible. When this option is unset, various options
1727 are set to make Vim more useful. The table below lists all the
1728 options affected.
1729 The {?} column indicates when the options are affected:
1730 + Means that the option is set to the value given in {set value} when
1731 'compatible' is set.
1732 & Means that the option is set to the value given in {set value} when
1733 'compatible' is set AND is set to its Vim default value when
1734 'compatible' is unset.
1735 - Means the option is NOT changed when setting 'compatible' but IS
1736 set to its Vim default when 'compatible' is unset.
1737 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738
Bram Moolenaar036986f2017-03-16 17:41:02 +01001739 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001740
1741 'allowrevins' + off no CTRL-_ command
1742 'antialias' + off don't use antialiased fonts
1743 'arabic' + off reset arabic-related options
1744 'arabicshape' + on correct character shapes
1745 'backspace' + "" normal backspace
1746 'backup' + off no backup file
1747 'backupcopy' & Unix: "yes" backup file is a copy
1748 else: "auto" copy or rename backup file
1749 'balloonexpr' + "" text to show in evaluation balloon
1750 'breakindent' + off don't indent when wrapping lines
1751 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1752 'cindent' + off no C code indentation
1753 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1754 'copyindent' + off don't copy indent structure
1755 'cpoptions' & (all flags) Vi-compatible flags
1756 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001757 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001758 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001759 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001760 'cscopeverbose' + off see |cscopeverbose|
1761 'delcombine' + off unicode: delete whole char combination
1762 'digraph' + off no digraphs
1763 'esckeys' & off no <Esc>-keys in Insert mode
1764 'expandtab' + off tabs not expanded to spaces
1765 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001767 'formatexpr' + "" use 'formatprg' for auto-formatting
1768 'formatoptions' & "vt" Vi compatible formatting
1769 'gdefault' + off no default 'g' flag for ":s"
1770 'history' & 0 no commandline history
1771 'hkmap' + off no Hebrew keyboard mapping
1772 'hkmapp' + off no phonetic Hebrew keyboard mapping
1773 'hlsearch' + off no highlighting of search matches
1774 'incsearch' + off no incremental searching
1775 'indentexpr' + "" no indenting by expression
1776 'insertmode' + off do not start in Insert mode
1777 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001779 'joinspaces' + on insert 2 spaces after period
1780 'modeline' & off no modelines
1781 'more' & off no pauses in listings
1782 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1783 'numberwidth' & 8 min number of columns for line number
1784 'preserveindent'+ off don't preserve current indent structure
1785 when changing it
1786 'revins' + off no reverse insert
1787 'ruler' + off no ruler
1788 'scrolljump' + 1 no jump scroll
1789 'scrolloff' + 0 no scroll offset
1790 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1791 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001792 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001793 'showcmd' & off command characters not shown
1794 'showmode' & off current mode not shown
1795 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1796 'smartcase' + off no automatic ignore case switch
1797 'smartindent' + off no smart indentation
1798 'smarttab' + off no smart tab size
1799 'softtabstop' + 0 tabs are always 'tabstop' positions
1800 'startofline' + on goto startofline with some commands
1801 'tagcase' & "followic" 'ignorecase' when searching tags file
1802 'tagrelative' & off tag file names are not relative
1803 'termguicolors' + off don't use highlight-(guifg|guibg)
1804 'textauto' & off no automatic textmode detection
1805 'textwidth' + 0 no automatic line wrap
1806 'tildeop' + off tilde is not an operator
1807 'ttimeout' + off no terminal timeout
1808 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001809 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001810 'virtualedit' + "" cursor can only be placed on characters
1811 'whichwrap' & "" left-right movements don't wrap
1812 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001814 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815
1816 *'complete'* *'cpt'* *E535*
1817'complete' 'cpt' string (default: ".,w,b,u,t,i")
1818 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 This option specifies how keyword completion |ins-completion| works
1820 when CTRL-P or CTRL-N are used. It is also used for whole-line
1821 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1822 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001823 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824 w scan buffers from other windows
1825 b scan other loaded buffers that are in the buffer list
1826 u scan the unloaded buffers that are in the buffer list
1827 U scan the buffers that are not in the buffer list
1828 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001829 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 k{dict} scan the file {dict}. Several "k" flags can be given,
1831 patterns are valid too. For example: >
1832 :set cpt=k/usr/dict/*,k~/spanish
1833< s scan the files given with the 'thesaurus' option
1834 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1835 are valid too.
1836 i scan current and included files
1837 d scan current and included files for defined name or macro
1838 |i_CTRL-X_CTRL-D|
1839 ] tag completion
1840 t same as "]"
1841
1842 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1843 not executed, this may lead to unexpected completions from some files
1844 (gzipped files for example). Unloaded buffers are not scanned for
1845 whole-line completion.
1846
1847 The default is ".,w,b,u,t,i", which means to scan:
1848 1. the current buffer
1849 2. buffers in other windows
1850 3. other loaded buffers
1851 4. unloaded buffers
1852 5. tags
1853 6. included files
1854
1855 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001856 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1857 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001859 *'completefunc'* *'cfu'*
1860'completefunc' 'cfu' string (default: empty)
1861 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001862 {not available when compiled without the |+eval|
1863 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001864 This option specifies a function to be used for Insert mode completion
1865 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001866 See |complete-functions| for an explanation of how the function is
1867 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001868 This option cannot be set from a |modeline| or in the |sandbox|, for
1869 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001870
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001871 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001872'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001873 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001874 {not available when compiled without the
1875 |+insert_expand| feature}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001876 A comma separated list of options for Insert mode completion
1877 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001878
1879 menu Use a popup menu to show the possible completions. The
1880 menu is only shown when there is more than one match and
1881 sufficient colors are available. |ins-completion-menu|
1882
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001883 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001884 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001885 match, e.g., what file it comes from.
1886
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001887 longest Only insert the longest common text of the matches. If
1888 the menu is displayed you can use CTRL-L to add more
1889 characters. Whether case is ignored depends on the kind
1890 of completion. For buffer text the 'ignorecase' option is
1891 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001892
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001893 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001894 completion in the preview window. Only works in
1895 combination with "menu" or "menuone".
1896
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001897 noinsert Do not insert any text for a match until the user selects
1898 a match from the menu. Only works in combination with
1899 "menu" or "menuone". No effect if "longest" is present.
1900
1901 noselect Do not select a match in the menu, force the user to
1902 select one from the menu. Only works in combination with
1903 "menu" or "menuone".
1904
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001905
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001906 *'concealcursor'* *'cocu'*
1907'concealcursor' 'cocu' string (default: "")
1908 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001909 {not available when compiled without the |+conceal|
1910 feature}
1911 Sets the modes in which text in the cursor line can also be concealed.
1912 When the current mode is listed then concealing happens just like in
1913 other lines.
1914 n Normal mode
1915 v Visual mode
1916 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001917 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001918
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001919 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001920 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001921 are moving around text is concealed, but when starting to insert text
1922 or selecting a Visual area the concealed text is displayed, so that
1923 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001924 Keep in mind that the cursor position is not always where it's
1925 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001926
1927
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001928 *'conceallevel'* *'cole'*
1929'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001930 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001931 {not available when compiled without the |+conceal|
1932 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001933 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1934 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001935
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001936 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001937 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001938 1 Each block of concealed text is replaced with one
1939 character. If the syntax item does not have a custom
1940 replacement character defined (see |:syn-cchar|) the
1941 character defined in 'listchars' is used (default is a
1942 space).
1943 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001944 2 Concealed text is completely hidden unless it has a
1945 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001946 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001947 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001948
Bram Moolenaara7781e02010-07-19 20:13:22 +02001949 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001950 edit and copy the text. This can be changed with the 'concealcursor'
1951 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001952
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1954'confirm' 'cf' boolean (default off)
1955 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956 When 'confirm' is on, certain operations that would normally
1957 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1958 instead raise a |dialog| asking if you wish to save the current
1959 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1960 If 'confirm' is off you can still activate confirmation for one
1961 command only (this is most useful in mappings) with the |:confirm|
1962 command.
1963 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1964
1965 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1966'conskey' 'consk' boolean (default off)
1967 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01001968 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969
1970 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1971'copyindent' 'ci' boolean (default off)
1972 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973 Copy the structure of the existing lines indent when autoindenting a
1974 new line. Normally the new indent is reconstructed by a series of
1975 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1976 in which case only spaces are used). Enabling this option makes the
1977 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001978 existing line. 'expandtab' has no effect on these characters, a Tab
1979 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001981 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982 Also see 'preserveindent'.
1983
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001984 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001985'cpoptions' 'cpo' string (Vim default: "aABceFs",
1986 Vi default: all flags)
1987 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001989 this indicates Vi-compatible behavior. This is used for things where
1990 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001991 'cpoptions' stands for "compatible-options".
1992 Commas can be added for readability.
1993 To avoid problems with flags that are added in the future, use the
1994 "+=" and "-=" feature of ":set" |add-option-flags|.
1995 NOTE: This option is set to the Vi default value when 'compatible' is
1996 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001997 NOTE: This option is set to the POSIX default value at startup when
1998 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001999 variable exists |posix|. This means Vim tries to behave like the
2000 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002001
2002 contains behavior ~
2003 *cpo-a*
2004 a When included, a ":read" command with a file name
2005 argument will set the alternate file name for the
2006 current window.
2007 *cpo-A*
2008 A When included, a ":write" command with a file name
2009 argument will set the alternate file name for the
2010 current window.
2011 *cpo-b*
2012 b "\|" in a ":map" command is recognized as the end of
2013 the map command. The '\' is included in the mapping,
2014 the text after the '|' is interpreted as the next
2015 command. Use a CTRL-V instead of a backslash to
2016 include the '|' in the mapping. Applies to all
2017 mapping, abbreviation, menu and autocmd commands.
2018 See also |map_bar|.
2019 *cpo-B*
2020 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002021 abbreviations, user commands and the "to" part of the
2022 menu commands. Remove this flag to be able to use a
2023 backslash like a CTRL-V. For example, the command
2024 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025 'B' included: "\^[" (^[ is a real <Esc>)
2026 'B' excluded: "<Esc>" (5 characters)
2027 ('<' excluded in both cases)
2028 *cpo-c*
2029 c Searching continues at the end of any match at the
2030 cursor position, but not further than the start of the
2031 next line. When not present searching continues
2032 one character from the cursor position. With 'c'
2033 "abababababab" only gets three matches when repeating
2034 "/abab", without 'c' there are five matches.
2035 *cpo-C*
2036 C Do not concatenate sourced lines that start with a
2037 backslash. See |line-continuation|.
2038 *cpo-d*
2039 d Using "./" in the 'tags' option doesn't mean to use
2040 the tags file relative to the current file, but the
2041 tags file in the current directory.
2042 *cpo-D*
2043 D Can't use CTRL-K to enter a digraph after Normal mode
2044 commands with a character argument, like |r|, |f| and
2045 |t|.
2046 *cpo-e*
2047 e When executing a register with ":@r", always add a
2048 <CR> to the last line, also when the register is not
2049 linewise. If this flag is not present, the register
2050 is not linewise and the last line does not end in a
2051 <CR>, then the last line is put on the command-line
2052 and can be edited before hitting <CR>.
2053 *cpo-E*
2054 E It is an error when using "y", "d", "c", "g~", "gu" or
2055 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002056 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 This makes "y0" fail in the first column.
2058 *cpo-f*
2059 f When included, a ":read" command with a file name
2060 argument will set the file name for the current buffer,
2061 if the current buffer doesn't have a file name yet.
2062 *cpo-F*
2063 F When included, a ":write" command with a file name
2064 argument will set the file name for the current
2065 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002066 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 *cpo-g*
2068 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002069 *cpo-H*
2070 H When using "I" on a line with only blanks, insert
2071 before the last blank. Without this flag insert after
2072 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073 *cpo-i*
2074 i When included, interrupting the reading of a file will
2075 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002076 *cpo-I*
2077 I When moving the cursor up or down just after inserting
2078 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 *cpo-j*
2080 j When joining lines, only add two spaces after a '.',
2081 not after '!' or '?'. Also see 'joinspaces'.
2082 *cpo-J*
2083 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002084 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 white space.
2086 *cpo-k*
2087 k Disable the recognition of raw key codes in
2088 mappings, abbreviations, and the "to" part of menu
2089 commands. For example, if <Key> sends ^[OA (where ^[
2090 is <Esc>), the command ":map X ^[OA" results in X
2091 being mapped to:
2092 'k' included: "^[OA" (3 characters)
2093 'k' excluded: "<Key>" (one key code)
2094 Also see the '<' flag below.
2095 *cpo-K*
2096 K Don't wait for a key code to complete when it is
2097 halfway a mapping. This breaks mapping <F1><F1> when
2098 only part of the second <F1> has been read. It
2099 enables cancelling the mapping by typing <F1><Esc>.
2100 *cpo-l*
2101 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002102 literally, only "\]", "\^", "\-" and "\\" are special.
2103 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2105 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002106 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107 *cpo-L*
2108 L When the 'list' option is set, 'wrapmargin',
2109 'textwidth', 'softtabstop' and Virtual Replace mode
2110 (see |gR|) count a <Tab> as two characters, instead of
2111 the normal behavior of a <Tab>.
2112 *cpo-m*
2113 m When included, a showmatch will always wait half a
2114 second. When not included, a showmatch will wait half
2115 a second or until a character is typed. |'showmatch'|
2116 *cpo-M*
2117 M When excluded, "%" matching will take backslashes into
2118 account. Thus in "( \( )" and "\( ( \)" the outer
2119 parenthesis match. When included "%" ignores
2120 backslashes, which is Vi compatible.
2121 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002122 n When included, the column used for 'number' and
2123 'relativenumber' will also be used for text of wrapped
2124 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125 *cpo-o*
2126 o Line offset to search command is not remembered for
2127 next search.
2128 *cpo-O*
2129 O Don't complain if a file is being overwritten, even
2130 when it didn't exist when editing it. This is a
2131 protection against a file unexpectedly created by
2132 someone else. Vi didn't complain about this.
2133 *cpo-p*
2134 p Vi compatible Lisp indenting. When not present, a
2135 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002136 *cpo-P*
2137 P When included, a ":write" command that appends to a
2138 file will set the file name for the current buffer, if
2139 the current buffer doesn't have a file name yet and
2140 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002141 *cpo-q*
2142 q When joining multiple lines leave the cursor at the
2143 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144 *cpo-r*
2145 r Redo ("." command) uses "/" to repeat a search
2146 command, instead of the actually used search string.
2147 *cpo-R*
2148 R Remove marks from filtered lines. Without this flag
2149 marks are kept like |:keepmarks| was used.
2150 *cpo-s*
2151 s Set buffer options when entering the buffer for the
2152 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002153 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002154 set when the buffer is created.
2155 *cpo-S*
2156 S Set buffer options always when entering a buffer
2157 (except 'readonly', 'fileformat', 'filetype' and
2158 'syntax'). This is the (most) Vi compatible setting.
2159 The options are set to the values in the current
2160 buffer. When you change an option and go to another
2161 buffer, the value is copied. Effectively makes the
2162 buffer options global to all buffers.
2163
2164 's' 'S' copy buffer options
2165 no no when buffer created
2166 yes no when buffer first entered (default)
2167 X yes each time when buffer entered (vi comp.)
2168 *cpo-t*
2169 t Search pattern for the tag command is remembered for
2170 "n" command. Otherwise Vim only puts the pattern in
2171 the history for search pattern, but doesn't change the
2172 last used search pattern.
2173 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002174 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002175 *cpo-v*
2176 v Backspaced characters remain visible on the screen in
2177 Insert mode. Without this flag the characters are
2178 erased from the screen right away. With this flag the
2179 screen newly typed text overwrites backspaced
2180 characters.
2181 *cpo-w*
2182 w When using "cw" on a blank character, only change one
2183 character and not all blanks until the start of the
2184 next word.
2185 *cpo-W*
2186 W Don't overwrite a readonly file. When omitted, ":w!"
2187 overwrites a readonly file, if possible.
2188 *cpo-x*
2189 x <Esc> on the command-line executes the command-line.
2190 The default in Vim is to abandon the command-line,
2191 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002192 *cpo-X*
2193 X When using a count with "R" the replaced text is
2194 deleted only once. Also when repeating "R" with "."
2195 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002197 y A yank command can be redone with ".". Think twice if
2198 you really want to use this, it may break some
2199 plugins, since most people expect "." to only repeat a
2200 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002201 *cpo-Z*
2202 Z When using "w!" while the 'readonly' option is set,
2203 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002204 *cpo-!*
2205 ! When redoing a filter command, use the last used
2206 external command, whatever it was. Otherwise the last
2207 used -filter- command is used.
2208 *cpo-$*
2209 $ When making a change to one line, don't redisplay the
2210 line, but put a '$' at the end of the changed text.
2211 The changed text will be overwritten when you type the
2212 new text. The line is redisplayed if you type any
2213 command that moves the cursor from the insertion
2214 point.
2215 *cpo-%*
2216 % Vi-compatible matching is done for the "%" command.
2217 Does not recognize "#if", "#endif", etc.
2218 Does not recognize "/*" and "*/".
2219 Parens inside single and double quotes are also
2220 counted, causing a string that contains a paren to
2221 disturb the matching. For example, in a line like
2222 "if (strcmp("foo(", s))" the first paren does not
2223 match the last one. When this flag is not included,
2224 parens inside single and double quotes are treated
2225 specially. When matching a paren outside of quotes,
2226 everything inside quotes is ignored. When matching a
2227 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002228 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002229 This flag is also used for other features, such as
2230 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002231 *cpo--*
2232 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002233 it would go above the first line or below the last
2234 line. Without it the cursor moves to the first or
2235 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002236 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002237 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002238 *cpo-+*
2239 + When included, a ":write file" command will reset the
2240 'modified' flag of the buffer, even though the buffer
2241 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002242 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243 * Use ":*" in the same way as ":@". When not included,
2244 ":*" is an alias for ":'<,'>", select the Visual area.
2245 *cpo-<*
2246 < Disable the recognition of special key codes in |<>|
2247 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002248 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002249 ":map X <Tab>" results in X being mapped to:
2250 '<' included: "<Tab>" (5 characters)
2251 '<' excluded: "^I" (^I is a real <Tab>)
2252 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002253 *cpo->*
2254 > When appending to a register, put a line break before
2255 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002256 *cpo-;*
2257 ; When using |,| or |;| to repeat the last |t| search
2258 and the cursor is right in front of the searched
2259 character, the cursor won't move. When not included,
2260 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002261 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002262
2263 POSIX flags. These are not included in the Vi default value, except
2264 when $VIM_POSIX was set on startup. |posix|
2265
2266 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002267 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002268 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002269 *cpo-&*
2270 & When ":preserve" was used keep the swap file when
2271 exiting normally while this buffer is still loaded.
2272 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002273 *cpo-\*
2274 \ Backslash in a [] range in a search pattern is taken
2275 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002276 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2277 '\' excluded: "/[ \-]" finds <Space> and '-'
2278 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002279 *cpo-/*
2280 / When "%" is used as the replacement string in a |:s|
2281 command, use the previous replacement string. |:s%|
2282 *cpo-{*
2283 { The |{| and |}| commands also stop at a "{" character
2284 at the start of a line.
2285 *cpo-.*
2286 . The ":chdir" and ":cd" commands fail if the current
2287 buffer is modified, unless ! is used. Vim doesn't
2288 need this, since it remembers the full path of an
2289 opened file.
2290 *cpo-bar*
2291 | The value of the $LINES and $COLUMNS environment
2292 variables overrule the terminal size values obtained
2293 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002294
Bram Moolenaar071d4272004-06-13 20:20:40 +00002295
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002296 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002297'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002298 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002299 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002300 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002301 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002302 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002303 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002304 blowfish Blowfish method. Medium strong encryption but it has
2305 an implementation flaw. Requires Vim 7.3 or later,
2306 files can NOT be read by Vim 7.2 and older. This adds
2307 a "seed" to the file, every time you write the file
2308 the encrypted bytes will be different.
2309 *blowfish2*
2310 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002311 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002312 and older. This adds a "seed" to the file, every time
2313 you write the file the encrypted bytes will be
2314 different. The whole undo file is encrypted, not just
2315 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002316
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002317 You should use "blowfish2", also to re-encrypt older files.
2318
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002319 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002320 to the detected method of the file being read. Thus if you write it
2321 without changing 'cryptmethod' the same method will be used.
2322 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002323 explicitly write it, you don't get a warning unless there are other
2324 modifications. Also see |:X|.
2325
2326 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002327 the value "blowfish2". When setting the local value to an empty
2328 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002329
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002330 When a new encryption method is added in a later version of Vim, and
2331 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002332 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002333
2334
Bram Moolenaar071d4272004-06-13 20:20:40 +00002335 *'cscopepathcomp'* *'cspc'*
2336'cscopepathcomp' 'cspc' number (default 0)
2337 global
2338 {not available when compiled without the |+cscope|
2339 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002340 Determines how many components of the path to show in a list of tags.
2341 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002342 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002343
2344 *'cscopeprg'* *'csprg'*
2345'cscopeprg' 'csprg' string (default "cscope")
2346 global
2347 {not available when compiled without the |+cscope|
2348 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349 Specifies the command to execute cscope. See |cscopeprg|.
2350 This option cannot be set from a |modeline| or in the |sandbox|, for
2351 security reasons.
2352
2353 *'cscopequickfix'* *'csqf'*
2354'cscopequickfix' 'csqf' string (default "")
2355 global
2356 {not available when compiled without the |+cscope|
2357 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358 Specifies whether to use quickfix window to show cscope results.
2359 See |cscopequickfix|.
2360
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002361 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002362'cscoperelative' 'csre' boolean (default off)
2363 global
2364 {not available when compiled without the |+cscope|
2365 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002366 In the absence of a prefix (-P) for cscope. setting this option enables
2367 to use the basename of cscope.out path as the prefix.
2368 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002369 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002370
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2372'cscopetag' 'cst' boolean (default off)
2373 global
2374 {not available when compiled without the |+cscope|
2375 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376 Use cscope for tag commands. See |cscope-options|.
2377 NOTE: This option is reset when 'compatible' is set.
2378
2379 *'cscopetagorder'* *'csto'*
2380'cscopetagorder' 'csto' number (default 0)
2381 global
2382 {not available when compiled without the |+cscope|
2383 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384 Determines the order in which ":cstag" performs a search. See
2385 |cscopetagorder|.
2386 NOTE: This option is set to 0 when 'compatible' is set.
2387
2388 *'cscopeverbose'* *'csverb'*
2389 *'nocscopeverbose'* *'nocsverb'*
2390'cscopeverbose' 'csverb' boolean (default off)
2391 global
2392 {not available when compiled without the |+cscope|
2393 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002394 Give messages when adding a cscope database. See |cscopeverbose|.
2395 NOTE: This option is reset when 'compatible' is set.
2396
Bram Moolenaar860cae12010-06-05 23:22:07 +02002397 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2398'cursorbind' 'crb' boolean (default off)
2399 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002400 When this option is set, as the cursor in the current
2401 window moves other cursorbound windows (windows that also have
2402 this option set) move their cursors to the corresponding line and
2403 column. This option is useful for viewing the
2404 differences between two versions of a file (see 'diff'); in diff mode,
2405 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002406 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002407
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002408
2409 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2410'cursorcolumn' 'cuc' boolean (default off)
2411 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002412 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002413 feature}
2414 Highlight the screen column of the cursor with CursorColumn
2415 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2416 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002417 If you only want the highlighting in the current window you can use
2418 these autocommands: >
2419 au WinLeave * set nocursorline nocursorcolumn
2420 au WinEnter * set cursorline cursorcolumn
2421<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002422
2423 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2424'cursorline' 'cul' boolean (default off)
2425 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002426 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002427 feature}
2428 Highlight the screen line of the cursor with CursorLine
2429 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2430 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002431 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002432 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002433
2434
Bram Moolenaar071d4272004-06-13 20:20:40 +00002435 *'debug'*
2436'debug' string (default "")
2437 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002438 These values can be used:
2439 msg Error messages that would otherwise be omitted will be given
2440 anyway.
2441 throw Error messages that would otherwise be omitted will be given
2442 anyway and also throw an exception and set |v:errmsg|.
2443 beep A message will be given when otherwise only a beep would be
2444 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002445 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002446 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2447 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448
2449 *'define'* *'def'*
2450'define' 'def' string (default "^\s*#\s*define")
2451 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002452 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002453 pattern, just like for the "/" command. This option is used for the
2454 commands like "[i" and "[d" |include-search|. The 'isident' option is
2455 used to recognize the defined name after the match:
2456 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2457 See |option-backslash| about inserting backslashes to include a space
2458 or backslash.
2459 The default value is for C programs. For C++ this value would be
2460 useful, to include const type declarations: >
2461 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002462< You can also use "\ze" just before the name and continue the pattern
2463 to check what is following. E.g. for Javascript, if a function is
2464 defined with "func_name = function(args)": >
2465 ^\s*\ze\i\+\s*=\s*function(
2466< If the function is defined with "func_name : function() {...": >
2467 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002469 To avoid that use `:let` with a single quote string: >
2470 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002471<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472
2473 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2474'delcombine' 'deco' boolean (default off)
2475 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002476 If editing Unicode and this option is set, backspace and Normal mode
2477 "x" delete each combining character on its own. When it is off (the
2478 default) the character along with its combining characters are
2479 deleted.
2480 Note: When 'delcombine' is set "xx" may work different from "2x"!
2481
2482 This is useful for Arabic, Hebrew and many other languages where one
2483 may have combining characters overtop of base characters, and want
2484 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002485 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486
2487 *'dictionary'* *'dict'*
2488'dictionary' 'dict' string (default "")
2489 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002490 List of file names, separated by commas, that are used to lookup words
2491 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2492 contain a list of words. This can be one word per line, or several
2493 words per line, separated by non-keyword characters (white space is
2494 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002495
2496 When this option is empty or an entry "spell" is present, and spell
2497 checking is enabled, words in the word lists for the currently active
2498 'spelllang' are used. See |spell|.
2499
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002500 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501 after a comma are ignored, otherwise spaces are included in the file
2502 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002503 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 Where to find a list of words?
2505 - On FreeBSD, there is the file "/usr/share/dict/words".
2506 - In the Simtel archive, look in the "msdos/linguist" directory.
2507 - In "miscfiles" of the GNU collection.
2508 The use of |:set+=| and |:set-=| is preferred when adding or removing
2509 directories from the list. This avoids problems when a future version
2510 uses another default.
2511 Backticks cannot be used in this option for security reasons.
2512
2513 *'diff'* *'nodiff'*
2514'diff' boolean (default off)
2515 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 {not available when compiled without the |+diff|
2517 feature}
2518 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002519 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520
2521 *'dex'* *'diffexpr'*
2522'diffexpr' 'dex' string (default "")
2523 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524 {not available when compiled without the |+diff|
2525 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002526 Expression which is evaluated to obtain a diff file (either ed-style
2527 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002528 This option cannot be set from a |modeline| or in the |sandbox|, for
2529 security reasons.
2530
2531 *'dip'* *'diffopt'*
Bram Moolenaarc93262b2018-09-10 21:15:40 +02002532'diffopt' 'dip' string (default "internal,filler")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002533 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 {not available when compiled without the |+diff|
2535 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002536 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002537 All are optional. Items must be separated by a comma.
2538
2539 filler Show filler lines, to keep the text
2540 synchronized with a window that has inserted
2541 lines at the same position. Mostly useful
2542 when windows are side-by-side and 'scrollbind'
2543 is set.
2544
2545 context:{n} Use a context of {n} lines between a change
2546 and a fold that contains unchanged lines.
2547 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002548 When using zero the context is actually one,
2549 since folds require a line in between, also
2550 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002551 See |fold-diff|.
2552
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002553 iblank Ignore changes where lines are all blank. Adds
2554 the "-B" flag to the "diff" command if
2555 'diffexpr' is empty. Check the documentation
2556 of the "diff" command for what this does
2557 exactly.
2558 NOTE: the diff windows will get out of sync,
2559 because no differences between blank lines are
2560 taken into account.
2561
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562 icase Ignore changes in case of text. "a" and "A"
2563 are considered the same. Adds the "-i" flag
2564 to the "diff" command if 'diffexpr' is empty.
2565
2566 iwhite Ignore changes in amount of white space. Adds
2567 the "-b" flag to the "diff" command if
2568 'diffexpr' is empty. Check the documentation
2569 of the "diff" command for what this does
2570 exactly. It should ignore adding trailing
2571 white space, but not leading white space.
2572
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002573 iwhiteall Ignore all white space changes. Adds
2574 the "-w" flag to the "diff" command if
2575 'diffexpr' is empty. Check the documentation
2576 of the "diff" command for what this does
2577 exactly.
2578
2579 iwhiteeol Ignore white space changes at end of line.
2580 Adds the "-Z" flag to the "diff" command if
2581 'diffexpr' is empty. Check the documentation
2582 of the "diff" command for what this does
2583 exactly.
2584
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002585 horizontal Start diff mode with horizontal splits (unless
2586 explicitly specified otherwise).
2587
2588 vertical Start diff mode with vertical splits (unless
2589 explicitly specified otherwise).
2590
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002591 hiddenoff Do not use diff mode for a buffer when it
2592 becomes hidden.
2593
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002594 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2595 starting diff mode. Without this 2 is used.
2596
Bram Moolenaare828b762018-09-10 17:51:58 +02002597 internal Use the internal diff library. This is
2598 ignored when 'diffexpr' is set. *E960*
2599 When running out of memory when writing a
2600 buffer this item will be ignored for diffs
2601 involving that buffer. Set the 'verbose'
2602 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002603
Bram Moolenaare828b762018-09-10 17:51:58 +02002604 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002605 Use the indent heuristic for the internal
2606 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002607
2608 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002609 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002610 algorithms are:
2611 myers the default algorithm
2612 minimal spend extra time to generate the
2613 smallest possible diff
2614 patience patience diff algorithm
2615 histogram histogram diff algorithm
2616
2617 Examples: >
2618 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002619 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002620 :set diffopt=internal,filler,foldcolumn:3
2621 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622<
2623 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2624'digraph' 'dg' boolean (default off)
2625 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626 {not available when compiled without the |+digraphs|
2627 feature}
2628 Enable the entering of digraphs in Insert mode with {char1} <BS>
2629 {char2}. See |digraphs|.
2630 NOTE: This option is reset when 'compatible' is set.
2631
2632 *'directory'* *'dir'*
2633'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002634 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 for Unix: ".,~/tmp,/var/tmp,/tmp")
2636 global
2637 List of directory names for the swap file, separated with commas.
2638 - The swap file will be created in the first directory where this is
2639 possible.
2640 - Empty means that no swap file will be used (recovery is
2641 impossible!).
2642 - A directory "." means to put the swap file in the same directory as
2643 the edited file. On Unix, a dot is prepended to the file name, so
2644 it doesn't show in a directory listing. On MS-Windows the "hidden"
2645 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002646 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002647 put the swap file relative to where the edited file is. The leading
2648 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002649 - For Unix and Win32, if a directory ends in two path separators "//",
2650 the swap file name will be built from the complete path to the file
2651 with all path separators substituted to percent '%' signs. This will
2652 ensure file name uniqueness in the preserve directory.
2653 On Win32, it is also possible to end with "\\". However, When a
2654 separating comma is following, you must use "//", since "\\" will
2655 include the comma in the file name. Therefore it is recommended to
2656 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657 - Spaces after the comma are ignored, other spaces are considered part
2658 of the directory name. To have a space at the start of a directory
2659 name, precede it with a backslash.
2660 - To include a comma in a directory name precede it with a backslash.
2661 - A directory name may end in an ':' or '/'.
2662 - Environment variables are expanded |:set_env|.
2663 - Careful with '\' characters, type one before a space, type two to
2664 get one in the option (see |option-backslash|), for example: >
2665 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2666< - For backwards compatibility with Vim version 3.0 a '>' at the start
2667 of the option is removed.
2668 Using "." first in the list is recommended. This means that editing
2669 the same file twice will result in a warning. Using "/tmp" on Unix is
2670 discouraged: When the system crashes you lose the swap file.
2671 "/var/tmp" is often not cleared when rebooting, thus is a better
2672 choice than "/tmp". But it can contain a lot of files, your swap
2673 files get lost in the crowd. That is why a "tmp" directory in your
2674 home directory is tried first.
2675 The use of |:set+=| and |:set-=| is preferred when adding or removing
2676 directories from the list. This avoids problems when a future version
2677 uses another default.
2678 This option cannot be set from a |modeline| or in the |sandbox|, for
2679 security reasons.
2680 {Vi: directory to put temp file in, defaults to "/tmp"}
2681
2682 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002683'display' 'dy' string (default "", set to "truncate" in
2684 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686 Change the way text is displayed. This is comma separated list of
2687 flags:
2688 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002689 in a window will be displayed. "@@@" is put in the
2690 last columns of the last screen line to indicate the
2691 rest of the line is not displayed.
2692 truncate Like "lastline", but "@@@" is displayed in the first
2693 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694 uhex Show unprintable characters hexadecimal as <xx>
2695 instead of using ^C and ~C.
2696
Bram Moolenaard0796902016-09-16 20:02:31 +02002697 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002698 doesn't fit is replaced with "@" lines.
2699
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 *'eadirection'* *'ead'*
2701'eadirection' 'ead' string (default "both")
2702 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02002703 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 feature}
2705 Tells when the 'equalalways' option applies:
2706 ver vertically, width of windows is not affected
2707 hor horizontally, height of windows is not affected
2708 both width and height of windows is affected
2709
2710 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2711'edcompatible' 'ed' boolean (default off)
2712 global
2713 Makes the 'g' and 'c' flags of the ":substitute" command to be
2714 toggled each time the flag is given. See |complex-change|. See
2715 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002716 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717
Bram Moolenaar03413f42016-04-12 21:07:15 +02002718 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002719'emoji' 'emo' boolean (default: on)
2720 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002721 When on all Unicode emoji characters are considered to be full width.
2722
2723
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 *'encoding'* *'enc'* *E543*
2725'encoding' 'enc' string (default: "latin1" or value from $LANG)
2726 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 Sets the character encoding used inside Vim. It applies to text in
2728 the buffers, registers, Strings in expressions, text stored in the
2729 viminfo file, etc. It sets the kind of characters which Vim can work
2730 with. See |encoding-names| for the possible values.
2731
2732 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002733 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002734 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002735 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736
Bram Moolenaar865242e2010-07-14 21:12:05 +02002737 This option cannot be set from a |modeline|. It would most likely
2738 corrupt the text.
2739
Bram Moolenaar3df01732017-02-17 22:47:16 +01002740 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2741 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 'encoding', "utf-8" is the natural choice for the environment and
2743 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002744 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745 versions, and to avoid changing the encoding of newly created files
2746 without your knowledge (in case 'fileencodings' is empty).
2747
2748 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002749 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 iconv() or as specified with 'charconvert'.
2751
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002752 If you need to know whether 'encoding' is a multi-byte encoding, you
2753 can use: >
2754 if has("multi_byte_encoding")
2755<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756 Normally 'encoding' will be equal to your current locale. This will
2757 be the default if Vim recognizes your environment settings. If
2758 'encoding' is not set to the current locale, 'termencoding' must be
2759 set to convert typed and displayed text. See |encoding-table|.
2760
2761 When you set this option, it fires the |EncodingChanged| autocommand
2762 event so that you can set up fonts if necessary.
2763
2764 When the option is set, the value is converted to lowercase. Thus
2765 you can set it with uppercase values too. Underscores are translated
2766 to '-' signs.
2767 When the encoding is recognized, it is changed to the standard name.
2768 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2769 "iso-8859-2" and "utf8" becomes "utf-8".
2770
2771 Note: "latin1" is also used when the encoding could not be detected.
2772 This only works when editing files in the same encoding! When the
2773 actual character set is not latin1, make sure 'fileencoding' and
2774 'fileencodings' are empty. When conversion is needed, switch to using
2775 utf-8.
2776
2777 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2778 You don't notice this while editing, but it does matter for the
2779 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2780 setting 'encoding' to one of these values instead of utf-8 only has
2781 effect for encoding used for files when 'fileencoding' is empty.
2782
Bram Moolenaar661b1822005-07-28 22:36:45 +00002783 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2784 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785
2786 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2787'endofline' 'eol' boolean (default on)
2788 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002790 is on, or 'fixeol' option is off, no <EOL> will be written for the
2791 last line in the file. This option is automatically set or reset when
2792 starting to edit a new file, depending on whether file has an <EOL>
2793 for the last line in the file. Normally you don't have to set or
2794 reset this option.
2795 When 'binary' is off and 'fixeol' is on the value is not used when
2796 writing the file. When 'binary' is on or 'fixeol' is off it is used
2797 to remember the presence of a <EOL> for the last line in the file, so
2798 that when you write the file the situation from the original file can
2799 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800
2801 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2802'equalalways' 'ea' boolean (default on)
2803 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002805 splitting or closing a window. This also happens the moment the
2806 option is switched on. When off, splitting a window will reduce the
2807 size of the current window and leave the other windows the same. When
2808 closing a window the extra lines are given to the window next to it
2809 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810 When mixing vertically and horizontally split windows, a minimal size
2811 is computed and some windows may be larger if there is room. The
2812 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002813 Changing the height and width of a window can be avoided by setting
2814 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002815 If a window size is specified when creating a new window sizes are
2816 currently not equalized (it's complicated, but may be implemented in
2817 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002818
2819 *'equalprg'* *'ep'*
2820'equalprg' 'ep' string (default "")
2821 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002823 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002824 or 'indentexpr'. When Vim was compiled without internal formatting,
2825 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002826 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827 about including spaces and backslashes.
2828 This option cannot be set from a |modeline| or in the |sandbox|, for
2829 security reasons.
2830
2831 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2832'errorbells' 'eb' boolean (default off)
2833 global
2834 Ring the bell (beep or screen flash) for error messages. This only
2835 makes a difference for error messages, the bell will be used always
2836 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002837 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002838 screen flash or do nothing. See 'belloff' to finetune when to ring the
2839 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840
2841 *'errorfile'* *'ef'*
2842'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2843 others: "errors.err")
2844 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845 {not available when compiled without the |+quickfix|
2846 feature}
2847 Name of the errorfile for the QuickFix mode (see |:cf|).
2848 When the "-q" command-line argument is used, 'errorfile' is set to the
2849 following argument. See |-q|.
2850 NOT used for the ":make" command. See 'makeef' for that.
2851 Environment variables are expanded |:set_env|.
2852 See |option-backslash| about including spaces and backslashes.
2853 This option cannot be set from a |modeline| or in the |sandbox|, for
2854 security reasons.
2855
2856 *'errorformat'* *'efm'*
2857'errorformat' 'efm' string (default is very long)
2858 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859 {not available when compiled without the |+quickfix|
2860 feature}
2861 Scanf-like description of the format for the lines in the error file
2862 (see |errorformat|).
2863
2864 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2865'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 Function keys that start with an <Esc> are recognized in Insert
2868 mode. When this option is off, the cursor and function keys cannot be
2869 used in Insert mode if they start with an <Esc>. The advantage of
2870 this is that the single <Esc> is recognized immediately, instead of
2871 after one second. Instead of resetting this option, you might want to
2872 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2873 when 'esckeys' is off, you can still map anything, but the cursor keys
2874 won't work by default.
2875 NOTE: This option is set to the Vi default value when 'compatible' is
2876 set and to the Vim default value when 'compatible' is reset.
2877
2878 *'eventignore'* *'ei'*
2879'eventignore' 'ei' string (default "")
2880 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002882 When set to "all" or when "all" is one of the items, all autocommand
2883 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002884 Otherwise this is a comma separated list of event names. Example: >
2885 :set ei=WinEnter,WinLeave
2886<
2887 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2888'expandtab' 'et' boolean (default off)
2889 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002891 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2893 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002894 This option is reset when the 'paste' option is set and restored when
2895 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002896 NOTE: This option is reset when 'compatible' is set.
2897
2898 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2899'exrc' 'ex' boolean (default off)
2900 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002902 directory.
2903
2904 Setting this option is a potential security leak. E.g., consider
2905 unpacking a package or fetching files from github, a .vimrc in there
2906 might be a trojan horse. BETTER NOT SET THIS OPTION!
2907 Instead, define an autocommand in your .vimrc to set options for a
2908 matching directory.
2909
2910 If you do switch this option on you should also consider setting the
2911 'secure' option (see |initialization|).
2912 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913 This option cannot be set from a |modeline| or in the |sandbox|, for
2914 security reasons.
2915
2916 *'fileencoding'* *'fenc'* *E213*
2917'fileencoding' 'fenc' string (default: "")
2918 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002920
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002922 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 When 'fileencoding' is empty, the same value as 'encoding' will be
2924 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002925 No error will be given when the value is set, only when it is used,
2926 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002927 Conversion will also be done when 'encoding' and 'fileencoding' are
2928 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2929 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002931 'encoding' is "utf-8" or another Unicode encoding, conversion
2932 is most likely done in a way that the reverse conversion
2933 results in the same text. When 'encoding' is not "utf-8" some
2934 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002935
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 See 'encoding' for the possible values. Additionally, values may be
2937 specified that can be handled by the converter, see
2938 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002939
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 When reading a file 'fileencoding' will be set from 'fileencodings'.
2941 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002942 'fileencoding', use the |++enc| argument. One exception: when
2943 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002944 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002945
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2947 When the option is set, the value is converted to lowercase. Thus
2948 you can set it with uppercase values too. '_' characters are
2949 replaced with '-'. If a name is recognized from the list for
2950 'encoding', it is replaced by the standard name. For example
2951 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002952
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 When this option is set, after starting to edit a file, the 'modified'
2954 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002955
2956 Keep in mind that changing 'fenc' from a modeline happens
2957 AFTER the text has been read, thus it applies to when the file will be
2958 written. If you do set 'fenc' in a modeline, you might want to set
2959 'nomodified' to avoid not being able to ":q".
2960
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 This option can not be changed when 'modifiable' is off.
2962
2963 *'fe'*
2964 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002965 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 old short name was 'fe', which is no longer used.
2967
2968 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002969'fileencodings' 'fencs' string (default: "ucs-bom",
2970 "ucs-bom,utf-8,default,latin1" when
2971 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 This is a list of character encodings considered when starting to edit
2974 an existing file. When a file is read, Vim tries to use the first
2975 mentioned character encoding. If an error is detected, the next one
2976 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002977 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 an empty string, which means the value of 'encoding' is used.
2979 WARNING: Conversion can cause loss of information! When
2980 'encoding' is "utf-8" (or one of the other Unicode variants)
2981 conversion is most likely done in a way that the reverse
2982 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002983 "utf-8" some non-ASCII characters may be lost! You can use
2984 the |++bad| argument to specify what is done with characters
2985 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 For an empty file or a file with only ASCII characters most encodings
2987 will work and the first entry of 'fileencodings' will be used (except
2988 "ucs-bom", which requires the BOM to be present). If you prefer
2989 another encoding use an BufReadPost autocommand event to test if your
2990 preferred encoding is to be used. Example: >
2991 au BufReadPost * if search('\S', 'w') == 0 |
2992 \ set fenc=iso-2022-jp | endif
2993< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2994 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002995 When the |++enc| argument is used then the value of 'fileencodings' is
2996 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002997 Note that 'fileencodings' is not used for a new file, the global value
2998 of 'fileencoding' is used instead. You can set it with: >
2999 :setglobal fenc=iso-8859-2
3000< This means that a non-existing file may get a different encoding than
3001 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 The special value "ucs-bom" can be used to check for a Unicode BOM
3003 (Byte Order Mark) at the start of the file. It must not be preceded
3004 by "utf-8" or another Unicode encoding for this to work properly.
3005 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3006 because Vim cannot detect an error, thus the encoding is always
3007 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003008 The special value "default" can be used for the encoding from the
3009 environment. This is the default value for 'encoding'. It is useful
3010 when 'encoding' is set to "utf-8" and your environment uses a
3011 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003012 When 'encoding' is "utf-8" and a file contains an illegal byte
3013 sequence it won't be recognized as UTF-8. You can use the |8g8|
3014 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 WRONG VALUES: WHAT'S WRONG:
3016 latin1,utf-8 "latin1" will always be used
3017 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3018 file
3019 cp1250,latin1 "cp1250" will always be used
3020 If 'fileencodings' is empty, 'fileencoding' is not modified.
3021 See 'fileencoding' for the possible values.
3022 Setting this option does not have an effect until the next time a file
3023 is read.
3024
3025 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003026'fileformat' 'ff' string (MS-Windows default: "dos",
3027 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029 This gives the <EOL> of the current buffer, which is used for
3030 reading/writing the buffer from/to a file:
3031 dos <CR> <NL>
3032 unix <NL>
3033 mac <CR>
3034 When "dos" is used, CTRL-Z at the end of a file is ignored.
3035 See |file-formats| and |file-read|.
3036 For the character encoding of the file see 'fileencoding'.
3037 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003038 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 This option is set automatically when starting to edit a file and
3040 'fileformats' is not empty and 'binary' is off.
3041 When this option is set, after starting to edit a file, the 'modified'
3042 option is set, because the file would be different when written.
3043 This option can not be changed when 'modifiable' is off.
3044 For backwards compatibility: When this option is set to "dos",
3045 'textmode' is set, otherwise 'textmode' is reset.
3046
3047 *'fileformats'* *'ffs'*
3048'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003049 Vim+Vi MS-Windows: "dos,unix",
3050 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 Vi Cygwin: "unix,dos",
3052 Vi others: "")
3053 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054 This gives the end-of-line (<EOL>) formats that will be tried when
3055 starting to edit a new buffer and when reading a file into an existing
3056 buffer:
3057 - When empty, the format defined with 'fileformat' will be used
3058 always. It is not set automatically.
3059 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003060 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 'fileformats' name will be used when a file is read into an existing
3062 buffer, no matter what 'fileformat' for that buffer is set to.
3063 - When more than one name is present, separated by commas, automatic
3064 <EOL> detection will be done when reading a file. When starting to
3065 edit a file, a check is done for the <EOL>:
3066 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3067 'fileformat' is set to "dos".
3068 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003069 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003071 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3072 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003073 This means that "mac" is only chosen when:
3074 "unix" is not present or no <NL> is found in the file, and
3075 "dos" is not present or no <CR><NL> is found in the file.
3076 Except: if "unix" was chosen, but there is a <CR> before
3077 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003078 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079 4. If 'fileformat' is still not set, the first name from
3080 'fileformats' is used.
3081 When reading a file into an existing buffer, the same is done, but
3082 this happens like 'fileformat' has been set appropriately for that
3083 file only, the option is not changed.
3084 When 'binary' is set, the value of 'fileformats' is not used.
3085
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003086 When Vim starts up with an empty buffer the first item is used. You
3087 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003088
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3090 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3091 done:
3092 - When 'fileformats' is empty, there is no automatic detection. Dos
3093 format will be used.
3094 - When 'fileformats' is set to one or more names, automatic detection
3095 is done. This is based on the first <NL> in the file: If there is a
3096 <CR> in front of it, Dos format is used, otherwise Unix format is
3097 used.
3098 Also see |file-formats|.
3099 For backwards compatibility: When this option is set to an empty
3100 string or one format (no comma is included), 'textauto' is reset,
3101 otherwise 'textauto' is set.
3102 NOTE: This option is set to the Vi default value when 'compatible' is
3103 set and to the Vim default value when 'compatible' is reset.
3104
Bram Moolenaarbf884932013-04-05 22:26:15 +02003105 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3106'fileignorecase' 'fic' boolean (default on for systems where case in file
3107 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003108 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003109 When set case is ignored when using file names and directories.
3110 See 'wildignorecase' for only ignoring case when doing completion.
3111
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 *'filetype'* *'ft'*
3113'filetype' 'ft' string (default: "")
3114 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 When this option is set, the FileType autocommand event is triggered.
3116 All autocommands that match with the value of this option will be
3117 executed. Thus the value of 'filetype' is used in place of the file
3118 name.
3119 Otherwise this option does not always reflect the current file type.
3120 This option is normally set when the file type is detected. To enable
3121 this use the ":filetype on" command. |:filetype|
3122 Setting this option to a different value is most useful in a modeline,
3123 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003124 Example, for in an IDL file:
3125 /* vim: set filetype=idl : */ ~
3126 |FileType| |filetypes|
3127 When a dot appears in the value then this separates two filetype
3128 names. Example:
3129 /* vim: set filetype=c.doxygen : */ ~
3130 This will use the "c" filetype first, then the "doxygen" filetype.
3131 This works both for filetype plugins and for syntax files. More than
3132 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 This option is not copied to another buffer, independent of the 's' or
3134 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003135 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136
3137 *'fillchars'* *'fcs'*
3138'fillchars' 'fcs' string (default "vert:|,fold:-")
3139 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140 {not available when compiled without the |+windows|
3141 and |+folding| features}
3142 Characters to fill the statuslines and vertical separators.
3143 It is a comma separated list of items:
3144
3145 item default Used for ~
3146 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003147 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 vert:c '|' vertical separators |:vsplit|
3149 fold:c '-' filling 'foldtext'
3150 diff:c '-' deleted lines of the 'diff' option
3151
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003152 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003153 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 otherwise.
3155
3156 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003157 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158< This is similar to the default, except that these characters will also
3159 be used when there is highlighting.
3160
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003161 for "stl" and "stlnc" only single-byte values are supported.
3162
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 The highlighting used for these items:
3164 item highlight group ~
3165 stl:c StatusLine |hl-StatusLine|
3166 stlnc:c StatusLineNC |hl-StatusLineNC|
3167 vert:c VertSplit |hl-VertSplit|
3168 fold:c Folded |hl-Folded|
3169 diff:c DiffDelete |hl-DiffDelete|
3170
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003171 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3172'fixendofline' 'fixeol' boolean (default on)
3173 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003174 When writing a file and this option is on, <EOL> at the end of file
3175 will be restored if missing. Turn this option off if you want to
3176 preserve the situation from the original file.
3177 When the 'binary' option is set the value of this option doesn't
3178 matter.
3179 See the 'endofline' option.
3180
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3182'fkmap' 'fk' boolean (default off) *E198*
3183 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 {only available when compiled with the |+rightleft|
3185 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003186 This option was for using Farsi, which has been removed. See
3187 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188
3189 *'foldclose'* *'fcl'*
3190'foldclose' 'fcl' string (default "")
3191 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 {not available when compiled without the |+folding|
3193 feature}
3194 When set to "all", a fold is closed when the cursor isn't in it and
3195 its level is higher than 'foldlevel'. Useful if you want folds to
3196 automatically close when moving out of them.
3197
3198 *'foldcolumn'* *'fdc'*
3199'foldcolumn' 'fdc' number (default 0)
3200 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 {not available when compiled without the |+folding|
3202 feature}
3203 When non-zero, a column with the specified width is shown at the side
3204 of the window which indicates open and closed folds. The maximum
3205 value is 12.
3206 See |folding|.
3207
3208 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3209'foldenable' 'fen' boolean (default on)
3210 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 {not available when compiled without the |+folding|
3212 feature}
3213 When off, all folds are open. This option can be used to quickly
3214 switch between showing all text unfolded and viewing the text with
3215 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003216 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 'foldenable' is off.
3218 This option is set by commands that create a new fold or close a fold.
3219 See |folding|.
3220
3221 *'foldexpr'* *'fde'*
3222'foldexpr' 'fde' string (default: "0")
3223 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003225 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003227 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003228
Bram Moolenaar30b65812012-07-12 22:01:11 +02003229 The expression will be evaluated in the |sandbox| if set from a
3230 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003231 This option can't be set from a |modeline| when the 'diff' option is
3232 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003233
3234 It is not allowed to change text or jump to another window while
3235 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236
3237 *'foldignore'* *'fdi'*
3238'foldignore' 'fdi' string (default: "#")
3239 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 {not available when compiled without the |+folding|
3241 feature}
3242 Used only when 'foldmethod' is "indent". Lines starting with
3243 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003244 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245 The default "#" works well for C programs. See |fold-indent|.
3246
3247 *'foldlevel'* *'fdl'*
3248'foldlevel' 'fdl' number (default: 0)
3249 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250 {not available when compiled without the |+folding|
3251 feature}
3252 Sets the fold level: Folds with a higher level will be closed.
3253 Setting this option to zero will close all folds. Higher numbers will
3254 close fewer folds.
3255 This option is set by commands like |zm|, |zM| and |zR|.
3256 See |fold-foldlevel|.
3257
3258 *'foldlevelstart'* *'fdls'*
3259'foldlevelstart' 'fdls' number (default: -1)
3260 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261 {not available when compiled without the |+folding|
3262 feature}
3263 Sets 'foldlevel' when starting to edit another buffer in a window.
3264 Useful to always start editing with all folds closed (value zero),
3265 some folds closed (one) or no folds closed (99).
3266 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003267 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 ignores this option and closes all folds.
3269 It is also done before BufReadPre autocommands, to allow an autocmd to
3270 overrule the 'foldlevel' value for specific files.
3271 When the value is negative, it is not used.
3272
3273 *'foldmarker'* *'fmr'* *E536*
3274'foldmarker' 'fmr' string (default: "{{{,}}}")
3275 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 {not available when compiled without the |+folding|
3277 feature}
3278 The start and end marker used when 'foldmethod' is "marker". There
3279 must be one comma, which separates the start and end marker. The
3280 marker is a literal string (a regular expression would be too slow).
3281 See |fold-marker|.
3282
3283 *'foldmethod'* *'fdm'*
3284'foldmethod' 'fdm' string (default: "manual")
3285 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 {not available when compiled without the |+folding|
3287 feature}
3288 The kind of folding used for the current window. Possible values:
3289 |fold-manual| manual Folds are created manually.
3290 |fold-indent| indent Lines with equal indent form a fold.
3291 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3292 |fold-marker| marker Markers are used to specify folds.
3293 |fold-syntax| syntax Syntax highlighting items specify folds.
3294 |fold-diff| diff Fold text that is not changed.
3295
3296 *'foldminlines'* *'fml'*
3297'foldminlines' 'fml' number (default: 1)
3298 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 {not available when compiled without the |+folding|
3300 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003301 Sets the number of screen lines above which a fold can be displayed
3302 closed. Also for manually closed folds. With the default value of
3303 one a fold can only be closed if it takes up two or more screen lines.
3304 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003305 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306 "zc" to close a fold, which is displayed open because it's smaller
3307 than 'foldminlines', a following "zc" may close a containing fold.
3308
3309 *'foldnestmax'* *'fdn'*
3310'foldnestmax' 'fdn' number (default: 20)
3311 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 {not available when compiled without the |+folding|
3313 feature}
3314 Sets the maximum nesting of folds for the "indent" and "syntax"
3315 methods. This avoids that too many folds will be created. Using more
3316 than 20 doesn't work, because the internal limit is 20.
3317
3318 *'foldopen'* *'fdo'*
3319'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3320 search,tag,undo")
3321 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 {not available when compiled without the |+folding|
3323 feature}
3324 Specifies for which type of commands folds will be opened, if the
3325 command moves the cursor into a closed fold. It is a comma separated
3326 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003327 NOTE: When the command is part of a mapping this option is not used.
3328 Add the |zv| command to the mapping to get the same effect.
3329 (rationale: the mapping may want to control opening folds itself)
3330
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 item commands ~
3332 all any
3333 block "(", "{", "[[", "[{", etc.
3334 hor horizontal movements: "l", "w", "fx", etc.
3335 insert any command in Insert mode
3336 jump far jumps: "G", "gg", etc.
3337 mark jumping to a mark: "'m", CTRL-O, etc.
3338 percent "%"
3339 quickfix ":cn", ":crew", ":make", etc.
3340 search search for a pattern: "/", "n", "*", "gd", etc.
3341 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003342 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343 tag jumping to a tag: ":ta", CTRL-T, etc.
3344 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 When a movement command is used for an operator (e.g., "dl" or "y%")
3346 this option is not used. This means the operator will include the
3347 whole closed fold.
3348 Note that vertical movements are not here, because it would make it
3349 very difficult to move onto a closed fold.
3350 In insert mode the folds containing the cursor will always be open
3351 when text is inserted.
3352 To close folds you can re-apply 'foldlevel' with the |zx| command or
3353 set the 'foldclose' option to "all".
3354
3355 *'foldtext'* *'fdt'*
3356'foldtext' 'fdt' string (default: "foldtext()")
3357 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 {not available when compiled without the |+folding|
3359 feature}
3360 An expression which is used to specify the text displayed for a closed
3361 fold. See |fold-foldtext|.
3362
Bram Moolenaar30b65812012-07-12 22:01:11 +02003363 The expression will be evaluated in the |sandbox| if set from a
3364 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003365
3366 It is not allowed to change text or jump to another window while
3367 evaluating 'foldtext' |textlock|.
3368
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003369 *'formatexpr'* *'fex'*
3370'formatexpr' 'fex' string (default "")
3371 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003372 {not available when compiled without the |+eval|
3373 feature}
3374 Expression which is evaluated to format a range of lines for the |gq|
3375 operator or automatic formatting (see 'formatoptions'). When this
3376 option is empty 'formatprg' is used.
3377
3378 The |v:lnum| variable holds the first line to be formatted.
3379 The |v:count| variable holds the number of lines to be formatted.
3380 The |v:char| variable holds the character that is going to be
3381 inserted if the expression is being evaluated due to
3382 automatic formatting. This can be empty. Don't insert
3383 it yet!
3384
3385 Example: >
3386 :set formatexpr=mylang#Format()
3387< This will invoke the mylang#Format() function in the
3388 autoload/mylang.vim file in 'runtimepath'. |autoload|
3389
3390 The expression is also evaluated when 'textwidth' is set and adding
3391 text beyond that limit. This happens under the same conditions as
3392 when internal formatting is used. Make sure the cursor is kept in the
3393 same spot relative to the text then! The |mode()| function will
3394 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003395
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003396 When the expression evaluates to non-zero Vim will fall back to using
3397 the internal format mechanism.
3398
3399 The expression will be evaluated in the |sandbox| when set from a
3400 modeline, see |sandbox-option|. That stops the option from working,
3401 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003402 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003403
Bram Moolenaar86b68352004-12-27 21:59:20 +00003404 *'formatlistpat'* *'flp'*
3405'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3406 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003407 A pattern that is used to recognize a list header. This is used for
3408 the "n" flag in 'formatoptions'.
3409 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003410 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003411 while still checking more characters. There must be a character
3412 following the pattern, when it matches the whole line it is handled
3413 like there is no match.
3414 The default recognizes a number, followed by an optional punctuation
3415 character and white space.
3416
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003417 *'formatoptions'* *'fo'*
3418'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3419 local to buffer
3420 This is a sequence of letters which describes how automatic
3421 formatting is to be done. See |fo-table|. When the 'paste' option is
3422 on, no formatting is done (like 'formatoptions' is empty). Commas can
3423 be inserted for readability.
3424 To avoid problems with flags that are added in the future, use the
3425 "+=" and "-=" feature of ":set" |add-option-flags|.
3426 NOTE: This option is set to the Vi default value when 'compatible' is
3427 set and to the Vim default value when 'compatible' is reset.
3428
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 *'formatprg'* *'fp'*
3430'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003431 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003433 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003435 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003436 If the 'formatexpr' option is not empty it will be used instead.
3437 Otherwise, if 'formatprg' option is an empty string, the internal
3438 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003439 Environment variables are expanded |:set_env|. See |option-backslash|
3440 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003441 This option cannot be set from a |modeline| or in the |sandbox|, for
3442 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443
Bram Moolenaard94464e2015-11-02 15:28:18 +01003444 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003445'fsync' 'fs' boolean (default on)
3446 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003447 When on, the library function fsync() will be called after writing a
3448 file. This will flush a file to disk, ensuring that it is safely
3449 written even on filesystems which do metadata-only journaling. This
3450 will force the harddrive to spin up on Linux systems running in laptop
3451 mode, so it may be undesirable in some situations. Be warned that
3452 turning this off increases the chances of data loss after a crash. On
3453 systems without an fsync() implementation, this variable is always
3454 off.
3455 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003456 'fsync' also applies to |writefile()|, unless a flag is used to
3457 overrule it.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003458
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3460'gdefault' 'gd' boolean (default off)
3461 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462 When on, the ":substitute" flag 'g' is default on. This means that
3463 all matches in a line are substituted instead of one. When a 'g' flag
3464 is given to a ":substitute" command, this will toggle the substitution
3465 of all or one match. See |complex-change|.
3466
3467 command 'gdefault' on 'gdefault' off ~
3468 :s/// subst. all subst. one
3469 :s///g subst. one subst. all
3470 :s///gg subst. all subst. one
3471
3472 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003473 DEPRECATED: Setting this option may break plugins that are not aware
3474 of this option. Also, many users get confused that adding the /g flag
3475 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476
3477 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003478'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 Format to recognize for the ":grep" command output.
3481 This is a scanf-like string that uses the same format as the
3482 'errorformat' option: see |errorformat|.
3483
3484 *'grepprg'* *'gp'*
3485'grepprg' 'gp' string (default "grep -n ",
3486 Unix: "grep -n $* /dev/null",
3487 Win32: "findstr /n" or "grep -n",
3488 VMS: "SEARCH/NUMBERS ")
3489 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003490 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 and '#' characters, which are expanded like when used in a command-
3492 line. The placeholder "$*" is allowed to specify where the arguments
3493 will be included. Environment variables are expanded |:set_env|. See
3494 |option-backslash| about including spaces and backslashes.
3495 When your "grep" accepts the "-H" argument, use this to make ":grep"
3496 also work well with a single file: >
3497 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003498< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003499 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3500 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003501 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502 apply equally to 'grepprg'.
3503 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3504 otherwise it's "grep -n".
3505 This option cannot be set from a |modeline| or in the |sandbox|, for
3506 security reasons.
3507
3508 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3509'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3510 ve:ver35-Cursor,
3511 o:hor50-Cursor,
3512 i-ci:ver25-Cursor/lCursor,
3513 r-cr:hor20-Cursor/lCursor,
3514 sm:block-Cursor
3515 -blinkwait175-blinkoff150-blinkon175",
3516 for MS-DOS and Win32 console:
3517 "n-v-c:block,o:hor50,i-ci:hor15,
3518 r-cr:hor30,sm:block")
3519 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 {only available when compiled with GUI enabled, and
3521 for MS-DOS and Win32 console}
3522 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003523 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524 the height of the cursor can be changed. This can be done by
3525 specifying a block cursor, or a percentage for a vertical or
3526 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003527 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3528 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003530 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531 mode-list and an argument-list:
3532 mode-list:argument-list,mode-list:argument-list,..
3533 The mode-list is a dash separated list of these modes:
3534 n Normal mode
3535 v Visual mode
3536 ve Visual mode with 'selection' "exclusive" (same as 'v',
3537 if not specified)
3538 o Operator-pending mode
3539 i Insert mode
3540 r Replace mode
3541 c Command-line Normal (append) mode
3542 ci Command-line Insert mode
3543 cr Command-line Replace mode
3544 sm showmatch in Insert mode
3545 a all modes
3546 The argument-list is a dash separated list of these arguments:
3547 hor{N} horizontal bar, {N} percent of the character height
3548 ver{N} vertical bar, {N} percent of the character width
3549 block block cursor, fills the whole character
3550 [only one of the above three should be present]
3551 blinkwait{N} *cursor-blinking*
3552 blinkon{N}
3553 blinkoff{N}
3554 blink times for cursor: blinkwait is the delay before
3555 the cursor starts blinking, blinkon is the time that
3556 the cursor is shown and blinkoff is the time that the
3557 cursor is not shown. The times are in msec. When one
3558 of the numbers is zero, there is no blinking. The
3559 default is: "blinkwait700-blinkon400-blinkoff250".
3560 These numbers are used for a missing entry. This
3561 means that blinking is enabled by default. To switch
3562 blinking off you can use "blinkon0". The cursor only
3563 blinks when Vim is waiting for input, not while
3564 executing a command.
3565 To make the cursor blink in an xterm, see
3566 |xterm-blink|.
3567 {group-name}
3568 a highlight group name, that sets the color and font
3569 for the cursor
3570 {group-name}/{group-name}
3571 Two highlight group names, the first is used when
3572 no language mappings are used, the other when they
3573 are. |language-mapping|
3574
3575 Examples of parts:
3576 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3577 block cursor with colors from the "nCursor"
3578 highlight group
3579 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3580 In Insert and Command-line Insert mode, use a
3581 30% vertical bar cursor with colors from the
3582 "iCursor" highlight group. Blink a bit
3583 faster.
3584
3585 The 'a' mode is different. It will set the given argument-list for
3586 all modes. It does not reset anything to defaults. This can be used
3587 to do a common setting for all modes. For example, to switch off
3588 blinking: "a:blinkon0"
3589
3590 Examples of cursor highlighting: >
3591 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3592 :highlight Cursor gui=NONE guifg=bg guibg=fg
3593<
3594 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003595 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596'guifont' 'gfn' string (default "")
3597 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 {only available when compiled with GUI enabled}
3599 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003600 In its simplest form the value is just one font name.
3601 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602
3603 *'guifontset'* *'gfs'*
3604 *E250* *E252* *E234* *E597* *E598*
3605'guifontset' 'gfs' string (default "")
3606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607 {only available when compiled with GUI enabled and
3608 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003609 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 When not empty, specifies two (or more) fonts to be used. The first
3611 one for normal English, the second one for your special language. See
3612 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003613
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3615'guifontwide' 'gfw' string (default "")
3616 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003617 {only available when compiled with GUI enabled}
3618 When not empty, specifies a comma-separated list of fonts to be used
3619 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003620 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003621
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 *'guiheadroom'* *'ghr'*
3623'guiheadroom' 'ghr' number (default 50)
3624 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003625- {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003626 The number of pixels subtracted from the screen height when fitting
3627 the GUI window on the screen. Set this before the GUI is started,
3628 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003629 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630 lines will be left for window decorations and other items on the
3631 screen. Set it to a negative value to allow windows taller than the
3632 screen.
3633
3634 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003635'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3636 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003637 "aegimrLtT" (GTK, Motif and Athena),
3638 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003641 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 sequence of letters which describes what components and options of the
3643 GUI should be used.
3644 To avoid problems with flags that are added in the future, use the
3645 "+=" and "-=" feature of ":set" |add-option-flags|.
3646
Bram Moolenaar13568252018-03-16 20:46:58 +01003647 Valid characters are as follows:
3648 *'go-!'*
3649 '!' External commands are executed in a terminal window. Without
3650 this flag the MS-Windows GUI will open a console window to
3651 execute the command. The Unix GUI will simulate a dumb
3652 terminal to list the command output.
3653 The terminal window will be positioned at the bottom, and grow
3654 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003655 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656 'a' Autoselect: If present, then whenever VISUAL mode is started,
3657 or the Visual area extended, Vim tries to become the owner of
3658 the windowing system's global selection. This means that the
3659 Visually highlighted text is available for pasting into other
3660 applications as well as into Vim itself. When the Visual mode
3661 ends, possibly due to an operation on the text, or when an
3662 application wants to paste the selection, the highlighted text
3663 is automatically yanked into the "* selection register.
3664 Thus the selection is still available for pasting into other
3665 applications after the VISUAL mode has ended.
3666 If not present, then Vim won't become the owner of the
3667 windowing system's global selection unless explicitly told to
3668 by a yank or delete operation for the "* register.
3669 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003670 *'go-P'*
3671 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003672 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003673 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003674 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 applies to the modeless selection.
3676
3677 'guioptions' autoselect Visual autoselect modeless ~
3678 "" - -
3679 "a" yes yes
3680 "A" - yes
3681 "aA" yes yes
3682
Bram Moolenaar02467872007-05-06 13:22:01 +00003683 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003684 'c' Use console dialogs instead of popup dialogs for simple
3685 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003686 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003687 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003688 'guitablabel' can be used to change the text in the labels.
3689 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003690 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003691 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003692 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 'f' Foreground: Don't use fork() to detach the GUI from the shell
3694 where it was started. Use this for programs that wait for the
3695 editor to finish (e.g., an e-mail program). Alternatively you
3696 can use "gvim -f" or ":gui -f" to start the GUI in the
3697 foreground. |gui-fork|
3698 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003699 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003700 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3702 corner of the window. It's black&white on non-GTK, because of
3703 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003704 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003706 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003707 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003709 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003711 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003712 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 'g' Grey menu items: Make menu items that are not active grey. If
3714 'g' is not included inactive menu items are not shown at all.
3715 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003716 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 't' Include tearoff menu items. Currently only works for Win32,
3718 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003719 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003720 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003721 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003722 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003724 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 'R' Right-hand scrollbar is present when there is a vertically
3726 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003727 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003729 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 'L' Left-hand scrollbar is present when there is a vertically
3731 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003732 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3734 the longest visible line, or on the cursor line if the 'h'
3735 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003736 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 'h' Limit horizontal scrollbar size to the length of the cursor
3738 line. Reduces computations. |gui-horiz-scroll|
3739
3740 And yes, you may even have scrollbars on the left AND the right if
3741 you really want to :-). See |gui-scrollbars| for more information.
3742
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003743 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 'v' Use a vertical button layout for dialogs. When not included,
3745 a horizontal layout is preferred, but when it doesn't fit a
3746 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003747 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 'p' Use Pointer callbacks for X11 GUI. This is required for some
3749 window managers. If the cursor is not blinking or hollow at
3750 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003751 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003753 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003754 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003755 *'go-k'*
3756 'k' Keep the GUI window size when adding/removing a scrollbar, or
3757 toolbar, tabline, etc. Instead, the behavior is similar to
3758 when the window is maximized and will adjust 'lines' and
3759 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003760 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003761 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003762
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 *'guipty'* *'noguipty'*
3764'guipty' boolean (default on)
3765 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 {only available when compiled with GUI enabled}
3767 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3768 I/O to/from shell commands. See |gui-pty|.
3769
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003770 *'guitablabel'* *'gtl'*
3771'guitablabel' 'gtl' string (default empty)
3772 global
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003773 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003774 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003775 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003776 pages line. When empty and when the result is empty Vim will use a
3777 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003778
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003779 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003780 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003781 The expression will be evaluated in the |sandbox| when set from a
3782 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003783
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003784 Only used when the GUI tab pages line is displayed. 'e' must be
3785 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3786 used.
3787
Bram Moolenaar57657d82006-04-21 22:12:41 +00003788 *'guitabtooltip'* *'gtt'*
3789'guitabtooltip' 'gtt' string (default empty)
3790 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00003791 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003792 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003793 When nonempty describes the text to use in a tooltip for the GUI tab
3794 pages line. When empty Vim will use a default tooltip.
3795 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003796 You can include a line break. Simplest method is to use |:let|: >
3797 :let &guitabtooltip = "line one\nline two"
3798<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003799
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 *'helpfile'* *'hf'*
3801'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3802 (others) "$VIMRUNTIME/doc/help.txt")
3803 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 Name of the main help file. All distributed help files should be
3805 placed together in one directory. Additionally, all "doc" directories
3806 in 'runtimepath' will be used.
3807 Environment variables are expanded |:set_env|. For example:
3808 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003809 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 spaces and backslashes.
3811 This option cannot be set from a |modeline| or in the |sandbox|, for
3812 security reasons.
3813
3814 *'helpheight'* *'hh'*
3815'helpheight' 'hh' number (default 20)
3816 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02003817 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 feature}
3819 Minimal initial height of the help window when it is opened with the
3820 ":help" command. The initial height of the help window is half of the
3821 current window, or (when the 'ea' option is on) the same as other
3822 windows. When the height is less than 'helpheight', the height is
3823 set to 'helpheight'. Set to zero to disable.
3824
3825 *'helplang'* *'hlg'*
3826'helplang' 'hlg' string (default: messages language or empty)
3827 global
3828 {only available when compiled with the |+multi_lang|
3829 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 Comma separated list of languages. Vim will use the first language
3831 for which the desired help can be found. The English help will always
3832 be used as a last resort. You can add "en" to prefer English over
3833 another language, but that will only find tags that exist in that
3834 language and not in the English help.
3835 Example: >
3836 :set helplang=de,it
3837< This will first search German, then Italian and finally English help
3838 files.
3839 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3840 try to find the tag in the current language before using this option.
3841 See |help-translated|.
3842
3843 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3844'hidden' 'hid' boolean (default off)
3845 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 When off a buffer is unloaded when it is |abandon|ed. When on a
3847 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3848 displayed in another window, it does not become hidden, of course.
3849 The commands that move through the buffer list sometimes make a buffer
3850 hidden although the 'hidden' option is off: When the buffer is
3851 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003852 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003853 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 This option is set for one command with ":hide {command}" |:hide|.
3855 WARNING: It's easy to forget that you have changes in hidden buffers.
3856 Think twice when using ":q!" or ":qa!".
3857
3858 *'highlight'* *'hl'*
3859'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003860 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3861 d:Directory,e:ErrorMsg,i:IncSearch,
3862 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
3863 N:CursorLineNr,r:Question,s:StatusLine,
3864 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003865 v:Visual,V:VisualNOS,w:WarningMsg,
3866 W:WildMenu,f:Folded,F:FoldColumn,
3867 A:DiffAdd,C:DiffChange,D:DiffDelete,
3868 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003869 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003870 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003871 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3872 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003873 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003874 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 This option can be used to set highlighting mode for various
3877 occasions. It is a comma separated list of character pairs. The
3878 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003879 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003881 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3882 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 characters from 'showbreak'
3884 |hl-Directory| d directories in CTRL-D listing and other special
3885 things in listings
3886 |hl-ErrorMsg| e error messages
3887 h (obsolete, ignored)
3888 |hl-IncSearch| i 'incsearch' highlighting
3889 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3890 |hl-MoreMsg| m |more-prompt|
3891 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003892 |hl-LineNr| n line number for ":number" and ":#" commands, and
3893 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003894 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3895 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 |hl-Question| r |hit-enter| prompt and yes/no questions
3897 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003898 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3900 |hl-VertSplit| c column used to separate vertically split windows
3901 |hl-Visual| v Visual mode
3902 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3903 Selection" Only X11 Gui's |gui-x11| and
3904 |xterm-clipboard|.
3905 |hl-WarningMsg| w warning messages
3906 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3907 |hl-Folded| f line used for closed folds
3908 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003909 |hl-DiffAdd| A added line in diff mode
3910 |hl-DiffChange| C changed line in diff mode
3911 |hl-DiffDelete| D deleted line in diff mode
3912 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003914 |hl-Conceal| - the placeholders used for concealed characters
3915 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00003916 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003917 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003918 |hl-SpellRare| R rare word |spell|
3919 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003920 |hl-Pmenu| + popup menu normal line
3921 |hl-PmenuSel| = popup menu selected line
3922 |hl-PmenuSbar| x popup menu scrollbar
3923 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924
3925 The display modes are:
3926 r reverse (termcap entry "mr" and "me")
3927 i italic (termcap entry "ZH" and "ZR")
3928 b bold (termcap entry "md" and "me")
3929 s standout (termcap entry "so" and "se")
3930 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003931 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02003932 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003933 n no highlighting
3934 - no highlighting
3935 : use a highlight group
3936 The default is used for occasions that are not included.
3937 If you want to change what the display modes do, see |dos-colors|
3938 for an example.
3939 When using the ':' display mode, this must be followed by the name of
3940 a highlight group. A highlight group can be used to define any type
3941 of highlighting, including using color. See |:highlight| on how to
3942 define one. The default uses a different group for each occasion.
3943 See |highlight-default| for the default highlight groups.
3944
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003946'history' 'hi' number (Vim default: 50, Vi default: 0,
3947 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003950 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003952 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 NOTE: This option is set to the Vi default value when 'compatible' is
3954 set and to the Vim default value when 'compatible' is reset.
3955
3956 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3957'hkmap' 'hk' boolean (default off)
3958 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 {only available when compiled with the |+rightleft|
3960 feature}
3961 When on, the keyboard is mapped for the Hebrew character set.
3962 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3963 toggle this option. See |rileft.txt|.
3964 NOTE: This option is reset when 'compatible' is set.
3965
3966 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3967'hkmapp' 'hkp' boolean (default off)
3968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 {only available when compiled with the |+rightleft|
3970 feature}
3971 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3972 This is useful if you have a non-Hebrew keyboard.
3973 See |rileft.txt|.
3974 NOTE: This option is reset when 'compatible' is set.
3975
Bram Moolenaar036986f2017-03-16 17:41:02 +01003976 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3977'hlsearch' 'hls' boolean (default off)
3978 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01003979 {not available when compiled without the
3980 |+extra_search| feature}
3981 When there is a previous search pattern, highlight all its matches.
3982 The type of highlighting used can be set with the 'l' occasion in the
3983 'highlight' option. This uses the "Search" highlight group by
3984 default. Note that only the matching text is highlighted, any offsets
3985 are not applied.
3986 See also: 'incsearch' and |:match|.
3987 When you get bored looking at the highlighted matches, you can turn it
3988 off with |:nohlsearch|. This does not change the option value, as
3989 soon as you use a search command, the highlighting comes back.
3990 'redrawtime' specifies the maximum time spent on finding matches.
3991 When the search pattern can match an end-of-line, Vim will try to
3992 highlight all of the matched text. However, this depends on where the
3993 search starts. This will be the first line in the window or the first
3994 line below a closed fold. A match in a previous line which is not
3995 drawn may not continue in a newly drawn line.
3996 You can specify whether the highlight status is restored on startup
3997 with the 'h' flag in 'viminfo' |viminfo-h|.
3998 NOTE: This option is reset when 'compatible' is set.
3999
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 *'icon'* *'noicon'*
4001'icon' boolean (default off, on when title can be restored)
4002 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003 {not available when compiled without the |+title|
4004 feature}
4005 When on, the icon text of the window will be set to the value of
4006 'iconstring' (if it is not empty), or to the name of the file
4007 currently being edited. Only the last part of the name is used.
4008 Overridden by the 'iconstring' option.
4009 Only works if the terminal supports setting window icons (currently
4010 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4011 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4012 builtin termcap).
4013 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004014 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004016 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017
4018 *'iconstring'*
4019'iconstring' string (default "")
4020 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 {not available when compiled without the |+title|
4022 feature}
4023 When this option is not empty, it will be used for the icon text of
4024 the window. This happens only when the 'icon' option is on.
4025 Only works if the terminal supports setting window icon text
4026 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4027 Does not work for MS Windows.
4028 When Vim was compiled with HAVE_X11 defined, the original icon will be
4029 restored if possible |X11|.
4030 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004031 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 'titlestring' for example settings.
4033 {not available when compiled without the |+statusline| feature}
4034
4035 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4036'ignorecase' 'ic' boolean (default off)
4037 global
4038 Ignore case in search patterns. Also used when searching in the tags
4039 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004040 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041 Can be overruled by using "\c" or "\C" in the pattern, see
4042 |/ignorecase|.
4043
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004044 *'imactivatefunc'* *'imaf'*
4045'imactivatefunc' 'imaf' string (default "")
4046 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004047 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004048 activate or deactivate the Input Method.
4049 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004050
4051 Example: >
4052 function ImActivateFunc(active)
4053 if a:active
4054 ... do something
4055 else
4056 ... do something
4057 endif
4058 " return value is not used
4059 endfunction
4060 set imactivatefunc=ImActivateFunc
4061<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 *'imactivatekey'* *'imak'*
4063'imactivatekey' 'imak' string (default "")
4064 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004066 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 Specifies the key that your Input Method in X-Windows uses for
4068 activation. When this is specified correctly, vim can fully control
4069 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4070 You can't use this option to change the activation key, the option
4071 tells Vim what the key is.
4072 Format:
4073 [MODIFIER_FLAG-]KEY_STRING
4074
4075 These characters can be used for MODIFIER_FLAG (case is ignored):
4076 S Shift key
4077 L Lock key
4078 C Control key
4079 1 Mod1 key
4080 2 Mod2 key
4081 3 Mod3 key
4082 4 Mod4 key
4083 5 Mod5 key
4084 Combinations are allowed, for example "S-C-space" or "SC-space" are
4085 both shift+ctrl+space.
4086 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4087
4088 Example: >
4089 :set imactivatekey=S-space
4090< "S-space" means shift+space. This is the activation key for kinput2 +
4091 canna (Japanese), and ami (Korean).
4092
4093 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4094'imcmdline' 'imc' boolean (default off)
4095 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096 When set the Input Method is always on when starting to edit a command
4097 line, unless entering a search pattern (see 'imsearch' for that).
4098 Setting this option is useful when your input method allows entering
4099 English characters directly, e.g., when it's used to type accented
4100 characters with dead keys.
4101
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004102 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4104 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 When set the Input Method is never used. This is useful to disable
4106 the IM when it doesn't work properly.
4107 Currently this option is on by default for SGI/IRIX machines. This
4108 may change in later releases.
4109
4110 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004111'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 Specifies whether :lmap or an Input Method (IM) is to be used in
4114 Insert mode. Valid values:
4115 0 :lmap is off and IM is off
4116 1 :lmap is ON and IM is off
4117 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 To always reset the option to zero when leaving Insert mode with <Esc>
4119 this can be used: >
4120 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4121< This makes :lmap and IM turn off automatically when leaving Insert
4122 mode.
4123 Note that this option changes when using CTRL-^ in Insert mode
4124 |i_CTRL-^|.
4125 The value is set to 1 when setting 'keymap' to a valid keymap name.
4126 It is also used for the argument of commands like "r" and "f".
4127 The value 0 may not work correctly with Athena and Motif with some XIM
4128 methods. Use 'imdisable' to disable XIM then.
4129
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004130 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004131 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004132 |+multi_byte_ime| or |global-ime|.
4133
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004135'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137 Specifies whether :lmap or an Input Method (IM) is to be used when
4138 entering a search pattern. Valid values:
4139 -1 the value of 'iminsert' is used, makes it look like
4140 'iminsert' is also used when typing a search pattern
4141 0 :lmap is off and IM is off
4142 1 :lmap is ON and IM is off
4143 2 :lmap is off and IM is ON
4144 Note that this option changes when using CTRL-^ in Command-line mode
4145 |c_CTRL-^|.
4146 The value is set to 1 when it is not -1 and setting the 'keymap'
4147 option to a valid keymap name.
4148 The value 0 may not work correctly with Athena and Motif with some XIM
4149 methods. Use 'imdisable' to disable XIM then.
4150
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004151 *'imstatusfunc'* *'imsf'*
4152'imstatusfunc' 'imsf' string (default "")
4153 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004154 This option specifies a function that is called to obtain the status
4155 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004156 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004157
4158 Example: >
4159 function ImStatusFunc()
4160 let is_active = ...do something
4161 return is_active ? 1 : 0
4162 endfunction
4163 set imstatusfunc=ImStatusFunc
4164<
4165 NOTE: This function is invoked very often. Keep it fast.
4166
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004167 *'imstyle'* *'imst'*
4168'imstyle' 'imst' number (default 1)
4169 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004170 {only available when compiled with |+xim| and
4171 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004172 This option specifies the input style of Input Method:
4173 0 use on-the-spot style
4174 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004175 See: |xim-input-style|
4176
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004177 For a long time on-the-spot style had been used in the GTK version of
4178 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004179 |single-repeat|, etc. Therefore over-the-spot style becomes the
4180 default now. This should work fine for most people, however if you
4181 have any problem with it, try using on-the-spot style.
4182
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 *'include'* *'inc'*
4184'include' 'inc' string (default "^\s*#\s*include")
4185 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 {not available when compiled without the
4187 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004188 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 pattern, just like for the "/" command (See |pattern|). The default
4190 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004191 "]I", "[d", etc.
4192 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004193 comes after the matched pattern. But if "\zs" appears in the pattern
4194 then the text matched from "\zs" to the end, or until "\ze" if it
4195 appears, is used as the file name. Use this to include characters
4196 that are not in 'isfname', such as a space. You can then use
4197 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004198 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199
4200 *'includeexpr'* *'inex'*
4201'includeexpr' 'inex' string (default "")
4202 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004204 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004206 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 :set includeexpr=substitute(v:fname,'\\.','/','g')
4208< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004209
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004211 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 Also used for |<cfile>|.
4213
Bram Moolenaar30b65812012-07-12 22:01:11 +02004214 The expression will be evaluated in the |sandbox| when set from a
4215 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004216
4217 It is not allowed to change text or jump to another window while
4218 evaluating 'includeexpr' |textlock|.
4219
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004221'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4222 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004225 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004226 While typing a search command, show where the pattern, as it was typed
4227 so far, matches. The matched string is highlighted. If the pattern
4228 is invalid or not found, nothing is shown. The screen will be updated
4229 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004230 Also applies to the pattern in commands: >
4231 :global
4232 :lvimgrep
4233 :lvimgrepadd
4234 :smagic
4235 :snomagic
4236 :sort
4237 :substitute
4238 :vglobal
4239 :vimgrep
4240 :vimgrepadd
4241< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004242 original position when no match is found and when pressing <Esc>. You
4243 still need to finish the search command with <Enter> to move the
4244 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004245 You can use the CTRL-G and CTRL-T keys to move to the next and
4246 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004247 When compiled with the |+reltime| feature Vim only searches for about
4248 half a second. With a complicated pattern and/or a lot of text the
4249 match may not be found. This is to avoid that Vim hangs while you
4250 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004251 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004252 When 'hlsearch' is on, all matched strings are highlighted too while
4253 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004254 If you don't want to turn 'hlsearch' on, but want to highlight all
4255 matches while searching, you can turn on and off 'hlsearch' with
4256 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004257 augroup vimrc-incsearch-highlight
4258 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004259 autocmd CmdlineEnter /,\? :set hlsearch
4260 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004261 augroup END
4262<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004263 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004264 to the command line. If 'ignorecase' and 'smartcase' are set and the
4265 command line has no uppercase characters, the added character is
4266 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004267 CTRL-R CTRL-W can be used to add the word at the end of the current
4268 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 NOTE: This option is reset when 'compatible' is set.
4270
4271 *'indentexpr'* *'inde'*
4272'indentexpr' 'inde' string (default "")
4273 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 {not available when compiled without the |+cindent|
4275 or |+eval| features}
4276 Expression which is evaluated to obtain the proper indent for a line.
4277 It is used when a new line is created, for the |=| operator and
4278 in Insert mode as specified with the 'indentkeys' option.
4279 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004280 'smartindent' indenting. When 'lisp' is set, this option is
4281 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 When 'paste' is set this option is not used for indenting.
4283 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004284 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 when the expression is evaluated (but it may be moved around).
4286 The expression must return the number of spaces worth of indent. It
4287 can return "-1" to keep the current indent (this means 'autoindent' is
4288 used for the indent).
4289 Functions useful for computing the indent are |indent()|, |cindent()|
4290 and |lispindent()|.
4291 The evaluation of the expression must not have side effects! It must
4292 not change the text, jump to another window, etc. Afterwards the
4293 cursor position is always restored, thus the cursor may be moved.
4294 Normally this option would be set to call a function: >
4295 :set indentexpr=GetMyIndent()
4296< Error messages will be suppressed, unless the 'debug' option contains
4297 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004298 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004299 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300
Bram Moolenaar30b65812012-07-12 22:01:11 +02004301 The expression will be evaluated in the |sandbox| when set from a
4302 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004303
4304 It is not allowed to change text or jump to another window while
4305 evaluating 'indentexpr' |textlock|.
4306
4307
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004309'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 {not available when compiled without the |+cindent|
4312 feature}
4313 A list of keys that, when typed in Insert mode, cause reindenting of
4314 the current line. Only happens if 'indentexpr' isn't empty.
4315 The format is identical to 'cinkeys', see |indentkeys-format|.
4316 See |C-indenting| and |indent-expression|.
4317
4318 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4319'infercase' 'inf' boolean (default off)
4320 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004322 'ignorecase' is also on, the case of the match is adjusted depending
4323 on the typed text. If the typed text contains a lowercase letter
4324 where the match has an upper case letter, the completed part is made
4325 lowercase. If the typed text has no lowercase letters and the match
4326 has a lowercase letter where the typed text has an uppercase letter,
4327 and there is a letter before it, the completed part is made uppercase.
4328 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329
4330 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4331'insertmode' 'im' boolean (default off)
4332 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 Makes Vim work in a way that Insert mode is the default mode. Useful
4334 if you want to use Vim as a modeless editor. Used for |evim|.
4335 These Insert mode commands will be useful:
4336 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004337 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 this is a mapping, it is executed as if 'insertmode' was off.
4339 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004341 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4342 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343
4344 These items change when 'insertmode' is set:
4345 - when starting to edit of a file, Vim goes to Insert mode.
4346 - <Esc> in Insert mode is a no-op and beeps.
4347 - <Esc> in Normal mode makes Vim go to Insert mode.
4348 - CTRL-L in Insert mode is a command, it is not inserted.
4349 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4350 However, when <Esc> is used inside a mapping, it behaves like
4351 'insertmode' was not set. This was done to be able to use the same
4352 mappings with 'insertmode' set or not set.
4353 When executing commands with |:normal| 'insertmode' is not used.
4354
4355 NOTE: This option is reset when 'compatible' is set.
4356
4357 *'isfname'* *'isf'*
4358'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4359 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4360 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4361 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4362 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4363 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4364 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 The characters specified by this option are included in file names and
4366 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004367 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368 Multi-byte characters 256 and above are always included, only the
4369 characters up to 255 are specified with this option.
4370 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004371 Think twice before adding white space to this option. Although a
4372 space may appear inside a file name, the effect will be that Vim
4373 doesn't know where a file name starts or ends when doing completion.
4374 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375
4376 Note that on systems using a backslash as path separator, Vim tries to
4377 do its best to make it work as you would expect. That is a bit
4378 tricky, since Vi originally used the backslash to escape special
4379 characters. Vim will not remove a backslash in front of a normal file
4380 name character on these systems, but it will on Unix and alikes. The
4381 '&' and '^' are not included by default, because these are special for
4382 cmd.exe.
4383
4384 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004385 Each part can be a single character number or a range. A range is two
4386 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387 decimal number between 0 and 255 or the ASCII character itself (does
4388 not work for digits). Example:
4389 "_,-,128-140,#-43" (include '_' and '-' and the range
4390 128 to 140 and '#' to 43)
4391 If a part starts with '^', the following character number or range
4392 will be excluded from the option. The option is interpreted from left
4393 to right. Put the excluded character after the range where it is
4394 included. To include '^' itself use it as the last character of the
4395 option or the end of a range. Example:
4396 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4397 If the character is '@', all characters where isalpha() returns TRUE
4398 are included. Normally these are the characters a to z and A to Z,
4399 plus accented characters. To include '@' itself use "@-@". Examples:
4400 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004401 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 "a-z,A-Z,@-@" All letters plus the '@' character.
4403 A comma can be included by using it where a character number is
4404 expected. Example:
4405 "48-57,,,_" Digits, comma and underscore.
4406 A comma can be excluded by prepending a '^'. Example:
4407 " -~,^,,9" All characters from space to '~', excluding
4408 comma, plus <Tab>.
4409 See |option-backslash| about including spaces and backslashes.
4410
4411 *'isident'* *'isi'*
4412'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4413 "@,48-57,_,128-167,224-235"
4414 otherwise: "@,48-57,_,192-255")
4415 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 The characters given by this option are included in identifiers.
4417 Identifiers are used in recognizing environment variables and after a
4418 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004419 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004420 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004422 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4424
4425 *'iskeyword'* *'isk'*
4426'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4427 "@,48-57,_,128-167,224-235"
4428 otherwise: "@,48-57,_,192-255"
4429 Vi default: "@,48-57,_")
4430 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004432 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004433 'isfname' for a description of the format of this option. For '@'
4434 characters above 255 check the "word" character class.
4435 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 For a help file it is set to all non-blank printable characters except
4437 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4438 command).
4439 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004440 This option also influences syntax highlighting, unless the syntax
4441 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442 NOTE: This option is set to the Vi default value when 'compatible' is
4443 set and to the Vim default value when 'compatible' is reset.
4444
4445 *'isprint'* *'isp'*
4446'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4447 "@,~-255"; otherwise: "@,161-255")
4448 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004449 The characters given by this option are displayed directly on the
4450 screen. It is also used for "\p" in a |pattern|. The characters from
4451 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4452 even when they are not included in 'isprint' or excluded. See
4453 'isfname' for a description of the format of this option.
4454
4455 Non-printable characters are displayed with two characters:
4456 0 - 31 "^@" - "^_"
4457 32 - 126 always single characters
4458 127 "^?"
4459 128 - 159 "~@" - "~_"
4460 160 - 254 "| " - "|~"
4461 255 "~?"
4462 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4463 displayed as <xx>, with the hexadecimal value of the byte.
4464 When 'display' contains "uhex" all unprintable characters are
4465 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004466 The SpecialKey highlighting will be used for unprintable characters.
4467 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468
4469 Multi-byte characters 256 and above are always included, only the
4470 characters up to 255 are specified with this option. When a character
4471 is printable but it is not available in the current font, a
4472 replacement character will be shown.
4473 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4474 There is no option to specify these characters.
4475
4476 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4477'joinspaces' 'js' boolean (default on)
4478 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 Insert two spaces after a '.', '?' and '!' with a join command.
4480 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4481 Otherwise only one space is inserted.
4482 NOTE: This option is set when 'compatible' is set.
4483
4484 *'key'*
4485'key' string (default "")
4486 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004487 {only available when compiled with the |+cryptv|
4488 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004490 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004491 Careful: Do not set the key value by hand, someone might see the typed
4492 key. Use the |:X| command. But you can make 'key' empty: >
4493 :set key=
4494< It is not possible to get the value of this option with ":set key" or
4495 "echo &key". This is to avoid showing it to someone who shouldn't
4496 know. It also means you cannot see it yourself once you have set it,
4497 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004498 You can use "&key" in an expression to detect whether encryption is
4499 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500
4501 *'keymap'* *'kmp'* *E544*
4502'keymap' 'kmp' string (default "")
4503 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 {only available when compiled with the |+keymap|
4505 feature}
4506 Name of a keyboard mapping. See |mbyte-keymap|.
4507 Setting this option to a valid keymap name has the side effect of
4508 setting 'iminsert' to one, so that the keymap becomes effective.
4509 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004510 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511
4512 *'keymodel'* *'km'*
4513'keymodel' 'km' string (default "")
4514 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515 List of comma separated words, which enable special things that keys
4516 can do. These values can be used:
4517 startsel Using a shifted special key starts selection (either
4518 Select mode or Visual mode, depending on "key" being
4519 present in 'selectmode').
4520 stopsel Using a not-shifted special key stops selection.
4521 Special keys in this context are the cursor keys, <End>, <Home>,
4522 <PageUp> and <PageDown>.
4523 The 'keymodel' option is set by the |:behave| command.
4524
4525 *'keywordprg'* *'kp'*
4526'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004527 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529 Program to use for the |K| command. Environment variables are
4530 expanded |:set_env|. ":help" may be used to access the Vim internal
4531 help. (Note that previously setting the global option to the empty
4532 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004533 When the first character is ":", the command is invoked as a Vim
4534 Ex command prefixed with [count].
4535 When "man", "man -s" or an Ex command is used, Vim will automatically
4536 translate a count for the "K" command and pass it as the first
4537 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538 See |option-backslash| about including spaces and backslashes.
4539 Example: >
4540 :set keywordprg=man\ -s
4541< This option cannot be set from a |modeline| or in the |sandbox|, for
4542 security reasons.
4543
4544 *'langmap'* *'lmap'* *E357* *E358*
4545'langmap' 'lmap' string (default "")
4546 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 {only available when compiled with the |+langmap|
4548 feature}
4549 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004550 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004551 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552 care of translating these special characters to the original meaning
4553 of the key. This means you don't have to change the keyboard mode to
4554 be able to execute Normal mode commands.
4555 This is the opposite of the 'keymap' option, where characters are
4556 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004557 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004558 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004559 This option cannot be set from a |modeline| or in the |sandbox|, for
4560 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004562 Example (for Greek, in UTF-8): *greek* >
4563 :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 +00004564< Example (exchanges meaning of z and y for commands): >
4565 :set langmap=zy,yz,ZY,YZ
4566<
4567 The 'langmap' option is a list of parts, separated with commas. Each
4568 part can be in one of two forms:
4569 1. A list of pairs. Each pair is a "from" character immediately
4570 followed by the "to" character. Examples: "aA", "aAbBcC".
4571 2. A list of "from" characters, a semi-colon and a list of "to"
4572 characters. Example: "abc;ABC"
4573 Example: "aA,fgh;FGH,cCdDeE"
4574 Special characters need to be preceded with a backslash. These are
4575 ";", ',' and backslash itself.
4576
4577 This will allow you to activate vim actions without having to switch
4578 back and forth between the languages. Your language characters will
4579 be understood as normal vim English characters (according to the
4580 langmap mappings) in the following cases:
4581 o Normal/Visual mode (commands, buffer/register names, user mappings)
4582 o Insert/Replace Mode: Register names after CTRL-R
4583 o Insert/Replace Mode: Mappings
4584 Characters entered in Command-line mode will NOT be affected by
4585 this option. Note that this option can be changed at any time
4586 allowing to switch between mappings for different languages/encodings.
4587 Use a mapping to avoid having to type it each time!
4588
4589 *'langmenu'* *'lm'*
4590'langmenu' 'lm' string (default "")
4591 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 {only available when compiled with the |+menu| and
4593 |+multi_lang| features}
4594 Language to use for menu translation. Tells which file is loaded
4595 from the "lang" directory in 'runtimepath': >
4596 "lang/menu_" . &langmenu . ".vim"
4597< (without the spaces). For example, to always use the Dutch menus, no
4598 matter what $LANG is set to: >
4599 :set langmenu=nl_NL.ISO_8859-1
4600< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004601 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 If your $LANG is set to a non-English language but you do want to use
4603 the English menus: >
4604 :set langmenu=none
4605< This option must be set before loading menus, switching on filetype
4606 detection or syntax highlighting. Once the menus are defined setting
4607 this option has no effect. But you could do this: >
4608 :source $VIMRUNTIME/delmenu.vim
4609 :set langmenu=de_DE.ISO_8859-1
4610 :source $VIMRUNTIME/menu.vim
4611< Warning: This deletes all menus that you defined yourself!
4612
Bram Moolenaard94464e2015-11-02 15:28:18 +01004613 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004614'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004615 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004616 {only available when compiled with the |+langmap|
4617 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004618 This is just like 'langremap' but with the value inverted. It only
4619 exists for backwards compatibility. When setting 'langremap' then
4620 'langnoremap' is set to the inverted value, and the other way around.
4621
4622 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4623'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4624 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004625 {only available when compiled with the |+langmap|
4626 feature}
4627 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004628 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004629 'langmap' disables some of your mappings, try resetting this option.
4630 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004631 that works for you to avoid mappings to break.
4632
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 *'laststatus'* *'ls'*
4634'laststatus' 'ls' number (default 1)
4635 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 The value of this option influences when the last window will have a
4637 status line:
4638 0: never
4639 1: only if there are at least two windows
4640 2: always
4641 The screen looks nicer with a status line if you have several
4642 windows, but it takes another screen line. |status-line|
4643
4644 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4645'lazyredraw' 'lz' boolean (default off)
4646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 When this option is set, the screen will not be redrawn while
4648 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004649 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 update use |:redraw|.
4651
4652 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4653'linebreak' 'lbr' boolean (default off)
4654 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004655 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004657 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658 than at the last character that fits on the screen. Unlike
4659 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004660 it only affects the way the file is displayed, not its contents.
4661 If 'breakindent' is set, line is visually indented. Then, the value
4662 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004663 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664 Note that <Tab> characters after an <EOL> are mostly not displayed
4665 with the right amount of white space.
4666
4667 *'lines'* *E593*
4668'lines' number (default 24 or terminal height)
4669 global
4670 Number of lines of the Vim window.
4671 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004672 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 When Vim is running in the GUI or in a resizable window, setting this
4674 option will cause the window size to be changed. When you only want
4675 to use the size for the GUI, put the command in your |gvimrc| file.
4676 Vim limits the number of lines to what fits on the screen. You can
4677 use this command to get the tallest window possible: >
4678 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004679< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004680 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 When you set this option and Vim is unable to change the physical
4682 number of lines of the display, the display may be messed up.
4683
4684 *'linespace'* *'lsp'*
4685'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 {only in the GUI}
4688 Number of pixel lines inserted between characters. Useful if the font
4689 uses the full character cell height, making lines touch each other.
4690 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004691 With some fonts there can be too much room between lines (to have
4692 space for ascents and descents). Then it makes sense to set
4693 'linespace' to a negative value. This may cause display problems
4694 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695
4696 *'lisp'* *'nolisp'*
4697'lisp' boolean (default off)
4698 local to buffer
4699 {not available when compiled without the |+lispindent|
4700 feature}
4701 Lisp mode: When <Enter> is typed in insert mode set the indent for
4702 the next line to Lisp standards (well, sort of). Also happens with
4703 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4704 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4705 better. Also see 'lispwords'.
4706 The '-' character is included in keyword characters. Redefines the
4707 "=" operator to use this same indentation algorithm rather than
4708 calling an external program if 'equalprg' is empty.
4709 This option is not used when 'paste' is set.
4710 {Vi: Does it a little bit differently}
4711
4712 *'lispwords'* *'lw'*
4713'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004714 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 {not available when compiled without the |+lispindent|
4716 feature}
4717 Comma separated list of words that influence the Lisp indenting.
4718 |'lisp'|
4719
4720 *'list'* *'nolist'*
4721'list' boolean (default off)
4722 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004723 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4724 line. Useful to see the difference between tabs and spaces and for
4725 trailing blanks. Further changed by the 'listchars' option.
4726
4727 The cursor is displayed at the start of the space a Tab character
4728 occupies, not at the end as usual in Normal mode. To get this cursor
4729 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004730 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004731<
4732 Note that list mode will also affect formatting (set with 'textwidth'
4733 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 changing the way tabs are displayed.
4735
4736 *'listchars'* *'lcs'*
4737'listchars' 'lcs' string (default "eol:$")
4738 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004739 Strings to use in 'list' mode and for the |:list| command. It is a
4740 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004741 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742 eol:c Character to show at the end of each line. When
4743 omitted, there is no extra character at the end of the
4744 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004745 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004746 tab:xy[z] Two or three characters to be used to show a tab.
4747 The third character is optional.
4748
4749 tab:xy The 'x' is always used, then 'y' as many times as will
4750 fit. Thus "tab:>-" displays:
4751 >
4752 >-
4753 >--
4754 etc.
4755
4756 tab:xyz The 'z' is always used, then 'x' is prepended, and
4757 then 'y' is used as many times as will fit. Thus
4758 "tab:<->" displays:
4759 >
4760 <>
4761 <->
4762 <-->
4763 etc.
4764
4765 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004766 *lcs-space*
4767 space:c Character to show for a space. When omitted, spaces
4768 are left blank.
4769 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004770 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004771 trailing spaces are blank. Overrides the "space"
4772 setting for trailing spaces.
4773 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774 extends:c Character to show in the last column, when 'wrap' is
4775 off and the line continues beyond the right of the
4776 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004777 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 precedes:c Character to show in the first column, when 'wrap'
4779 is off and there is text preceding the character
4780 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004781 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004782 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004783 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004784 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004785 nbsp:c Character to show for a non-breakable space character
4786 (0xA0 (160 decimal) and U+202F). Left blank when
4787 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004789 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004791 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792
4793 Examples: >
4794 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004795 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796 :set lcs=extends:>,precedes:<
4797< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004798 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004799 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800
4801 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4802'loadplugins' 'lpl' boolean (default on)
4803 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 When on the plugin scripts are loaded when starting up |load-plugins|.
4805 This option can be reset in your |vimrc| file to disable the loading
4806 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004807 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4808 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809
Bram Moolenaard94464e2015-11-02 15:28:18 +01004810 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004811'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004812 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004813 {only available when compiled with the |+lua/dyn|
4814 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004815 Specifies the name of the Lua shared library. The default is
4816 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004817 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004818 This option cannot be set from a |modeline| or in the |sandbox|, for
4819 security reasons.
4820
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004821 *'macatsui'* *'nomacatsui'*
4822'macatsui' boolean (default on)
4823 global
4824 {only available in Mac GUI version}
4825 This is a workaround for when drawing doesn't work properly. When set
4826 and compiled with multi-byte support ATSUI text drawing is used. When
4827 not set ATSUI text drawing is not used. Switch this option off when
4828 you experience drawing problems. In a future version the problems may
4829 be solved and this option becomes obsolete. Therefore use this method
4830 to unset it: >
4831 if exists('&macatsui')
4832 set nomacatsui
4833 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004834< Another option to check if you have drawing problems is
4835 'termencoding'.
4836
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837 *'magic'* *'nomagic'*
4838'magic' boolean (default on)
4839 global
4840 Changes the special characters that can be used in search patterns.
4841 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004842 WARNING: Switching this option off most likely breaks plugins! That
4843 is because many patterns assume it's on and will fail when it's off.
4844 Only switch it off when working with old Vi scripts. In any other
4845 situation write patterns that work when 'magic' is on. Include "\M"
4846 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847
4848 *'makeef'* *'mef'*
4849'makeef' 'mef' string (default: "")
4850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 {not available when compiled without the |+quickfix|
4852 feature}
4853 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4854 and the |:grep| command.
4855 When it is empty, an internally generated temp file will be used.
4856 When "##" is included, it is replaced by a number to make the name
4857 unique. This makes sure that the ":make" command doesn't overwrite an
4858 existing file.
4859 NOT used for the ":cf" command. See 'errorfile' for that.
4860 Environment variables are expanded |:set_env|.
4861 See |option-backslash| about including spaces and backslashes.
4862 This option cannot be set from a |modeline| or in the |sandbox|, for
4863 security reasons.
4864
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004865 *'makeencoding'* *'menc'*
4866'makeencoding' 'menc' string (default "")
4867 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004868 Encoding used for reading the output of external commands. When empty,
4869 encoding is not converted.
4870 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4871 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4872 and `:laddfile`.
4873
4874 This would be mostly useful when you use MS-Windows and set 'encoding'
4875 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4876 'makeencoding' to "char" has the same effect as setting to the system
4877 locale encoding. Example: >
4878 :set encoding=utf-8
4879 :set makeencoding=char " system locale is used
4880<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 *'makeprg'* *'mp'*
4882'makeprg' 'mp' string (default "make", VMS: "MMS")
4883 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004884 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004885 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4886 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004887 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004888 Environment variables are expanded |:set_env|. See |option-backslash|
4889 about including spaces and backslashes.
4890 Note that a '|' must be escaped twice: once for ":set" and once for
4891 the interpretation of a command. When you use a filter called
4892 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893 :set makeprg=gmake\ \\\|\ myfilter
4894< The placeholder "$*" can be given (even multiple times) to specify
4895 where the arguments will be included, for example: >
4896 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4897< This option cannot be set from a |modeline| or in the |sandbox|, for
4898 security reasons.
4899
4900 *'matchpairs'* *'mps'*
4901'matchpairs' 'mps' string (default "(:),{:},[:]")
4902 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004904 other.
4905 Only character pairs are allowed that are different, thus you cannot
4906 jump between two double quotes.
4907 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004908 The pairs must be separated by a comma. Example for including '<' and
4909 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 :set mps+=<:>
4911
4912< A more exotic example, to jump between the '=' and ';' in an
4913 assignment, useful for languages like C and Java: >
4914 :au FileType c,cpp,java set mps+==:;
4915
4916< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01004917 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918
4919 *'matchtime'* *'mat'*
4920'matchtime' 'mat' number (default 5)
4921 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02004922 {in Nvi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 Tenths of a second to show the matching paren, when 'showmatch' is
4924 set. Note that this is not in milliseconds, like other options that
4925 set a time. This is to be compatible with Nvi.
4926
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004927 *'maxcombine'* *'mco'*
4928'maxcombine' 'mco' number (default 2)
4929 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004930 The maximum number of combining characters supported for displaying.
4931 Only used when 'encoding' is "utf-8".
4932 The default is OK for most languages. Hebrew may require 4.
4933 Maximum value is 6.
4934 Even when this option is set to 2 you can still edit text with more
4935 combining characters, you just can't see them. Use |g8| or |ga|.
4936 See |mbyte-combining|.
4937
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938 *'maxfuncdepth'* *'mfd'*
4939'maxfuncdepth' 'mfd' number (default 100)
4940 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02004941 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004942 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943 Maximum depth of function calls for user functions. This normally
4944 catches endless recursion. When using a recursive function with
4945 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4946 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01004947 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02004948 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949 See also |:function|.
4950
4951 *'maxmapdepth'* *'mmd'* *E223*
4952'maxmapdepth' 'mmd' number (default 1000)
4953 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004954 Maximum number of times a mapping is done without resulting in a
4955 character to be used. This normally catches endless mappings, like
4956 ":map x y" with ":map y x". It still does not catch ":map g wg",
4957 because the 'w' is used before the next mapping is done. See also
4958 |key-mapping|.
4959
4960 *'maxmem'* *'mm'*
4961'maxmem' 'mm' number (default between 256 to 5120 (system
4962 dependent) or half the amount of memory
4963 available)
4964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4966 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01004967 other memory to be freed.
4968 The maximum usable value is about 2000000. Use this to work without a
4969 limit.
4970 The value is ignored when 'swapfile' is off.
4971 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004973 *'maxmempattern'* *'mmp'*
4974'maxmempattern' 'mmp' number (default 1000)
4975 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004976 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004977 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004978 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004979 When Vim runs into the limit it gives an error message and mostly
4980 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004981 Running into the limit often means that the pattern is very
4982 inefficient or too complex. This may already happen with the pattern
4983 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02004984 Might also happen on redraw, when syntax rules try to match a complex
4985 text structure.
4986 Vim may run out of memory before hitting the 'maxmempattern' limit, in
4987 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004988
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989 *'maxmemtot'* *'mmt'*
4990'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4991 dependent) or half the amount of memory
4992 available)
4993 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004994 Maximum amount of memory in Kbyte to use for all buffers together.
4995 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01004996 without a limit.
4997 On 64 bit machines higher values might work. But hey, do you really
4998 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004999 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005000 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005001 Buffers with 'swapfile' off still count to the total amount of memory
5002 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005003 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004
5005 *'menuitems'* *'mis'*
5006'menuitems' 'mis' number (default 25)
5007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008 {not available when compiled without the |+menu|
5009 feature}
5010 Maximum number of items to use in a menu. Used for menus that are
5011 generated from a list of items, e.g., the Buffers menu. Changing this
5012 option has no direct effect, the menu must be refreshed first.
5013
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005014 *'mkspellmem'* *'msm'*
5015'mkspellmem' 'msm' string (default "460000,2000,500")
5016 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005017 {not available when compiled without the |+syntax|
5018 feature}
5019 Parameters for |:mkspell|. This tunes when to start compressing the
5020 word tree. Compression can be slow when there are many words, but
5021 it's needed to avoid running out of memory. The amount of memory used
5022 per word depends very much on how similar the words are, that's why
5023 this tuning is complicated.
5024
5025 There are three numbers, separated by commas:
5026 {start},{inc},{added}
5027
5028 For most languages the uncompressed word tree fits in memory. {start}
5029 gives the amount of memory in Kbyte that can be used before any
5030 compression is done. It should be a bit smaller than the amount of
5031 memory that is available to Vim.
5032
5033 When going over the {start} limit the {inc} number specifies the
5034 amount of memory in Kbyte that can be allocated before another
5035 compression is done. A low number means compression is done after
5036 less words are added, which is slow. A high number means more memory
5037 will be allocated.
5038
5039 After doing compression, {added} times 1024 words can be added before
5040 the {inc} limit is ignored and compression is done when any extra
5041 amount of memory is needed. A low number means there is a smaller
5042 chance of hitting the {inc} limit, less memory is used but it's
5043 slower.
5044
5045 The languages for which these numbers are important are Italian and
5046 Hungarian. The default works for when you have about 512 Mbyte. If
5047 you have 1 Gbyte you could use: >
5048 :set mkspellmem=900000,3000,800
5049< If you have less than 512 Mbyte |:mkspell| may fail for some
5050 languages, no matter what you set 'mkspellmem' to.
5051
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005053'modeline' 'ml' boolean (Vim default: on (off for root),
5054 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 local to buffer
5056 *'modelines'* *'mls'*
5057'modelines' 'mls' number (default 5)
5058 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005059 If 'modeline' is on 'modelines' gives the number of lines that is
5060 checked for set commands. If 'modeline' is off or 'modelines' is zero
5061 no lines are checked. See |modeline|.
5062 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5063 set and to the Vim default value when 'compatible' is reset.
5064
5065 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5066'modifiable' 'ma' boolean (default on)
5067 local to buffer
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005068 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005069 When off the buffer contents cannot be changed. The 'fileformat' and
5070 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005071 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072
5073 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5074'modified' 'mod' boolean (default off)
5075 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076 When on, the buffer is considered to be modified. This option is set
5077 when:
5078 1. A change was made to the text since it was last written. Using the
5079 |undo| command to go back to the original text will reset the
5080 option. But undoing changes that were made before writing the
5081 buffer will set the option again, since the text is different from
5082 when it was written.
5083 2. 'fileformat' or 'fileencoding' is different from its original
5084 value. The original value is set when the buffer is read or
5085 written. A ":set nomodified" command also resets the original
5086 values to the current values and the 'modified' option will be
5087 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005088 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005089 This option is not set when a change is made to the buffer as the
5090 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5091 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5092 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5094 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005095 Note that the text may actually be the same, e.g. 'modified' is set
5096 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097
5098 *'more'* *'nomore'*
5099'more' boolean (Vim default: on, Vi default: off)
5100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 When on, listings pause when the whole screen is filled. You will get
5102 the |more-prompt|. When this option is off there are no pauses, the
5103 listing continues until finished.
5104 NOTE: This option is set to the Vi default value when 'compatible' is
5105 set and to the Vim default value when 'compatible' is reset.
5106
5107 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005108'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5109 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005112 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5113 sysmouse and Linux console with gpm). For using the mouse in the
5114 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005116 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 v Visual mode
5118 i Insert mode
5119 c Command-line mode
5120 h all previous modes when editing a help file
5121 a all previous modes
5122 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005123 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124 :set mouse=a
5125< When the mouse is not enabled, the GUI will still use the mouse for
5126 modeless selection. This doesn't move the text cursor.
5127
5128 See |mouse-using|. Also see |'clipboard'|.
5129
5130 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005131 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132 the mouse buttons can still be used by keeping the shift key pressed.
5133 Also see the 'clipboard' option.
5134
5135 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5136'mousefocus' 'mousef' boolean (default off)
5137 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 {only works in the GUI}
5139 The window that the mouse pointer is on is automatically activated.
5140 When changing the window layout or window focus in another way, the
5141 mouse pointer is moved to the window with keyboard focus. Off is the
5142 default because it makes using the pull down menus a little goofy, as
5143 a pointer transit may activate a window unintentionally.
5144
5145 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5146'mousehide' 'mh' boolean (default on)
5147 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 {only works in the GUI}
5149 When on, the mouse pointer is hidden when characters are typed.
5150 The mouse pointer is restored when the mouse is moved.
5151
5152 *'mousemodel'* *'mousem'*
5153'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 Sets the model to use for the mouse. The name mostly specifies what
5156 the right mouse button is used for:
5157 extend Right mouse button extends a selection. This works
5158 like in an xterm.
5159 popup Right mouse button pops up a menu. The shifted left
5160 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005161 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 popup_setpos Like "popup", but the cursor will be moved to the
5163 position where the mouse was clicked, and thus the
5164 selected operation will act upon the clicked object.
5165 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005166 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 course, that right clicking outside a selection will
5168 end Visual mode.
5169 Overview of what button does what for each model:
5170 mouse extend popup(_setpos) ~
5171 left click place cursor place cursor
5172 left drag start selection start selection
5173 shift-left search word extend selection
5174 right click extend selection popup menu (place cursor)
5175 right drag extend selection -
5176 middle click paste paste
5177
5178 In the "popup" model the right mouse button produces a pop-up menu.
5179 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005180 In a terminal the popup menu works if Vim is compiled with the
5181 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182
5183 Note that you can further refine the meaning of buttons with mappings.
5184 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5185 selection (because that's handled in the GUI code directly).
5186
5187 The 'mousemodel' option is set by the |:behave| command.
5188
5189 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005190'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5191 vs:leftright,vd:lrsizing,m:no,
5192 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194 {only available when compiled with the |+mouseshape|
5195 feature}
5196 This option tells Vim what the mouse pointer should look like in
5197 different modes. The option is a comma separated list of parts, much
5198 like used for 'guicursor'. Each part consist of a mode/location-list
5199 and an argument-list:
5200 mode-list:shape,mode-list:shape,..
5201 The mode-list is a dash separated list of these modes/locations:
5202 In a normal window: ~
5203 n Normal mode
5204 v Visual mode
5205 ve Visual mode with 'selection' "exclusive" (same as 'v',
5206 if not specified)
5207 o Operator-pending mode
5208 i Insert mode
5209 r Replace mode
5210
5211 Others: ~
5212 c appending to the command-line
5213 ci inserting in the command-line
5214 cr replacing in the command-line
5215 m at the 'Hit ENTER' or 'More' prompts
5216 ml idem, but cursor in the last line
5217 e any mode, pointer below last window
5218 s any mode, pointer on a status line
5219 sd any mode, while dragging a status line
5220 vs any mode, pointer on a vertical separator line
5221 vd any mode, while dragging a vertical separator line
5222 a everywhere
5223
5224 The shape is one of the following:
5225 avail name looks like ~
5226 w x arrow Normal mouse pointer
5227 w x blank no pointer at all (use with care!)
5228 w x beam I-beam
5229 w x updown up-down sizing arrows
5230 w x leftright left-right sizing arrows
5231 w x busy The system's usual busy pointer
5232 w x no The system's usual 'no input' pointer
5233 x udsizing indicates up-down resizing
5234 x lrsizing indicates left-right resizing
5235 x crosshair like a big thin +
5236 x hand1 black hand
5237 x hand2 white hand
5238 x pencil what you write with
5239 x question big ?
5240 x rightup-arrow arrow pointing right-up
5241 w x up-arrow arrow pointing up
5242 x <number> any X11 pointer number (see X11/cursorfont.h)
5243
5244 The "avail" column contains a 'w' if the shape is available for Win32,
5245 x for X11.
5246 Any modes not specified or shapes not available use the normal mouse
5247 pointer.
5248
5249 Example: >
5250 :set mouseshape=s:udsizing,m:no
5251< will make the mouse turn to a sizing arrow over the status lines and
5252 indicate no input when the hit-enter prompt is displayed (since
5253 clicking the mouse has no effect in this state.)
5254
5255 *'mousetime'* *'mouset'*
5256'mousetime' 'mouset' number (default 500)
5257 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005258 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5259 time in msec between two mouse clicks for the second click to be
5260 recognized as a multi click.
5261
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005262 *'mzschemedll'*
5263'mzschemedll' string (default depends on the build)
5264 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005265 {only available when compiled with the |+mzscheme/dyn|
5266 feature}
5267 Specifies the name of the MzScheme shared library. The default is
5268 DYNAMIC_MZSCH_DLL which was specified at compile time.
5269 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005270 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005271 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005272 This option cannot be set from a |modeline| or in the |sandbox|, for
5273 security reasons.
5274
5275 *'mzschemegcdll'*
5276'mzschemegcdll' string (default depends on the build)
5277 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005278 {only available when compiled with the |+mzscheme/dyn|
5279 feature}
5280 Specifies the name of the MzScheme GC shared library. The default is
5281 DYNAMIC_MZGC_DLL which was specified at compile time.
5282 The value can be equal to 'mzschemedll' if it includes the GC code.
5283 Environment variables are expanded |:set_env|.
5284 This option cannot be set from a |modeline| or in the |sandbox|, for
5285 security reasons.
5286
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005287 *'mzquantum'* *'mzq'*
5288'mzquantum' 'mzq' number (default 100)
5289 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005290 {not available when compiled without the |+mzscheme|
5291 feature}
5292 The number of milliseconds between polls for MzScheme threads.
5293 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005294 NOTE: This option is set to the Vim default value when 'compatible'
5295 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005296
Bram Moolenaar071d4272004-06-13 20:20:40 +00005297 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005298'nrformats' 'nf' string (default "bin,octal,hex",
5299 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 This defines what bases Vim will consider for numbers when using the
5302 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5303 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005304 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005306 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005307 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005309 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310 considered to be hexadecimal. Example: Using CTRL-X on
5311 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005312 bin If included, numbers starting with "0b" or "0B" will be
5313 considered to be binary. Example: Using CTRL-X on
5314 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315 Numbers which simply begin with a digit in the range 1-9 are always
5316 considered decimal. This also happens for numbers that are not
5317 recognized as octal or hex.
5318
5319 *'number'* *'nu'* *'nonumber'* *'nonu'*
5320'number' 'nu' boolean (default off)
5321 local to window
5322 Print the line number in front of each line. When the 'n' option is
5323 excluded from 'cpoptions' a wrapped line will not use the column of
5324 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005325 The 'numberwidth' option can be used to set the room used for the line
5326 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327 When a long, wrapped line doesn't start with the first character, '-'
5328 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005329 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5330 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005331 *number_relativenumber*
5332 The 'relativenumber' option changes the displayed number to be
5333 relative to the cursor. Together with 'number' there are these
5334 four combinations (cursor in line 3):
5335
Bram Moolenaar3848e002016-03-19 18:42:29 +01005336 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005337 'nornu' 'nornu' 'rnu' 'rnu'
5338
5339 |apple | 1 apple | 2 apple | 2 apple
5340 |pear | 2 pear | 1 pear | 1 pear
5341 |nobody | 3 nobody | 0 nobody |3 nobody
5342 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005344 *'numberwidth'* *'nuw'*
5345'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5346 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005347 {only available when compiled with the |+linebreak|
5348 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005349 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005350 when the 'number' or 'relativenumber' option is set or printing lines
5351 with a line number. Since one space is always between the number and
5352 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005353 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005354 fit the highest line number in the buffer respectively the number of
5355 rows in the window, depending on whether 'number' or 'relativenumber'
5356 is set. Thus with the Vim default of 4 there is room for a line number
5357 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005358 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005359 NOTE: This option is set to the Vi default value when 'compatible' is
5360 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005361
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005362 *'omnifunc'* *'ofu'*
5363'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005364 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005365 {not available when compiled without the |+eval|
5366 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005367 This option specifies a function to be used for Insert mode omni
5368 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005369 See |complete-functions| for an explanation of how the function is
5370 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005371 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005372 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005373 This option cannot be set from a |modeline| or in the |sandbox|, for
5374 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005375
5376
Bram Moolenaar02467872007-05-06 13:22:01 +00005377 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005378'opendevice' 'odev' boolean (default off)
5379 global
Bram Moolenaar043545e2006-10-10 16:44:07 +00005380 {only for MS-DOS, MS-Windows and OS/2}
5381 Enable reading and writing from devices. This may get Vim stuck on a
5382 device that can be opened but doesn't actually do the I/O. Therefore
5383 it is off by default.
5384 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5385 result in editing a device.
5386
5387
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005388 *'operatorfunc'* *'opfunc'*
5389'operatorfunc' 'opfunc' string (default: empty)
5390 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005391 This option specifies a function to be called by the |g@| operator.
5392 See |:map-operator| for more info and an example.
5393
5394 This option cannot be set from a |modeline| or in the |sandbox|, for
5395 security reasons.
5396
5397
Bram Moolenaar251e1912011-06-19 05:09:16 +02005398 *'osfiletype'* *'oft'*
5399'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005400 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005401 This option was supported on RISC OS, which has been removed.
5402
Bram Moolenaar071d4272004-06-13 20:20:40 +00005403
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005404 *'packpath'* *'pp'*
5405'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005406 Directories used to find packages. See |packages|.
5407
5408
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005410'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005411 global
5412 Specifies the nroff macros that separate paragraphs. These are pairs
5413 of two letters (see |object-motions|).
5414
5415 *'paste'* *'nopaste'*
5416'paste' boolean (default off)
5417 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005418 Put Vim in Paste mode. This is useful if you want to cut or copy
5419 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420 unexpected effects.
5421 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005422 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 knows about pasting and will mostly do the right thing without 'paste'
5424 being set. The same is true for a terminal where Vim handles the
5425 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005426 This option is reset when starting the GUI. Thus if you set it in
5427 your .vimrc it will work in a terminal, but not in the GUI. Setting
5428 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5429 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005430 When the 'paste' option is switched on (also when it was already on):
5431 - mapping in Insert mode and Command-line mode is disabled
5432 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005434 - 'expandtab' is reset
5435 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 - 'revins' is reset
5437 - 'ruler' is reset
5438 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005439 - 'smartindent' is reset
5440 - 'smarttab' is reset
5441 - 'softtabstop' is set to 0
5442 - 'textwidth' is set to 0
5443 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005446 - 'indentexpr'
5447 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448 NOTE: When you start editing another file while the 'paste' option is
5449 on, settings from the modelines or autocommands may change the
5450 settings again, causing trouble when pasting text. You might want to
5451 set the 'paste' option again.
5452 When the 'paste' option is reset the mentioned options are restored to
5453 the value before the moment 'paste' was switched from off to on.
5454 Resetting 'paste' before ever setting it does not have any effect.
5455 Since mapping doesn't work while 'paste' is active, you need to use
5456 the 'pastetoggle' option to toggle the 'paste' option with some key.
5457
5458 *'pastetoggle'* *'pt'*
5459'pastetoggle' 'pt' string (default "")
5460 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461 When non-empty, specifies the key sequence that toggles the 'paste'
5462 option. This is like specifying a mapping: >
5463 :map {keys} :set invpaste<CR>
5464< Where {keys} is the value of 'pastetoggle'.
5465 The difference is that it will work even when 'paste' is set.
5466 'pastetoggle' works in Insert mode and Normal mode, but not in
5467 Command-line mode.
5468 Mappings are checked first, thus overrule 'pastetoggle'. However,
5469 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5470 this: >
5471 :map <F10> :set paste<CR>
5472 :map <F11> :set nopaste<CR>
5473 :imap <F10> <C-O>:set paste<CR>
5474 :imap <F11> <nop>
5475 :set pastetoggle=<F11>
5476< This will make <F10> start paste mode and <F11> stop paste mode.
5477 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5478 mode everything is inserted literally, except the 'pastetoggle' key
5479 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005480 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481
5482 *'pex'* *'patchexpr'*
5483'patchexpr' 'pex' string (default "")
5484 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005485 {not available when compiled without the |+diff|
5486 feature}
5487 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005488 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489
Bram Moolenaardbc28022014-07-26 13:40:44 +02005490 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491'patchmode' 'pm' string (default "")
5492 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493 When non-empty the oldest version of a file is kept. This can be used
5494 to keep the original version of a file if you are changing files in a
5495 source distribution. Only the first time that a file is written a
5496 copy of the original file will be kept. The name of the copy is the
5497 name of the original file with the string in the 'patchmode' option
5498 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005499 ".orig" or ".org". 'backupdir' must not be empty for this to work
5500 (Detail: The backup file is renamed to the patchmode file after the
5501 new file has been successfully written, that's why it must be possible
5502 to write a backup file). If there was no file to be backed up, an
5503 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 When the 'backupskip' pattern matches, a patchmode file is not made.
5505 Using 'patchmode' for compressed files appends the extension at the
5506 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5507 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005508 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005510 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005511'path' 'pa' string (default on Unix: ".,/usr/include,,"
5512 on OS/2: ".,/emx/include,,"
5513 other systems: ".,,")
5514 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005516 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5517 provided that the file being searched for has a relative path (not
5518 starting with "/", "./" or "../"). The directories in the 'path'
5519 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005520 - Use commas to separate directory names: >
5521 :set path=.,/usr/local/include,/usr/include
5522< - Spaces can also be used to separate directory names (for backwards
5523 compatibility with version 3.0). To have a space in a directory
5524 name, precede it with an extra backslash, and escape the space: >
5525 :set path=.,/dir/with\\\ space
5526< - To include a comma in a directory name precede it with an extra
5527 backslash: >
5528 :set path=.,/dir/with\\,comma
5529< - To search relative to the directory of the current file, use: >
5530 :set path=.
5531< - To search in the current directory use an empty string between two
5532 commas: >
5533 :set path=,,
5534< - A directory name may end in a ':' or '/'.
5535 - Environment variables are expanded |:set_env|.
5536 - When using |netrw.vim| URLs can be used. For example, adding
5537 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005538 - Search upwards and downwards in a directory tree using "*", "**" and
5539 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 {not available when compiled without the |+path_extra| feature}
5541 - Careful with '\' characters, type two to get one in the option: >
5542 :set path=.,c:\\include
5543< Or just use '/' instead: >
5544 :set path=.,c:/include
5545< Don't forget "." or files won't even be found in the same directory as
5546 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005547 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 it is something like 256 or 1024 characters.
5549 You can check if all the include files are found, using the value of
5550 'path', see |:checkpath|.
5551 The use of |:set+=| and |:set-=| is preferred when adding or removing
5552 directories from the list. This avoids problems when a future version
5553 uses another default. To remove the current directory use: >
5554 :set path-=
5555< To add the current directory use: >
5556 :set path+=
5557< To use an environment variable, you probably need to replace the
5558 separator. Here is an example to append $INCL, in which directory
5559 names are separated with a semi-colon: >
5560 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5561< Replace the ';' with a ':' or whatever separator is used. Note that
5562 this doesn't work when $INCL contains a comma or white space.
5563
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005564 *'perldll'*
5565'perldll' string (default depends on the build)
5566 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005567 {only available when compiled with the |+perl/dyn|
5568 feature}
5569 Specifies the name of the Perl shared library. The default is
5570 DYNAMIC_PERL_DLL, which was specified at compile time.
5571 Environment variables are expanded |:set_env|.
5572 This option cannot be set from a |modeline| or in the |sandbox|, for
5573 security reasons.
5574
Bram Moolenaar071d4272004-06-13 20:20:40 +00005575 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5576'preserveindent' 'pi' boolean (default off)
5577 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005578 When changing the indent of the current line, preserve as much of the
5579 indent structure as possible. Normally the indent is replaced by a
5580 series of tabs followed by spaces as required (unless |'expandtab'| is
5581 enabled, in which case only spaces are used). Enabling this option
5582 means the indent will preserve as many existing characters as possible
5583 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005584 'expandtab' does not apply to the preserved white space, a Tab remains
5585 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586 NOTE: When using ">>" multiple times the resulting indent is a mix of
5587 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005588 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 Also see 'copyindent'.
5590 Use |:retab| to clean up white space.
5591
5592 *'previewheight'* *'pvh'*
5593'previewheight' 'pvh' number (default 12)
5594 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005595 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005596 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597 Default height for a preview window. Used for |:ptag| and associated
5598 commands. Used for |CTRL-W_}| when no count is given.
5599
5600 *'previewwindow'* *'nopreviewwindow'*
5601 *'pvw'* *'nopvw'* *E590*
5602'previewwindow' 'pvw' boolean (default off)
5603 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005605 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005606 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607 set. It's normally not set directly, but by using one of the commands
5608 |:ptag|, |:pedit|, etc.
5609
5610 *'printdevice'* *'pdev'*
5611'printdevice' 'pdev' string (default empty)
5612 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613 {only available when compiled with the |+printer|
5614 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005615 The name of the printer to be used for |:hardcopy|.
5616 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005617 This option cannot be set from a |modeline| or in the |sandbox|, for
5618 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619
Bram Moolenaar8299df92004-07-10 09:47:34 +00005620 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005621'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623 {only available when compiled with the |+printer|
5624 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005625 Sets the character encoding used when printing.
5626 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627
5628 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005629'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631 {only available when compiled with the |+printer|
5632 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005633 Expression used to print the PostScript produced with |:hardcopy|.
5634 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005635 This option cannot be set from a |modeline| or in the |sandbox|, for
5636 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005637
Bram Moolenaar8299df92004-07-10 09:47:34 +00005638 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005639'printfont' 'pfn' string (default "courier")
5640 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005641 {only available when compiled with the |+printer|
5642 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005643 The name of the font that will be used for |:hardcopy|.
5644 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005645
5646 *'printheader'* *'pheader'*
5647'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5648 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649 {only available when compiled with the |+printer|
5650 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005651 The format of the header produced in |:hardcopy| output.
5652 See |pheader-option|.
5653
5654 *'printmbcharset'* *'pmbcs'*
5655'printmbcharset' 'pmbcs' string (default "")
5656 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005657 {only available when compiled with the |+printer|
5658 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005659 The CJK character set to be used for CJK output from |:hardcopy|.
5660 See |pmbcs-option|.
5661
5662 *'printmbfont'* *'pmbfn'*
5663'printmbfont' 'pmbfn' string (default "")
5664 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005665 {only available when compiled with the |+printer|
5666 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005667 List of font names to be used for CJK output from |:hardcopy|.
5668 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669
5670 *'printoptions'* *'popt'*
5671'printoptions' 'popt' string (default "")
5672 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005674 List of items that control the format of the output of |:hardcopy|.
5675 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005677 *'prompt'* *'noprompt'*
5678'prompt' boolean (default on)
5679 global
5680 When on a ":" prompt is used in Ex mode.
5681
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005682 *'pumheight'* *'ph'*
5683'pumheight' 'ph' number (default 0)
5684 global
5685 {not available when compiled without the
5686 |+insert_expand| feature}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005687 Determines the maximum number of items to show in the popup menu for
5688 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005689 |ins-completion-menu|.
5690
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005691 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005692'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005693 global
5694 {not available when compiled without the
5695 |+insert_expand| feature}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005696 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005697 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005698
Bram Moolenaard94464e2015-11-02 15:28:18 +01005699 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005700'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005701 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005702 {only available when compiled with the |+python/dyn|
5703 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005704 Specifies the name of the Python 2.x shared library. The default is
5705 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005706 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005707 This option cannot be set from a |modeline| or in the |sandbox|, for
5708 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005709
Bram Moolenaar94073162018-01-31 21:49:05 +01005710 *'pythonhome'*
5711'pythonhome' string (default "")
5712 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005713 {only available when compiled with the |+python/dyn|
5714 feature}
5715 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5716 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5717 which was specified at compile time, will be used for the Python 2.x
5718 home directory.
5719 Environment variables are expanded |:set_env|.
5720 This option cannot be set from a |modeline| or in the |sandbox|, for
5721 security reasons.
5722
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005723 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005724'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005725 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005726 {only available when compiled with the |+python3/dyn|
5727 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005728 Specifies the name of the Python 3 shared library. The default is
5729 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005730 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005731 This option cannot be set from a |modeline| or in the |sandbox|, for
5732 security reasons.
5733
Bram Moolenaar94073162018-01-31 21:49:05 +01005734 *'pythonthreehome'*
5735'pythonthreehome' string (default "")
5736 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005737 {only available when compiled with the |+python3/dyn|
5738 feature}
5739 Specifies the name of the Python 3 home directory. When
5740 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5741 PYTHON3_HOME, which was specified at compile time, will be used for
5742 the Python 3 home directory.
5743 Environment variables are expanded |:set_env|.
5744 This option cannot be set from a |modeline| or in the |sandbox|, for
5745 security reasons.
5746
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005747 *'pyxversion'* *'pyx'*
5748'pyxversion' 'pyx' number (default depends on the build)
5749 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005750 {only available when compiled with the |+python| or
5751 the |+python3| feature}
5752 Specifies the python version used for pyx* functions and commands
5753 |python_x|. The default value is as follows:
5754
5755 Compiled with Default ~
5756 |+python| and |+python3| 0
5757 only |+python| 2
5758 only |+python3| 3
5759
5760 Available values are 0, 2 and 3.
5761 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5762 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5763 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5764 to 2 if Python 2 is available.
5765 See also: |has-pythonx|
5766
5767 If Vim is compiled with only |+python| or |+python3| setting
5768 'pyxversion' has no effect. The pyx* functions and commands are
5769 always the same as the compiled version.
5770
5771 This option cannot be set from a |modeline| or in the |sandbox|, for
5772 security reasons.
5773
Bram Moolenaar677ee682005-01-27 14:41:15 +00005774 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005775'quoteescape' 'qe' string (default "\")
5776 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005777 The characters that are used to escape quotes in a string. Used for
5778 objects like a', a" and a` |a'|.
5779 When one of the characters in this option is found inside a string,
5780 the following character will be skipped. The default value makes the
5781 text "foo\"bar\\" considered to be one string.
5782
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5784'readonly' 'ro' boolean (default off)
5785 local to buffer
5786 If on, writes fail unless you use a '!'. Protects you from
5787 accidentally overwriting a file. Default on when Vim is started
5788 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005789 When using ":w!" the 'readonly' option is reset for the current
5790 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005791 When using the ":view" command the 'readonly' option is set for the
5792 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005793 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005795 *'redrawtime'* *'rdt'*
5796'redrawtime' 'rdt' number (default 2000)
5797 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005798 {only available when compiled with the |+reltime|
5799 feature}
5800 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005801 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005802 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005803 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005804 matches will be highlighted.
5805 For syntax highlighting the time applies per window. When over the
5806 limit syntax highlighting is disabled until |CTRL-L| is used.
5807 This is used to avoid that Vim hangs when using a very complicated
5808 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005809
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005810 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005811'regexpengine' 're' number (default 0)
5812 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005813 This selects the default regexp engine. |two-engines|
5814 The possible values are:
5815 0 automatic selection
5816 1 old engine
5817 2 NFA engine
5818 Note that when using the NFA engine and the pattern contains something
5819 that is not supported the pattern will not match. This is only useful
5820 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005821 Using automatic selection enables Vim to switch the engine, if the
5822 default engine becomes too costly. E.g., when the NFA engine uses too
5823 many states. This should prevent Vim from hanging on a combination of
5824 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005825
Bram Moolenaar64486672010-05-16 15:46:46 +02005826 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5827'relativenumber' 'rnu' boolean (default off)
5828 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005829 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005830 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005831 precede some vertical motion commands (e.g. j k + -) with, without
5832 having to calculate it yourself. Especially useful in combination with
5833 other commands (e.g. y d c < > gq gw =).
5834 When the 'n' option is excluded from 'cpoptions' a wrapped
5835 line will not use the column of line numbers (this is the default when
5836 'compatible' isn't set).
5837 The 'numberwidth' option can be used to set the room used for the line
5838 number.
5839 When a long, wrapped line doesn't start with the first character, '-'
5840 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005841 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5842 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005843
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005844 The number in front of the cursor line also depends on the value of
5845 'number', see |number_relativenumber| for all combinations of the two
5846 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005847
Bram Moolenaar071d4272004-06-13 20:20:40 +00005848 *'remap'* *'noremap'*
5849'remap' boolean (default on)
5850 global
5851 Allows for mappings to work recursively. If you do not want this for
5852 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005853 NOTE: To avoid portability problems with Vim scripts, always keep
5854 this option at the default "on". Only switch it off when working with
5855 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005857 *'renderoptions'* *'rop'*
5858'renderoptions' 'rop' string (default: empty)
5859 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005860 {only available when compiled with GUI and DIRECTX on
5861 MS-Windows}
5862 Select a text renderer and set its options. The options depend on the
5863 renderer.
5864
5865 Syntax: >
5866 set rop=type:{renderer}(,{name}:{value})*
5867<
5868 Currently, only one optional renderer is available.
5869
5870 render behavior ~
5871 directx Vim will draw text using DirectX (DirectWrite). It makes
5872 drawn glyphs more beautiful than default GDI.
5873 It requires 'encoding' is "utf-8", and only works on
5874 MS-Windows Vista or newer version.
5875
5876 Options:
5877 name meaning type value ~
5878 gamma gamma float 1.0 - 2.2 (maybe)
5879 contrast enhancedContrast float (unknown)
5880 level clearTypeLevel float (unknown)
5881 geom pixelGeometry int 0 - 2 (see below)
5882 renmode renderingMode int 0 - 6 (see below)
5883 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01005884 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005885
Bram Moolenaar92467d32017-12-05 13:22:16 +01005886 See this URL for detail (except for scrlines):
5887 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005888
5889 For geom: structure of a device pixel.
5890 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5891 1 - DWRITE_PIXEL_GEOMETRY_RGB
5892 2 - DWRITE_PIXEL_GEOMETRY_BGR
5893
5894 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005895 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005896
5897 For renmode: method of rendering glyphs.
5898 0 - DWRITE_RENDERING_MODE_DEFAULT
5899 1 - DWRITE_RENDERING_MODE_ALIASED
5900 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5901 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5902 4 - DWRITE_RENDERING_MODE_NATURAL
5903 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5904 6 - DWRITE_RENDERING_MODE_OUTLINE
5905
5906 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005907 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005908
5909 For taamode: antialiasing mode used for drawing text.
5910 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5911 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5912 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5913 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5914
5915 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005916 https://msdn.microsoft.com/en-us/library/dd368170.aspx
5917
Bram Moolenaara338adc2018-01-31 20:51:47 +01005918 For scrlines:
5919 This was used for optimizing scrolling behavior, however this
5920 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005921
5922 Example: >
5923 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005924 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005925 set rop=type:directx
5926<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005927 If select a raster font (Courier, Terminal or FixedSys which
5928 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01005929 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005930
5931 NOTE: It is known that some fonts and options combination
5932 causes trouble on drawing glyphs.
5933
Bram Moolenaar92467d32017-12-05 13:22:16 +01005934 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005935 special made fonts (True-Type fonts which includes only
5936 bitmap glyphs).
5937 - 'taamode:3' will not work with some vector fonts.
5938
5939 NOTE: With this option, you can display colored emoji
5940 (emoticon) in Windows 8.1 or later. To display colored emoji,
5941 there are some conditions which you should notice.
5942
5943 - If your font includes non-colored emoji already, it will
5944 be used.
5945 - If your font doesn't have emoji, the system chooses an
5946 alternative symbol font. On Windows 10, "Segoe UI Emoji"
5947 will be used.
5948 - When this alternative font didn't have fixed width glyph,
5949 emoji might be rendered beyond the bounding box of drawing
5950 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005951
5952 Other render types are currently not supported.
5953
Bram Moolenaar071d4272004-06-13 20:20:40 +00005954 *'report'*
5955'report' number (default 2)
5956 global
5957 Threshold for reporting number of lines changed. When the number of
5958 changed lines is more than 'report' a message will be given for most
5959 ":" commands. If you want it always, set 'report' to 0.
5960 For the ":substitute" command the number of substitutions is used
5961 instead of the number of lines.
5962
5963 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5964'restorescreen' 'rs' boolean (default on)
5965 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005966 {only in Windows 95/NT console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967 When set, the screen contents is restored when exiting Vim. This also
5968 happens when executing external commands.
5969
5970 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5971 options in your .vimrc. To disable restoring:
5972 set t_ti= t_te=
5973 To enable restoring (for an xterm):
5974 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5975 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5976
5977 *'revins'* *'ri'* *'norevins'* *'nori'*
5978'revins' 'ri' boolean (default off)
5979 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005980 {only available when compiled with the |+rightleft|
5981 feature}
5982 Inserting characters in Insert mode will work backwards. See "typing
5983 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5984 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02005985 NOTE: This option is reset when 'compatible' is set.
5986 This option is reset when 'paste' is set and restored when 'paste' is
5987 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005988
5989 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5990'rightleft' 'rl' boolean (default off)
5991 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005992 {only available when compiled with the |+rightleft|
5993 feature}
5994 When on, display orientation becomes right-to-left, i.e., characters
5995 that are stored in the file appear from the right to the left.
5996 Using this option, it is possible to edit files for languages that
5997 are written from the right to the left such as Hebrew and Arabic.
5998 This option is per window, so it is possible to edit mixed files
5999 simultaneously, or to view the same file in both ways (this is
6000 useful whenever you have a mixed text file with both right-to-left
6001 and left-to-right strings so that both sets are displayed properly
6002 in different windows). Also see |rileft.txt|.
6003
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006004 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005'rightleftcmd' 'rlc' string (default "search")
6006 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007 {only available when compiled with the |+rightleft|
6008 feature}
6009 Each word in this option enables the command line editing to work in
6010 right-to-left mode for a group of commands:
6011
6012 search "/" and "?" commands
6013
6014 This is useful for languages such as Hebrew, Arabic and Farsi.
6015 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6016
Bram Moolenaard94464e2015-11-02 15:28:18 +01006017 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006018'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006019 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006020 {only available when compiled with the |+ruby/dyn|
6021 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006022 Specifies the name of the Ruby shared library. The default is
6023 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006024 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006025 This option cannot be set from a |modeline| or in the |sandbox|, for
6026 security reasons.
6027
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006029'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 {not available when compiled without the
6032 |+cmdline_info| feature}
6033 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006034 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006035 text in the file is shown on the far right:
6036 Top first line is visible
6037 Bot last line is visible
6038 All first and last line are visible
6039 45% relative position in the file
6040 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006041 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006043 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044 this option takes precedence over 'ruler' and 'rulerformat'
6045 If the number of characters displayed is different from the number of
6046 bytes in the text (e.g., for a TAB or a multi-byte character), both
6047 the text column (byte number) and the screen column are shown,
6048 separated with a dash.
6049 For an empty line "0-1" is shown.
6050 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006051 This option is reset when 'paste' is set and restored when 'paste' is
6052 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006053 If you don't want to see the ruler all the time but want to know where
6054 you are, use "g CTRL-G" |g_CTRL-G|.
6055 NOTE: This option is reset when 'compatible' is set.
6056
6057 *'rulerformat'* *'ruf'*
6058'rulerformat' 'ruf' string (default empty)
6059 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006060 {not available when compiled without the |+statusline|
6061 feature}
6062 When this option is not empty, it determines the content of the ruler
6063 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006064 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006065 The default ruler width is 17 characters. To make the ruler 15
6066 characters wide, put "%15(" at the start and "%)" at the end.
6067 Example: >
6068 :set rulerformat=%15(%c%V\ %p%%%)
6069<
6070 *'runtimepath'* *'rtp'* *vimfiles*
6071'runtimepath' 'rtp' string (default:
6072 Unix: "$HOME/.vim,
6073 $VIM/vimfiles,
6074 $VIMRUNTIME,
6075 $VIM/vimfiles/after,
6076 $HOME/.vim/after"
6077 Amiga: "home:vimfiles,
6078 $VIM/vimfiles,
6079 $VIMRUNTIME,
6080 $VIM/vimfiles/after,
6081 home:vimfiles/after"
6082 PC, OS/2: "$HOME/vimfiles,
6083 $VIM/vimfiles,
6084 $VIMRUNTIME,
6085 $VIM/vimfiles/after,
6086 $HOME/vimfiles/after"
6087 Macintosh: "$VIM:vimfiles,
6088 $VIMRUNTIME,
6089 $VIM:vimfiles:after"
6090 RISC-OS: "Choices:vimfiles,
6091 $VIMRUNTIME,
6092 Choices:vimfiles/after"
6093 VMS: "sys$login:vimfiles,
6094 $VIM/vimfiles,
6095 $VIMRUNTIME,
6096 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006097 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006099 This is a list of directories which will be searched for runtime
6100 files:
6101 filetype.vim filetypes by file name |new-filetype|
6102 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006103 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104 colors/ color scheme files |:colorscheme|
6105 compiler/ compiler files |:compiler|
6106 doc/ documentation |write-local-help|
6107 ftplugin/ filetype plugins |write-filetype-plugin|
6108 indent/ indent scripts |indent-expression|
6109 keymap/ key mapping files |mbyte-keymap|
6110 lang/ menu translations |:menutrans|
6111 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006112 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006113 plugin/ plugin scripts |write-plugin|
6114 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006115 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006116 syntax/ syntax files |mysyntaxfile|
6117 tutor/ files for vimtutor |tutor|
6118
6119 And any other file searched for with the |:runtime| command.
6120
6121 The defaults for most systems are setup to search five locations:
6122 1. In your home directory, for your personal preferences.
6123 2. In a system-wide Vim directory, for preferences from the system
6124 administrator.
6125 3. In $VIMRUNTIME, for files distributed with Vim.
6126 *after-directory*
6127 4. In the "after" directory in the system-wide Vim directory. This is
6128 for the system administrator to overrule or add to the distributed
6129 defaults (rarely needed)
6130 5. In the "after" directory in your home directory. This is for
6131 personal preferences to overrule or add to the distributed defaults
6132 or system-wide settings (rarely needed).
6133
Bram Moolenaard0796902016-09-16 20:02:31 +02006134 More entries are added when using |packages|. If it gets very long
6135 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6136 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006137
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6139 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006140 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 wildcards.
6142 See |:runtime|.
6143 Example: >
6144 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6145< This will use the directory "~/vimruntime" first (containing your
6146 personal Vim runtime files), then "/mygroup/vim" (shared between a
6147 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6148 files).
6149 You probably should always include $VIMRUNTIME somewhere, to use the
6150 distributed runtime files. You can put a directory before $VIMRUNTIME
6151 to find files which replace a distributed runtime files. You can put
6152 a directory after $VIMRUNTIME to find files which add to distributed
6153 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006154 When Vim is started with |--clean| the home directory entries are not
6155 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156 This option cannot be set from a |modeline| or in the |sandbox|, for
6157 security reasons.
6158
6159 *'scroll'* *'scr'*
6160'scroll' 'scr' number (default: half the window height)
6161 local to window
6162 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6163 set to half the number of lines in the window when the window size
6164 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006165 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006166 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167
6168 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6169'scrollbind' 'scb' boolean (default off)
6170 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 See also |scroll-binding|. When this option is set, the current
6172 window scrolls as other scrollbind windows (windows that also have
6173 this option set) scroll. This option is useful for viewing the
6174 differences between two versions of a file, see 'diff'.
6175 See |'scrollopt'| for options that determine how this option should be
6176 interpreted.
6177 This option is mostly reset when splitting a window to edit another
6178 file. This means that ":split | edit file" results in two windows
6179 with scroll-binding, but ":split file" does not.
6180
6181 *'scrolljump'* *'sj'*
6182'scrolljump' 'sj' number (default 1)
6183 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006184 Minimal number of lines to scroll when the cursor gets off the
6185 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6186 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006187 When set to a negative number from -1 to -100 this is used as the
6188 percentage of the window height. Thus -50 scrolls half the window
6189 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 NOTE: This option is set to 1 when 'compatible' is set.
6191
6192 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006193'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006194 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195 Minimal number of screen lines to keep above and below the cursor.
6196 This will make some context visible around where you are working. If
6197 you set it to a very large value (999) the cursor line will always be
6198 in the middle of the window (except at the start or end of the file or
6199 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006200 After using the local value, go back the global value with one of
6201 these two: >
6202 setlocal scrolloff<
6203 setlocal scrolloff=-1
6204< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205 NOTE: This option is set to 0 when 'compatible' is set.
6206
6207 *'scrollopt'* *'sbo'*
6208'scrollopt' 'sbo' string (default "ver,jump")
6209 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006211 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6212 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 The following words are available:
6214 ver Bind vertical scrolling for 'scrollbind' windows
6215 hor Bind horizontal scrolling for 'scrollbind' windows
6216 jump Applies to the offset between two windows for vertical
6217 scrolling. This offset is the difference in the first
6218 displayed line of the bound windows. When moving
6219 around in a window, another 'scrollbind' window may
6220 reach a position before the start or after the end of
6221 the buffer. The offset is not changed though, when
6222 moving back the 'scrollbind' window will try to scroll
6223 to the desired position when possible.
6224 When now making that window the current one, two
6225 things can be done with the relative offset:
6226 1. When "jump" is not included, the relative offset is
6227 adjusted for the scroll position in the new current
6228 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006229 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006230 2. When "jump" is included, the other windows are
6231 scrolled to keep the same relative offset. When
6232 going back to the other window, it still uses the
6233 same relative offset.
6234 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006235 When 'diff' mode is active there always is vertical scroll binding,
6236 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237
6238 *'sections'* *'sect'*
6239'sections' 'sect' string (default "SHNHH HUnhsh")
6240 global
6241 Specifies the nroff macros that separate sections. These are pairs of
6242 two letters (See |object-motions|). The default makes a section start
6243 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6244
6245 *'secure'* *'nosecure'* *E523*
6246'secure' boolean (default off)
6247 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248 When on, ":autocmd", shell and write commands are not allowed in
6249 ".vimrc" and ".exrc" in the current directory and map commands are
6250 displayed. Switch it off only if you know that you will not run into
6251 problems, or when the 'exrc' option is off. On Unix this option is
6252 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006253 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006254 'secure' at the end of your ~/.vimrc then.
6255 This option cannot be set from a |modeline| or in the |sandbox|, for
6256 security reasons.
6257
6258 *'selection'* *'sel'*
6259'selection' 'sel' string (default "inclusive")
6260 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 This option defines the behavior of the selection. It is only used
6262 in Visual and Select mode.
6263 Possible values:
6264 value past line inclusive ~
6265 old no yes
6266 inclusive yes yes
6267 exclusive yes no
6268 "past line" means that the cursor is allowed to be positioned one
6269 character past the line.
6270 "inclusive" means that the last character of the selection is included
6271 in an operation. For example, when "x" is used to delete the
6272 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006273 When "old" is used and 'virtualedit' allows the cursor to move past
6274 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006275 Note that when "exclusive" is used and selecting from the end
6276 backwards, you cannot include the last character of a line, when
6277 starting in Normal mode and 'virtualedit' empty.
6278
6279 The 'selection' option is set by the |:behave| command.
6280
6281 *'selectmode'* *'slm'*
6282'selectmode' 'slm' string (default "")
6283 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284 This is a comma separated list of words, which specifies when to start
6285 Select mode instead of Visual mode, when a selection is started.
6286 Possible values:
6287 mouse when using the mouse
6288 key when using shifted special keys
6289 cmd when using "v", "V" or CTRL-V
6290 See |Select-mode|.
6291 The 'selectmode' option is set by the |:behave| command.
6292
6293 *'sessionoptions'* *'ssop'*
6294'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006295 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006296 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006297 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298 feature}
6299 Changes the effect of the |:mksession| command. It is a comma
6300 separated list of words. Each word enables saving and restoring
6301 something:
6302 word save and restore ~
6303 blank empty windows
6304 buffers hidden and unloaded buffers, not just those in windows
6305 curdir the current directory
6306 folds manually created folds, opened/closed folds and local
6307 fold options
6308 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006309 and contain at least one lowercase letter. Only
6310 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311 help the help window
6312 localoptions options and mappings local to a window or buffer (not
6313 global values for local options)
6314 options all options and mappings (also global values for local
6315 options)
6316 resize size of the Vim window: 'lines' and 'columns'
6317 sesdir the directory in which the session file is located
6318 will become the current directory (useful with
6319 projects accessed over a network from different
6320 systems)
6321 slash backslashes in file names replaced with forward
6322 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006323 tabpages all tab pages; without this only the current tab page
6324 is restored, so that you can make a session for each
6325 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006326 terminal include terminal windows where the command can be
6327 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006328 unix with Unix end-of-line format (single <NL>), even when
6329 on Windows or DOS
6330 winpos position of the whole Vim window
6331 winsize window sizes
6332
6333 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006334 When neither "curdir" nor "sesdir" is included, file names are stored
6335 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 "slash" and "unix" are useful on Windows when sharing session files
6337 with Unix. The Unix version of Vim cannot source dos format scripts,
6338 but the Windows version of Vim can source unix format scripts.
6339
6340 *'shell'* *'sh'* *E91*
6341'shell' 'sh' string (default $SHELL or "sh",
6342 MS-DOS and Win32: "command.com" or
6343 "cmd.exe", OS/2: "cmd")
6344 global
6345 Name of the shell to use for ! and :! commands. When changing the
6346 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6347 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006348 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349 See |option-backslash| about including spaces and backslashes.
6350 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006351
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006353 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006354 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6355< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006356 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006358 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006360 Example with escaped space (Vim will do this when initializing the
6361 option from $SHELL): >
6362 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006363< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006364 backslashes are consumed by `:set`.
6365
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366 Under MS-Windows, when the executable ends in ".com" it must be
6367 included. Thus setting the shell to "command.com" or "4dos.com"
6368 works, but "command" and "4dos" do not work for all commands (e.g.,
6369 filtering).
6370 For unknown reasons, when using "4dos.com" the current directory is
6371 changed to "C:\". To avoid this set 'shell' like this: >
6372 :set shell=command.com\ /c\ 4dos
6373< This option cannot be set from a |modeline| or in the |sandbox|, for
6374 security reasons.
6375
6376 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006377'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006378 MS-DOS and Win32, when 'shell' does not
6379 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6382 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6383 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006384 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006385 On Unix it can have more than one flag. Each white space separated
6386 part is passed as an argument to the shell command.
6387 See |option-backslash| about including spaces and backslashes.
6388 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006389 This option cannot be set from a |modeline| or in the |sandbox|, for
6390 security reasons.
6391
6392 *'shellpipe'* *'sp'*
6393'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6394 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395 {not available when compiled without the |+quickfix|
6396 feature}
6397 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006398 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 including spaces and backslashes.
6400 The name of the temporary file can be represented by "%s" if necessary
6401 (the file name is appended automatically if no %s appears in the value
6402 of this option).
6403 For the Amiga and MS-DOS the default is ">". The output is directly
6404 saved in a file and not echoed to the screen.
6405 For Unix the default it "| tee". The stdout of the compiler is saved
6406 in a file and echoed to the screen. If the 'shell' option is "csh" or
6407 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006408 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6409 default becomes "2>&1| tee". This means that stderr is also included.
6410 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6411 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 The initialization of this option is done after reading the ".vimrc"
6413 and the other initializations, so that when the 'shell' option is set
6414 there, the 'shellpipe' option changes automatically, unless it was
6415 explicitly set before.
6416 When 'shellpipe' is set to an empty string, no redirection of the
6417 ":make" output will be done. This is useful if you use a 'makeprg'
6418 that writes to 'makeef' by itself. If you want no piping, but do
6419 want to include the 'makeef', set 'shellpipe' to a single space.
6420 Don't forget to precede the space with a backslash: ":set sp=\ ".
6421 In the future pipes may be used for filtering and this option will
6422 become obsolete (at least for Unix).
6423 This option cannot be set from a |modeline| or in the |sandbox|, for
6424 security reasons.
6425
6426 *'shellquote'* *'shq'*
6427'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6428 contains "sh" somewhere: "\"")
6429 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 Quoting character(s), put around the command passed to the shell, for
6431 the "!" and ":!" commands. The redirection is kept outside of the
6432 quoting. See 'shellxquote' to include the redirection. It's
6433 probably not useful to set both options.
6434 This is an empty string by default. Only known to be useful for
6435 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6436 or bash, where it should be "\"". The default is adjusted according
6437 the value of 'shell', to reduce the need to set this option by the
6438 user. See |dos-shell|.
6439 This option cannot be set from a |modeline| or in the |sandbox|, for
6440 security reasons.
6441
6442 *'shellredir'* *'srr'*
6443'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6444 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445 String to be used to put the output of a filter command in a temporary
6446 file. See also |:!|. See |option-backslash| about including spaces
6447 and backslashes.
6448 The name of the temporary file can be represented by "%s" if necessary
6449 (the file name is appended automatically if no %s appears in the value
6450 of this option).
6451 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6452 or "zsh" during initializations, the default becomes ">&". If the
6453 'shell' option is "sh", "ksh" or "bash" the default becomes
6454 ">%s 2>&1". This means that stderr is also included.
6455 For Win32, the Unix checks are done and additionally "cmd" is checked
6456 for, which makes the default ">%s 2>&1". Also, the same names with
6457 ".exe" appended are checked for.
6458 The initialization of this option is done after reading the ".vimrc"
6459 and the other initializations, so that when the 'shell' option is set
6460 there, the 'shellredir' option changes automatically unless it was
6461 explicitly set before.
6462 In the future pipes may be used for filtering and this option will
6463 become obsolete (at least for Unix).
6464 This option cannot be set from a |modeline| or in the |sandbox|, for
6465 security reasons.
6466
6467 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6468'shellslash' 'ssl' boolean (default off)
6469 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006470 {only for MSDOS, MS-Windows and OS/2}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006471 When set, a forward slash is used when expanding file names. This is
6472 useful when a Unix-like shell is used instead of command.com or
6473 cmd.exe. Backward slashes can still be typed, but they are changed to
6474 forward slashes by Vim.
6475 Note that setting or resetting this option has no effect for some
6476 existing file names, thus this option needs to be set before opening
6477 any file for best results. This might change in the future.
6478 'shellslash' only works when a backslash can be used as a path
6479 separator. To test if this is so use: >
6480 if exists('+shellslash')
6481<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006482 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6483'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6484 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006485 When on, use temp files for shell commands. When off use a pipe.
6486 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006487 Currently a pipe is only supported on Unix and MS-Windows 2K and
6488 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006489 :if has("filterpipe")
6490< The advantage of using a pipe is that nobody can read the temp file
6491 and the 'shell' command does not need to support redirection.
6492 The advantage of using a temp file is that the file type and encoding
6493 can be detected.
6494 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6495 |FilterWritePost| autocommands event are not triggered when
6496 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006497 The `system()` function does not respect this option and always uses
6498 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006499 NOTE: This option is set to the Vim default value when 'compatible'
6500 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006501
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502 *'shelltype'* *'st'*
6503'shelltype' 'st' number (default 0)
6504 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006505 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 On the Amiga this option influences the way how the commands work
6507 which use a shell.
6508 0 and 1: always use the shell
6509 2 and 3: use the shell only to filter lines
6510 4 and 5: use shell only for ':sh' command
6511 When not using the shell, the command is executed directly.
6512
6513 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6514 1 and 3: use "shell cmd" to start external commands
6515
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006516 *'shellxescape'* *'sxe'*
6517'shellxescape' 'sxe' string (default: "";
6518 for MS-DOS and MS-Windows: "\"&|<>()@^")
6519 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006520 When 'shellxquote' is set to "(" then the characters listed in this
6521 option will be escaped with a '^' character. This makes it possible
6522 to execute most external commands with cmd.exe.
6523
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 *'shellxquote'* *'sxq'*
6525'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006526 for Win32, when 'shell' is cmd.exe: "("
6527 for Win32, when 'shell' contains "sh"
6528 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529 for Unix, when using system(): "\"")
6530 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531 Quoting character(s), put around the command passed to the shell, for
6532 the "!" and ":!" commands. Includes the redirection. See
6533 'shellquote' to exclude the redirection. It's probably not useful
6534 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006535 When the value is '(' then ')' is appended. When the value is '"('
6536 then ')"' is appended.
6537 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006538 This is an empty string by default on most systems, but is known to be
6539 useful for on Win32 version, either for cmd.exe which automatically
6540 strips off the first and last quote on a command, or 3rd-party shells
6541 such as the MKS Korn Shell or bash, where it should be "\"". The
6542 default is adjusted according the value of 'shell', to reduce the need
6543 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544 This option cannot be set from a |modeline| or in the |sandbox|, for
6545 security reasons.
6546
6547 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6548'shiftround' 'sr' boolean (default off)
6549 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550 Round indent to multiple of 'shiftwidth'. Applies to > and <
6551 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6552 a multiple of 'shiftwidth' (this is Vi compatible).
6553 NOTE: This option is reset when 'compatible' is set.
6554
6555 *'shiftwidth'* *'sw'*
6556'shiftwidth' 'sw' number (default 8)
6557 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006558 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006560 When zero the 'ts' value will be used. Use the |shiftwidth()|
6561 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562
6563 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006564'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6565 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006567 This option helps to avoid all the |hit-enter| prompts caused by file
6568 messages, for example with CTRL-G, and to avoid some other messages.
6569 It is a list of flags:
6570 flag meaning when present ~
6571 f use "(3 of 5)" instead of "(file 3 of 5)"
6572 i use "[noeol]" instead of "[Incomplete last line]"
6573 l use "999L, 888C" instead of "999 lines, 888 characters"
6574 m use "[+]" instead of "[Modified]"
6575 n use "[New]" instead of "[New File]"
6576 r use "[RO]" instead of "[readonly]"
6577 w use "[w]" instead of "written" for file write message
6578 and "[a]" instead of "appended" for ':w >> file' command
6579 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6580 "[unix format]" and "[mac]" instead of "[mac format]".
6581 a all of the above abbreviations
6582
6583 o overwrite message for writing a file with subsequent message
6584 for reading a file (useful for ":wn" or when 'autowrite' on)
6585 O message for reading a file overwrites any previous message.
6586 Also for quickfix message (e.g., ":cn").
6587 s don't give "search hit BOTTOM, continuing at TOP" or "search
6588 hit TOP, continuing at BOTTOM" messages
6589 t truncate file message at the start if it is too long to fit
6590 on the command-line, "<" will appear in the left most column.
6591 Ignored in Ex mode.
6592 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006593 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 Ignored in Ex mode.
6595 W don't give "written" or "[w]" when writing a file
6596 A don't give the "ATTENTION" message when an existing swap file
6597 is found.
6598 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006599 c don't give |ins-completion-menu| messages. For example,
6600 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6601 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006602 q use "recording" instead of "recording @a"
6603 F don't give the file info when editing a file, like `:silent`
6604 was used for the command
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006605 S do not show search count message when searching, e.g.
6606 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607
6608 This gives you the opportunity to avoid that a change between buffers
6609 requires you to hit <Enter>, but still gives as useful a message as
6610 possible for the space available. To get the whole message that you
6611 would have got with 'shm' empty, use ":file!"
6612 Useful values:
6613 shm= No abbreviation of message.
6614 shm=a Abbreviation, but no loss of information.
6615 shm=at Abbreviation, and truncate message when necessary.
6616
6617 NOTE: This option is set to the Vi default value when 'compatible' is
6618 set and to the Vim default value when 'compatible' is reset.
6619
6620 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6621'shortname' 'sn' boolean (default off)
6622 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 Filenames are assumed to be 8 characters plus one extension of 3
6624 characters. Multiple dots in file names are not allowed. When this
6625 option is on, dots in file names are replaced with underscores when
6626 adding an extension (".~" or ".swp"). This option is not available
6627 for MS-DOS, because then it would always be on. This option is useful
6628 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6629 or crossdos. When running the Win32 GUI version under Win32s, this
6630 option is always on by default.
6631
6632 *'showbreak'* *'sbr'* *E595*
6633'showbreak' 'sbr' string (default "")
6634 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006635 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636 feature}
6637 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006638 values are "> " or "+++ ": >
6639 :set showbreak=>\
6640< Note the backslash to escape the trailing space. It's easier like
6641 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006642 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006643< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 comma (in a future version the comma might be used to separate the
6645 part that is shown at the end and at the start of a line).
6646 The characters are highlighted according to the '@' flag in
6647 'highlight'.
6648 Note that tabs after the showbreak will be displayed differently.
6649 If you want the 'showbreak' to appear in between line numbers, add the
6650 "n" flag to 'cpoptions'.
6651
6652 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006653'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6654 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 {not available when compiled without the
6657 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006658 Show (partial) command in the last line of the screen. Set this
6659 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660 In Visual mode the size of the selected area is shown:
6661 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006662 If the number of bytes is different it is also displayed: "2-6"
6663 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006665 - When selecting a block, the size in screen characters:
6666 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 NOTE: This option is set to the Vi default value when 'compatible' is
6668 set and to the Vim default value when 'compatible' is reset.
6669
6670 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6671'showfulltag' 'sft' boolean (default off)
6672 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673 When completing a word in insert mode (see |ins-completion|) from the
6674 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006675 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 matched a C function, you can see a template for what arguments are
6677 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006678 Note that this doesn't work well together with having "longest" in
6679 'completeopt', because the completion from the search pattern may not
6680 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681
6682 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6683'showmatch' 'sm' boolean (default off)
6684 global
6685 When a bracket is inserted, briefly jump to the matching one. The
6686 jump is only done if the match can be seen on the screen. The time to
6687 show the match can be set with 'matchtime'.
6688 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006689 seen or not).
6690 This option is reset when 'paste' is set and restored when 'paste' is
6691 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 When the 'm' flag is not included in 'cpoptions', typing a character
6693 will immediately move the cursor back to where it belongs.
6694 See the "sm" field in 'guicursor' for setting the cursor shape and
6695 blinking when showing the match.
6696 The 'matchpairs' option can be used to specify the characters to show
6697 matches for. 'rightleft' and 'revins' are used to look for opposite
6698 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006699 Also see the matchparen plugin for highlighting the match when moving
6700 around |pi_paren.txt|.
6701 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702
6703 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6704'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6705 global
6706 If in Insert, Replace or Visual mode put a message on the last line.
6707 Use the 'M' flag in 'highlight' to set the type of highlighting for
6708 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006709 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006710 doesn't mean XIM is really active, especially when 'imactivatekey' is
6711 not set.
6712 NOTE: This option is set to the Vi default value when 'compatible' is
6713 set and to the Vim default value when 'compatible' is reset.
6714
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006715 *'showtabline'* *'stal'*
6716'showtabline' 'stal' number (default 1)
6717 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006718 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006719 feature}
6720 The value of this option specifies when the line with tab page labels
6721 will be displayed:
6722 0: never
6723 1: only if there are at least two tab pages
6724 2: always
6725 This is both for the GUI and non-GUI implementation of the tab pages
6726 line.
6727 See |tab-page| for more information about tab pages.
6728
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729 *'sidescroll'* *'ss'*
6730'sidescroll' 'ss' number (default 0)
6731 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 The minimal number of columns to scroll horizontally. Used only when
6733 the 'wrap' option is off and the cursor is moved off of the screen.
6734 When it is zero the cursor will be put in the middle of the screen.
6735 When using a slow terminal set it to a large number or 0. When using
6736 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6737 commands.
6738
6739 *'sidescrolloff'* *'siso'*
6740'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006741 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006743 right of the cursor if 'nowrap' is set. Setting this option to a
6744 value greater than 0 while having |'sidescroll'| also at a non-zero
6745 value makes some context visible in the line you are scrolling in
6746 horizontally (except at beginning of the line). Setting this option
6747 to a large value (like 999) has the effect of keeping the cursor
6748 horizontally centered in the window, as long as one does not come too
6749 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006750 After using the local value, go back the global value with one of
6751 these two: >
6752 setlocal sidescrolloff<
6753 setlocal sidescrolloff=-1
6754< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755
6756 Example: Try this together with 'sidescroll' and 'listchars' as
6757 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006758 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006759
6760 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6761 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006762<
6763 *'signcolumn'* *'scl'*
6764'signcolumn' 'scl' string (default "auto")
6765 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006766 {not available when compiled without the |+signs|
6767 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006768 Whether or not to draw the signcolumn. Valid values are:
6769 "auto" only when there is a sign to display
6770 "no" never
6771 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772
6773
6774 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6775'smartcase' 'scs' boolean (default off)
6776 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777 Override the 'ignorecase' option if the search pattern contains upper
6778 case characters. Only used when the search pattern is typed and
6779 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006780 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6782 recalling the search pattern from history and hitting <Enter>.
6783 NOTE: This option is reset when 'compatible' is set.
6784
6785 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6786'smartindent' 'si' boolean (default off)
6787 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 {not available when compiled without the
6789 |+smartindent| feature}
6790 Do smart autoindenting when starting a new line. Works for C-like
6791 programs, but can also be used for other languages. 'cindent' does
6792 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006793 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006794 setting 'si' has no effect. 'indentexpr' is a more advanced
6795 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796 Normally 'autoindent' should also be on when using 'smartindent'.
6797 An indent is automatically inserted:
6798 - After a line ending in '{'.
6799 - After a line starting with a keyword from 'cinwords'.
6800 - Before a line starting with '}' (only with the "O" command).
6801 When typing '}' as the first character in a new line, that line is
6802 given the same indent as the matching '{'.
6803 When typing '#' as the first character in a new line, the indent for
6804 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006805 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6807 When using the ">>" command, lines starting with '#' are not shifted
6808 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006809 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006810 This option is reset when 'paste' is set and restored when 'paste' is
6811 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812
6813 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6814'smarttab' 'sta' boolean (default off)
6815 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006817 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6818 <BS> will delete a 'shiftwidth' worth of space at the start of the
6819 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006820 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006821 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6822 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006823 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006825 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006826 This option is reset when 'paste' is set and restored when 'paste' is
6827 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 NOTE: This option is reset when 'compatible' is set.
6829
6830 *'softtabstop'* *'sts'*
6831'softtabstop' 'sts' number (default 0)
6832 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833 Number of spaces that a <Tab> counts for while performing editing
6834 operations, like inserting a <Tab> or using <BS>. It "feels" like
6835 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6836 used. This is useful to keep the 'ts' setting at its standard value
6837 of 8, while being able to edit like it is set to 'sts'. However,
6838 commands like "x" still work on the actual characters.
6839 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006840 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006841 'softtabstop' is set to 0 when the 'paste' option is set and restored
6842 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6844 spaces is minimized by using <Tab>s.
6845 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6846 set.
6847 NOTE: This option is set to 0 when 'compatible' is set.
6848
Bram Moolenaar04958cb2018-06-23 19:23:02 +02006849 If Vim is compiled with the |+vartabs| feature then the value of
6850 'softtabstop' will be ignored if |'varsofttabstop'| is set to
6851 anything other than an empty string.
6852
Bram Moolenaar217ad922005-03-20 22:37:15 +00006853 *'spell'* *'nospell'*
6854'spell' boolean (default off)
6855 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00006856 {not available when compiled without the |+syntax|
6857 feature}
6858 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006859 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006860
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006861 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006862'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006863 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006864 {not available when compiled without the |+syntax|
6865 feature}
6866 Pattern to locate the end of a sentence. The following word will be
6867 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006868 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006869 When this check is not wanted make this option empty.
6870 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006871 Be careful with special characters, see |option-backslash| about
6872 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006873 To set this option automatically depending on the language, see
6874 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006875
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006876 *'spellfile'* *'spf'*
6877'spellfile' 'spf' string (default empty)
6878 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006879 {not available when compiled without the |+syntax|
6880 feature}
6881 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006882 commands. It must end in ".{encoding}.add". You need to include the
6883 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006884 *E765*
6885 It may also be a comma separated list of names. A count before the
6886 |zg| and |zw| commands can be used to access each. This allows using
6887 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006888 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006889 you: Using the first directory in 'runtimepath' that is writable. If
6890 there is no "spell" directory yet it will be created. For the file
6891 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006892 ignoring the region.
6893 The resulting ".spl" file will be used for spell checking, it does not
6894 have to appear in 'spelllang'.
6895 Normally one file is used for all regions, but you can add the region
6896 name if you want to. However, it will then only be used when
6897 'spellfile' is set to it, for entries in 'spelllang' only files
6898 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006899 This option cannot be set from a |modeline| or in the |sandbox|, for
6900 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006901
Bram Moolenaar217ad922005-03-20 22:37:15 +00006902 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006903'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006904 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00006905 {not available when compiled without the |+syntax|
6906 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006907 A comma separated list of word list names. When the 'spell' option is
6908 on spellchecking will be done for these languages. Example: >
6909 set spelllang=en_us,nl,medical
6910< This means US English, Dutch and medical words are recognized. Words
6911 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02006912 The word list name must consist of alphanumeric characters, a dash or
6913 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00006914 recommended to separate the two letter language name from a
6915 specification. Thus "en-rare" is used for rare English words.
6916 A region name must come last and have the form "_xx", where "xx" is
6917 the two-letter, lower case region name. You can use more than one
6918 region by listing them: "en_us,en_ca" supports both US and Canadian
6919 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01006920 Britain. (Note: currently en_au and en_nz dictionaries are older than
6921 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006922 If the name "cjk" is included East Asian characters are excluded from
6923 spell checking. This is useful when editing text that also has Asian
6924 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006925 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006926 As a special case the name of a .spl file can be given as-is. The
6927 first "_xx" in the name is removed and used as the region name
6928 (_xx is an underscore, two letters and followed by a non-letter).
6929 This is mainly for testing purposes. You must make sure the correct
6930 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006931 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006932 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6933 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006934 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006935
Bram Moolenaar98692072006-02-04 00:57:42 +00006936 If the |spellfile.vim| plugin is active and you use a language name
6937 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6938 will ask you if you want to download the file.
6939
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006940 After this option has been set successfully, Vim will source the files
6941 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01006942 up to the first character that is not an ASCII letter or number and
6943 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006944
6945
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006946 *'spellsuggest'* *'sps'*
6947'spellsuggest' 'sps' string (default "best")
6948 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006949 {not available when compiled without the |+syntax|
6950 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006951 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006952 the |spellsuggest()| function. This is a comma-separated list of
6953 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006954
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006955 best Internal method that works best for English. Finds
6956 changes like "fast" and uses a bit of sound-a-like
6957 scoring to improve the ordering.
6958
6959 double Internal method that uses two methods and mixes the
6960 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006961 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006962 word. That only works when the language specifies
6963 sound folding. Can be slow and doesn't always give
6964 better results.
6965
6966 fast Internal method that only checks for simple changes:
6967 character inserts/deletes/swaps. Works well for
6968 simple typing mistakes.
6969
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006970 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006971 Not used for |spellsuggest()|. The number of
6972 suggestions is never more than the value of 'lines'
6973 minus two.
6974
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006975 file:{filename} Read file {filename}, which must have two columns,
6976 separated by a slash. The first column contains the
6977 bad word, the second column the suggested good word.
6978 Example:
6979 theribal/terrible ~
6980 Use this for common mistakes that do not appear at the
6981 top of the suggestion list with the internal methods.
6982 Lines without a slash are ignored, use this for
6983 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006984 The word in the second column must be correct,
6985 otherwise it will not be used. Add the word to an
6986 ".add" file if it is currently flagged as a spelling
6987 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006988 The file is used for all languages.
6989
6990 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6991 trouble with spaces. |v:val| holds the badly spelled
6992 word. The expression must evaluate to a List of
6993 Lists, each with a suggestion and a score.
6994 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01006995 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006996 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006997 internal methods use. A lower score is better.
6998 This may invoke |spellsuggest()| if you temporarily
6999 set 'spellsuggest' to exclude the "expr:" part.
7000 Errors are silently ignored, unless you set the
7001 'verbose' option to a non-zero value.
7002
7003 Only one of "best", "double" or "fast" may be used. The others may
7004 appear several times in any order. Example: >
7005 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7006<
7007 This option cannot be set from a |modeline| or in the |sandbox|, for
7008 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007009
7010
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7012'splitbelow' 'sb' boolean (default off)
7013 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007014 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015 feature}
7016 When on, splitting a window will put the new window below the current
7017 one. |:split|
7018
7019 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7020'splitright' 'spr' boolean (default off)
7021 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007022 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007023 feature}
7024 When on, splitting a window will put the new window right of the
7025 current one. |:vsplit|
7026
7027 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7028'startofline' 'sol' boolean (default on)
7029 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007031 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007032 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007033 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 with a linewise operator, with "%" with a count and to buffer changing
7035 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7036 only has a line number, e.g., ":25" or ":+".
7037 In case of buffer changing commands the cursor is placed at the column
7038 where it was the last time the buffer was edited.
7039 NOTE: This option is set when 'compatible' is set.
7040
Bram Moolenaar00654022011-02-25 14:42:19 +01007041 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007042'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007043 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 {not available when compiled without the |+statusline|
7045 feature}
7046 When nonempty, this option determines the content of the status line.
7047 Also see |status-line|.
7048
7049 The option consists of printf style '%' items interspersed with
7050 normal text. Each status line item is of the form:
7051 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007052 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007053 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007054
Bram Moolenaar238a5642006-02-21 22:12:05 +00007055 When the option starts with "%!" then it is used as an expression,
7056 evaluated and the result is used as the option value. Example: >
7057 :set statusline=%!MyStatusLine()
7058< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007059 Note that the "%!" expression is evaluated in the context of the
7060 current window and buffer, while %{} items are evaluated in the
7061 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007062
7063 When there is error while evaluating the option then it will be made
7064 empty to avoid further errors. Otherwise screen updating would loop.
7065
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066 Note that the only effect of 'ruler' when this option is set (and
7067 'laststatus' is 2) is controlling the output of |CTRL-G|.
7068
7069 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007070 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007071 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007072 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007073 minwid Minimum width of the item, padding as set by '-' & '0'.
7074 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007075 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007076 on the left for text items. Numeric items will be
7077 shifted down to maxwid-2 digits followed by '>'number
7078 where number is the amount of missing digits, much like
7079 an exponential notation.
7080 item A one letter code as described below.
7081
7082 Following is a description of the possible statusline items. The
7083 second character in "item" is the type:
7084 N for number
7085 S for string
7086 F for flags as described below
7087 - not applicable
7088
7089 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007090 f S Path to the file in the buffer, as typed or relative to current
7091 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 F S Full path to the file in the buffer.
7093 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007094 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007096 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007098 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007100 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007101 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007102 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007104 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7106 being used: "<keymap>"
7107 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007108 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109 B N As above, in hexadecimal.
7110 o N Byte number in file of byte under cursor, first byte is 1.
7111 Mnemonic: Offset from start of file (with one added)
7112 {not available when compiled without |+byte_offset| feature}
7113 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007114 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 l N Line number.
7116 L N Number of lines in buffer.
7117 c N Column number.
7118 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007119 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 p N Percentage through file in lines as in |CTRL-G|.
7121 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007122 percentage described for 'ruler'. Always 3 in length, unless
7123 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007124 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007126 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007127 Note that there is no '%' before the closing '}'. The
7128 expression cannot contain a '}' character, call a function to
7129 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 ( - Start of item group. Can be used for setting the width and
7131 alignment of a section. Must be followed by %) somewhere.
7132 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007133 T N For 'tabline': start of tab page N label. Use %T after the last
7134 label. This information is used for mouse clicks.
7135 X N For 'tabline': start of close tab N label. Use %X after the
7136 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7137 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 < - Where to truncate line if too long. Default is at the start.
7139 No width fields allowed.
7140 = - Separation point between left and right aligned items.
7141 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007142 # - Set highlight group. The name must follow and then a # again.
7143 Thus use %#HLname# for highlight group HLname. The same
7144 highlighting is used, also for the statusline of non-current
7145 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007147 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 The difference between User{N} and StatusLine will be applied
7149 to StatusLineNC for the statusline of non-current windows.
7150 The number N must be between 1 and 9. See |hl-User1..9|
7151
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007152 When displaying a flag, Vim removes the leading comma, if any, when
7153 that flag comes right after plaintext. This will make a nice display
7154 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007155
Bram Moolenaar582fd852005-03-28 20:58:01 +00007156 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 not set) and a minwid is not set for the group, the whole group will
7158 become empty. This will make a group like the following disappear
7159 completely from the statusline when none of the flags are set. >
7160 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007161< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 Beware that an expression is evaluated each and every time the status
7163 line is displayed. The current buffer and current window will be set
7164 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007165 currently being drawn. The expression will evaluate in this context.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007166 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007167 real current buffer.
7168
Bram Moolenaar30b65812012-07-12 22:01:11 +02007169 The 'statusline' option will be evaluated in the |sandbox| if set from
7170 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007171
7172 It is not allowed to change text or jump to another window while
7173 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174
7175 If the statusline is not updated when you want it (e.g., after setting
7176 a variable that's used in an expression), you can force an update by
7177 setting an option without changing its value. Example: >
7178 :let &ro = &ro
7179
7180< A result of all digits is regarded a number for display purposes.
7181 Otherwise the result is taken as flag text and applied to the rules
7182 described above.
7183
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007184 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007186 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187
7188 Examples:
7189 Emulate standard status line with 'ruler' set >
7190 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7191< Similar, but add ASCII value of char under the cursor (like "ga") >
7192 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7193< Display byte count and byte value, modified flag in red. >
7194 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7195 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7196< Display a ,GZ flag if a compressed file is loaded >
7197 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7198< In the |:autocmd|'s: >
7199 :let b:gzflag = 1
7200< And: >
7201 :unlet b:gzflag
7202< And define this function: >
7203 :function VarExists(var, val)
7204 : if exists(a:var) | return a:val | else | return '' | endif
7205 :endfunction
7206<
7207 *'suffixes'* *'su'*
7208'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7209 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 Files with these suffixes get a lower priority when multiple files
7211 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007212 suffixes. Spaces after the comma are ignored. A dot is also seen as
7213 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007214 separator, precede it with a backslash (see |option-backslash| about
7215 including spaces and backslashes).
7216 See 'wildignore' for completely ignoring files.
7217 The use of |:set+=| and |:set-=| is preferred when adding or removing
7218 suffixes from the list. This avoids problems when a future version
7219 uses another default.
7220
7221 *'suffixesadd'* *'sua'*
7222'suffixesadd' 'sua' string (default "")
7223 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224 {not available when compiled without the
7225 |+file_in_path| feature}
7226 Comma separated list of suffixes, which are used when searching for a
7227 file for the "gf", "[I", etc. commands. Example: >
7228 :set suffixesadd=.java
7229<
7230 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7231'swapfile' 'swf' boolean (default on)
7232 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007233 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234 swapfile is not wanted for a specific buffer. For example, with
7235 confidential information that even root must not be able to access.
7236 Careful: All text will be in memory:
7237 - Don't use this for big files.
7238 - Recovery will be impossible!
7239 A swapfile will only be present when |'updatecount'| is non-zero and
7240 'swapfile' is set.
7241 When 'swapfile' is reset, the swap file for the current buffer is
7242 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7243 non-zero, a swap file is immediately created.
7244 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007245 If you want to open a new buffer without creating a swap file for it,
7246 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007247 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248
7249 This option is used together with 'bufhidden' and 'buftype' to
7250 specify special kinds of buffers. See |special-buffers|.
7251
7252 *'swapsync'* *'sws'*
7253'swapsync' 'sws' string (default "fsync")
7254 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007256 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007257 When this option is empty parts of the swap file may be in memory and
7258 not written to disk. When the system crashes you may lose more work.
7259 On Unix the system does a sync now and then without Vim asking for it,
7260 so the disadvantage of setting this option off is small. On some
7261 systems the swap file will not be written at all. For a unix system
7262 setting it to "sync" will use the sync() call instead of the default
7263 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007264 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265
7266 *'switchbuf'* *'swb'*
7267'switchbuf' 'swb' string (default "")
7268 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 This option controls the behavior when switching between buffers.
7270 Possible values (comma separated list):
7271 useopen If included, jump to the first open window that
7272 contains the specified buffer (if there is one).
7273 Otherwise: Do not examine other windows.
7274 This setting is checked with |quickfix| commands, when
7275 jumping to errors (":cc", ":cn", "cp", etc.). It is
7276 also used in all buffer related split commands, for
7277 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007278 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007279 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007280 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007281 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007282 Otherwise: do not split, use current window (when used
7283 in the quickfix window: the previously used window or
7284 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007285 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007286 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007287 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007289 *'synmaxcol'* *'smc'*
7290'synmaxcol' 'smc' number (default 3000)
7291 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007292 {not available when compiled without the |+syntax|
7293 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007294 Maximum column in which to search for syntax items. In long lines the
7295 text after this column is not highlighted and following lines may not
7296 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007297 This helps to avoid very slow redrawing for an XML file that is one
7298 long line.
7299 Set to zero to remove the limit.
7300
Bram Moolenaar071d4272004-06-13 20:20:40 +00007301 *'syntax'* *'syn'*
7302'syntax' 'syn' string (default empty)
7303 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304 {not available when compiled without the |+syntax|
7305 feature}
7306 When this option is set, the syntax with this name is loaded, unless
7307 syntax highlighting has been switched off with ":syntax off".
7308 Otherwise this option does not always reflect the current syntax (the
7309 b:current_syntax variable does).
7310 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007311 not automatically recognized. Example, in an IDL file:
7312 /* vim: set syntax=idl : */ ~
7313 When a dot appears in the value then this separates two filetype
7314 names. Example:
7315 /* vim: set syntax=c.doxygen : */ ~
7316 This will use the "c" syntax first, then the "doxygen" syntax.
7317 Note that the second one must be prepared to be loaded as an addition,
7318 otherwise it will be skipped. More than one dot may appear.
7319 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 :set syntax=OFF
7321< To switch syntax highlighting on according to the current value of the
7322 'filetype' option: >
7323 :set syntax=ON
7324< What actually happens when setting the 'syntax' option is that the
7325 Syntax autocommand event is triggered with the value as argument.
7326 This option is not copied to another buffer, independent of the 's' or
7327 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007328 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007330 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007331'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007332 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007333 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007334 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007335 When nonempty, this option determines the content of the tab pages
7336 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007337 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007338
7339 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007340 option and only when there is no GUI tab line. When 'e' is in
7341 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007342 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007343
7344 The value is evaluated like with 'statusline'. You can use
7345 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007346 the text to be displayed. Use "%1T" for the first label, "%2T" for
7347 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007348
Bram Moolenaare12bab32019-01-08 22:02:56 +01007349 When changing something that is used in 'tabline' that does not
7350 trigger it to be updated, use |:redrawtabline|.
7351
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007352 Keep in mind that only one of the tab pages is the current one, others
7353 are invisible and you can't jump to their windows.
7354
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007355
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007356 *'tabpagemax'* *'tpm'*
7357'tabpagemax' 'tpm' number (default 10)
7358 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007359 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007360 feature}
7361 Maximum number of tab pages to be opened by the |-p| command line
7362 argument or the ":tab all" command. |tabpage|
7363
7364
7365 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366'tabstop' 'ts' number (default 8)
7367 local to buffer
7368 Number of spaces that a <Tab> in the file counts for. Also see
7369 |:retab| command, and 'softtabstop' option.
7370
7371 Note: Setting 'tabstop' to any other value than 8 can make your file
7372 appear wrong in many places (e.g., when printing it).
7373
7374 There are four main ways to use tabs in Vim:
7375 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7376 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007377 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007378 behave like a tab appears every 4 (or 3) characters.
7379 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7380 'expandtab'. This way you will always insert spaces. The
7381 formatting will never be messed up when 'tabstop' is changed.
7382 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007383 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 works when using Vim to edit the file.
7385 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7386 'noexpandtab'. This should then work (for initial indents only)
7387 for any tabstop setting that people use. It might be nice to have
7388 tabs after the first non-blank inserted as spaces if you do this
7389 though. Otherwise aligned comments will be wrong when 'tabstop' is
7390 changed.
7391
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007392 If Vim is compiled with the |+vartabs| feature then the value of
7393 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7394 than an empty string.
7395
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7397'tagbsearch' 'tbs' boolean (default on)
7398 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007400 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007401 searching makes searching for a tag a LOT faster, but a linear search
7402 will find more tags if the tags file wasn't properly sorted.
7403 Vim normally assumes that your tags files are sorted, or indicate that
7404 they are not sorted. Only when this is not the case does the
7405 'tagbsearch' option need to be switched off.
7406
7407 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007408 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007409 certain files, or retry all files with a linear search. When
7410 'tagbsearch' is off, only a linear search is done.
7411
7412 Linear searching is done anyway, for one file, when Vim finds a line
7413 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007414 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007415< [The whitespace before and after the '0' must be a single <Tab>]
7416
7417 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007418 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007419 instead of a normal tag name, a retry is done with a linear search.
7420 Tags in unsorted tags files, and matches with different case will only
7421 be found in the retry.
7422
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007423 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007424 linear search can be avoided when case is ignored. Use a value of '2'
7425 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7426 sorted with the -f switch to "sort" in most unices, as in the command:
7427 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7428 (at least 5.5) the --sort=foldcase switch can be used for this as
7429 well. Note that case must be folded to uppercase for this to work.
7430
7431 By default, tag searches are case-sensitive. Case is ignored when
7432 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7433 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007434 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7435 'tagcase' is "smart", and the pattern contains only lowercase
7436 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007437
7438 When 'tagbsearch' is off, tags searching is slower when a full match
7439 exists, but faster when no full match exists. Tags in unsorted tags
7440 files may only be found with 'tagbsearch' off.
7441 When the tags file is not sorted, or sorted in a wrong way (not on
7442 ASCII byte value), 'tagbsearch' should be off, or the line given above
7443 must be included in the tags file.
7444 This option doesn't affect commands that find all matching tags (e.g.,
7445 command-line completion and ":help").
7446 {Vi: always uses binary search in some versions}
7447
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007448 *'tagcase'* *'tc'*
7449'tagcase' 'tc' string (default "followic")
7450 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007451 This option specifies how case is handled when searching the tags
7452 file:
7453 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007454 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007455 ignore Ignore case
7456 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007457 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007458 NOTE: This option is set to the Vi default value when 'compatible' is
7459 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007460
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007461 *'tagfunc'* *'tfu'*
7462'tagfunc' 'tfu' string (default: empty)
7463 local to buffer
7464 {not available when compiled without the |+eval|
7465 feature}
7466 This option specifies a function to be used to perform tag searches.
7467 The function gets the tag pattern and should return a List of matching
7468 tags. See |tag-function| for an explanation of how to write the
7469 function and an example.
7470
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 *'taglength'* *'tl'*
7472'taglength' 'tl' number (default 0)
7473 global
7474 If non-zero, tags are significant up to this number of characters.
7475
7476 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7477'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7478 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007479 If on and using a tags file in another directory, file names in that
7480 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 NOTE: This option is set to the Vi default value when 'compatible' is
7482 set and to the Vim default value when 'compatible' is reset.
7483
7484 *'tags'* *'tag'* *E433*
7485'tags' 'tag' string (default "./tags,tags", when compiled with
7486 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7487 global or local to buffer |global-local|
7488 Filenames for the tag command, separated by spaces or commas. To
7489 include a space or comma in a file name, precede it with a backslash
7490 (see |option-backslash| about including spaces and backslashes).
7491 When a file name starts with "./", the '.' is replaced with the path
7492 of the current file. But only when the 'd' flag is not included in
7493 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7494 |tags-option|.
7495 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007496 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7497 find all files named "tags" below "/lib". The filename itself cannot
7498 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7499 files called "tags?". {not available when compiled without the
7500 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007501 The |tagfiles()| function can be used to get a list of the file names
7502 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7504 files are also supported. They are automatically recognized. The
7505 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7506 differences are ignored (MS-Windows). |emacs-tags|
7507 The use of |:set+=| and |:set-=| is preferred when adding or removing
7508 file names from the list. This avoids problems when a future version
7509 uses another default.
7510 {Vi: default is "tags /usr/lib/tags"}
7511
7512 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7513'tagstack' 'tgst' boolean (default on)
7514 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515 When on, the |tagstack| is used normally. When off, a ":tag" or
7516 ":tselect" command with an argument will not push the tag onto the
7517 tagstack. A following ":tag" without an argument, a ":pop" command or
7518 any other command that uses the tagstack will use the unmodified
7519 tagstack, but does change the pointer to the active entry.
7520 Resetting this option is useful when using a ":tag" command in a
7521 mapping which should not change the tagstack.
7522
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007523 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007524'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007525 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007526 {only available when compiled with the |+tcl/dyn|
7527 feature}
7528 Specifies the name of the Tcl shared library. The default is
7529 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007530 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007531 This option cannot be set from a |modeline| or in the |sandbox|, for
7532 security reasons.
7533
Bram Moolenaar071d4272004-06-13 20:20:40 +00007534 *'term'* *E529* *E530* *E531*
7535'term' string (default is $TERM, if that fails:
7536 in the GUI: "builtin_gui"
7537 on Amiga: "amiga"
7538 on BeOS: "beos-ansi"
7539 on Mac: "mac-ansi"
7540 on MiNT: "vt52"
7541 on MS-DOS: "pcterm"
7542 on OS/2: "os2ansi"
7543 on Unix: "ansi"
7544 on VMS: "ansi"
7545 on Win 32: "win32")
7546 global
7547 Name of the terminal. Used for choosing the terminal control
7548 characters. Environment variables are expanded |:set_env|.
7549 For example: >
7550 :set term=$TERM
7551< See |termcap|.
7552
7553 *'termbidi'* *'tbidi'*
7554 *'notermbidi'* *'notbidi'*
7555'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7556 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557 {only available when compiled with the |+arabic|
7558 feature}
7559 The terminal is in charge of Bi-directionality of text (as specified
7560 by Unicode). The terminal is also expected to do the required shaping
7561 that some languages (such as Arabic) require.
7562 Setting this option implies that 'rightleft' will not be set when
7563 'arabic' is set and the value of 'arabicshape' will be ignored.
7564 Note that setting 'termbidi' has the immediate effect that
7565 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7566 This option is reset when the GUI is started.
7567 For further details see |arabic.txt|.
7568
7569 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007570'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007571 Macintosh GUI: "macroman")
7572 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 Encoding used for the terminal. This specifies what character
7574 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007575 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007576 display). Except for the Mac when 'macatsui' is off, then
7577 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007579 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7581 Any attempts to set a different value will be rejected, and an error
7582 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007583 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584 because the Win32 system always passes Unicode characters.
7585 When empty, the same encoding is used as for the 'encoding' option.
7586 This is the normal value.
7587 Not all combinations for 'termencoding' and 'encoding' are valid. See
7588 |encoding-table|.
7589 The value for this option must be supported by internal conversions or
7590 iconv(). When this is not possible no conversion will be done and you
7591 will probably experience problems with non-ASCII characters.
7592 Example: You are working with the locale set to euc-jp (Japanese) and
7593 want to edit a UTF-8 file: >
7594 :let &termencoding = &encoding
7595 :set encoding=utf-8
7596< You need to do this when your system has no locale support for UTF-8.
7597
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007598 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007599'termguicolors' 'tgc' boolean (default off)
7600 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007601 {not available when compiled without the
7602 |+termguicolors| feature}
7603 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007604 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007605
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007606 Requires a ISO-8613-3 compatible terminal. If setting this option
7607 does not work (produces a colorless UI) reading |xterm-true-color|
7608 might help.
7609
7610 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7611 is required. Use this check to find out: >
7612 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007613< This requires Vim to be built with the |+vtp| feature.
7614
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007615 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007616 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007617
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007618 *'termwinkey'* *'twk'*
7619'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007620 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007621 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007622 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007623 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007624 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007625< The string must be one key stroke but can be multiple bytes.
7626 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007627 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007628 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007629
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007630 *'termwinscroll'* *'twsl'*
7631'termwinscroll' 'twsl' number (default 10000)
7632 local to buffer
7633 {not available when compiled without the
7634 |+terminal| feature}
7635 Number of scrollback lines to keep. When going over this limit the
7636 first 10% of the scrollback lines are deleted. This is just to reduce
7637 the memory usage. See |Terminal-Normal|.
7638
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007639 *'termwinsize'* *'tws'*
7640'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007641 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007642 Size of the |terminal| window. Format: {rows}x{columns} or
7643 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007644 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007645 - When set with a "x" (e.g., "24x80") the terminal size is not
7646 adjusted to the window size. If the window is smaller only the
7647 top-left part is displayed.
7648 - When set with a "*" (e.g., "10*50") the terminal size follows the
7649 window size, but will not be smaller than the specified rows and/or
7650 columns.
7651 - When rows is zero then use the height of the window.
7652 - When columns is zero then use the width of the window.
7653 - Using "0x0" or "0*0" is the same as empty.
7654
7655 Examples:
7656 "30x0" uses 30 rows and the current window width.
7657 "20*0" uses at least 20 rows and the current window width.
7658 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007659 Note that the command running in the terminal window may still change
7660 the size of the terminal. In that case the Vim window will be
7661 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007662
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007663 *'termwintype'* *'twt'*
7664'termwintype' 'twt' string (default "")
7665 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007666 {only available when compiled with the |terminal|
7667 feature on MS-Windows}
7668 Specify the virtual console (pty) used when opening the terminal
7669 window.
7670
7671 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007672 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007673 "winpty" use winpty, fail if not supported
7674 "conpty" use |ConPTY|, fail if not supported
7675
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007676 |ConPTY| support depends on the platform. Windows 10 October 2018
7677 Update is the first version that supports ConPTY, however it is still
7678 considered unstable. ConPTY might become stable in the next release
7679 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007680 supported then you cannot open a terminal window.
7681
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682 *'terse'* *'noterse'*
7683'terse' boolean (default off)
7684 global
7685 When set: Add 's' flag to 'shortmess' option (this makes the message
7686 for a search that hits the start or end of the file not being
7687 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7688 shortens a lot of messages}
7689
7690 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7691'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7692 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693 This option is obsolete. Use 'fileformats'.
7694 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7695 set to the default value for the current system. When 'textauto' is
7696 reset, 'fileformats' is made empty.
7697 NOTE: This option is set to the Vi default value when 'compatible' is
7698 set and to the Vim default value when 'compatible' is reset.
7699
7700 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7701'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7702 others: default off)
7703 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007704 This option is obsolete. Use 'fileformat'.
7705 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7706 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7707 "unix".
7708
7709 *'textwidth'* *'tw'*
7710'textwidth' 'tw' number (default 0)
7711 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712 Maximum width of text that is being inserted. A longer line will be
7713 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007714 this.
7715 'textwidth' is set to 0 when the 'paste' option is set and restored
7716 when 'paste' is reset.
7717 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007718 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007719 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007720 NOTE: This option is set to 0 when 'compatible' is set.
7721
7722 *'thesaurus'* *'tsr'*
7723'thesaurus' 'tsr' string (default "")
7724 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007726 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7727
7728 Each line in the file should contain words with similar meaning,
7729 separated by non-keyword characters (white space is preferred).
7730 Maximum line length is 510 bytes.
7731
Bram Moolenaard47d5222018-12-09 20:43:55 +01007732 An English word list was added to this github issue:
7733 https://github.com/vim/vim/issues/629#issuecomment-443293282
7734 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7735 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7736 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007737
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007738 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007739 after a comma are ignored, otherwise spaces are included in the file
7740 name. See |option-backslash| about using backslashes.
7741 The use of |:set+=| and |:set-=| is preferred when adding or removing
7742 directories from the list. This avoids problems when a future version
7743 uses another default.
7744 Backticks cannot be used in this option for security reasons.
7745
7746 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7747'tildeop' 'top' boolean (default off)
7748 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007749 When on: The tilde command "~" behaves like an operator.
7750 NOTE: This option is reset when 'compatible' is set.
7751
7752 *'timeout'* *'to'* *'notimeout'* *'noto'*
7753'timeout' 'to' boolean (default on)
7754 global
7755 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007756'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758 These two options together determine the behavior when part of a
7759 mapped key sequence or keyboard code has been received:
7760
7761 'timeout' 'ttimeout' action ~
7762 off off do not time out
7763 on on or off time out on :mappings and key codes
7764 off on time out on key codes
7765
7766 If both options are off, Vim will wait until either the complete
7767 mapping or key sequence has been received, or it is clear that there
7768 is no mapping or key sequence for the received characters. For
7769 example: if you have mapped "vl" and Vim has received 'v', the next
7770 character is needed to see if the 'v' is followed by an 'l'.
7771 When one of the options is on, Vim will wait for about 1 second for
7772 the next character to arrive. After that the already received
7773 characters are interpreted as single characters. The waiting time can
7774 be changed with the 'timeoutlen' option.
7775 On slow terminals or very busy systems timing out may cause
7776 malfunctioning cursor keys. If both options are off, Vim waits
7777 forever after an entered <Esc> if there are key codes that start
7778 with <Esc>. You will have to type <Esc> twice. If you do not have
7779 problems with key codes, but would like to have :mapped key
7780 sequences not timing out in 1 second, set the 'ttimeout' option and
7781 reset the 'timeout' option.
7782
7783 NOTE: 'ttimeout' is reset when 'compatible' is set.
7784
7785 *'timeoutlen'* *'tm'*
7786'timeoutlen' 'tm' number (default 1000)
7787 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007788
Bram Moolenaar071d4272004-06-13 20:20:40 +00007789 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007790'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007792 The time in milliseconds that is waited for a key code or mapped key
7793 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7794 when part of a command has been typed.
7795 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7796 different timeout value for key codes is desired set 'ttimeoutlen' to
7797 a non-negative number.
7798
7799 ttimeoutlen mapping delay key code delay ~
7800 < 0 'timeoutlen' 'timeoutlen'
7801 >= 0 'timeoutlen' 'ttimeoutlen'
7802
7803 The timeout only happens when the 'timeout' and 'ttimeout' options
7804 tell so. A useful setting would be >
7805 :set timeout timeoutlen=3000 ttimeoutlen=100
7806< (time out on mapping after three seconds, time out on key codes after
7807 a tenth of a second).
7808
7809 *'title'* *'notitle'*
7810'title' boolean (default off, on when title can be restored)
7811 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812 {not available when compiled without the |+title|
7813 feature}
7814 When on, the title of the window will be set to the value of
7815 'titlestring' (if it is not empty), or to:
7816 filename [+=-] (path) - VIM
7817 Where:
7818 filename the name of the file being edited
7819 - indicates the file cannot be modified, 'ma' off
7820 + indicates the file was modified
7821 = indicates the file is read-only
7822 =+ indicates the file is read-only and modified
7823 (path) is the path of the file being edited
7824 - VIM the server name |v:servername| or "VIM"
7825 Only works if the terminal supports setting window titles
7826 (currently Amiga console, Win32 console, all GUI versions and
7827 terminals with a non- empty 't_ts' option - these are Unix xterm and
7828 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7829 *X11*
7830 When Vim was compiled with HAVE_X11 defined, the original title will
7831 be restored if possible. The output of ":version" will include "+X11"
7832 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7833 works for the icon name |'icon'|.
7834 But: When Vim was started with the |-X| argument, restoring the title
7835 will not work (except in the GUI).
7836 If the title cannot be restored, it is set to the value of 'titleold'.
7837 You might want to restore the title outside of Vim then.
7838 When using an xterm from a remote machine you can use this command:
7839 rsh machine_name xterm -display $DISPLAY &
7840 then the WINDOWID environment variable should be inherited and the
7841 title of the window should change back to what it should be after
7842 exiting Vim.
7843
7844 *'titlelen'*
7845'titlelen' number (default 85)
7846 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847 {not available when compiled without the |+title|
7848 feature}
7849 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007850 title. When the title is longer, only the end of the path name is
7851 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007852 Using a percentage makes this adapt to the width of the window. But
7853 it won't work perfectly, because the actual number of characters
7854 available also depends on the font used and other things in the title
7855 bar. When 'titlelen' is zero the full path is used. Otherwise,
7856 values from 1 to 30000 percent can be used.
7857 'titlelen' is also used for the 'titlestring' option.
7858
7859 *'titleold'*
7860'titleold' string (default "Thanks for flying Vim")
7861 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 {only available when compiled with the |+title|
7863 feature}
7864 This option will be used for the window title when exiting Vim if the
7865 original title cannot be restored. Only happens if 'title' is on or
7866 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007867 This option cannot be set from a |modeline| or in the |sandbox|, for
7868 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007869 *'titlestring'*
7870'titlestring' string (default "")
7871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872 {not available when compiled without the |+title|
7873 feature}
7874 When this option is not empty, it will be used for the title of the
7875 window. This happens only when the 'title' option is on.
7876 Only works if the terminal supports setting window titles (currently
7877 Amiga console, Win32 console, all GUI versions and terminals with a
7878 non-empty 't_ts' option).
7879 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007880 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881 When this option contains printf-style '%' items, they will be
7882 expanded according to the rules used for 'statusline'.
7883 Example: >
7884 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7885 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7886< The value of 'titlelen' is used to align items in the middle or right
7887 of the available space.
7888 Some people prefer to have the file name first: >
7889 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7890< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007891 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 separating space only when needed.
7893 NOTE: Use of special characters in 'titlestring' may cause the display
7894 to be garbled (e.g., when it contains a CR or NL character).
7895 {not available when compiled without the |+statusline| feature}
7896
7897 *'toolbar'* *'tb'*
7898'toolbar' 'tb' string (default "icons,tooltips")
7899 global
7900 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7901 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007902 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903 possible values are:
7904 icons Toolbar buttons are shown with icons.
7905 text Toolbar buttons shown with text.
7906 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007907 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007908 tooltips Tooltips are active for toolbar buttons.
7909 Tooltips refer to the popup help text which appears after the mouse
7910 cursor is placed over a toolbar button for a brief moment.
7911
7912 If you want the toolbar to be shown with icons as well as text, do the
7913 following: >
7914 :set tb=icons,text
7915< Motif and Athena cannot display icons and text at the same time. They
7916 will show icons if both are requested.
7917
7918 If none of the strings specified in 'toolbar' are valid or if
7919 'toolbar' is empty, this option is ignored. If you want to disable
7920 the toolbar, you need to set the 'guioptions' option. For example: >
7921 :set guioptions-=T
7922< Also see |gui-toolbar|.
7923
7924 *'toolbariconsize'* *'tbis'*
7925'toolbariconsize' 'tbis' string (default "small")
7926 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01007927 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007928 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007929 tiny Use tiny icons.
7930 small Use small icons (default).
7931 medium Use medium-sized icons.
7932 large Use large icons.
7933 huge Use even larger icons.
7934 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007936 the current theme. Common dimensions are giant=48x48, huge=32x32,
7937 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938
7939 If 'toolbariconsize' is empty, the global default size as determined
7940 by user preferences or the current theme is used.
7941
7942 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7943'ttybuiltin' 'tbi' boolean (default on)
7944 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945 When on, the builtin termcaps are searched before the external ones.
7946 When off the builtin termcaps are searched after the external ones.
7947 When this option is changed, you should set the 'term' option next for
7948 the change to take effect, for example: >
7949 :set notbi term=$TERM
7950< See also |termcap|.
7951 Rationale: The default for this option is "on", because the builtin
7952 termcap entries are generally better (many systems contain faulty
7953 xterm entries...).
7954
7955 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7956'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7957 sun-cmd, screen, rxvt, dtterm or
7958 iris-ansi; also on when running Vim in
7959 a DOS console)
7960 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 Indicates a fast terminal connection. More characters will be sent to
7962 the screen for redrawing, instead of using insert/delete line
7963 commands. Improves smoothness of redrawing when there are multiple
7964 windows and the terminal does not support a scrolling region.
7965 Also enables the extra writing of characters at the end of each screen
7966 line for lines that wrap. This helps when using copy/paste with the
7967 mouse in an xterm and other terminals.
7968
7969 *'ttymouse'* *'ttym'*
7970'ttymouse' 'ttym' string (default depends on 'term')
7971 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007972 {only in Unix and VMS, doesn't work in the GUI; not
7973 available when compiled without |+mouse|}
7974 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007975 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007976 *xterm-mouse*
7977 xterm xterm-like mouse handling. The mouse generates
7978 "<Esc>[Mscr", where "scr" is three bytes:
7979 "s" = button state
7980 "c" = column plus 33
7981 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02007982 This only works up to 223 columns! See "dec",
7983 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007984 xterm2 Works like "xterm", but with the xterm reporting the
7985 mouse position while the mouse is dragged. This works
7986 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007987 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 work. See below for how Vim detects this
7989 automatically.
7990 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007991 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00007992 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007993 for the row and column. No other mouse events are
7994 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 *dec-mouse*
7996 dec DEC terminal mouse handling. The mouse generates a
7997 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007998 This is also available for an Xterm, if it was
7999 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008000 *jsbterm-mouse*
8001 jsbterm JSB term mouse handling.
8002 *pterm-mouse*
8003 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008004 *urxvt-mouse*
8005 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008006 The mouse works only if the terminal supports this
8007 encoding style, but it does not have 223 columns limit
8008 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008009 *sgr-mouse*
8010 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008011 mouse reporting. The mouse works even in columns
8012 beyond 223. This option is backward compatible with
8013 "xterm2" because it can also decode "xterm2" style
8014 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015
8016 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008017 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8018 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008019 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8020 recognized, if enabled at compile time. DEC terminal mouse codes
8021 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008022 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8023 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008025 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8026 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8027 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008028 Additionally, if vim is compiled with the |+termresponse| feature and
8029 |t_RV| is set to the escape sequence to request the xterm version
8030 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008031 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008032 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8033 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8034 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008035 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8036 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008037 :set t_RV=
8038<
8039 *'ttyscroll'* *'tsl'*
8040'ttyscroll' 'tsl' number (default 999)
8041 global
8042 Maximum number of lines to scroll the screen. If there are more lines
8043 to scroll the window is redrawn. For terminals where scrolling is
8044 very slow and redrawing is not slow this can be set to a small number,
8045 e.g., 3, to speed up displaying.
8046
8047 *'ttytype'* *'tty'*
8048'ttytype' 'tty' string (default from $TERM)
8049 global
8050 Alias for 'term', see above.
8051
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008052 *'undodir'* *'udir'*
8053'undodir' 'udir' string (default ".")
8054 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008055 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008056 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008057 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008058 "." means using the directory of the file. The undo file name for
8059 "file.txt" is ".file.txt.un~".
8060 For other directories the file name is the full path of the edited
8061 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008062 When writing: The first directory that exists is used. "." always
8063 works, no directories after "." will be used for writing.
8064 When reading all entries are tried to find an undo file. The first
8065 undo file that exists is used. When it cannot be read an error is
8066 given, no further entry is used.
8067 See |undo-persistence|.
8068
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008069 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008070'undofile' 'udf' boolean (default off)
8071 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008072 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008073 When on, Vim automatically saves undo history to an undo file when
8074 writing a buffer to a file, and restores undo history from the same
8075 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008076 The directory where the undo file is stored is specified by 'undodir'.
8077 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008078 The undo file is not read when 'undoreload' causes the buffer from
8079 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008080 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008081 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008082
Bram Moolenaar071d4272004-06-13 20:20:40 +00008083 *'undolevels'* *'ul'*
8084'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8085 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008086 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008087 Maximum number of changes that can be undone. Since undo information
8088 is kept in memory, higher numbers will cause more memory to be used
8089 (nevertheless, a single change can use an unlimited amount of memory).
8090 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8091 itself: >
8092 set ul=0
8093< But you can also get Vi compatibility by including the 'u' flag in
8094 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008095 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008096 Set to -1 for no undo at all. You might want to do this only for the
8097 current buffer: >
8098 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008099< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008100
8101 The local value is set to -123456 when the global value is to be used.
8102
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008103 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008104
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008105 *'undoreload'* *'ur'*
8106'undoreload' 'ur' number (default 10000)
8107 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008108 Save the whole buffer for undo when reloading it. This applies to the
8109 ":e!" command and reloading for when the buffer changed outside of
8110 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008111 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008112 of lines is smaller than the value of this option.
8113 Set this option to zero to disable undo for a reload.
8114
8115 When saving undo for a reload, any undo file is not read.
8116
8117 Note that this causes the whole buffer to be stored in memory. Set
8118 this option to a lower value if you run out of memory.
8119
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120 *'updatecount'* *'uc'*
8121'updatecount' 'uc' number (default: 200)
8122 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008123 After typing this many characters the swap file will be written to
8124 disk. When zero, no swap file will be created at all (see chapter on
8125 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8126 Vim with the "-n" option, see |startup|. When editing in readonly
8127 mode this option will be initialized to 10000.
8128 The swapfile can be disabled per buffer with |'swapfile'|.
8129 When 'updatecount' is set from zero to non-zero, swap files are
8130 created for all buffers that have 'swapfile' set. When 'updatecount'
8131 is set to zero, existing swap files are not deleted.
8132 Also see |'swapsync'|.
8133 This option has no meaning in buffers where |'buftype'| is "nofile"
8134 or "nowrite".
8135
8136 *'updatetime'* *'ut'*
8137'updatetime' 'ut' number (default 4000)
8138 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008139 If this many milliseconds nothing is typed the swap file will be
8140 written to disk (see |crash-recovery|). Also used for the
8141 |CursorHold| autocommand event.
8142
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008143 *'varsofttabstop'* *'vsts'*
8144'varsofttabstop' 'vsts' string (default "")
8145 local to buffer
8146 {only available when compiled with the |+vartabs|
8147 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008148 A list of the number of spaces that a <Tab> counts for while editing,
8149 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8150 width <Tab>s are being inserted, while in fact a mixture of spaces
8151 and <Tab>s is used. Tab widths are separated with commas, with the
8152 final value applying to all subsequent tabs.
8153
8154 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008155 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008156 to use the following: >
8157 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008158< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8159 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008160
8161 Note that the value of |'softtabstop'| will be ignored while
8162 'varsofttabstop' is set.
8163
8164 *'vartabstop'* *'vts'*
8165'vartabstop' 'vts' string (default "")
8166 local to buffer
8167 {only available when compiled with the |+vartabs|
8168 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008169 A list of the number of spaces that a <Tab> in the file counts for,
8170 separated by commas. Each value corresponds to one tab, with the
8171 final value applying to all subsequent tabs. For example: >
8172 :set vartabstop=4,20,10,8
8173< This will make the first tab 4 spaces wide, the second 20 spaces,
8174 the third 10 spaces, and all following tabs 8 spaces.
8175
8176 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8177 is set.
8178
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179 *'verbose'* *'vbs'*
8180'verbose' 'vbs' number (default 0)
8181 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008182 When bigger than zero, Vim will give messages about what it is doing.
8183 Currently, these messages are given:
8184 >= 1 When the viminfo file is read or written.
8185 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008186 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008187 >= 8 Files for which a group of autocommands is executed.
8188 >= 9 Every executed autocommand.
8189 >= 12 Every executed function.
8190 >= 13 When an exception is thrown, caught, finished, or discarded.
8191 >= 14 Anything pending in a ":finally" clause.
8192 >= 15 Every executed Ex command (truncated at 200 characters).
8193
8194 This option can also be set with the "-V" argument. See |-V|.
8195 This option is also set by the |:verbose| command.
8196
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008197 When the 'verbosefile' option is set then the verbose messages are not
8198 displayed.
8199
8200 *'verbosefile'* *'vfile'*
8201'verbosefile' 'vfile' string (default empty)
8202 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008203 When not empty all messages are written in a file with this name.
8204 When the file exists messages are appended.
8205 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008206 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008207 Setting 'verbosefile' to a new value is like making it empty first.
8208 The difference with |:redir| is that verbose messages are not
8209 displayed when 'verbosefile' is set.
8210
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211 *'viewdir'* *'vdir'*
8212'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8213 "$VIM/vimfiles/view",
8214 for Unix: "~/.vim/view",
8215 for Macintosh: "$VIM:vimfiles:view"
8216 for VMS: "sys$login:vimfiles/view"
8217 for RiscOS: "Choices:vimfiles/view")
8218 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008219 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008220 feature}
8221 Name of the directory where to store files for |:mkview|.
8222 This option cannot be set from a |modeline| or in the |sandbox|, for
8223 security reasons.
8224
8225 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008226'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008228 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008229 feature}
8230 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008231 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008232 word save and restore ~
8233 cursor cursor position in file and in window
8234 folds manually created folds, opened/closed folds and local
8235 fold options
8236 options options and mappings local to a window or buffer (not
8237 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008238 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008239 slash backslashes in file names replaced with forward
8240 slashes
8241 unix with Unix end-of-line format (single <NL>), even when
8242 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008243 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008244
8245 "slash" and "unix" are useful on Windows when sharing view files
8246 with Unix. The Unix version of Vim cannot source dos format scripts,
8247 but the Windows version of Vim can source unix format scripts.
8248
8249 *'viminfo'* *'vi'* *E526* *E527* *E528*
8250'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008251 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8252 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8253 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008254 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008255 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008256 feature}
8257 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008258 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8259 "NONE".
8260 The string should be a comma separated list of parameters, each
8261 consisting of a single character identifying the particular parameter,
8262 followed by a number or string which specifies the value of that
8263 parameter. If a particular character is left out, then the default
8264 value is used for that parameter. The following is a list of the
8265 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008266 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008267 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008268 ! When included, save and restore global variables that start
8269 with an uppercase letter, and don't contain a lowercase
8270 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008271 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008272 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008273 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008274 " Maximum number of lines saved for each register. Old name of
8275 the '<' item, with the disadvantage that you need to put a
8276 backslash before the ", otherwise it will be recognized as the
8277 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008278 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008279 % When included, save and restore the buffer list. If Vim is
8280 started with a file name argument, the buffer list is not
8281 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008282 buffer list is restored from the viminfo file. Quickfix
8283 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8284 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008285 When followed by a number, the number specifies the maximum
8286 number of buffers that are stored. Without a number all
8287 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008288 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008289 ' Maximum number of previously edited files for which the marks
8290 are remembered. This parameter must always be included when
8291 'viminfo' is non-empty.
8292 Including this item also means that the |jumplist| and the
8293 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008294 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008296 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008297 patterns are also saved. When not included, the value of
8298 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008299 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008300 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008301 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008302 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008303 < Maximum number of lines saved for each register. If zero then
8304 registers are not saved. When not included, all lines are
8305 saved. '"' is the old name for this item.
8306 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008307 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008308 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008309 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008310 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311 c When included, convert the text in the viminfo file from the
8312 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008313 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008314 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008315 f Whether file marks need to be stored. If zero, file marks ('0
8316 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008317 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008318 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008319 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008320 h Disable the effect of 'hlsearch' when loading the viminfo
8321 file. When not included, it depends on whether ":nohlsearch"
8322 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008323 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008324 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008325 the 'n'. Must be at the end of the option! If the
8326 'viminfofile' option is set, that file name overrides the one
8327 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008328 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008329 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008330 r Removable media. The argument is a string (up to the next
8331 ','). This parameter can be given several times. Each
8332 specifies the start of a path for which no marks will be
8333 stored. This is to avoid removable media. For MS-DOS you
8334 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8335 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8336 ignored. Maximum length of each 'r' argument is 50
8337 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008338 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008339 s Maximum size of an item in Kbyte. If zero then registers are
8340 not saved. Currently only applies to registers. The default
8341 "s10" will exclude registers with more than 10 Kbyte of text.
8342 Also see the '<' item above: line count limit.
8343
8344 Example: >
8345 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8346<
8347 '50 Marks will be remembered for the last 50 files you
8348 edited.
8349 <1000 Contents of registers (up to 1000 lines each) will be
8350 remembered.
8351 s100 Registers with more than 100 Kbyte text are skipped.
8352 :0 Command-line history will not be saved.
8353 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8354 no / Since '/' is not specified, the default will be used,
8355 that is, save all of the search history, and also the
8356 previous search and substitute patterns.
8357 no % The buffer list will not be saved nor read back.
8358 no h 'hlsearch' highlighting will be restored.
8359
8360 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8361 load the contents of the file, this is not done automatically.
8362
8363 This option cannot be set from a |modeline| or in the |sandbox|, for
8364 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008365 NOTE: This option is set to the Vim default value when 'compatible'
8366 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008367
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008368 *'viminfofile'* *'vif'*
8369'viminfofile' 'vif' string (default: "")
8370 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008371 {not available when compiled without the |+viminfo|
8372 feature}
8373 When non-empty, overrides the file name used for viminfo.
8374 When equal to "NONE" no viminfo file will be read or written.
8375 This option can be set with the |-i| command line flag. The |--clean|
8376 command line flag sets it to "NONE".
8377
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378 *'virtualedit'* *'ve'*
8379'virtualedit' 've' string (default "")
8380 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008381 {not available when compiled without the
8382 |+virtualedit| feature}
8383 A comma separated list of these words:
8384 block Allow virtual editing in Visual block mode.
8385 insert Allow virtual editing in Insert mode.
8386 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008387 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008388
Bram Moolenaar071d4272004-06-13 20:20:40 +00008389 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008390 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008391 of the line. Useful for selecting a rectangle in Visual mode and
8392 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008393 "onemore" is not the same, it will only allow moving the cursor just
8394 after the last character of the line. This makes some commands more
8395 consistent. Previously the cursor was always past the end of the line
8396 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008397 break some plugins or Vim scripts. For example because |l| can move
8398 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008399 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008400 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008401 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008402 It doesn't make sense to combine "all" with "onemore", but you will
8403 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008404 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008405
8406 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8407'visualbell' 'vb' boolean (default off)
8408 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008409 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008410 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008411 use: >
8412 :set vb t_vb=
8413< If you want a short flash, you can use this on many terminals: >
8414 :set vb t_vb=[?5h$<100>[?5l
8415< Here $<100> specifies the time, you can use a smaller or bigger value
8416 to get a shorter or longer flash.
8417
8418 Note: Vim will limit the bell to once per half a second. This avoids
8419 having to wait for the flashing to finish when there are lots of
8420 bells, e.g. on key repeat. This also happens without 'visualbell'
8421 set.
8422
Bram Moolenaar071d4272004-06-13 20:20:40 +00008423 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8424 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8425 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008426
8427 Note: When the GUI starts, 't_vb' is reset to its default value. You
8428 might want to set it again in your |gvimrc|.
8429
Bram Moolenaar071d4272004-06-13 20:20:40 +00008430 Does not work on the Amiga, you always get a screen flash.
8431 Also see 'errorbells'.
8432
8433 *'warn'* *'nowarn'*
8434'warn' boolean (default on)
8435 global
8436 Give a warning message when a shell command is used while the buffer
8437 has been changed.
8438
8439 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8440'weirdinvert' 'wiv' boolean (default off)
8441 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008442 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008443 It is provided for backwards compatibility with version 4.x.
8444 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8445 vice versa. Has no effect when the GUI is running.
8446
8447 *'whichwrap'* *'ww'*
8448'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8449 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008450 Allow specified keys that move the cursor left/right to move to the
8451 previous/next line when the cursor is on the first/last character in
8452 the line. Concatenate characters to allow this for these keys:
8453 char key mode ~
8454 b <BS> Normal and Visual
8455 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008456 h "h" Normal and Visual (not recommended)
8457 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 < <Left> Normal and Visual
8459 > <Right> Normal and Visual
8460 ~ "~" Normal
8461 [ <Left> Insert and Replace
8462 ] <Right> Insert and Replace
8463 For example: >
8464 :set ww=<,>,[,]
8465< allows wrap only when cursor keys are used.
8466 When the movement keys are used in combination with a delete or change
8467 operator, the <EOL> also counts for a character. This makes "3h"
8468 different from "3dh" when the cursor crosses the end of a line. This
8469 is also true for "x" and "X", because they do the same as "dl" and
8470 "dh". If you use this, you may also want to use the mapping
8471 ":map <BS> X" to make backspace delete the character in front of the
8472 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008473 When 'l' is included and it is used after an operator at the end of a
8474 line then it will not move to the next line. This makes "dl", "cl",
8475 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008476 NOTE: This option is set to the Vi default value when 'compatible' is
8477 set and to the Vim default value when 'compatible' is reset.
8478
8479 *'wildchar'* *'wc'*
8480'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8481 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008482 Character you have to type to start wildcard expansion in the
8483 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008484 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008485 The character is not recognized when used inside a macro. See
8486 'wildcharm' for that.
8487 Although 'wc' is a number option, you can set it to a special key: >
8488 :set wc=<Esc>
8489< NOTE: This option is set to the Vi default value when 'compatible' is
8490 set and to the Vim default value when 'compatible' is reset.
8491
8492 *'wildcharm'* *'wcm'*
8493'wildcharm' 'wcm' number (default: none (0))
8494 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008495 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008496 recognized when used inside a macro. You can find "spare" command-line
8497 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008498 you'll never actually type 'wildcharm', just use it in mappings that
8499 automatically invoke completion mode, e.g.: >
8500 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008501 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502< Then after typing :ss you can use CTRL-P & CTRL-N.
8503
8504 *'wildignore'* *'wig'*
8505'wildignore' 'wig' string (default "")
8506 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008507 {not available when compiled without the |+wildignore|
8508 feature}
8509 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008510 patterns is ignored when expanding |wildcards|, completing file or
8511 directory names, and influences the result of |expand()|, |glob()| and
8512 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008513 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8514 Also see 'suffixes'.
8515 Example: >
8516 :set wildignore=*.o,*.obj
8517< The use of |:set+=| and |:set-=| is preferred when adding or removing
8518 a pattern from the list. This avoids problems when a future version
8519 uses another default.
8520
Bram Moolenaar94950a92010-12-02 16:01:29 +01008521
Bram Moolenaar81af9252010-12-10 20:35:50 +01008522 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008523'wildignorecase' 'wic' boolean (default off)
8524 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008525 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008526 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008527 Does not apply when the shell is used to expand wildcards, which
8528 happens when there are special characters.
8529
8530
Bram Moolenaar071d4272004-06-13 20:20:40 +00008531 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008532'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008533 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008534 {not available if compiled without the |+wildmenu|
8535 feature}
8536 When 'wildmenu' is on, command-line completion operates in an enhanced
8537 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8538 the possible matches are shown just above the command line, with the
8539 first match highlighted (overwriting the status line, if there is
8540 one). Keys that show the previous/next match, such as <Tab> or
8541 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8542 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8543 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008544 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 If there are more matches than can fit in the line, a ">" is shown on
8546 the right and/or a "<" is shown on the left. The status line scrolls
8547 as needed.
8548 The "wildmenu" mode is abandoned when a key is hit that is not used
8549 for selecting a completion.
8550 While the "wildmenu" is active the following keys have special
8551 meanings:
8552
8553 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8554 <Down> - in filename/menu name completion: move into a
8555 subdirectory or submenu.
8556 <CR> - in menu completion, when the cursor is just after a
8557 dot: move into a submenu.
8558 <Up> - in filename/menu name completion: move up into
8559 parent directory or parent menu.
8560
8561 This makes the menus accessible from the console |console-menus|.
8562
8563 If you prefer the <Left> and <Right> keys to move the cursor instead
8564 of selecting a different match, use this: >
8565 :cnoremap <Left> <Space><BS><Left>
8566 :cnoremap <Right> <Space><BS><Right>
8567<
8568 The "WildMenu" highlighting is used for displaying the current match
8569 |hl-WildMenu|.
8570
8571 *'wildmode'* *'wim'*
8572'wildmode' 'wim' string (Vim default: "full")
8573 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008574 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008575 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008576 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008577 first part specifies the behavior for the first use of 'wildchar',
8578 The second part for the second use, etc.
8579 These are the possible values for each part:
8580 "" Complete only the first match.
8581 "full" Complete the next full match. After the last match,
8582 the original string is used and then the first match
8583 again.
8584 "longest" Complete till longest common string. If this doesn't
8585 result in a longer string, use the next part.
8586 "longest:full" Like "longest", but also start 'wildmenu' if it is
8587 enabled.
8588 "list" When more than one match, list all matches.
8589 "list:full" When more than one match, list all matches and
8590 complete first match.
8591 "list:longest" When more than one match, list all matches and
8592 complete till longest common string.
8593 When there is only a single match, it is fully completed in all cases.
8594
8595 Examples: >
8596 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008597< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008598 :set wildmode=longest,full
8599< Complete longest common string, then each full match >
8600 :set wildmode=list:full
8601< List all matches and complete each full match >
8602 :set wildmode=list,full
8603< List all matches without completing, then each full match >
8604 :set wildmode=longest,list
8605< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008606 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008607
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008608 *'wildoptions'* *'wop'*
8609'wildoptions' 'wop' string (default "")
8610 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008611 {not available when compiled without the |+wildignore|
8612 feature}
8613 A list of words that change how command line completion is done.
8614 Currently only one word is allowed:
8615 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008616 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008617 is displayed per line. Often used tag kinds are:
8618 d #define
8619 f function
8620 Also see |cmdline-completion|.
8621
Bram Moolenaar071d4272004-06-13 20:20:40 +00008622 *'winaltkeys'* *'wak'*
8623'winaltkeys' 'wak' string (default "menu")
8624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 {only used in Win32, Motif, GTK and Photon GUI}
8626 Some GUI versions allow the access to menu entries by using the ALT
8627 key in combination with a character that appears underlined in the
8628 menu. This conflicts with the use of the ALT key for mappings and
8629 entering special characters. This option tells what to do:
8630 no Don't use ALT keys for menus. ALT key combinations can be
8631 mapped, but there is no automatic handling. This can then be
8632 done with the |:simalt| command.
8633 yes ALT key handling is done by the windowing system. ALT key
8634 combinations cannot be mapped.
8635 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008636 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008637 keys can be mapped.
8638 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8639 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008640 This option is not used for <F10>; on Win32 and with GTK <F10> will
8641 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008642
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008643 *'window'* *'wi'*
8644'window' 'wi' number (default screen height - 1)
8645 global
8646 Window height. Do not confuse this with the height of the Vim window,
8647 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008648 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8649 value is smaller than 'lines' minus one. The screen will scroll
8650 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008651 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8652 in a much smarter way, taking care of wrapping lines.
8653 When resizing the Vim window, the value is smaller than 1 or more than
8654 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008655
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 *'winheight'* *'wh'* *E591*
8657'winheight' 'wh' number (default 1)
8658 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008659 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008660 feature}
8661 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008662 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008663 focus goes to a window that is smaller, its size is increased, at the
8664 cost of the height of other windows.
8665 Set 'winheight' to a small number for normal editing.
8666 Set it to 999 to make the current window fill most of the screen.
8667 Other windows will be only 'winminheight' high. This has the drawback
8668 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8669 to create only two windows, set the option after startup is done,
8670 using the |VimEnter| event: >
8671 au VimEnter * set winheight=999
8672< Minimum value is 1.
8673 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008674 height of the current window.
8675 'winheight' applies to the current window. Use 'winminheight' to set
8676 the minimal height for other windows.
8677
8678 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8679'winfixheight' 'wfh' boolean (default off)
8680 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02008681 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008682 feature}
8683 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008684 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8685 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008686 The height may be changed anyway when running out of room.
8687
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008688 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8689'winfixwidth' 'wfw' boolean (default off)
8690 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02008691 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008692 feature}
8693 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008694 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008695 The width may be changed anyway when running out of room.
8696
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697 *'winminheight'* *'wmh'*
8698'winminheight' 'wmh' number (default 1)
8699 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008700 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008701 feature}
8702 The minimal height of a window, when it's not the current window.
8703 This is a hard minimum, windows will never become smaller.
8704 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8705 status bar) if necessary. They will return to at least one line when
8706 they become active (since the cursor has to have somewhere to go.)
8707 Use 'winheight' to set the minimal height of the current window.
8708 This option is only checked when making a window smaller. Don't use a
8709 large number, it will cause errors when opening more than a few
8710 windows. A value of 0 to 3 is reasonable.
8711
8712 *'winminwidth'* *'wmw'*
8713'winminwidth' 'wmw' number (default 1)
8714 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008715 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008716 feature}
8717 The minimal width of a window, when it's not the current window.
8718 This is a hard minimum, windows will never become smaller.
8719 When set to zero, windows may be "squashed" to zero columns (i.e. just
8720 a vertical separator) if necessary. They will return to at least one
8721 line when they become active (since the cursor has to have somewhere
8722 to go.)
8723 Use 'winwidth' to set the minimal width of the current window.
8724 This option is only checked when making a window smaller. Don't use a
8725 large number, it will cause errors when opening more than a few
8726 windows. A value of 0 to 12 is reasonable.
8727
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008728 *'winptydll'*
8729'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8730 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008731 {only available when compiled with the |terminal|
8732 feature on MS-Windows}
8733 Specifies the name of the winpty shared library, used for the
8734 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008735 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008736 a fallback.
8737 Environment variables are expanded |:set_env|.
8738 This option cannot be set from a |modeline| or in the |sandbox|, for
8739 security reasons.
8740
Bram Moolenaar071d4272004-06-13 20:20:40 +00008741 *'winwidth'* *'wiw'* *E592*
8742'winwidth' 'wiw' number (default 20)
8743 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008744 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 feature}
8746 Minimal number of columns for the current window. This is not a hard
8747 minimum, Vim will use fewer columns if there is not enough room. If
8748 the current window is smaller, its size is increased, at the cost of
8749 the width of other windows. Set it to 999 to make the current window
8750 always fill the screen. Set it to a small number for normal editing.
8751 The width is not adjusted after one of the commands to change the
8752 width of the current window.
8753 'winwidth' applies to the current window. Use 'winminwidth' to set
8754 the minimal width for other windows.
8755
8756 *'wrap'* *'nowrap'*
8757'wrap' boolean (default on)
8758 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008759 This option changes how text is displayed. It doesn't change the text
8760 in the buffer, see 'textwidth' for that.
8761 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008762 displaying continues on the next line. When off lines will not wrap
8763 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764 moved to a part that is not shown, the screen will scroll
8765 horizontally.
8766 The line will be broken in the middle of a word if necessary. See
8767 'linebreak' to get the break at a word boundary.
8768 To make scrolling horizontally a bit more useful, try this: >
8769 :set sidescroll=5
8770 :set listchars+=precedes:<,extends:>
8771< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008772 This option can't be set from a |modeline| when the 'diff' option is
8773 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774
8775 *'wrapmargin'* *'wm'*
8776'wrapmargin' 'wm' number (default 0)
8777 local to buffer
8778 Number of characters from the right window border where wrapping
8779 starts. When typing text beyond this limit, an <EOL> will be inserted
8780 and inserting continues on the next line.
8781 Options that add a margin, such as 'number' and 'foldcolumn', cause
8782 the text width to be further reduced. This is Vi compatible.
8783 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008784 This option is set to 0 when 'paste' is set and restored when 'paste'
8785 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008786 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8787 and less usefully}
8788
8789 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8790'wrapscan' 'ws' boolean (default on) *E384* *E385*
8791 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008792 Searches wrap around the end of the file. Also applies to |]s| and
8793 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008794
8795 *'write'* *'nowrite'*
8796'write' boolean (default on)
8797 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798 Allows writing files. When not set, writing a file is not allowed.
8799 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008800 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008801 argument. Filtering text is still possible, even though this requires
8802 writing a temporary file.
8803
8804 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8805'writeany' 'wa' boolean (default off)
8806 global
8807 Allows writing to any file with no need for "!" override.
8808
8809 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8810'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8811 otherwise)
8812 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008813 Make a backup before overwriting a file. The backup is removed after
8814 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008815 also on.
8816 WARNING: Switching this option off means that when Vim fails to write
8817 your buffer correctly and then, for whatever reason, Vim exits, you
8818 lose both the original file and what you were writing. Only reset
8819 this option if your file system is almost full and it makes the write
8820 fail (and make sure not to exit Vim until the write was successful).
8821 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008822 When the 'backupskip' pattern matches, a backup is not made anyway.
8823 NOTE: This option is set to the default value when 'compatible' is
8824 set.
8825
8826 *'writedelay'* *'wd'*
8827'writedelay' 'wd' number (default 0)
8828 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008829 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008830 screen. When non-zero, characters are sent to the terminal one by
8831 one. For MS-DOS pcterm this does not work. For debugging purposes.
8832
Bram Moolenaar91f84f62018-07-29 15:07:52 +02008833 vim:tw=78:ts=8:noet:ft=help:norl: