blob: e352ed8f26b93130456838fa2126dedf094a91e7 [file] [log] [blame]
Bram Moolenaar6304be62021-11-27 10:57:26 +00001*options.txt* For Vim version 8.2. Last change: 2021 Nov 24
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*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
37
38 *E518* *E519*
39:se[t] {option}? Show value of {option}.
40
41:se[t] {option} Toggle option: set, switch it on.
42 Number option: show value.
43 String option: show value.
44
45:se[t] no{option} Toggle option: Reset, switch it off.
46
Bram Moolenaar00a927d2010-05-14 23:24:24 +020047 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000048:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000050
51 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
52:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053 current value of 'compatible'.
54:se[t] {option}&vi Reset option to its Vi default value.
55:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000056
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010057:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020058 these options are not changed:
59 all terminal options, starting with t_
60 'columns'
61 'cryptmethod'
62 'encoding'
63 'key'
64 'lines'
65 'term'
66 'ttymouse'
67 'ttytype'
68 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000069
70 *:set-args* *E487* *E521*
71:se[t] {option}={value} or
72:se[t] {option}:{value}
73 Set string or number option to {value}.
74 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010075 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000076 The old value can be inserted by typing 'wildchar' (by
77 default this is a <Tab> or CTRL-E if 'compatible' is
78 set). See |cmdline-completion|.
79 White space between {option} and '=' is allowed and
80 will be ignored. White space between '=' and {value}
81 is not allowed.
82 See |option-backslash| for using white space and
83 backslashes in {value}.
84
85:se[t] {option}+={value} *:set+=*
86 Add the {value} to a number option, or append the
87 {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000091 are removed. When adding a flag that was already
92 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000093 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000094
95:se[t] {option}^={value} *:set^=*
96 Multiply the {value} to a number option, or prepend
97 the {value} to a string option. When the option is a
98 comma separated list, a comma is added, unless the
99 value was empty.
100 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:se[t] {option}-={value} *:set-=*
103 Subtract the {value} from a number option, or remove
104 the {value} from a string option, if it is there.
105 If the {value} is not found in a string option, there
106 is no error or warning. When the option is a comma
107 separated list, a comma is deleted, unless the option
108 becomes empty.
109 When the option is a list of flags, {value} must be
110 exactly as they appear in the option. Remove flags
111 one by one to avoid problems.
112 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200123< shiftwidth=4 ~
124 Last set from modeline line 1 ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200135 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200198Similarly, in legacy script the double quote character starts a comment. To
199include the '"' in the option value, use '\"' instead. This example sets the
200'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000201 :set titlestring=hi\ \"there\"
202
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200203In |Vim9| script it's simpler, comments start with a '#' character, and only
204when preceded by white space. A backslash is needed less often: >
205 vim9script
206 set titlestring=hi\ "there"
207 set titlestring=hi#there#
208 set titlestring=hi\ \#there#
209
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100210For Win32 backslashes in file names are mostly not removed. More precise: For
211options that expect a file name (those where environment variables are
212expanded) a backslash before a normal file name character is not removed. But
213a backslash before a special character (space, backslash, comma, etc.) is used
214like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215There is one special situation, when the value starts with "\\": >
216 :set dir=\\machine\path results in "\\machine\path"
217 :set dir=\\\\machine\\path results in "\\machine\path"
218 :set dir=\\path\\file results in "\\path\file" (wrong!)
219For the first one the start is kept, but for the second one the backslashes
220are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000221halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000222result which is probably not what you want. Avoid it.
223
224 *add-option-flags* *remove-option-flags*
225 *E539* *E550* *E551* *E552*
226Some options are a list of flags. When you want to add a flag to such an
227option, without changing the existing ones, you can do it like this: >
228 :set guioptions+=a
229Remove a flag from an option like this: >
230 :set guioptions-=a
231This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000232Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000233the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
234doesn't appear.
235
236 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000237Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000238environment variable exists the '$' and the following environment variable
239name is replaced with its value. If it does not exist the '$' and the name
240are not modified. Any non-id character (not a letter, digit or '_') may
241follow the environment variable name. That character and what follows is
242appended to the value of the environment variable. Examples: >
243 :set term=$TERM.new
244 :set path=/usr/$INCLUDE,$HOME/include,.
245When adding or removing a string from an option with ":set opt-=val" or ":set
246opt+=val" the expansion is done before the adding or removing.
247
248
249Handling of local options *local-options*
250
251Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100252has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000253allows you to set 'list' in one window but not in another. And set
254'shiftwidth' to 3 in one buffer and 4 in another.
255
256The following explains what happens to these local options in specific
257situations. You don't really need to know all of this, since Vim mostly uses
258the option values you would expect. Unfortunately, doing what the user
259expects is a bit complicated...
260
261When splitting a window, the local options are copied to the new window. Thus
262right after the split the contents of the two windows look the same.
263
264When editing a new buffer, its local option values must be initialized. Since
265the local options of the current buffer might be specifically for that buffer,
266these are not used. Instead, for each buffer-local option there also is a
267global value, which is used for new buffers. With ":set" both the local and
268global value is changed. With "setlocal" only the local value is changed,
269thus this value is not used when editing a new buffer.
270
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200271When editing a buffer that has been edited before, the options from the window
272that was last closed are used again. If this buffer has been edited in this
273window, the values from back then are used. Otherwise the values from the
274last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000275
276It's possible to set a local window option specifically for a type of buffer.
277When you edit another buffer in the same window, you don't want to keep
278using these local window options. Therefore Vim keeps a global value of the
279local window options, which is used when editing another buffer. Each window
280has its own copy of these values. Thus these are local to the window, but
281global to all buffers in the window. With this you can do: >
282 :e one
283 :set list
284 :e two
285Now the 'list' option will also be set in "two", since with the ":set list"
286command you have also set the global value. >
287 :set nolist
288 :e one
289 :setlocal list
290 :e two
291Now the 'list' option is not set, because ":set nolist" resets the global
292value, ":setlocal list" only changes the local value and ":e two" gets the
293global value. Note that if you do this next: >
294 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200295You will get back the 'list' value as it was the last time you edited "one".
296The options local to a window are remembered for each buffer. This also
297happens when the buffer is not loaded, but they are lost when the buffer is
298wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000299
300 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100301:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 current buffer or window. Not all options have a
303 local value. If the option does not have a local
304 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200305 With the "all" argument: display local values for all
306 local options.
307 Without argument: Display local values for all local
308 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000310 local value. For a global/local boolean option, when
311 the global value is being used, "--" is displayed
312 before the option name.
313 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000315
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000316:setl[ocal] {option}< Set the local value of {option} to its global value by
317 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000318
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100319:se[t] {option}< For |global-local| options: Remove the local value of
320 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000321
322 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100323:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324 option without changing the local value.
325 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200326 With the "all" argument: display global values for all
327 local options.
328 Without argument: display global values for all local
329 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330
331For buffer-local and window-local options:
332 Command global value local value ~
333 :set option=value set set
334 :setlocal option=value - set
335:setglobal option=value set -
336 :set option? - display
337 :setlocal option? - display
338:setglobal option? display -
339
340
341Global options with a local value *global-local*
342
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000343Options are global when you mostly use one value for all buffers and windows.
344For some global options it's useful to sometimes have a different local value.
345You can set the local value with ":setlocal". That buffer or window will then
346use the local value, while other buffers and windows continue using the global
347value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000348
349For example, you have two windows, both on C source code. They use the global
350'makeprg' option. If you do this in one of the two windows: >
351 :set makeprg=gmake
352then the other window will switch to the same value. There is no need to set
353the 'makeprg' option in the other C source window too.
354However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000355another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000356files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357 :setlocal makeprg=perlmake
358You can switch back to using the global value by making the local value empty: >
359 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100360This only works for a string option. For a number or boolean option you need
361to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100363Note that for non-boolean and non-number options using "<" copies the global
364value to the local value, it doesn't switch back to using the global value
365(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000366 :set path<
367This will make the local value of 'path' empty, so that the global value is
368used. Thus it does the same as: >
369 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370Note: In the future more global options can be made global-local. Using
371":setlocal" on a global option might work differently then.
372
373
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000374 *option-value-function*
375Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000376'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
377a function name or a function reference or a lambda function. Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000378>
379 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000380 set opfunc=function('MyOpFunc')
381 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000382 set opfunc={a\ ->\ MyOpFunc(a)}
383 " set using a funcref variable
384 let Fn = function('MyTagFunc')
385 let &tagfunc = string(Fn)
386 " set using a lambda expression
387 let &tagfunc = "{t -> MyTagFunc(t)}"
388 " set using a variable with lambda expression
389 let L = {a, b, c -> MyTagFunc(a, b , c)}
390 let &tagfunc = string(L)
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000391<
392
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393Setting the filetype
394
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200395:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000396 Set the 'filetype' option to {filetype}, but only if
397 not done yet in a sequence of (nested) autocommands.
398 This is short for: >
399 :if !did_filetype()
400 : setlocal filetype={filetype}
401 :endif
402< This command is used in a filetype.vim file to avoid
403 setting the 'filetype' option twice, causing different
404 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200405
406 When the optional FALLBACK argument is present, a
407 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100408 'filetype'. This is to be used for filetype
409 detections that are just a guess. |did_filetype()|
410 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200411
Bram Moolenaard58e9292011-02-09 17:07:58 +0100412 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
414:opt[ions] Open a window for viewing and setting all options.
415 Options are grouped by function.
416 Offers short help for each option. Hit <CR> on the
417 short help to open a help window with more help for
418 the option.
419 Modify the value of the option and hit <CR> on the
420 "set" line to set the new value. For window and
421 buffer specific options, the last accessed window is
422 used to set the option value in, unless this is a help
423 window, in which case the window below help window is
424 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100425 {not available when compiled without the |+eval|
426 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427
428 *$HOME*
429Using "~" is like using "$HOME", but it is only recognized at the start of an
430option and after a space or comma.
431
432On Unix systems "~user" can be used too. It is replaced by the home directory
433of user "user". Example: >
434 :set path=~mool/include,/usr/include,.
435
436On Unix systems the form "${HOME}" can be used too. The name between {} can
437contain non-id characters then. Note that if you want to use this for the
438"gf" command, you need to add the '{' and '}' characters to 'isfname'.
439
440NOTE: expanding environment variables and "~/" is only done with the ":set"
441command, not when assigning a value to an option with ":let".
442
Bram Moolenaarc572da52017-08-27 16:52:01 +0200443 *$HOME-windows*
444On MS-Windows, if $HOME is not defined as an environment variable, then
445at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200446If $HOMEDRIVE is not set then $USERPROFILE is used.
447
448This expanded value is not exported to the environment, this matters when
449running an external command: >
450 :echo system('set | findstr ^HOME=')
451and >
452 :echo luaeval('os.getenv("HOME")')
453should echo nothing (an empty string) despite exists('$HOME') being true.
454When setting $HOME to a non-empty string it will be exported to the
455subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200456
Bram Moolenaar071d4272004-06-13 20:20:40 +0000457
458Note the maximum length of an expanded option is limited. How much depends on
459the system, mostly it is something like 256 or 1024 characters.
460
461 *:fix* *:fixdel*
462:fix[del] Set the value of 't_kD':
463 't_kb' is 't_kD' becomes ~
464 CTRL-? CTRL-H
465 not CTRL-? CTRL-?
466
Bram Moolenaar82be4842021-01-11 19:40:15 +0100467 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000468
469 If your delete key terminal code is wrong, but the
470 code for backspace is alright, you can put this in
471 your .vimrc: >
472 :fixdel
473< This works no matter what the actual code for
474 backspace is.
475
476 If the backspace key terminal code is wrong you can
477 use this: >
478 :if &term == "termname"
479 : set t_kb=^V<BS>
480 : fixdel
481 :endif
482< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000483 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000484 with your terminal name.
485
486 If your <Delete> key sends a strange key sequence (not
487 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
488 :if &term == "termname"
489 : set t_kD=^V<Delete>
490 :endif
491< Where "^V" is CTRL-V and "<Delete>" is the delete key
492 (don't type eight characters!). Replace "termname"
493 with your terminal name.
494
495 *Linux-backspace*
496 Note about Linux: By default the backspace key
497 produces CTRL-?, which is wrong. You can fix it by
498 putting this line in your rc.local: >
499 echo "keycode 14 = BackSpace" | loadkeys
500<
501 *NetBSD-backspace*
502 Note about NetBSD: If your backspace doesn't produce
503 the right code, try this: >
504 xmodmap -e "keycode 22 = BackSpace"
505< If this works, add this in your .Xmodmap file: >
506 keysym 22 = BackSpace
507< You need to restart for this to take effect.
508
509==============================================================================
5102. Automatically setting options *auto-setting*
511
512Besides changing options with the ":set" command, there are three alternatives
513to set options automatically for one or more files:
514
5151. When starting Vim initializations are read from various places. See
516 |initialization|. Most of them are performed for all editing sessions,
517 and some of them depend on the directory where Vim is started.
518 You can create an initialization file with |:mkvimrc|, |:mkview| and
519 |:mksession|.
5202. If you start editing a new file, the automatic commands are executed.
521 This can be used to set options for files matching a particular pattern and
522 many other things. See |autocommand|.
5233. If you start editing a new file, and the 'modeline' option is on, a
524 number of lines at the beginning and end of the file are checked for
525 modelines. This is explained here.
526
527 *modeline* *vim:* *vi:* *ex:* *E520*
528There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100529 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100531[text{white}] empty or any text followed by at least one blank
532 character (<Space> or <Tab>); "ex:" always requires at
533 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200534{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200535[white] optional white space
536{options} a list of option settings, separated with white space
537 or ':', where each part between ':' is the argument
538 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000539
Bram Moolenaar14b69452013-06-29 23:05:20 +0200540Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000541 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200542 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543
544The second form (this is compatible with some versions of Vi):
545
Bram Moolenaarade0d392020-01-21 22:33:58 +0100546 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
Bram Moolenaarade0d392020-01-21 22:33:58 +0100548[text{white}] empty or any text followed by at least one blank
549 character (<Space> or <Tab>); "ex:" always requires at
550 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200551{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
552[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200553se[t] the string "set " or "se " (note the space); When
554 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200555{options} a list of options, separated with white space, which
556 is the argument for a ":set" command
557: a colon
558[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000559
Bram Moolenaar14b69452013-06-29 23:05:20 +0200560Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000561 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200562 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200564The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
565chance that a normal word like "lex:" is caught. There is one exception:
566"vi:" and "vim:" can also be at the start of the line (for compatibility with
567version 3.0). Using "ex:" at the start of the line will be ignored (this
568could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000569
Hu Jialun9dcd3492021-08-28 20:42:50 +0200570If the modeline is disabled within a modeline, subsequent modelines will be
571ignored. This is to allow turning off modeline on a per-file basis. This is
572useful when a line looks like a modeline but isn't. For example, it would be
573good to start a YAML file containing strings like "vim:" with
574 # vim: nomodeline ~
575so as to avoid modeline misdetection. Following options on the same line
576after modeline deactivation, if any, are still evaluated (but you would
577normally not have any).
578
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579 *modeline-local*
580The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000581buffer and window that contain the file. Although it's possible to set global
582options from a modeline, this is unusual. If you have two windows open and
583the files in it set the same global option to a different value, the result
584depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000585
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000586When editing a file that was already loaded, only the window-local options
587from the modeline are used. Thus if you manually changed a buffer-local
588option after opening the file, it won't be changed if you edit the same buffer
589in another window. But window-local options will be set.
590
Bram Moolenaar071d4272004-06-13 20:20:40 +0000591 *modeline-version*
592If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200593number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594 vim{vers}: version {vers} or later
595 vim<{vers}: version before {vers}
596 vim={vers}: version {vers}
597 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100598{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
599For example, to use a modeline only for Vim 7.0:
600 /* vim700: set foldmethod=marker */ ~
601To use a modeline for Vim after version 7.2:
602 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000603There can be no blanks between "vim" and the ":".
604
605
606The number of lines that are checked can be set with the 'modelines' option.
607If 'modeline' is off or 'modelines' is 0 no lines are checked.
608
609Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000610like:
611 /* vi:ts=4: */ ~
612will give an error message for the trailing "*/". This line is OK:
613 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614
615If an error is detected the rest of the line is skipped.
616
617If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000618backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100619 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
620This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
621before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200622 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000623No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000624might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200625can be set. For some options a flag is set, so that when the value is used
626the |sandbox| is effective. Some options can only be set from the modeline
627when 'modelineexpr' is set (the default is off).
628
629Still, there is always a small risk that a modeline causes trouble. E.g.,
630when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
631So disable modelines before editing untrusted text. The mail ftplugin does
632this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633
634Hint: If you would like to do something else than setting an option, you could
635define an autocommand that checks the file for a specific string. For
636example: >
637 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
638And define a function SetVar() that does something with the line containing
639"VAR".
640
641==============================================================================
6423. Options summary *option-summary*
643
644In the list below all the options are mentioned with their full name and with
645an abbreviation if there is one. Both forms may be used.
646
647In this document when a boolean option is "set" that means that ":set option"
648is entered. When an option is "reset", ":set nooption" is used.
649
650For some options there are two default values: The "Vim default", which is
651used when 'compatible' is not set, and the "Vi default", which is used when
652'compatible' is set.
653
654Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000655are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656different value in each window. For example the 'list' option can be set in
657one window and reset in another for the same text, giving both types of view
658at the same time. There are a few options that are specific to a certain
659file. These can have a different value for each file or buffer. For example
660the 'textwidth' option can be 78 for a normal text file and 0 for a C
661program.
662
663 global one option for all buffers and windows
664 local to window each window has its own copy of this option
665 local to buffer each buffer has its own copy of this option
666
667When creating a new window the option values from the currently active window
668are used as a default value for the window-specific options. For the
669buffer-specific options this depends on the 's' and 'S' flags in the
670'cpoptions' option. If 's' is included (which is the default) the values for
671buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000672first entered. If 'S' is present the options are copied each time the buffer
673is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674present, the options are copied from the currently active buffer when the
675buffer is created.
676
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000677Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000679Not all options are supported in all versions. This depends on the supported
680features and sometimes on the system. A remark about this is in curly braces
681below. When an option is not supported it may still be set without getting an
682error, this is called a hidden option. You can't get the value of a hidden
683option though, it is not stored.
684
685To test if option "foo" can be used with ":set" use something like this: >
686 if exists('&foo')
687This also returns true for a hidden option. To test if option "foo" is really
688supported use something like this: >
689 if exists('+foo')
690<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691 *E355*
692A jump table for the options with a short description can be found at |Q_op|.
693
694 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100695'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697 {only available when compiled with the |+rightleft|
698 feature}
699 The ASCII code for the first letter of the Hebrew alphabet. The
700 routine that maps the keyboard in Hebrew mode, both in Insert mode
701 (when hkmap is set) and on the command-line (when hitting CTRL-_)
702 outputs the Hebrew characters in the range [aleph..aleph+26].
703 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
704 See |rileft.txt|.
705
706 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
707'allowrevins' 'ari' boolean (default off)
708 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709 {only available when compiled with the |+rightleft|
710 feature}
711 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
712 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
713 into reverse Insert mode, and don't know how to get out. See
714 'revins'.
715 NOTE: This option is reset when 'compatible' is set.
716
717 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
718'altkeymap' 'akm' boolean (default off)
719 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 {only available when compiled with the |+farsi|
721 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100722 This option was for using Farsi, which has been removed. See
723 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000724
725 *'ambiwidth'* *'ambw'*
726'ambiwidth' 'ambw' string (default: "single")
727 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
729 Tells Vim what to do with characters with East Asian Width Class
730 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
731 letters, Cyrillic letters).
732
733 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000734 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735 expected by most users.
736 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200737 *E834* *E835*
738 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100739 contains a character that would be double width. These errors may
740 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200741
742 The values are overruled for characters specified with
743 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000744
745 There are a number of CJK fonts for which the width of glyphs for
746 those characters are solely based on how many octets they take in
747 legacy/traditional CJK encodings. In those encodings, Euro,
748 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000749 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000751 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 Vim is running inside a terminal (emulators) that uses a CJK font
753 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
754 this option should be set to "double" to match the width perceived
755 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100756 to be set to "double" under CJK MS-Windows when the system locale is
757 set to one of CJK locales. See Unicode Standard Annex #11
758 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000759
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100760 Vim may set this option automatically at startup time when Vim is
761 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200762 escape sequence to request cursor position report. The response can
763 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100764
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
766'antialias' 'anti' boolean (default: off)
767 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000768 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200769 on macOS}
770 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
772 which can be easier to read at certain sizes on certain displays.
773 Setting this option can sometimes cause problems if 'guifont' is set
774 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100775 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776
777 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
778'autochdir' 'acd' boolean (default off)
779 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200780 {only available when compiled with it, use
781 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000782 When on, Vim will change the current working directory whenever you
783 open a file, switch buffers, delete a buffer or open/close a window.
784 It will change to the directory containing the file which was opened
785 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000786 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200788 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
789'autoshelldir' 'asd' boolean (default off)
790 global
791 When on, Vim will change the current working directory whenever you
792 change the directory of the shell running in a terminal window. You
793 need proper setting-up, so whenever the shell's pwd changes an OSC 7
794 escape sequence will be emitted. For example, on Linux, you can source
795 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
796
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
798'arabic' 'arab' boolean (default off)
799 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800 {only available when compiled with the |+arabic|
801 feature}
802 This option can be set to start editing Arabic text.
803 Setting this option will:
804 - Set the 'rightleft' option, unless 'termbidi' is set.
805 - Set the 'arabicshape' option, unless 'termbidi' is set.
806 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
807 between typing English and Arabic key mapping.
808 - Set the 'delcombine' option
809 Note that 'encoding' must be "utf-8" for working with Arabic text.
810
811 Resetting this option will:
812 - Reset the 'rightleft' option.
813 - Disable the use of 'keymap' (without changing its value).
814 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200815 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100816 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 Also see |arabic.txt|.
818
819 *'arabicshape'* *'arshape'*
820 *'noarabicshape'* *'noarshape'*
821'arabicshape' 'arshape' boolean (default on)
822 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823 {only available when compiled with the |+arabic|
824 feature}
825 When on and 'termbidi' is off, the required visual character
826 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200827 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828 one which encompasses:
829 a) the changing/morphing of characters based on their location
830 within a word (initial, medial, final and stand-alone).
831 b) the enabling of the ability to compose characters
832 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100833 When disabled the display shows each character's true stand-alone
834 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 Arabic is a complex language which requires other settings, for
836 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100837 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000838
839 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
840'autoindent' 'ai' boolean (default off)
841 local to buffer
842 Copy indent from current line when starting a new line (typing <CR>
843 in Insert mode or when using the "o" or "O" command). If you do not
844 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000845 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
846 to another line has the same effect, unless the 'I' flag is included
847 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000848 When autoindent is on, formatting (with the "gq" command or when you
849 reach 'textwidth' in Insert mode) uses the indentation of the first
850 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851 When 'smartindent' or 'cindent' is on the indent is changed in
852 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200853 The 'autoindent' option is reset when the 'paste' option is set and
854 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855
856 *'autoread'* *'ar'* *'noautoread'* *'noar'*
857'autoread' 'ar' boolean (default off)
858 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859 When a file has been detected to have been changed outside of Vim and
860 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200861 When the file has been deleted this is not done, so you have the text
862 from before it was deleted. When it appears again then it is read.
863 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 If this option has a local value, use this command to switch back to
865 using the global value: >
866 :set autoread<
867<
868 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
869'autowrite' 'aw' boolean (default off)
870 global
871 Write the contents of the file, if it has been modified, on each
872 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000873 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
875 Note that for some commands the 'autowrite' option is not used, see
876 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200877 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200878 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879
880 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
881'autowriteall' 'awa' boolean (default off)
882 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
884 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
885 Setting this option also implies that Vim behaves like 'autowrite' has
886 been set.
887
888 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200889'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891 When set to "dark", Vim will try to use colors that look good on a
892 dark background. When set to "light", Vim will try to use colors that
893 look good on a light background. Any other value is illegal.
894 Vim tries to set the default value according to the terminal used.
895 This will not always be correct.
896 Setting this option does not change the background color, it tells Vim
897 what the background color looks like. For changing the background
898 color, see |:hi-normal|.
899
900 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000901 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000902 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100903 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904 setting 'background' will cause the color scheme to be reloaded. If
905 the color scheme adjusts to the value of 'background' this will work.
906 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100907 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908
909 When setting 'background' to the default value with: >
910 :set background&
911< Vim will guess the value. In the GUI this should work correctly,
912 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200913 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200914 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000915
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200916 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200917 color from the terminal. If the returned RGB value is dark/light and
918 'background' is not dark/light, 'background' will be set and the
919 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200920 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100921 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200922
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923 When starting the GUI, the default value for 'background' will be
924 "light". When the value is not set in the .gvimrc, and Vim detects
925 that the background is actually quite dark, 'background' is set to
926 "dark". But this happens only AFTER the .gvimrc file has been read
927 (because the window needs to be opened to find the actual background
928 color). To get around this, force the GUI window to be opened by
929 putting a ":gui" command in the .gvimrc file, before where the value
930 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200931
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100932 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200933 For other systems "dark" is used when 'term' is "linux",
934 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
935 background. Otherwise the default is "light".
936
Bram Moolenaarc572da52017-08-27 16:52:01 +0200937 The |:terminal| command and the |term_start()| function use the
938 'background' value to decide whether the terminal window will start
939 with a white or black background.
940
Bram Moolenaar071d4272004-06-13 20:20:40 +0000941 Normally this option would be set in the .vimrc file. Possibly
942 depending on the terminal name. Example: >
943 :if &term == "pcterm"
944 : set background=dark
945 :endif
946< When this option is set, the default settings for the highlight groups
947 will change. To use other settings, place ":highlight" commands AFTER
948 the setting of the 'background' option.
949 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
950 to select the colors for syntax highlighting. After changing this
951 option, you must load syntax.vim again to see the result. This can be
952 done with ":syntax on".
953
954 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200955'backspace' 'bs' string (default "", set to "indent,eol,start"
956 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000957 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000958 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
959 mode. This is a list of items, separated by commas. Each item allows
960 a way to backspace over something:
961 value effect ~
962 indent allow backspacing over autoindent
963 eol allow backspacing over line breaks (join lines)
964 start allow backspacing over the start of insert; CTRL-W and CTRL-U
965 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200966 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
967 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968
969 When the value is empty, Vi compatible backspacing is used.
970
971 For backwards compatibility with version 5.4 and earlier:
972 value effect ~
973 0 same as ":set backspace=" (Vi compatible)
974 1 same as ":set backspace=indent,eol"
975 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200976 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000977
978 See |:fixdel| if your <BS> or <Del> key does not do what you want.
979 NOTE: This option is set to "" when 'compatible' is set.
980
981 *'backup'* *'bk'* *'nobackup'* *'nobk'*
982'backup' 'bk' boolean (default off)
983 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000984 Make a backup before overwriting a file. Leave it around after the
985 file has been successfully written. If you do not want to keep the
986 backup file, but you do want a backup while the file is being
987 written, reset this option and set the 'writebackup' option (this is
988 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000989 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000990 |backup-table| for more explanations.
991 When the 'backupskip' pattern matches, a backup is not made anyway.
992 When 'patchmode' is set, the backup may be renamed to become the
993 oldest version of a file.
994 NOTE: This option is reset when 'compatible' is set.
995
996 *'backupcopy'* *'bkc'*
997'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200998 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 When writing a file and a backup is made, this option tells how it's
1000 done. This is a comma separated list of words.
1001
1002 The main values are:
1003 "yes" make a copy of the file and overwrite the original one
1004 "no" rename the file and write a new one
1005 "auto" one of the previous, what works best
1006
1007 Extra values that can be combined with the ones above are:
1008 "breaksymlink" always break symlinks when writing
1009 "breakhardlink" always break hardlinks when writing
1010
1011 Making a copy and overwriting the original file:
1012 - Takes extra time to copy the file.
1013 + When the file has special attributes, is a (hard/symbolic) link or
1014 has a resource fork, all this is preserved.
1015 - When the file is a link the backup will have the name of the link,
1016 not of the real file.
1017
1018 Renaming the file and writing a new one:
1019 + It's fast.
1020 - Sometimes not all attributes of the file can be copied to the new
1021 file.
1022 - When the file is a link the new file will not be a link.
1023
1024 The "auto" value is the middle way: When Vim sees that renaming file
1025 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +00001026 the file is not a link) that is used. When problems are expected, a
1027 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028
1029 The "breaksymlink" and "breakhardlink" values can be used in
1030 combination with any of "yes", "no" and "auto". When included, they
1031 force Vim to always break either symbolic or hard links by doing
1032 exactly what the "no" option does, renaming the original file to
1033 become the backup and writing a new file in its place. This can be
1034 useful for example in source trees where all the files are symbolic or
1035 hard links and any changes should stay in the local source tree, not
1036 be propagated back to the original source.
1037 *crontab*
1038 One situation where "no" and "auto" will cause problems: A program
1039 that opens a file, invokes Vim to edit that file, and then tests if
1040 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001041 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042 example.
1043
1044 When a copy is made, the original file is truncated and then filled
1045 with the new text. This means that protection bits, owner and
1046 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001047 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 group of the backup is set to the group of the original file. If this
1049 fails, the protection bits for the group are made the same as for
1050 others.
1051
1052 When the file is renamed this is the other way around: The backup has
1053 the same attributes of the original file, and the newly written file
1054 is owned by the current user. When the file was a (hard/symbolic)
1055 link, the new file will not! That's why the "auto" value doesn't
1056 rename when the file is a link. The owner and group of the newly
1057 written file will be set to the same ones as the original file, but
1058 the system may refuse to do this. In that case the "auto" value will
1059 again not rename the file.
1060
Bram Moolenaar036986f2017-03-16 17:41:02 +01001061 NOTE: This option is set to the Vi default value when 'compatible' is
1062 set and to the Vim default value when 'compatible' is reset.
1063
Bram Moolenaar071d4272004-06-13 20:20:40 +00001064 *'backupdir'* *'bdir'*
1065'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001066 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067 for Unix: ".,~/tmp,~/")
1068 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069 List of directories for the backup file, separated with commas.
1070 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001071 where this is possible. The directory must exist, Vim will not
1072 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001073 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 impossible!). Writing may fail because of this.
1075 - A directory "." means to put the backup file in the same directory
1076 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001077 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1078 the backup file relative to where the edited file is. The leading
1079 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080 ("." inside a directory name has no special meaning).
1081 - Spaces after the comma are ignored, other spaces are considered part
1082 of the directory name. To have a space at the start of a directory
1083 name, precede it with a backslash.
1084 - To include a comma in a directory name precede it with a backslash.
1085 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001086 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001087 the backup file name will be built from the complete path to the
1088 file with all path separators changed to percent '%' signs. This
1089 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001090 On Win32, it is also possible to end with "\\". However, When a
1091 separating comma is following, you must use "//", since "\\" will
1092 include the comma in the file name. Therefore it is recommended to
1093 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094 - Environment variables are expanded |:set_env|.
1095 - Careful with '\' characters, type one before a space, type two to
1096 get one in the option (see |option-backslash|), for example: >
1097 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1098< - For backwards compatibility with Vim version 3.0 a '>' at the start
1099 of the option is removed.
1100 See also 'backup' and 'writebackup' options.
1101 If you want to hide your backup files on Unix, consider this value: >
1102 :set backupdir=./.backup,~/.backup,.,/tmp
1103< You must create a ".backup" directory in each directory and in your
1104 home directory for this to work properly.
1105 The use of |:set+=| and |:set-=| is preferred when adding or removing
1106 directories from the list. This avoids problems when a future version
1107 uses another default.
1108 This option cannot be set from a |modeline| or in the |sandbox|, for
1109 security reasons.
1110
1111 *'backupext'* *'bex'* *E589*
1112'backupext' 'bex' string (default "~", for VMS: "_")
1113 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114 String which is appended to a file name to make the name of the
1115 backup file. The default is quite unusual, because this avoids
1116 accidentally overwriting existing files with a backup file. You might
1117 prefer using ".bak", but make sure that you don't have files with
1118 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001119 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001120
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001121 If you like to keep a lot of backups, you could use a BufWritePre
1122 autocommand to change 'backupext' just before writing the file to
1123 include a timestamp. >
1124 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1125< Use 'backupdir' to put the backup in a different directory.
1126
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001128'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1129 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1130 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132 {not available when compiled without the |+wildignore|
1133 feature}
1134 A list of file patterns. When one of the patterns matches with the
1135 name of the file which is written, no backup file is created. Both
1136 the specified file name and the full path name of the file are used.
1137 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1138 Watch out for special characters, see |option-backslash|.
1139 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001140 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001141
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001142 WARNING: Not having a backup file means that when Vim fails to write
1143 your buffer correctly and then, for whatever reason, Vim exits, you
1144 lose both the original file and what you were writing. Only disable
1145 backups if you don't care about losing the file.
1146
Bram Moolenaar02467872007-05-06 13:22:01 +00001147 Note that environment variables are not expanded. If you want to use
1148 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001149 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001150
1151< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001152 backup would be made by renaming the original file crontab won't see
1153 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154
1155 *'balloondelay'* *'bdlay'*
1156'balloondelay' 'bdlay' number (default: 600)
1157 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001158 {only available when compiled with the |+balloon_eval|
1159 feature}
1160 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1161
1162 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1163'ballooneval' 'beval' boolean (default off)
1164 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001166 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001167 Switch on the |balloon-eval| functionality for the GUI.
1168
1169 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1170 *'nobevalterm'*
1171'balloonevalterm' 'bevalterm' boolean (default off)
1172 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001173 {only available when compiled with the
1174 |+balloon_eval_term| feature}
1175 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001177 *'balloonexpr'* *'bexpr'*
1178'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001179 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001180 {only available when compiled with the |+balloon_eval|
1181 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001182 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001183 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1184 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001185
1186 v:beval_bufnr number of the buffer in which balloon is going to show
1187 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001188 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001189 v:beval_lnum line number
1190 v:beval_col column number (byte index)
1191 v:beval_text word under or after the mouse pointer
1192
Bram Moolenaar54775062019-07-31 21:07:14 +02001193 Instead of showing a balloon, which is limited to plain text, consider
1194 using a popup window, see |popup_beval_example|. A popup window can
1195 use highlighting and show a border.
1196
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001197 The evaluation of the expression must not have side effects!
1198 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001199 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001200 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001201 \', column ' . v:beval_col .
1202 \ ' of file ' . bufname(v:beval_bufnr) .
1203 \ ' on word "' . v:beval_text . '"'
1204 endfunction
1205 set bexpr=MyBalloonExpr()
1206 set ballooneval
1207<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001208 Also see |balloon_show()|, it can be used if the content of the balloon
1209 is to be fetched asynchronously. In that case evaluating
1210 'balloonexpr' should result in an empty string. If you get a balloon
1211 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001212
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001213 NOTE: The balloon is displayed only if the cursor is on a text
1214 character. If the result of evaluating 'balloonexpr' is not empty,
1215 Vim does not try to send a message to an external debugger (Netbeans
1216 or Sun Workshop).
1217
Bram Moolenaar30b65812012-07-12 22:01:11 +02001218 The expression will be evaluated in the |sandbox| when set from a
1219 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001220 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001221
1222 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001223 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001224
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001225 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001226 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001227< When they are supported "\n" characters will start a new line. If the
1228 expression evaluates to a |List| this is equal to using each List item
1229 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001230 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001231
Bram Moolenaar165bc692015-07-21 17:53:25 +02001232 *'belloff'* *'bo'*
1233'belloff' 'bo' string (default "")
1234 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001235 Specifies for which events the bell will not be rung. It is a comma
1236 separated list of items. For each item that is present, the bell
1237 will be silenced. This is most useful to specify specific events in
1238 insert mode to be silenced.
1239
1240 item meaning when present ~
1241 all All events.
1242 backspace When hitting <BS> or <Del> and deleting results in an
1243 error.
1244 cursor Fail to move around using the cursor keys or
1245 <PageUp>/<PageDown> in |Insert-mode|.
1246 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1247 |i_CTRL-X_CTRL-T|.
1248 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1249 |i_CTRL-E|.
1250 ctrlg Unknown Char after <C-G> in Insert mode.
1251 error Other Error occurred (e.g. try to join last line)
1252 (mostly used in |Normal-mode| or |Cmdline-mode|).
1253 esc hitting <Esc> in |Normal-mode|.
1254 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001255 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001256 insertmode Pressing <Esc> in 'insertmode'.
1257 lang Calling the beep module for Lua/Mzscheme/TCL.
1258 mess No output available for |g<|.
1259 showmatch Error occurred for 'showmatch' function.
1260 operator Empty region error |cpo-E|.
1261 register Unknown register after <C-R> in |Insert-mode|.
1262 shell Bell from shell output |:!|.
1263 spell Error happened on spell suggest.
1264 wildmode More matches in |cmdline-completion| available
1265 (depends on the 'wildmode' setting).
1266
Bram Moolenaar036986f2017-03-16 17:41:02 +01001267 This is most useful to fine tune when in Insert mode the bell should
1268 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001269 indicate that an error occurred. It can be silenced by adding the
1270 "error" keyword.
1271
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1273'binary' 'bin' boolean (default off)
1274 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 This option should be set before editing a binary file. You can also
1276 use the |-b| Vim argument. When this option is switched on a few
1277 options will be changed (also when it already was on):
1278 'textwidth' will be set to 0
1279 'wrapmargin' will be set to 0
1280 'modeline' will be off
1281 'expandtab' will be off
1282 Also, 'fileformat' and 'fileformats' options will not be used, the
1283 file is read and written like 'fileformat' was "unix" (a single <NL>
1284 separates lines).
1285 The 'fileencoding' and 'fileencodings' options will not be used, the
1286 file is read without conversion.
1287 NOTE: When you start editing a(nother) file while the 'bin' option is
1288 on, settings from autocommands may change the settings again (e.g.,
1289 'textwidth'), causing trouble when editing. You might want to set
1290 'bin' again when the file has been loaded.
1291 The previous values of these options are remembered and restored when
1292 'bin' is switched from on to off. Each buffer has its own set of
1293 saved option values.
1294 To edit a file with 'binary' set you can use the |++bin| argument.
1295 This avoids you have to do ":set bin", which would have effect for all
1296 files you edit.
1297 When writing a file the <EOL> for the last line is only written if
1298 there was one in the original file (normally Vim appends an <EOL> to
1299 the last line if there is none; this would make the file longer). See
1300 the 'endofline' option.
1301
1302 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1303'bioskey' 'biosk' boolean (default on)
1304 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001305 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001306 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307
1308 *'bomb'* *'nobomb'*
1309'bomb' boolean (default off)
1310 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001311 When writing a file and the following conditions are met, a BOM (Byte
1312 Order Mark) is prepended to the file:
1313 - this option is on
1314 - the 'binary' option is off
1315 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1316 endian variants.
1317 Some applications use the BOM to recognize the encoding of the file.
1318 Often used for UCS-2 files on MS-Windows. For other applications it
1319 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001320 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1322 check for the presence of the BOM is done and 'bomb' set accordingly.
1323 Unless 'binary' is set, it is removed from the first line, so that you
1324 don't see it when editing. When you don't change the options, the BOM
1325 will be restored when writing the file.
1326
1327 *'breakat'* *'brk'*
1328'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1329 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001330 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331 feature}
1332 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001333 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1334 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001335
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001336 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001337'breakindent' 'bri' boolean (default off)
1338 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001339 {not available when compiled without the |+linebreak|
1340 feature}
1341 Every wrapped line will continue visually indented (same amount of
1342 space as the beginning of that line), thus preserving horizontal blocks
1343 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001344 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001345
1346 *'breakindentopt'* *'briopt'*
1347'breakindentopt' 'briopt' string (default empty)
1348 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001349 {not available when compiled without the |+linebreak|
1350 feature}
1351 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001352 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001353 min:{n} Minimum text width that will be kept after
1354 applying 'breakindent', even if the resulting
1355 text should normally be narrower. This prevents
1356 text indented almost to the right window border
1357 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001358 shift:{n} After applying 'breakindent', the wrapped line's
1359 beginning will be shifted by the given number of
1360 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001361 indentation (negative) or emphasizing the line
1362 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001363 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001364 additional indent.
Maxim Kimf674b352021-07-22 11:46:59 +02001365 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001366 numbered or bulleted list (using the
1367 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001368 list:-1 Uses the length of a match with 'formatlistpat'
1369 for indentation.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001370 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001371
Bram Moolenaar071d4272004-06-13 20:20:40 +00001372 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001373'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001374 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001375 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001376 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001377 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001378 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379 buffer Use the directory of the related buffer.
1380 current Use the current directory.
1381 {path} Use the specified directory
1382
1383 *'bufhidden'* *'bh'*
1384'bufhidden' 'bh' string (default: "")
1385 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386 This option specifies what happens when a buffer is no longer
1387 displayed in a window:
1388 <empty> follow the global 'hidden' option
1389 hide hide the buffer (don't unload it), also when 'hidden'
1390 is not set
1391 unload unload the buffer, also when 'hidden' is set or using
1392 |:hide|
1393 delete delete the buffer from the buffer list, also when
1394 'hidden' is set or using |:hide|, like using
1395 |:bdelete|
1396 wipe wipe out the buffer from the buffer list, also when
1397 'hidden' is set or using |:hide|, like using
1398 |:bwipeout|
1399
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001400 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001401 are lost without a warning. Also, these values may break autocommands
1402 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403 This option is used together with 'buftype' and 'swapfile' to specify
1404 special kinds of buffers. See |special-buffers|.
1405
1406 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1407'buflisted' 'bl' boolean (default: on)
1408 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001409 When this option is set, the buffer shows up in the buffer list. If
1410 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1411 This option is reset by Vim for buffers that are only used to remember
1412 a file name or marks. Vim sets it when starting to edit a buffer.
1413 But not when moving to a buffer with ":buffer".
1414
1415 *'buftype'* *'bt'* *E382*
1416'buftype' 'bt' string (default: "")
1417 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001418 The value of this option specifies the type of a buffer:
1419 <empty> normal buffer
1420 nofile buffer which is not related to a file and will not be
1421 written
1422 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001423 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001424 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001425 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001426 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001427 help help buffer (you are not supposed to set this
1428 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001429 terminal buffer for a |terminal| (you are not supposed to set
1430 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001431 prompt buffer where only the last line can be edited, meant
1432 to be used by a plugin, see |prompt-buffer|
1433 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001434 popup buffer used in a popup window, see |popup|.
1435 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436
1437 This option is used together with 'bufhidden' and 'swapfile' to
1438 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001439 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440
1441 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001442 One such effect is that Vim will not check the timestamp of the file,
1443 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001444
Bram Moolenaar280f1262006-01-30 00:14:18 +00001445 A "quickfix" buffer is only used for the error list and the location
1446 list. This value is set by the |:cwindow| and |:lwindow| commands and
1447 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448
1449 "nofile" and "nowrite" buffers are similar:
1450 both: The buffer is not to be written to disk, ":w" doesn't
1451 work (":w filename" does work though).
1452 both: The buffer is never considered to be |'modified'|.
1453 There is no warning when the changes will be lost, for
1454 example when you quit Vim.
1455 both: A swap file is only created when using too much memory
1456 (when 'swapfile' has been reset there is never a swap
1457 file).
1458 nofile only: The buffer name is fixed, it is not handled like a
1459 file name. It is not modified in response to a |:cd|
1460 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001461 both: When using ":e bufname" and already editing "bufname"
1462 the buffer is made empty and autocommands are
1463 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001464 *E676*
1465 "acwrite" implies that the buffer name is not related to a file, like
1466 "nofile", but it will be written. Thus, in contrast to "nofile" and
1467 "nowrite", ":w" does work and a modified buffer can't be abandoned
1468 without saving. For writing there must be matching |BufWriteCmd|,
1469 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470
1471 *'casemap'* *'cmp'*
1472'casemap' 'cmp' string (default: "internal,keepascii")
1473 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474 Specifies details about changing the case of letters. It may contain
1475 these words, separated by a comma:
1476 internal Use internal case mapping functions, the current
1477 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001478 matters when 'encoding' is a Unicode encoding,
1479 "latin1" or "iso-8859-15". When "internal" is
1480 omitted, the towupper() and towlower() system library
1481 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001482 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1483 case mapping, the current locale is not effective.
1484 This probably only matters for Turkish.
1485
1486 *'cdpath'* *'cd'* *E344* *E346*
1487'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1488 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 {not available when compiled without the
1490 |+file_in_path| feature}
1491 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001492 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1493 searched for has a relative path, not an absolute part starting with
1494 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001495 The 'cdpath' option's value has the same form and semantics as
1496 |'path'|. Also see |file-searching|.
1497 The default value is taken from $CDPATH, with a "," prepended to look
1498 in the current directory first.
1499 If the default value taken from $CDPATH is not what you want, include
1500 a modified version of the following command in your vimrc file to
1501 override it: >
1502 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1503< This option cannot be set from a |modeline| or in the |sandbox|, for
1504 security reasons.
1505 (parts of 'cdpath' can be passed to the shell to expand file names).
1506
1507 *'cedit'*
1508'cedit' string (Vi default: "", Vim default: CTRL-F)
1509 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001510 The key used in Command-line Mode to open the command-line window.
1511 The default is CTRL-F when 'compatible' is off.
1512 Only non-printable keys are allowed.
1513 The key can be specified as a single character, but it is difficult to
1514 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001515 :exe "set cedit=\<C-Y>"
1516 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001517< |Nvi| also has this option, but it only uses the first character.
1518 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001519 NOTE: This option is set to the Vim default value when 'compatible'
1520 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521
1522 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1523'charconvert' 'ccv' string (default "")
1524 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001525 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001526 An expression that is used for character encoding conversion. It is
1527 evaluated when a file that is to be read or has been written has a
1528 different encoding from what is desired.
1529 'charconvert' is not used when the internal iconv() function is
1530 supported and is able to do the conversion. Using iconv() is
1531 preferred, because it is much faster.
1532 'charconvert' is not used when reading stdin |--|, because there is no
1533 file to convert from. You will have to save the text in a file first.
1534 The expression must return zero or an empty string for success,
1535 non-zero for failure.
1536 The possible encoding names encountered are in 'encoding'.
1537 Additionally, names given in 'fileencodings' and 'fileencoding' are
1538 used.
1539 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1540 is done internally by Vim, 'charconvert' is not used for this.
1541 'charconvert' is also used to convert the viminfo file, if the 'c'
1542 flag is present in 'viminfo'. Also used for Unicode conversion.
1543 Example: >
1544 set charconvert=CharConvert()
1545 fun CharConvert()
1546 system("recode "
1547 \ . v:charconvert_from . ".." . v:charconvert_to
1548 \ . " <" . v:fname_in . " >" v:fname_out)
1549 return v:shell_error
1550 endfun
1551< The related Vim variables are:
1552 v:charconvert_from name of the current encoding
1553 v:charconvert_to name of the desired encoding
1554 v:fname_in name of the input file
1555 v:fname_out name of the output file
1556 Note that v:fname_in and v:fname_out will never be the same.
1557 Note that v:charconvert_from and v:charconvert_to may be different
1558 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1559 Encryption is not done by Vim when using 'charconvert'. If you want
1560 to encrypt the file after conversion, 'charconvert' should take care
1561 of this.
1562 This option cannot be set from a |modeline| or in the |sandbox|, for
1563 security reasons.
1564
1565 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1566'cindent' 'cin' boolean (default off)
1567 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 {not available when compiled without the |+cindent|
1569 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001570 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571 that trigger reindenting in insert mode and 'cinoptions' to set your
1572 preferred indent style.
1573 If 'indentexpr' is not empty, it overrules 'cindent'.
1574 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1575 the "=" operator indents using this algorithm rather than calling an
1576 external program.
1577 See |C-indenting|.
1578 When you don't like the way 'cindent' works, try the 'smartindent'
1579 option or 'indentexpr'.
1580 This option is not used when 'paste' is set.
1581 NOTE: This option is reset when 'compatible' is set.
1582
1583 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001584'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001585 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001586 {not available when compiled without the |+cindent|
1587 feature}
1588 A list of keys that, when typed in Insert mode, cause reindenting of
1589 the current line. Only used if 'cindent' is on and 'indentexpr' is
1590 empty.
1591 For the format of this option see |cinkeys-format|.
1592 See |C-indenting|.
1593
1594 *'cinoptions'* *'cino'*
1595'cinoptions' 'cino' string (default "")
1596 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001597 {not available when compiled without the |+cindent|
1598 feature}
1599 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1600 program. See |cinoptions-values| for the values of this option, and
1601 |C-indenting| for info on C indenting in general.
1602
1603
1604 *'cinwords'* *'cinw'*
1605'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1606 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 {not available when compiled without both the
1608 |+cindent| and the |+smartindent| features}
1609 These keywords start an extra indent in the next line when
1610 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1611 an appropriate place (inside {}).
1612 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1613 matter, include the keyword both the uppercase and lowercase:
1614 "if,If,IF".
1615
1616 *'clipboard'* *'cb'*
1617'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1618 for X-windows, "" otherwise)
1619 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001620 {only in GUI versions or when the |+xterm_clipboard|
1621 feature is included}
1622 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001623 Note: if one of the items is "exclude:", then you can't add an item
1624 after that. Therefore do append an item with += but use ^= to
1625 prepend, e.g.: >
1626 set clipboard^=unnamed
1627< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001629 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001630 unnamed When included, Vim will use the clipboard register '*'
1631 for all yank, delete, change and put operations which
1632 would normally go to the unnamed register. When a
1633 register is explicitly specified, it will always be
1634 used regardless of whether "unnamed" is in 'clipboard'
1635 or not. The clipboard register can always be
1636 explicitly accessed using the "* notation. Also see
1637 |gui-clipboard|.
1638
Bram Moolenaar30b65812012-07-12 22:01:11 +02001639 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001640 unnamedplus A variant of the "unnamed" flag which uses the
1641 clipboard register '+' (|quoteplus|) instead of
1642 register '*' for all yank, delete, change and put
1643 operations which would normally go to the unnamed
1644 register. When "unnamed" is also included to the
1645 option, yank operations (but not delete, change or
1646 put) will additionally copy the text into register
1647 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001648 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001649 Availability can be checked with: >
1650 if has('unnamedplus')
1651<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001652 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653 autoselect Works like the 'a' flag in 'guioptions': If present,
1654 then whenever Visual mode is started, or the Visual
1655 area extended, Vim tries to become the owner of the
1656 windowing system's global selection or put the
1657 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001658 register "*. See |'go-a'| and |quotestar| for details.
1659 When the GUI is active, the 'a' flag in 'guioptions'
1660 is used, when the GUI is not active, this "autoselect"
1661 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001662 Also applies to the modeless selection.
1663
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001664 *clipboard-autoselectplus*
1665 autoselectplus Like "autoselect" but using the + register instead of
1666 the * register. Compare to the 'P' flag in
1667 'guioptions'.
1668
1669 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670 autoselectml Like "autoselect", but for the modeless selection
1671 only. Compare to the 'A' flag in 'guioptions'.
1672
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001673 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001674 html When the clipboard contains HTML, use this when
1675 pasting. When putting text on the clipboard, mark it
1676 as HTML. This works to copy rendered HTML from
1677 Firefox, paste it as raw HTML in Vim, select the HTML
1678 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001679 You probably want to add this only temporarily,
1680 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001681 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001682
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001683 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001684 exclude:{pattern}
1685 Defines a pattern that is matched against the name of
1686 the terminal 'term'. If there is a match, no
1687 connection will be made to the X server. This is
1688 useful in this situation:
1689 - Running Vim in a console.
1690 - $DISPLAY is set to start applications on another
1691 display.
1692 - You do not want to connect to the X server in the
1693 console, but do want this in a terminal emulator.
1694 To never connect to the X server use: >
1695 exclude:.*
1696< This has the same effect as using the |-X| argument.
1697 Note that when there is no connection to the X server
1698 the window title won't be restored and the clipboard
1699 cannot be accessed.
1700 The value of 'magic' is ignored, {pattern} is
1701 interpreted as if 'magic' was on.
1702 The rest of the option value will be used for
1703 {pattern}, this must be the last entry.
1704
1705 *'cmdheight'* *'ch'*
1706'cmdheight' 'ch' number (default 1)
1707 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 Number of screen lines to use for the command-line. Helps avoiding
1709 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001710 The value of this option is stored with the tab page, so that each tab
1711 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712
1713 *'cmdwinheight'* *'cwh'*
1714'cmdwinheight' 'cwh' number (default 7)
1715 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716 Number of screen lines to use for the command-line window. |cmdwin|
1717
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001718 *'colorcolumn'* *'cc'*
1719'colorcolumn' 'cc' string (default "")
1720 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001721 {not available when compiled without the |+syntax|
1722 feature}
1723 'colorcolumn' is a comma separated list of screen columns that are
1724 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1725 text. Will make screen redrawing slower.
1726 The screen column can be an absolute number, or a number preceded with
1727 '+' or '-', which is added to or subtracted from 'textwidth'. >
1728
1729 :set cc=+1 " highlight column after 'textwidth'
1730 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1731 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1732<
1733 When 'textwidth' is zero then the items with '-' and '+' are not used.
1734 A maximum of 256 columns are highlighted.
1735
Bram Moolenaar071d4272004-06-13 20:20:40 +00001736 *'columns'* *'co'* *E594*
1737'columns' 'co' number (default 80 or terminal width)
1738 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001740 initialization and does not have to be set by hand. Also see
1741 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742 When Vim is running in the GUI or in a resizable window, setting this
1743 option will cause the window size to be changed. When you only want
1744 to use the size for the GUI, put the command in your |gvimrc| file.
1745 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001746 number of columns of the display, the display may be messed up. For
1747 the GUI it is always possible and Vim limits the number of columns to
1748 what fits on the screen. You can use this command to get the widest
1749 window possible: >
1750 :set columns=9999
1751< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752
1753 *'comments'* *'com'* *E524* *E525*
1754'comments' 'com' string (default
1755 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1756 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757 A comma separated list of strings that can start a comment line. See
1758 |format-comments|. See |option-backslash| about using backslashes to
1759 insert a space.
1760
1761 *'commentstring'* *'cms'* *E537*
1762'commentstring' 'cms' string (default "/*%s*/")
1763 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764 {not available when compiled without the |+folding|
1765 feature}
1766 A template for a comment. The "%s" in the value is replaced with the
1767 comment text. Currently only used to add markers for folding, see
1768 |fold-marker|.
1769
1770 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001771'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001772 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 This option has the effect of making Vim either more Vi-compatible, or
1775 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001776
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001778 other options are also changed as a side effect.
1779 NOTE: Setting or resetting this option can have a lot of unexpected
1780 effects: Mappings are interpreted in another way, undo behaves
1781 differently, etc. If you set this option in your vimrc file, you
1782 should probably put it at the very start.
1783
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 By default this option is on and the Vi defaults are used for the
1785 options. This default was chosen for those people who want to use Vim
1786 just like Vi, and don't even (want to) know about the 'compatible'
1787 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001788 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001789 this option is switched off, and all options that have not been
1790 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001791 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001792 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001793 happen for the system-wide vimrc or gvimrc file, nor for a file given
1794 with the |-u| argument). Also see |compatible-default| and
1795 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 You can also set this option with the "-C" argument, and reset it with
1797 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001798 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799
Bram Moolenaar214641f2017-03-05 17:04:09 +01001800 When this option is set, numerous other options are set to make Vim as
1801 Vi-compatible as possible. When this option is unset, various options
1802 are set to make Vim more useful. The table below lists all the
1803 options affected.
1804 The {?} column indicates when the options are affected:
1805 + Means that the option is set to the value given in {set value} when
1806 'compatible' is set.
1807 & Means that the option is set to the value given in {set value} when
1808 'compatible' is set AND is set to its Vim default value when
1809 'compatible' is unset.
1810 - Means the option is NOT changed when setting 'compatible' but IS
1811 set to its Vim default when 'compatible' is unset.
1812 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813
Bram Moolenaar036986f2017-03-16 17:41:02 +01001814 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001815
1816 'allowrevins' + off no CTRL-_ command
1817 'antialias' + off don't use antialiased fonts
1818 'arabic' + off reset arabic-related options
1819 'arabicshape' + on correct character shapes
1820 'backspace' + "" normal backspace
1821 'backup' + off no backup file
1822 'backupcopy' & Unix: "yes" backup file is a copy
1823 else: "auto" copy or rename backup file
1824 'balloonexpr' + "" text to show in evaluation balloon
1825 'breakindent' + off don't indent when wrapping lines
1826 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1827 'cindent' + off no C code indentation
1828 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1829 'copyindent' + off don't copy indent structure
1830 'cpoptions' & (all flags) Vi-compatible flags
1831 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001832 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001833 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001834 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001835 'cscopeverbose' + off see |cscopeverbose|
1836 'delcombine' + off unicode: delete whole char combination
1837 'digraph' + off no digraphs
1838 'esckeys' & off no <Esc>-keys in Insert mode
1839 'expandtab' + off tabs not expanded to spaces
1840 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001841 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001842 'formatexpr' + "" use 'formatprg' for auto-formatting
1843 'formatoptions' & "vt" Vi compatible formatting
1844 'gdefault' + off no default 'g' flag for ":s"
1845 'history' & 0 no commandline history
1846 'hkmap' + off no Hebrew keyboard mapping
1847 'hkmapp' + off no phonetic Hebrew keyboard mapping
1848 'hlsearch' + off no highlighting of search matches
1849 'incsearch' + off no incremental searching
1850 'indentexpr' + "" no indenting by expression
1851 'insertmode' + off do not start in Insert mode
1852 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001854 'joinspaces' + on insert 2 spaces after period
1855 'modeline' & off no modelines
1856 'more' & off no pauses in listings
1857 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1858 'numberwidth' & 8 min number of columns for line number
1859 'preserveindent'+ off don't preserve current indent structure
1860 when changing it
1861 'revins' + off no reverse insert
1862 'ruler' + off no ruler
1863 'scrolljump' + 1 no jump scroll
1864 'scrolloff' + 0 no scroll offset
1865 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1866 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001867 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001868 'showcmd' & off command characters not shown
1869 'showmode' & off current mode not shown
1870 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1871 'smartcase' + off no automatic ignore case switch
1872 'smartindent' + off no smart indentation
1873 'smarttab' + off no smart tab size
1874 'softtabstop' + 0 tabs are always 'tabstop' positions
1875 'startofline' + on goto startofline with some commands
1876 'tagcase' & "followic" 'ignorecase' when searching tags file
1877 'tagrelative' & off tag file names are not relative
1878 'termguicolors' + off don't use highlight-(guifg|guibg)
1879 'textauto' & off no automatic textmode detection
1880 'textwidth' + 0 no automatic line wrap
1881 'tildeop' + off tilde is not an operator
1882 'ttimeout' + off no terminal timeout
1883 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001884 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001885 'virtualedit' + "" cursor can only be placed on characters
1886 'whichwrap' & "" left-right movements don't wrap
1887 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001889 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890
1891 *'complete'* *'cpt'* *E535*
1892'complete' 'cpt' string (default: ".,w,b,u,t,i")
1893 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 This option specifies how keyword completion |ins-completion| works
1895 when CTRL-P or CTRL-N are used. It is also used for whole-line
1896 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1897 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001898 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001899 w scan buffers from other windows
1900 b scan other loaded buffers that are in the buffer list
1901 u scan the unloaded buffers that are in the buffer list
1902 U scan the buffers that are not in the buffer list
1903 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001904 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905 k{dict} scan the file {dict}. Several "k" flags can be given,
1906 patterns are valid too. For example: >
1907 :set cpt=k/usr/dict/*,k~/spanish
1908< s scan the files given with the 'thesaurus' option
1909 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1910 are valid too.
1911 i scan current and included files
1912 d scan current and included files for defined name or macro
1913 |i_CTRL-X_CTRL-D|
1914 ] tag completion
1915 t same as "]"
1916
1917 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1918 not executed, this may lead to unexpected completions from some files
1919 (gzipped files for example). Unloaded buffers are not scanned for
1920 whole-line completion.
1921
1922 The default is ".,w,b,u,t,i", which means to scan:
1923 1. the current buffer
1924 2. buffers in other windows
1925 3. other loaded buffers
1926 4. unloaded buffers
1927 5. tags
1928 6. included files
1929
1930 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001931 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1932 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001934 *'completefunc'* *'cfu'*
1935'completefunc' 'cfu' string (default: empty)
1936 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001937 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001938 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001939 This option specifies a function to be used for Insert mode completion
1940 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001941 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00001942 invoked and what it should return. The value can be the name of a
1943 function, a |lambda| or a |Funcref|. See |option-value-function| for
1944 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001945 This option cannot be set from a |modeline| or in the |sandbox|, for
1946 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001947
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001948 *'completeslash'* *'csl'*
1949'completeslash' 'csl' string (default: "")
1950 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001951 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001952 When this option is set it overrules 'shellslash' for completion:
1953 - When this option is set to "slash", a forward slash is used for path
1954 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001955 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001956 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001957 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001958 - When this option is empty, same character is used as for
1959 'shellslash'.
1960 For Insert mode completion the buffer-local value is used. For
1961 command line completion the global value is used.
1962
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001963 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001964'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001965 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001966 A comma separated list of options for Insert mode completion
1967 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001968
1969 menu Use a popup menu to show the possible completions. The
1970 menu is only shown when there is more than one match and
1971 sufficient colors are available. |ins-completion-menu|
1972
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001973 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001974 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001975 match, e.g., what file it comes from.
1976
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001977 longest Only insert the longest common text of the matches. If
1978 the menu is displayed you can use CTRL-L to add more
1979 characters. Whether case is ignored depends on the kind
1980 of completion. For buffer text the 'ignorecase' option is
1981 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001982
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001983 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001984 completion in the preview window. Only works in
1985 combination with "menu" or "menuone".
1986
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001987 popup Show extra information about the currently selected
1988 completion in a popup window. Only works in combination
1989 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001990 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001991 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001992
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001993 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001994 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001995 |CompleteChanged| autocommand to fetch the info and call
1996 |popup_show()| once the popup has been filled.
1997 See the example at |complete-popuphidden|.
1998 {only works when compiled with the |+textprop| feature}
1999
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002000 noinsert Do not insert any text for a match until the user selects
2001 a match from the menu. Only works in combination with
2002 "menu" or "menuone". No effect if "longest" is present.
2003
2004 noselect Do not select a match in the menu, force the user to
2005 select one from the menu. Only works in combination with
2006 "menu" or "menuone".
2007
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002008
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002009 *'completepopup'* *'cpp'*
2010'completepopup' 'cpp' string (default empty)
2011 global
2012 {not available when compiled without the |+textprop|
2013 or |+quickfix| feature}
2014 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002015 properties of the info popup when it is created. If an info popup
2016 window already exists it is closed, so that the option value is
2017 applied when it is created again.
2018 You can also use |popup_findinfo()| and then set properties for an
2019 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002020
2021
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002022 *'concealcursor'* *'cocu'*
2023'concealcursor' 'cocu' string (default: "")
2024 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002025 {not available when compiled without the |+conceal|
2026 feature}
2027 Sets the modes in which text in the cursor line can also be concealed.
2028 When the current mode is listed then concealing happens just like in
2029 other lines.
2030 n Normal mode
2031 v Visual mode
2032 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002033 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002034
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002035 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002036 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002037 are moving around text is concealed, but when starting to insert text
2038 or selecting a Visual area the concealed text is displayed, so that
2039 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002040 Keep in mind that the cursor position is not always where it's
2041 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002042
2043
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002044 *'conceallevel'* *'cole'*
2045'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002046 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002047 {not available when compiled without the |+conceal|
2048 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002049 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2050 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002051
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002052 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002053 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002054 1 Each block of concealed text is replaced with one
2055 character. If the syntax item does not have a custom
2056 replacement character defined (see |:syn-cchar|) the
2057 character defined in 'listchars' is used (default is a
2058 space).
2059 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002060 2 Concealed text is completely hidden unless it has a
2061 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002062 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002063 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002064
Bram Moolenaara7781e02010-07-19 20:13:22 +02002065 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002066 edit and copy the text. This can be changed with the 'concealcursor'
2067 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002068
Bram Moolenaar071d4272004-06-13 20:20:40 +00002069 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2070'confirm' 'cf' boolean (default off)
2071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072 When 'confirm' is on, certain operations that would normally
2073 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2074 instead raise a |dialog| asking if you wish to save the current
2075 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2076 If 'confirm' is off you can still activate confirmation for one
2077 command only (this is most useful in mappings) with the |:confirm|
2078 command.
2079 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2080
2081 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2082'conskey' 'consk' boolean (default off)
2083 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002084 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085
2086 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2087'copyindent' 'ci' boolean (default off)
2088 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002089 Copy the structure of the existing lines indent when autoindenting a
2090 new line. Normally the new indent is reconstructed by a series of
2091 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2092 in which case only spaces are used). Enabling this option makes the
2093 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002094 existing line. 'expandtab' has no effect on these characters, a Tab
2095 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002097 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098 Also see 'preserveindent'.
2099
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002100 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101'cpoptions' 'cpo' string (Vim default: "aABceFs",
2102 Vi default: all flags)
2103 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002105 this indicates Vi-compatible behavior. This is used for things where
2106 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107 'cpoptions' stands for "compatible-options".
2108 Commas can be added for readability.
2109 To avoid problems with flags that are added in the future, use the
2110 "+=" and "-=" feature of ":set" |add-option-flags|.
2111 NOTE: This option is set to the Vi default value when 'compatible' is
2112 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002113 NOTE: This option is set to the POSIX default value at startup when
2114 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002115 variable exists |posix|. This means Vim tries to behave like the
2116 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117
2118 contains behavior ~
2119 *cpo-a*
2120 a When included, a ":read" command with a file name
2121 argument will set the alternate file name for the
2122 current window.
2123 *cpo-A*
2124 A When included, a ":write" command with a file name
2125 argument will set the alternate file name for the
2126 current window.
2127 *cpo-b*
2128 b "\|" in a ":map" command is recognized as the end of
2129 the map command. The '\' is included in the mapping,
2130 the text after the '|' is interpreted as the next
2131 command. Use a CTRL-V instead of a backslash to
2132 include the '|' in the mapping. Applies to all
2133 mapping, abbreviation, menu and autocmd commands.
2134 See also |map_bar|.
2135 *cpo-B*
2136 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002137 abbreviations, user commands and the "to" part of the
2138 menu commands. Remove this flag to be able to use a
2139 backslash like a CTRL-V. For example, the command
2140 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002141 'B' included: "\^[" (^[ is a real <Esc>)
2142 'B' excluded: "<Esc>" (5 characters)
2143 ('<' excluded in both cases)
2144 *cpo-c*
2145 c Searching continues at the end of any match at the
2146 cursor position, but not further than the start of the
2147 next line. When not present searching continues
2148 one character from the cursor position. With 'c'
2149 "abababababab" only gets three matches when repeating
2150 "/abab", without 'c' there are five matches.
2151 *cpo-C*
2152 C Do not concatenate sourced lines that start with a
2153 backslash. See |line-continuation|.
2154 *cpo-d*
2155 d Using "./" in the 'tags' option doesn't mean to use
2156 the tags file relative to the current file, but the
2157 tags file in the current directory.
2158 *cpo-D*
2159 D Can't use CTRL-K to enter a digraph after Normal mode
2160 commands with a character argument, like |r|, |f| and
2161 |t|.
2162 *cpo-e*
2163 e When executing a register with ":@r", always add a
2164 <CR> to the last line, also when the register is not
2165 linewise. If this flag is not present, the register
2166 is not linewise and the last line does not end in a
2167 <CR>, then the last line is put on the command-line
2168 and can be edited before hitting <CR>.
2169 *cpo-E*
2170 E It is an error when using "y", "d", "c", "g~", "gu" or
2171 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002172 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002173 This makes "y0" fail in the first column.
2174 *cpo-f*
2175 f When included, a ":read" command with a file name
2176 argument will set the file name for the current buffer,
2177 if the current buffer doesn't have a file name yet.
2178 *cpo-F*
2179 F When included, a ":write" command with a file name
2180 argument will set the file name for the current
2181 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002182 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 *cpo-g*
2184 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002185 *cpo-H*
2186 H When using "I" on a line with only blanks, insert
2187 before the last blank. Without this flag insert after
2188 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189 *cpo-i*
2190 i When included, interrupting the reading of a file will
2191 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002192 *cpo-I*
2193 I When moving the cursor up or down just after inserting
2194 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002195 *cpo-j*
2196 j When joining lines, only add two spaces after a '.',
2197 not after '!' or '?'. Also see 'joinspaces'.
2198 *cpo-J*
2199 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002200 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201 white space.
2202 *cpo-k*
2203 k Disable the recognition of raw key codes in
2204 mappings, abbreviations, and the "to" part of menu
2205 commands. For example, if <Key> sends ^[OA (where ^[
2206 is <Esc>), the command ":map X ^[OA" results in X
2207 being mapped to:
2208 'k' included: "^[OA" (3 characters)
2209 'k' excluded: "<Key>" (one key code)
2210 Also see the '<' flag below.
2211 *cpo-K*
2212 K Don't wait for a key code to complete when it is
2213 halfway a mapping. This breaks mapping <F1><F1> when
2214 only part of the second <F1> has been read. It
2215 enables cancelling the mapping by typing <F1><Esc>.
2216 *cpo-l*
2217 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002218 literally, only "\]", "\^", "\-" and "\\" are special.
2219 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2221 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002222 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002223 *cpo-L*
2224 L When the 'list' option is set, 'wrapmargin',
2225 'textwidth', 'softtabstop' and Virtual Replace mode
2226 (see |gR|) count a <Tab> as two characters, instead of
2227 the normal behavior of a <Tab>.
2228 *cpo-m*
2229 m When included, a showmatch will always wait half a
2230 second. When not included, a showmatch will wait half
2231 a second or until a character is typed. |'showmatch'|
2232 *cpo-M*
2233 M When excluded, "%" matching will take backslashes into
2234 account. Thus in "( \( )" and "\( ( \)" the outer
2235 parenthesis match. When included "%" ignores
2236 backslashes, which is Vi compatible.
2237 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002238 n When included, the column used for 'number' and
2239 'relativenumber' will also be used for text of wrapped
2240 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002241 *cpo-o*
2242 o Line offset to search command is not remembered for
2243 next search.
2244 *cpo-O*
2245 O Don't complain if a file is being overwritten, even
2246 when it didn't exist when editing it. This is a
2247 protection against a file unexpectedly created by
2248 someone else. Vi didn't complain about this.
2249 *cpo-p*
2250 p Vi compatible Lisp indenting. When not present, a
2251 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002252 *cpo-P*
2253 P When included, a ":write" command that appends to a
2254 file will set the file name for the current buffer, if
2255 the current buffer doesn't have a file name yet and
2256 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002257 *cpo-q*
2258 q When joining multiple lines leave the cursor at the
2259 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260 *cpo-r*
2261 r Redo ("." command) uses "/" to repeat a search
2262 command, instead of the actually used search string.
2263 *cpo-R*
2264 R Remove marks from filtered lines. Without this flag
2265 marks are kept like |:keepmarks| was used.
2266 *cpo-s*
2267 s Set buffer options when entering the buffer for the
2268 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002269 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270 set when the buffer is created.
2271 *cpo-S*
2272 S Set buffer options always when entering a buffer
2273 (except 'readonly', 'fileformat', 'filetype' and
2274 'syntax'). This is the (most) Vi compatible setting.
2275 The options are set to the values in the current
2276 buffer. When you change an option and go to another
2277 buffer, the value is copied. Effectively makes the
2278 buffer options global to all buffers.
2279
2280 's' 'S' copy buffer options
2281 no no when buffer created
2282 yes no when buffer first entered (default)
2283 X yes each time when buffer entered (vi comp.)
2284 *cpo-t*
2285 t Search pattern for the tag command is remembered for
2286 "n" command. Otherwise Vim only puts the pattern in
2287 the history for search pattern, but doesn't change the
2288 last used search pattern.
2289 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002290 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291 *cpo-v*
2292 v Backspaced characters remain visible on the screen in
2293 Insert mode. Without this flag the characters are
2294 erased from the screen right away. With this flag the
2295 screen newly typed text overwrites backspaced
2296 characters.
2297 *cpo-w*
2298 w When using "cw" on a blank character, only change one
2299 character and not all blanks until the start of the
2300 next word.
2301 *cpo-W*
2302 W Don't overwrite a readonly file. When omitted, ":w!"
2303 overwrites a readonly file, if possible.
2304 *cpo-x*
2305 x <Esc> on the command-line executes the command-line.
2306 The default in Vim is to abandon the command-line,
2307 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002308 *cpo-X*
2309 X When using a count with "R" the replaced text is
2310 deleted only once. Also when repeating "R" with "."
2311 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002313 y A yank command can be redone with ".". Think twice if
2314 you really want to use this, it may break some
2315 plugins, since most people expect "." to only repeat a
2316 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002317 *cpo-Z*
2318 Z When using "w!" while the 'readonly' option is set,
2319 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002320 *cpo-!*
2321 ! When redoing a filter command, use the last used
2322 external command, whatever it was. Otherwise the last
2323 used -filter- command is used.
2324 *cpo-$*
2325 $ When making a change to one line, don't redisplay the
2326 line, but put a '$' at the end of the changed text.
2327 The changed text will be overwritten when you type the
2328 new text. The line is redisplayed if you type any
2329 command that moves the cursor from the insertion
2330 point.
2331 *cpo-%*
2332 % Vi-compatible matching is done for the "%" command.
2333 Does not recognize "#if", "#endif", etc.
2334 Does not recognize "/*" and "*/".
2335 Parens inside single and double quotes are also
2336 counted, causing a string that contains a paren to
2337 disturb the matching. For example, in a line like
2338 "if (strcmp("foo(", s))" the first paren does not
2339 match the last one. When this flag is not included,
2340 parens inside single and double quotes are treated
2341 specially. When matching a paren outside of quotes,
2342 everything inside quotes is ignored. When matching a
2343 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002344 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002345 This flag is also used for other features, such as
2346 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002347 *cpo--*
2348 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002349 it would go above the first line or below the last
2350 line. Without it the cursor moves to the first or
2351 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002352 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002353 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002354 *cpo-+*
2355 + When included, a ":write file" command will reset the
2356 'modified' flag of the buffer, even though the buffer
2357 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002358 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359 * Use ":*" in the same way as ":@". When not included,
2360 ":*" is an alias for ":'<,'>", select the Visual area.
2361 *cpo-<*
2362 < Disable the recognition of special key codes in |<>|
2363 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002364 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365 ":map X <Tab>" results in X being mapped to:
2366 '<' included: "<Tab>" (5 characters)
2367 '<' excluded: "^I" (^I is a real <Tab>)
2368 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002369 *cpo->*
2370 > When appending to a register, put a line break before
2371 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002372 *cpo-;*
2373 ; When using |,| or |;| to repeat the last |t| search
2374 and the cursor is right in front of the searched
2375 character, the cursor won't move. When not included,
2376 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002377 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002378
2379 POSIX flags. These are not included in the Vi default value, except
2380 when $VIM_POSIX was set on startup. |posix|
2381
2382 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002383 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002384 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002385 *cpo-&*
2386 & When ":preserve" was used keep the swap file when
2387 exiting normally while this buffer is still loaded.
2388 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002389 *cpo-\*
2390 \ Backslash in a [] range in a search pattern is taken
2391 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002392 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2393 '\' excluded: "/[ \-]" finds <Space> and '-'
2394 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002395 *cpo-/*
2396 / When "%" is used as the replacement string in a |:s|
2397 command, use the previous replacement string. |:s%|
2398 *cpo-{*
2399 { The |{| and |}| commands also stop at a "{" character
2400 at the start of a line.
2401 *cpo-.*
2402 . The ":chdir" and ":cd" commands fail if the current
2403 buffer is modified, unless ! is used. Vim doesn't
2404 need this, since it remembers the full path of an
2405 opened file.
2406 *cpo-bar*
2407 | The value of the $LINES and $COLUMNS environment
2408 variables overrule the terminal size values obtained
2409 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002410
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002412 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002413'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002414 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002415 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002416 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002417 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002418 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002419 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002420 blowfish Blowfish method. Medium strong encryption but it has
2421 an implementation flaw. Requires Vim 7.3 or later,
2422 files can NOT be read by Vim 7.2 and older. This adds
2423 a "seed" to the file, every time you write the file
2424 the encrypted bytes will be different.
2425 *blowfish2*
2426 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002427 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002428 and older. This adds a "seed" to the file, every time
2429 you write the file the encrypted bytes will be
2430 different. The whole undo file is encrypted, not just
2431 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002432 *E1193* *E1194* *E1195* *E1196*
2433 *E1197* *E1198* *E1199* *E1200* *E1201*
2434 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2435 Code. Medium strong till strong encryption.
2436 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002437 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002438 It adds a seed and a message authentication code (MAC)
2439 to the file. This needs at least a Vim 8.2.3022 to
2440 read the encrypted file.
2441 Encryption of swap files is not supported, therefore
2442 no swap file will be used when xchacha20 encryption is
2443 enabled.
2444 Encryption of undo files is not yet supported,
2445 therefore no undo file will currently be written.
2446 CURRENTLY EXPERIMENTAL: Files written with this method
2447 might have to be read back with the same version of
2448 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002449
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002450 You should use "blowfish2", also to re-encrypt older files.
2451
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002452 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002453 to the detected method of the file being read. Thus if you write it
2454 without changing 'cryptmethod' the same method will be used.
2455 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002456 explicitly write it, you don't get a warning unless there are other
2457 modifications. Also see |:X|.
2458
2459 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002460 the value "blowfish2". When setting the local value to an empty
2461 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002462
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002463 When a new encryption method is added in a later version of Vim, and
2464 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002465 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002466
2467
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 *'cscopepathcomp'* *'cspc'*
2469'cscopepathcomp' 'cspc' number (default 0)
2470 global
2471 {not available when compiled without the |+cscope|
2472 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002473 Determines how many components of the path to show in a list of tags.
2474 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002475 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002476
2477 *'cscopeprg'* *'csprg'*
2478'cscopeprg' 'csprg' string (default "cscope")
2479 global
2480 {not available when compiled without the |+cscope|
2481 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002482 Specifies the command to execute cscope. See |cscopeprg|.
2483 This option cannot be set from a |modeline| or in the |sandbox|, for
2484 security reasons.
2485
2486 *'cscopequickfix'* *'csqf'*
2487'cscopequickfix' 'csqf' string (default "")
2488 global
2489 {not available when compiled without the |+cscope|
2490 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002491 Specifies whether to use quickfix window to show cscope results.
2492 See |cscopequickfix|.
2493
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002494 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002495'cscoperelative' 'csre' boolean (default off)
2496 global
2497 {not available when compiled without the |+cscope|
2498 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002499 In the absence of a prefix (-P) for cscope. setting this option enables
2500 to use the basename of cscope.out path as the prefix.
2501 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002502 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002503
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2505'cscopetag' 'cst' boolean (default off)
2506 global
2507 {not available when compiled without the |+cscope|
2508 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509 Use cscope for tag commands. See |cscope-options|.
2510 NOTE: This option is reset when 'compatible' is set.
2511
2512 *'cscopetagorder'* *'csto'*
2513'cscopetagorder' 'csto' number (default 0)
2514 global
2515 {not available when compiled without the |+cscope|
2516 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517 Determines the order in which ":cstag" performs a search. See
2518 |cscopetagorder|.
2519 NOTE: This option is set to 0 when 'compatible' is set.
2520
2521 *'cscopeverbose'* *'csverb'*
2522 *'nocscopeverbose'* *'nocsverb'*
2523'cscopeverbose' 'csverb' boolean (default off)
2524 global
2525 {not available when compiled without the |+cscope|
2526 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527 Give messages when adding a cscope database. See |cscopeverbose|.
2528 NOTE: This option is reset when 'compatible' is set.
2529
Bram Moolenaar860cae12010-06-05 23:22:07 +02002530 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2531'cursorbind' 'crb' boolean (default off)
2532 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002533 When this option is set, as the cursor in the current
2534 window moves other cursorbound windows (windows that also have
2535 this option set) move their cursors to the corresponding line and
2536 column. This option is useful for viewing the
2537 differences between two versions of a file (see 'diff'); in diff mode,
2538 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002539 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002540
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002541
2542 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2543'cursorcolumn' 'cuc' boolean (default off)
2544 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002545 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002546 feature}
2547 Highlight the screen column of the cursor with CursorColumn
2548 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2549 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002550 If you only want the highlighting in the current window you can use
2551 these autocommands: >
2552 au WinLeave * set nocursorline nocursorcolumn
2553 au WinEnter * set cursorline cursorcolumn
2554<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002555
2556 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2557'cursorline' 'cul' boolean (default off)
2558 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002559 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002560 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002561 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2562 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002563 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002564 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002565
2566
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002567 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002568'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002569 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002570 {not available when compiled without the |+syntax|
2571 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002572 Comma separated list of settings for how 'cursorline' is displayed.
2573 Valid values:
2574 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002575 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002576 "screenline" Highlight only the screen line of the cursor with
2577 CursorLine |hl-CursorLine|.
2578 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002579 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002580
2581 Special value:
2582 "both" Alias for the values "line,number".
2583
2584 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002585
2586
Bram Moolenaar071d4272004-06-13 20:20:40 +00002587 *'debug'*
2588'debug' string (default "")
2589 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002590 These values can be used:
2591 msg Error messages that would otherwise be omitted will be given
2592 anyway.
2593 throw Error messages that would otherwise be omitted will be given
2594 anyway and also throw an exception and set |v:errmsg|.
2595 beep A message will be given when otherwise only a beep would be
2596 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002597 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002598 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2599 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600
2601 *'define'* *'def'*
2602'define' 'def' string (default "^\s*#\s*define")
2603 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002604 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605 pattern, just like for the "/" command. This option is used for the
2606 commands like "[i" and "[d" |include-search|. The 'isident' option is
2607 used to recognize the defined name after the match:
2608 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2609 See |option-backslash| about inserting backslashes to include a space
2610 or backslash.
2611 The default value is for C programs. For C++ this value would be
2612 useful, to include const type declarations: >
2613 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002614< You can also use "\ze" just before the name and continue the pattern
2615 to check what is following. E.g. for Javascript, if a function is
2616 defined with "func_name = function(args)": >
2617 ^\s*\ze\i\+\s*=\s*function(
2618< If the function is defined with "func_name : function() {...": >
2619 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002620< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002621 To avoid that use `:let` with a single quote string: >
2622 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002623<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624
2625 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2626'delcombine' 'deco' boolean (default off)
2627 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 If editing Unicode and this option is set, backspace and Normal mode
2629 "x" delete each combining character on its own. When it is off (the
2630 default) the character along with its combining characters are
2631 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002632 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633
2634 This is useful for Arabic, Hebrew and many other languages where one
2635 may have combining characters overtop of base characters, and want
2636 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002637 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002638
2639 *'dictionary'* *'dict'*
2640'dictionary' 'dict' string (default "")
2641 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002642 List of file names, separated by commas, that are used to lookup words
2643 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2644 contain a list of words. This can be one word per line, or several
2645 words per line, separated by non-keyword characters (white space is
2646 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002647
2648 When this option is empty or an entry "spell" is present, and spell
2649 checking is enabled, words in the word lists for the currently active
2650 'spelllang' are used. See |spell|.
2651
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002652 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653 after a comma are ignored, otherwise spaces are included in the file
2654 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002655 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 Where to find a list of words?
2657 - On FreeBSD, there is the file "/usr/share/dict/words".
2658 - In the Simtel archive, look in the "msdos/linguist" directory.
2659 - In "miscfiles" of the GNU collection.
2660 The use of |:set+=| and |:set-=| is preferred when adding or removing
2661 directories from the list. This avoids problems when a future version
2662 uses another default.
2663 Backticks cannot be used in this option for security reasons.
2664
2665 *'diff'* *'nodiff'*
2666'diff' boolean (default off)
2667 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002668 {not available when compiled without the |+diff|
2669 feature}
2670 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002671 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672
2673 *'dex'* *'diffexpr'*
2674'diffexpr' 'dex' string (default "")
2675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676 {not available when compiled without the |+diff|
2677 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002678 Expression which is evaluated to obtain a diff file (either ed-style
2679 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680 This option cannot be set from a |modeline| or in the |sandbox|, for
2681 security reasons.
2682
2683 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002684'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686 {not available when compiled without the |+diff|
2687 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002688 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002689 All are optional. Items must be separated by a comma.
2690
2691 filler Show filler lines, to keep the text
2692 synchronized with a window that has inserted
2693 lines at the same position. Mostly useful
2694 when windows are side-by-side and 'scrollbind'
2695 is set.
2696
2697 context:{n} Use a context of {n} lines between a change
2698 and a fold that contains unchanged lines.
2699 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002700 When using zero the context is actually one,
2701 since folds require a line in between, also
2702 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703 See |fold-diff|.
2704
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002705 iblank Ignore changes where lines are all blank. Adds
2706 the "-B" flag to the "diff" command if
2707 'diffexpr' is empty. Check the documentation
2708 of the "diff" command for what this does
2709 exactly.
2710 NOTE: the diff windows will get out of sync,
2711 because no differences between blank lines are
2712 taken into account.
2713
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 icase Ignore changes in case of text. "a" and "A"
2715 are considered the same. Adds the "-i" flag
2716 to the "diff" command if 'diffexpr' is empty.
2717
2718 iwhite Ignore changes in amount of white space. Adds
2719 the "-b" flag to the "diff" command if
2720 'diffexpr' is empty. Check the documentation
2721 of the "diff" command for what this does
2722 exactly. It should ignore adding trailing
2723 white space, but not leading white space.
2724
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002725 iwhiteall Ignore all white space changes. Adds
2726 the "-w" flag to the "diff" command if
2727 'diffexpr' is empty. Check the documentation
2728 of the "diff" command for what this does
2729 exactly.
2730
2731 iwhiteeol Ignore white space changes at end of line.
2732 Adds the "-Z" flag to the "diff" command if
2733 'diffexpr' is empty. Check the documentation
2734 of the "diff" command for what this does
2735 exactly.
2736
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002737 horizontal Start diff mode with horizontal splits (unless
2738 explicitly specified otherwise).
2739
2740 vertical Start diff mode with vertical splits (unless
2741 explicitly specified otherwise).
2742
Bram Moolenaarc8234772019-11-10 21:00:27 +01002743 closeoff When a window is closed where 'diff' is set
2744 and there is only one window remaining in the
2745 same tab page with 'diff' set, execute
2746 `:diffoff` in that window. This undoes a
2747 `:diffsplit` command.
2748
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002749 hiddenoff Do not use diff mode for a buffer when it
2750 becomes hidden.
2751
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002752 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2753 starting diff mode. Without this 2 is used.
2754
Bram Moolenaar4223d432021-02-10 13:18:17 +01002755 followwrap Follow the 'wrap' option and leave as it is.
2756
Bram Moolenaare828b762018-09-10 17:51:58 +02002757 internal Use the internal diff library. This is
2758 ignored when 'diffexpr' is set. *E960*
2759 When running out of memory when writing a
2760 buffer this item will be ignored for diffs
2761 involving that buffer. Set the 'verbose'
2762 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763
Bram Moolenaare828b762018-09-10 17:51:58 +02002764 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002765 Use the indent heuristic for the internal
2766 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002767
2768 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002769 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002770 algorithms are:
2771 myers the default algorithm
2772 minimal spend extra time to generate the
2773 smallest possible diff
2774 patience patience diff algorithm
2775 histogram histogram diff algorithm
2776
2777 Examples: >
2778 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002779 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002780 :set diffopt=internal,filler,foldcolumn:3
2781 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782<
2783 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2784'digraph' 'dg' boolean (default off)
2785 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786 {not available when compiled without the |+digraphs|
2787 feature}
2788 Enable the entering of digraphs in Insert mode with {char1} <BS>
2789 {char2}. See |digraphs|.
2790 NOTE: This option is reset when 'compatible' is set.
2791
2792 *'directory'* *'dir'*
2793'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002794 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 for Unix: ".,~/tmp,/var/tmp,/tmp")
2796 global
2797 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002798 Recommended value: ".,~/vimswap//" - this will put the swap file next
2799 to the edited file if possible, and in your personal swap directory
2800 otherwise. Make sure "~/vimswap//" is only readable for you.
2801
2802 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002803 - The swap file will be created in the first directory where this is
2804 possible.
2805 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002806 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 - A directory "." means to put the swap file in the same directory as
2808 the edited file. On Unix, a dot is prepended to the file name, so
2809 it doesn't show in a directory listing. On MS-Windows the "hidden"
2810 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002811 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2812 the swap file relative to where the edited file is. The leading "."
2813 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002814 - For Unix and Win32, if a directory ends in two path separators "//",
2815 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002816 with all path separators replaced by percent '%' signs (including
2817 the colon following the drive letter on Win32). This will ensure
2818 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002819 On Win32, it is also possible to end with "\\". However, When a
2820 separating comma is following, you must use "//", since "\\" will
2821 include the comma in the file name. Therefore it is recommended to
2822 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823 - Spaces after the comma are ignored, other spaces are considered part
2824 of the directory name. To have a space at the start of a directory
2825 name, precede it with a backslash.
2826 - To include a comma in a directory name precede it with a backslash.
2827 - A directory name may end in an ':' or '/'.
2828 - Environment variables are expanded |:set_env|.
2829 - Careful with '\' characters, type one before a space, type two to
2830 get one in the option (see |option-backslash|), for example: >
2831 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2832< - For backwards compatibility with Vim version 3.0 a '>' at the start
2833 of the option is removed.
2834 Using "." first in the list is recommended. This means that editing
2835 the same file twice will result in a warning. Using "/tmp" on Unix is
2836 discouraged: When the system crashes you lose the swap file.
2837 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002838 choice than "/tmp". But others on the computer may be able to see the
2839 files, and it can contain a lot of files, your swap files get lost in
2840 the crowd. That is why a "tmp" directory in your home directory is
2841 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 The use of |:set+=| and |:set-=| is preferred when adding or removing
2843 directories from the list. This avoids problems when a future version
2844 uses another default.
2845 This option cannot be set from a |modeline| or in the |sandbox|, for
2846 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847
2848 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002849'display' 'dy' string (default "", set to "truncate" in
2850 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852 Change the way text is displayed. This is comma separated list of
2853 flags:
2854 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002855 in a window will be displayed. "@@@" is put in the
2856 last columns of the last screen line to indicate the
2857 rest of the line is not displayed.
2858 truncate Like "lastline", but "@@@" is displayed in the first
2859 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860 uhex Show unprintable characters hexadecimal as <xx>
2861 instead of using ^C and ~C.
2862
Bram Moolenaard0796902016-09-16 20:02:31 +02002863 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002864 doesn't fit is replaced with "@" lines.
2865
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866 *'eadirection'* *'ead'*
2867'eadirection' 'ead' string (default "both")
2868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869 Tells when the 'equalalways' option applies:
2870 ver vertically, width of windows is not affected
2871 hor horizontally, height of windows is not affected
2872 both width and height of windows is affected
2873
2874 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2875'edcompatible' 'ed' boolean (default off)
2876 global
2877 Makes the 'g' and 'c' flags of the ":substitute" command to be
2878 toggled each time the flag is given. See |complex-change|. See
2879 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002880 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002881 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882
Bram Moolenaar03413f42016-04-12 21:07:15 +02002883 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002884'emoji' 'emo' boolean (default: on)
2885 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002886 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002887 This excludes "text emoji" characters, which are normally displayed as
2888 single width. Unfortunately there is no good specification for this
2889 and it has been determined on trial-and-error basis. Use the
2890 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002891
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002893'encoding' 'enc' string (default for MS-Windows: "utf-8",
2894 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002896 Sets the character encoding used inside Vim. It applies to text in
2897 the buffers, registers, Strings in expressions, text stored in the
2898 viminfo file, etc. It sets the kind of characters which Vim can work
2899 with. See |encoding-names| for the possible values.
2900
2901 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002902 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002904 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905
Bram Moolenaar865242e2010-07-14 21:12:05 +02002906 This option cannot be set from a |modeline|. It would most likely
2907 corrupt the text.
2908
Bram Moolenaar3df01732017-02-17 22:47:16 +01002909 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2910 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911 'encoding', "utf-8" is the natural choice for the environment and
2912 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002913 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 versions, and to avoid changing the encoding of newly created files
2915 without your knowledge (in case 'fileencodings' is empty).
2916
2917 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002918 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 iconv() or as specified with 'charconvert'.
2920
Bram Moolenaar207f0092020-08-30 17:20:20 +02002921 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002922 can use: >
2923 if has("multi_byte_encoding")
2924<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 Normally 'encoding' will be equal to your current locale. This will
2926 be the default if Vim recognizes your environment settings. If
2927 'encoding' is not set to the current locale, 'termencoding' must be
2928 set to convert typed and displayed text. See |encoding-table|.
2929
2930 When you set this option, it fires the |EncodingChanged| autocommand
2931 event so that you can set up fonts if necessary.
2932
2933 When the option is set, the value is converted to lowercase. Thus
2934 you can set it with uppercase values too. Underscores are translated
2935 to '-' signs.
2936 When the encoding is recognized, it is changed to the standard name.
2937 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2938 "iso-8859-2" and "utf8" becomes "utf-8".
2939
2940 Note: "latin1" is also used when the encoding could not be detected.
2941 This only works when editing files in the same encoding! When the
2942 actual character set is not latin1, make sure 'fileencoding' and
2943 'fileencodings' are empty. When conversion is needed, switch to using
2944 utf-8.
2945
2946 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2947 You don't notice this while editing, but it does matter for the
2948 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2949 setting 'encoding' to one of these values instead of utf-8 only has
2950 effect for encoding used for files when 'fileencoding' is empty.
2951
Bram Moolenaar661b1822005-07-28 22:36:45 +00002952 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2953 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954
2955 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2956'endofline' 'eol' boolean (default on)
2957 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002959 is on, or 'fixeol' option is off, no <EOL> will be written for the
2960 last line in the file. This option is automatically set or reset when
2961 starting to edit a new file, depending on whether file has an <EOL>
2962 for the last line in the file. Normally you don't have to set or
2963 reset this option.
2964 When 'binary' is off and 'fixeol' is on the value is not used when
2965 writing the file. When 'binary' is on or 'fixeol' is off it is used
2966 to remember the presence of a <EOL> for the last line in the file, so
2967 that when you write the file the situation from the original file can
2968 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969
2970 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2971'equalalways' 'ea' boolean (default on)
2972 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002974 splitting or closing a window. This also happens the moment the
2975 option is switched on. When off, splitting a window will reduce the
2976 size of the current window and leave the other windows the same. When
2977 closing a window the extra lines are given to the window next to it
2978 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979 When mixing vertically and horizontally split windows, a minimal size
2980 is computed and some windows may be larger if there is room. The
2981 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002982 Changing the height and width of a window can be avoided by setting
2983 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002984 If a window size is specified when creating a new window sizes are
2985 currently not equalized (it's complicated, but may be implemented in
2986 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987
2988 *'equalprg'* *'ep'*
2989'equalprg' 'ep' string (default "")
2990 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002992 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002993 or 'indentexpr'. When Vim was compiled without internal formatting,
2994 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002995 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 about including spaces and backslashes.
2997 This option cannot be set from a |modeline| or in the |sandbox|, for
2998 security reasons.
2999
3000 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3001'errorbells' 'eb' boolean (default off)
3002 global
3003 Ring the bell (beep or screen flash) for error messages. This only
3004 makes a difference for error messages, the bell will be used always
3005 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003006 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003007 screen flash or do nothing. See 'belloff' to finetune when to ring the
3008 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009
3010 *'errorfile'* *'ef'*
3011'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3012 others: "errors.err")
3013 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 {not available when compiled without the |+quickfix|
3015 feature}
3016 Name of the errorfile for the QuickFix mode (see |:cf|).
3017 When the "-q" command-line argument is used, 'errorfile' is set to the
3018 following argument. See |-q|.
3019 NOT used for the ":make" command. See 'makeef' for that.
3020 Environment variables are expanded |:set_env|.
3021 See |option-backslash| about including spaces and backslashes.
3022 This option cannot be set from a |modeline| or in the |sandbox|, for
3023 security reasons.
3024
3025 *'errorformat'* *'efm'*
3026'errorformat' 'efm' string (default is very long)
3027 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 {not available when compiled without the |+quickfix|
3029 feature}
3030 Scanf-like description of the format for the lines in the error file
3031 (see |errorformat|).
3032
3033 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3034'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3035 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 Function keys that start with an <Esc> are recognized in Insert
3037 mode. When this option is off, the cursor and function keys cannot be
3038 used in Insert mode if they start with an <Esc>. The advantage of
3039 this is that the single <Esc> is recognized immediately, instead of
3040 after one second. Instead of resetting this option, you might want to
3041 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3042 when 'esckeys' is off, you can still map anything, but the cursor keys
3043 won't work by default.
3044 NOTE: This option is set to the Vi default value when 'compatible' is
3045 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003046 NOTE: when this option is off then the |modifyOtherKeys| functionality
3047 is disabled while in Insert mode to avoid ending Insert mode with any
3048 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049
3050 *'eventignore'* *'ei'*
3051'eventignore' 'ei' string (default "")
3052 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003054 When set to "all" or when "all" is one of the items, all autocommand
3055 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 Otherwise this is a comma separated list of event names. Example: >
3057 :set ei=WinEnter,WinLeave
3058<
3059 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3060'expandtab' 'et' boolean (default off)
3061 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003063 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3065 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003066 This option is reset when the 'paste' option is set and restored when
3067 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 NOTE: This option is reset when 'compatible' is set.
3069
3070 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3071'exrc' 'ex' boolean (default off)
3072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003074 directory.
3075
3076 Setting this option is a potential security leak. E.g., consider
3077 unpacking a package or fetching files from github, a .vimrc in there
3078 might be a trojan horse. BETTER NOT SET THIS OPTION!
3079 Instead, define an autocommand in your .vimrc to set options for a
3080 matching directory.
3081
3082 If you do switch this option on you should also consider setting the
3083 'secure' option (see |initialization|).
3084 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 This option cannot be set from a |modeline| or in the |sandbox|, for
3086 security reasons.
3087
3088 *'fileencoding'* *'fenc'* *E213*
3089'fileencoding' 'fenc' string (default: "")
3090 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003092
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003094 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 When 'fileencoding' is empty, the same value as 'encoding' will be
3096 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003097 No error will be given when the value is set, only when it is used,
3098 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003099 Conversion will also be done when 'encoding' and 'fileencoding' are
3100 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3101 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003103 'encoding' is "utf-8" or another Unicode encoding, conversion
3104 is most likely done in a way that the reverse conversion
3105 results in the same text. When 'encoding' is not "utf-8" some
3106 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003107
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 See 'encoding' for the possible values. Additionally, values may be
3109 specified that can be handled by the converter, see
3110 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003111
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 When reading a file 'fileencoding' will be set from 'fileencodings'.
3113 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003114 'fileencoding', use the |++enc| argument. One exception: when
3115 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003116 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003117
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3119 When the option is set, the value is converted to lowercase. Thus
3120 you can set it with uppercase values too. '_' characters are
3121 replaced with '-'. If a name is recognized from the list for
3122 'encoding', it is replaced by the standard name. For example
3123 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003124
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 When this option is set, after starting to edit a file, the 'modified'
3126 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003127
3128 Keep in mind that changing 'fenc' from a modeline happens
3129 AFTER the text has been read, thus it applies to when the file will be
3130 written. If you do set 'fenc' in a modeline, you might want to set
3131 'nomodified' to avoid not being able to ":q".
3132
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 This option can not be changed when 'modifiable' is off.
3134
3135 *'fe'*
3136 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003137 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 old short name was 'fe', which is no longer used.
3139
3140 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003141'fileencodings' 'fencs' string (default: "ucs-bom",
3142 "ucs-bom,utf-8,default,latin1" when
3143 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 This is a list of character encodings considered when starting to edit
3146 an existing file. When a file is read, Vim tries to use the first
3147 mentioned character encoding. If an error is detected, the next one
3148 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003149 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150 an empty string, which means the value of 'encoding' is used.
3151 WARNING: Conversion can cause loss of information! When
3152 'encoding' is "utf-8" (or one of the other Unicode variants)
3153 conversion is most likely done in a way that the reverse
3154 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003155 "utf-8" some non-ASCII characters may be lost! You can use
3156 the |++bad| argument to specify what is done with characters
3157 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 For an empty file or a file with only ASCII characters most encodings
3159 will work and the first entry of 'fileencodings' will be used (except
3160 "ucs-bom", which requires the BOM to be present). If you prefer
3161 another encoding use an BufReadPost autocommand event to test if your
3162 preferred encoding is to be used. Example: >
3163 au BufReadPost * if search('\S', 'w') == 0 |
3164 \ set fenc=iso-2022-jp | endif
3165< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3166 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003167 When the |++enc| argument is used then the value of 'fileencodings' is
3168 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003169 Note that 'fileencodings' is not used for a new file, the global value
3170 of 'fileencoding' is used instead. You can set it with: >
3171 :setglobal fenc=iso-8859-2
3172< This means that a non-existing file may get a different encoding than
3173 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 The special value "ucs-bom" can be used to check for a Unicode BOM
3175 (Byte Order Mark) at the start of the file. It must not be preceded
3176 by "utf-8" or another Unicode encoding for this to work properly.
3177 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3178 because Vim cannot detect an error, thus the encoding is always
3179 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003180 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003181 environment. On MS-Windows this is the system encoding. Otherwise
3182 this is the default value for 'encoding'. It is useful when
3183 'encoding' is set to "utf-8" and your environment uses a non-latin1
3184 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003185 When 'encoding' is "utf-8" and a file contains an illegal byte
3186 sequence it won't be recognized as UTF-8. You can use the |8g8|
3187 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 WRONG VALUES: WHAT'S WRONG:
3189 latin1,utf-8 "latin1" will always be used
3190 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3191 file
3192 cp1250,latin1 "cp1250" will always be used
3193 If 'fileencodings' is empty, 'fileencoding' is not modified.
3194 See 'fileencoding' for the possible values.
3195 Setting this option does not have an effect until the next time a file
3196 is read.
3197
3198 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003199'fileformat' 'ff' string (MS-Windows default: "dos",
3200 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 This gives the <EOL> of the current buffer, which is used for
3203 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003204 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205 unix <NL>
3206 mac <CR>
3207 When "dos" is used, CTRL-Z at the end of a file is ignored.
3208 See |file-formats| and |file-read|.
3209 For the character encoding of the file see 'fileencoding'.
3210 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003211 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 This option is set automatically when starting to edit a file and
3213 'fileformats' is not empty and 'binary' is off.
3214 When this option is set, after starting to edit a file, the 'modified'
3215 option is set, because the file would be different when written.
3216 This option can not be changed when 'modifiable' is off.
3217 For backwards compatibility: When this option is set to "dos",
3218 'textmode' is set, otherwise 'textmode' is reset.
3219
3220 *'fileformats'* *'ffs'*
3221'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003222 Vim+Vi MS-Windows: "dos,unix",
3223 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224 Vi Cygwin: "unix,dos",
3225 Vi others: "")
3226 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 This gives the end-of-line (<EOL>) formats that will be tried when
3228 starting to edit a new buffer and when reading a file into an existing
3229 buffer:
3230 - When empty, the format defined with 'fileformat' will be used
3231 always. It is not set automatically.
3232 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003233 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 'fileformats' name will be used when a file is read into an existing
3235 buffer, no matter what 'fileformat' for that buffer is set to.
3236 - When more than one name is present, separated by commas, automatic
3237 <EOL> detection will be done when reading a file. When starting to
3238 edit a file, a check is done for the <EOL>:
3239 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3240 'fileformat' is set to "dos".
3241 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003242 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003244 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3245 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003246 This means that "mac" is only chosen when:
3247 "unix" is not present or no <NL> is found in the file, and
3248 "dos" is not present or no <CR><NL> is found in the file.
3249 Except: if "unix" was chosen, but there is a <CR> before
3250 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003251 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 4. If 'fileformat' is still not set, the first name from
3253 'fileformats' is used.
3254 When reading a file into an existing buffer, the same is done, but
3255 this happens like 'fileformat' has been set appropriately for that
3256 file only, the option is not changed.
3257 When 'binary' is set, the value of 'fileformats' is not used.
3258
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003259 When Vim starts up with an empty buffer the first item is used. You
3260 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003261
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3263 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3264 done:
3265 - When 'fileformats' is empty, there is no automatic detection. Dos
3266 format will be used.
3267 - When 'fileformats' is set to one or more names, automatic detection
3268 is done. This is based on the first <NL> in the file: If there is a
3269 <CR> in front of it, Dos format is used, otherwise Unix format is
3270 used.
3271 Also see |file-formats|.
3272 For backwards compatibility: When this option is set to an empty
3273 string or one format (no comma is included), 'textauto' is reset,
3274 otherwise 'textauto' is set.
3275 NOTE: This option is set to the Vi default value when 'compatible' is
3276 set and to the Vim default value when 'compatible' is reset.
3277
Bram Moolenaarbf884932013-04-05 22:26:15 +02003278 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3279'fileignorecase' 'fic' boolean (default on for systems where case in file
3280 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003281 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003282 When set case is ignored when using file names and directories.
3283 See 'wildignorecase' for only ignoring case when doing completion.
3284
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 *'filetype'* *'ft'*
3286'filetype' 'ft' string (default: "")
3287 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 When this option is set, the FileType autocommand event is triggered.
3289 All autocommands that match with the value of this option will be
3290 executed. Thus the value of 'filetype' is used in place of the file
3291 name.
3292 Otherwise this option does not always reflect the current file type.
3293 This option is normally set when the file type is detected. To enable
3294 this use the ":filetype on" command. |:filetype|
3295 Setting this option to a different value is most useful in a modeline,
3296 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003297 Example, for in an IDL file:
3298 /* vim: set filetype=idl : */ ~
3299 |FileType| |filetypes|
3300 When a dot appears in the value then this separates two filetype
3301 names. Example:
3302 /* vim: set filetype=c.doxygen : */ ~
3303 This will use the "c" filetype first, then the "doxygen" filetype.
3304 This works both for filetype plugins and for syntax files. More than
3305 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306 This option is not copied to another buffer, independent of the 's' or
3307 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003308 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309
3310 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003311'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003313 {not available when compiled without the |+folding|
3314 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315 Characters to fill the statuslines and vertical separators.
3316 It is a comma separated list of items:
3317
3318 item default Used for ~
3319 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003320 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 vert:c '|' vertical separators |:vsplit|
3322 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003323 foldopen:c '-' mark the beginning of a fold
3324 foldclose:c '+' show a closed fold
3325 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003327 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003329 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003330 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 otherwise.
3332
3333 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003334 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335< This is similar to the default, except that these characters will also
3336 be used when there is highlighting.
3337
Bram Moolenaar008bff92021-03-04 21:55:58 +01003338 For "stl" and "stlnc" single-byte and multibyte characters are
3339 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003340
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 The highlighting used for these items:
3342 item highlight group ~
3343 stl:c StatusLine |hl-StatusLine|
3344 stlnc:c StatusLineNC |hl-StatusLineNC|
3345 vert:c VertSplit |hl-VertSplit|
3346 fold:c Folded |hl-Folded|
3347 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003348 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003350 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3351'fixendofline' 'fixeol' boolean (default on)
3352 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003353 When writing a file and this option is on, <EOL> at the end of file
3354 will be restored if missing. Turn this option off if you want to
3355 preserve the situation from the original file.
3356 When the 'binary' option is set the value of this option doesn't
3357 matter.
3358 See the 'endofline' option.
3359
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003361'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003362 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363 {only available when compiled with the |+rightleft|
3364 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003365 This option was for using Farsi, which has been removed. See
3366 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367
3368 *'foldclose'* *'fcl'*
3369'foldclose' 'fcl' string (default "")
3370 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371 {not available when compiled without the |+folding|
3372 feature}
3373 When set to "all", a fold is closed when the cursor isn't in it and
3374 its level is higher than 'foldlevel'. Useful if you want folds to
3375 automatically close when moving out of them.
3376
3377 *'foldcolumn'* *'fdc'*
3378'foldcolumn' 'fdc' number (default 0)
3379 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 {not available when compiled without the |+folding|
3381 feature}
3382 When non-zero, a column with the specified width is shown at the side
3383 of the window which indicates open and closed folds. The maximum
3384 value is 12.
3385 See |folding|.
3386
3387 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3388'foldenable' 'fen' boolean (default on)
3389 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 {not available when compiled without the |+folding|
3391 feature}
3392 When off, all folds are open. This option can be used to quickly
3393 switch between showing all text unfolded and viewing the text with
3394 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003395 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 'foldenable' is off.
3397 This option is set by commands that create a new fold or close a fold.
3398 See |folding|.
3399
3400 *'foldexpr'* *'fde'*
3401'foldexpr' 'fde' string (default: "0")
3402 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003404 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003406 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003407
Bram Moolenaar30b65812012-07-12 22:01:11 +02003408 The expression will be evaluated in the |sandbox| if set from a
3409 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003410 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003411 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003412
3413 It is not allowed to change text or jump to another window while
3414 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415
3416 *'foldignore'* *'fdi'*
3417'foldignore' 'fdi' string (default: "#")
3418 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419 {not available when compiled without the |+folding|
3420 feature}
3421 Used only when 'foldmethod' is "indent". Lines starting with
3422 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003423 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424 The default "#" works well for C programs. See |fold-indent|.
3425
3426 *'foldlevel'* *'fdl'*
3427'foldlevel' 'fdl' number (default: 0)
3428 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 {not available when compiled without the |+folding|
3430 feature}
3431 Sets the fold level: Folds with a higher level will be closed.
3432 Setting this option to zero will close all folds. Higher numbers will
3433 close fewer folds.
3434 This option is set by commands like |zm|, |zM| and |zR|.
3435 See |fold-foldlevel|.
3436
3437 *'foldlevelstart'* *'fdls'*
3438'foldlevelstart' 'fdls' number (default: -1)
3439 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 {not available when compiled without the |+folding|
3441 feature}
3442 Sets 'foldlevel' when starting to edit another buffer in a window.
3443 Useful to always start editing with all folds closed (value zero),
3444 some folds closed (one) or no folds closed (99).
3445 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003446 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003447 ignores this option and closes all folds.
3448 It is also done before BufReadPre autocommands, to allow an autocmd to
3449 overrule the 'foldlevel' value for specific files.
3450 When the value is negative, it is not used.
3451
3452 *'foldmarker'* *'fmr'* *E536*
3453'foldmarker' 'fmr' string (default: "{{{,}}}")
3454 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 {not available when compiled without the |+folding|
3456 feature}
3457 The start and end marker used when 'foldmethod' is "marker". There
3458 must be one comma, which separates the start and end marker. The
3459 marker is a literal string (a regular expression would be too slow).
3460 See |fold-marker|.
3461
3462 *'foldmethod'* *'fdm'*
3463'foldmethod' 'fdm' string (default: "manual")
3464 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465 {not available when compiled without the |+folding|
3466 feature}
3467 The kind of folding used for the current window. Possible values:
3468 |fold-manual| manual Folds are created manually.
3469 |fold-indent| indent Lines with equal indent form a fold.
3470 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3471 |fold-marker| marker Markers are used to specify folds.
3472 |fold-syntax| syntax Syntax highlighting items specify folds.
3473 |fold-diff| diff Fold text that is not changed.
3474
3475 *'foldminlines'* *'fml'*
3476'foldminlines' 'fml' number (default: 1)
3477 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 {not available when compiled without the |+folding|
3479 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003480 Sets the number of screen lines above which a fold can be displayed
3481 closed. Also for manually closed folds. With the default value of
3482 one a fold can only be closed if it takes up two or more screen lines.
3483 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003484 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 "zc" to close a fold, which is displayed open because it's smaller
3486 than 'foldminlines', a following "zc" may close a containing fold.
3487
3488 *'foldnestmax'* *'fdn'*
3489'foldnestmax' 'fdn' number (default: 20)
3490 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 {not available when compiled without the |+folding|
3492 feature}
3493 Sets the maximum nesting of folds for the "indent" and "syntax"
3494 methods. This avoids that too many folds will be created. Using more
3495 than 20 doesn't work, because the internal limit is 20.
3496
3497 *'foldopen'* *'fdo'*
3498'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3499 search,tag,undo")
3500 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 {not available when compiled without the |+folding|
3502 feature}
3503 Specifies for which type of commands folds will be opened, if the
3504 command moves the cursor into a closed fold. It is a comma separated
3505 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003506 NOTE: When the command is part of a mapping this option is not used.
3507 Add the |zv| command to the mapping to get the same effect.
3508 (rationale: the mapping may want to control opening folds itself)
3509
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 item commands ~
3511 all any
3512 block "(", "{", "[[", "[{", etc.
3513 hor horizontal movements: "l", "w", "fx", etc.
3514 insert any command in Insert mode
3515 jump far jumps: "G", "gg", etc.
3516 mark jumping to a mark: "'m", CTRL-O, etc.
3517 percent "%"
3518 quickfix ":cn", ":crew", ":make", etc.
3519 search search for a pattern: "/", "n", "*", "gd", etc.
3520 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003521 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522 tag jumping to a tag: ":ta", CTRL-T, etc.
3523 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524 When a movement command is used for an operator (e.g., "dl" or "y%")
3525 this option is not used. This means the operator will include the
3526 whole closed fold.
3527 Note that vertical movements are not here, because it would make it
3528 very difficult to move onto a closed fold.
3529 In insert mode the folds containing the cursor will always be open
3530 when text is inserted.
3531 To close folds you can re-apply 'foldlevel' with the |zx| command or
3532 set the 'foldclose' option to "all".
3533
3534 *'foldtext'* *'fdt'*
3535'foldtext' 'fdt' string (default: "foldtext()")
3536 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537 {not available when compiled without the |+folding|
3538 feature}
3539 An expression which is used to specify the text displayed for a closed
3540 fold. See |fold-foldtext|.
3541
Bram Moolenaar30b65812012-07-12 22:01:11 +02003542 The expression will be evaluated in the |sandbox| if set from a
3543 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003544 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003545
3546 It is not allowed to change text or jump to another window while
3547 evaluating 'foldtext' |textlock|.
3548
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003549 *'formatexpr'* *'fex'*
3550'formatexpr' 'fex' string (default "")
3551 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003552 {not available when compiled without the |+eval|
3553 feature}
3554 Expression which is evaluated to format a range of lines for the |gq|
3555 operator or automatic formatting (see 'formatoptions'). When this
3556 option is empty 'formatprg' is used.
3557
3558 The |v:lnum| variable holds the first line to be formatted.
3559 The |v:count| variable holds the number of lines to be formatted.
3560 The |v:char| variable holds the character that is going to be
3561 inserted if the expression is being evaluated due to
3562 automatic formatting. This can be empty. Don't insert
3563 it yet!
3564
3565 Example: >
3566 :set formatexpr=mylang#Format()
3567< This will invoke the mylang#Format() function in the
3568 autoload/mylang.vim file in 'runtimepath'. |autoload|
3569
3570 The expression is also evaluated when 'textwidth' is set and adding
3571 text beyond that limit. This happens under the same conditions as
3572 when internal formatting is used. Make sure the cursor is kept in the
3573 same spot relative to the text then! The |mode()| function will
3574 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003575
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003576 When the expression evaluates to non-zero Vim will fall back to using
3577 the internal format mechanism.
3578
3579 The expression will be evaluated in the |sandbox| when set from a
3580 modeline, see |sandbox-option|. That stops the option from working,
3581 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003582 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003583 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003584
Bram Moolenaar86b68352004-12-27 21:59:20 +00003585 *'formatlistpat'* *'flp'*
3586'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3587 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003588 A pattern that is used to recognize a list header. This is used for
3589 the "n" flag in 'formatoptions'.
3590 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003591 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003592 while still checking more characters. There must be a character
3593 following the pattern, when it matches the whole line it is handled
3594 like there is no match.
3595 The default recognizes a number, followed by an optional punctuation
3596 character and white space.
3597
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003598 *'formatoptions'* *'fo'*
3599'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3600 local to buffer
3601 This is a sequence of letters which describes how automatic
3602 formatting is to be done. See |fo-table|. When the 'paste' option is
3603 on, no formatting is done (like 'formatoptions' is empty). Commas can
3604 be inserted for readability.
3605 To avoid problems with flags that are added in the future, use the
3606 "+=" and "-=" feature of ":set" |add-option-flags|.
3607 NOTE: This option is set to the Vi default value when 'compatible' is
3608 set and to the Vim default value when 'compatible' is reset.
3609
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 *'formatprg'* *'fp'*
3611'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003612 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003614 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003616 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003617 If the 'formatexpr' option is not empty it will be used instead.
3618 Otherwise, if 'formatprg' option is an empty string, the internal
3619 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003620 Environment variables are expanded |:set_env|. See |option-backslash|
3621 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003622 This option cannot be set from a |modeline| or in the |sandbox|, for
3623 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624
Bram Moolenaard94464e2015-11-02 15:28:18 +01003625 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003626'fsync' 'fs' boolean (default on)
3627 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003628 When on, the library function fsync() will be called after writing a
3629 file. This will flush a file to disk, ensuring that it is safely
3630 written even on filesystems which do metadata-only journaling. This
3631 will force the harddrive to spin up on Linux systems running in laptop
3632 mode, so it may be undesirable in some situations. Be warned that
3633 turning this off increases the chances of data loss after a crash. On
3634 systems without an fsync() implementation, this variable is always
3635 off.
3636 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003637 'fsync' also applies to |writefile()| (unless a flag is used to
3638 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003639 This option cannot be set from a |modeline| or in the |sandbox|, for
3640 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003641
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3643'gdefault' 'gd' boolean (default off)
3644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 When on, the ":substitute" flag 'g' is default on. This means that
3646 all matches in a line are substituted instead of one. When a 'g' flag
3647 is given to a ":substitute" command, this will toggle the substitution
3648 of all or one match. See |complex-change|.
3649
3650 command 'gdefault' on 'gdefault' off ~
3651 :s/// subst. all subst. one
3652 :s///g subst. one subst. all
3653 :s///gg subst. all subst. one
3654
3655 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003656 DEPRECATED: Setting this option may break plugins that are not aware
3657 of this option. Also, many users get confused that adding the /g flag
3658 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003659 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660
3661 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003662'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 Format to recognize for the ":grep" command output.
3665 This is a scanf-like string that uses the same format as the
3666 'errorformat' option: see |errorformat|.
3667
3668 *'grepprg'* *'gp'*
3669'grepprg' 'gp' string (default "grep -n ",
3670 Unix: "grep -n $* /dev/null",
3671 Win32: "findstr /n" or "grep -n",
3672 VMS: "SEARCH/NUMBERS ")
3673 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003674 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 and '#' characters, which are expanded like when used in a command-
3676 line. The placeholder "$*" is allowed to specify where the arguments
3677 will be included. Environment variables are expanded |:set_env|. See
3678 |option-backslash| about including spaces and backslashes.
3679 When your "grep" accepts the "-H" argument, use this to make ":grep"
3680 also work well with a single file: >
3681 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003682< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003683 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3684 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003685 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686 apply equally to 'grepprg'.
3687 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3688 otherwise it's "grep -n".
3689 This option cannot be set from a |modeline| or in the |sandbox|, for
3690 security reasons.
3691
3692 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3693'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3694 ve:ver35-Cursor,
3695 o:hor50-Cursor,
3696 i-ci:ver25-Cursor/lCursor,
3697 r-cr:hor20-Cursor/lCursor,
3698 sm:block-Cursor
3699 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003700 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701 "n-v-c:block,o:hor50,i-ci:hor15,
3702 r-cr:hor30,sm:block")
3703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003705 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003707 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003708 height of the cursor can be changed. This can be done by specifying a
3709 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003710 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3711 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003713 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 mode-list and an argument-list:
3715 mode-list:argument-list,mode-list:argument-list,..
3716 The mode-list is a dash separated list of these modes:
3717 n Normal mode
3718 v Visual mode
3719 ve Visual mode with 'selection' "exclusive" (same as 'v',
3720 if not specified)
3721 o Operator-pending mode
3722 i Insert mode
3723 r Replace mode
3724 c Command-line Normal (append) mode
3725 ci Command-line Insert mode
3726 cr Command-line Replace mode
3727 sm showmatch in Insert mode
3728 a all modes
3729 The argument-list is a dash separated list of these arguments:
3730 hor{N} horizontal bar, {N} percent of the character height
3731 ver{N} vertical bar, {N} percent of the character width
3732 block block cursor, fills the whole character
3733 [only one of the above three should be present]
3734 blinkwait{N} *cursor-blinking*
3735 blinkon{N}
3736 blinkoff{N}
3737 blink times for cursor: blinkwait is the delay before
3738 the cursor starts blinking, blinkon is the time that
3739 the cursor is shown and blinkoff is the time that the
3740 cursor is not shown. The times are in msec. When one
3741 of the numbers is zero, there is no blinking. The
3742 default is: "blinkwait700-blinkon400-blinkoff250".
3743 These numbers are used for a missing entry. This
3744 means that blinking is enabled by default. To switch
3745 blinking off you can use "blinkon0". The cursor only
3746 blinks when Vim is waiting for input, not while
3747 executing a command.
3748 To make the cursor blink in an xterm, see
3749 |xterm-blink|.
3750 {group-name}
3751 a highlight group name, that sets the color and font
3752 for the cursor
3753 {group-name}/{group-name}
3754 Two highlight group names, the first is used when
3755 no language mappings are used, the other when they
3756 are. |language-mapping|
3757
3758 Examples of parts:
3759 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3760 block cursor with colors from the "nCursor"
3761 highlight group
3762 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3763 In Insert and Command-line Insert mode, use a
3764 30% vertical bar cursor with colors from the
3765 "iCursor" highlight group. Blink a bit
3766 faster.
3767
3768 The 'a' mode is different. It will set the given argument-list for
3769 all modes. It does not reset anything to defaults. This can be used
3770 to do a common setting for all modes. For example, to switch off
3771 blinking: "a:blinkon0"
3772
3773 Examples of cursor highlighting: >
3774 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3775 :highlight Cursor gui=NONE guifg=bg guibg=fg
3776<
3777 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003778 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779'guifont' 'gfn' string (default "")
3780 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 {only available when compiled with GUI enabled}
3782 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003783 In its simplest form the value is just one font name.
3784 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785
3786 *'guifontset'* *'gfs'*
3787 *E250* *E252* *E234* *E597* *E598*
3788'guifontset' 'gfs' string (default "")
3789 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 {only available when compiled with GUI enabled and
3791 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003792 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003793 When not empty, specifies two (or more) fonts to be used. The first
3794 one for normal English, the second one for your special language. See
3795 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003796
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3798'guifontwide' 'gfw' string (default "")
3799 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 {only available when compiled with GUI enabled}
3801 When not empty, specifies a comma-separated list of fonts to be used
3802 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003803 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003804
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 *'guiheadroom'* *'ghr'*
3806'guiheadroom' 'ghr' number (default 50)
3807 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003808 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 The number of pixels subtracted from the screen height when fitting
3810 the GUI window on the screen. Set this before the GUI is started,
3811 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003812 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 lines will be left for window decorations and other items on the
3814 screen. Set it to a negative value to allow windows taller than the
3815 screen.
3816
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003817 *'guiligatures'* *'gli'* *E1243*
3818'guiligatures' 'gli' string (default "")
3819 global
3820 {only for GTK GUI}
3821 List of ASCII characters that, when combined together, can create more
3822 complex shapes. Each character must be a printable ASCII character
3823 with a value in the 32-127 range.
3824 Example: >
3825 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3826< Changing this option updates screen output immediately. Set it to an
3827 empty string to disable ligatures.
3828
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003830'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3831 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003832 "aegimrLtT" (GTK, Motif and Athena),
3833 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003836 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837 sequence of letters which describes what components and options of the
3838 GUI should be used.
3839 To avoid problems with flags that are added in the future, use the
3840 "+=" and "-=" feature of ":set" |add-option-flags|.
3841
Bram Moolenaar13568252018-03-16 20:46:58 +01003842 Valid characters are as follows:
3843 *'go-!'*
3844 '!' External commands are executed in a terminal window. Without
3845 this flag the MS-Windows GUI will open a console window to
3846 execute the command. The Unix GUI will simulate a dumb
3847 terminal to list the command output.
3848 The terminal window will be positioned at the bottom, and grow
3849 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003850 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 'a' Autoselect: If present, then whenever VISUAL mode is started,
3852 or the Visual area extended, Vim tries to become the owner of
3853 the windowing system's global selection. This means that the
3854 Visually highlighted text is available for pasting into other
3855 applications as well as into Vim itself. When the Visual mode
3856 ends, possibly due to an operation on the text, or when an
3857 application wants to paste the selection, the highlighted text
3858 is automatically yanked into the "* selection register.
3859 Thus the selection is still available for pasting into other
3860 applications after the VISUAL mode has ended.
3861 If not present, then Vim won't become the owner of the
3862 windowing system's global selection unless explicitly told to
3863 by a yank or delete operation for the "* register.
3864 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003865 *'go-P'*
3866 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003867 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003868 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003869 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 applies to the modeless selection.
3871
3872 'guioptions' autoselect Visual autoselect modeless ~
3873 "" - -
3874 "a" yes yes
3875 "A" - yes
3876 "aA" yes yes
3877
Bram Moolenaar02467872007-05-06 13:22:01 +00003878 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 'c' Use console dialogs instead of popup dialogs for simple
3880 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003881 *'go-d'*
3882 'd' Use dark theme variant if available. Currently only works for
3883 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003884 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003885 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003886 'guitablabel' can be used to change the text in the labels.
3887 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003888 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003889 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003890 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891 'f' Foreground: Don't use fork() to detach the GUI from the shell
3892 where it was started. Use this for programs that wait for the
3893 editor to finish (e.g., an e-mail program). Alternatively you
3894 can use "gvim -f" or ":gui -f" to start the GUI in the
3895 foreground. |gui-fork|
3896 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003897 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003898 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3900 corner of the window. It's black&white on non-GTK, because of
3901 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003902 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003904 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003905 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003907 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003909 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003910 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 'g' Grey menu items: Make menu items that are not active grey. If
3912 'g' is not included inactive menu items are not shown at all.
3913 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003914 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 't' Include tearoff menu items. Currently only works for Win32,
3916 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003917 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003918 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003919 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003920 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003922 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 'R' Right-hand scrollbar is present when there is a vertically
3924 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003925 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003927 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003928 'L' Left-hand scrollbar is present when there is a vertically
3929 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003930 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3932 the longest visible line, or on the cursor line if the 'h'
3933 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003934 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 'h' Limit horizontal scrollbar size to the length of the cursor
3936 line. Reduces computations. |gui-horiz-scroll|
3937
3938 And yes, you may even have scrollbars on the left AND the right if
3939 you really want to :-). See |gui-scrollbars| for more information.
3940
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003941 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942 'v' Use a vertical button layout for dialogs. When not included,
3943 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003944 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003945 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 'p' Use Pointer callbacks for X11 GUI. This is required for some
3947 window managers. If the cursor is not blinking or hollow at
3948 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003949 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003951 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003952 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003953 *'go-k'*
3954 'k' Keep the GUI window size when adding/removing a scrollbar, or
3955 toolbar, tabline, etc. Instead, the behavior is similar to
3956 when the window is maximized and will adjust 'lines' and
3957 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003958 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003959 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003960
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 *'guipty'* *'noguipty'*
3962'guipty' boolean (default on)
3963 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 {only available when compiled with GUI enabled}
3965 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3966 I/O to/from shell commands. See |gui-pty|.
3967
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003968 *'guitablabel'* *'gtl'*
3969'guitablabel' 'gtl' string (default empty)
3970 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003971 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003972 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003973 pages line. When empty and when the result is empty Vim will use a
3974 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003975
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003976 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003977 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003978 The expression will be evaluated in the |sandbox| when set from a
3979 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003980 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003981
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003982 Only used when the GUI tab pages line is displayed. 'e' must be
3983 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3984 used.
3985
Bram Moolenaar57657d82006-04-21 22:12:41 +00003986 *'guitabtooltip'* *'gtt'*
3987'guitabtooltip' 'gtt' string (default empty)
3988 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003989 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003990 When nonempty describes the text to use in a tooltip for the GUI tab
3991 pages line. When empty Vim will use a default tooltip.
3992 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003993 You can include a line break. Simplest method is to use |:let|: >
3994 :let &guitabtooltip = "line one\nline two"
3995<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003996
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003998'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 (others) "$VIMRUNTIME/doc/help.txt")
4000 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 Name of the main help file. All distributed help files should be
4002 placed together in one directory. Additionally, all "doc" directories
4003 in 'runtimepath' will be used.
4004 Environment variables are expanded |:set_env|. For example:
4005 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004006 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 spaces and backslashes.
4008 This option cannot be set from a |modeline| or in the |sandbox|, for
4009 security reasons.
4010
4011 *'helpheight'* *'hh'*
4012'helpheight' 'hh' number (default 20)
4013 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 Minimal initial height of the help window when it is opened with the
4015 ":help" command. The initial height of the help window is half of the
4016 current window, or (when the 'ea' option is on) the same as other
4017 windows. When the height is less than 'helpheight', the height is
4018 set to 'helpheight'. Set to zero to disable.
4019
4020 *'helplang'* *'hlg'*
4021'helplang' 'hlg' string (default: messages language or empty)
4022 global
4023 {only available when compiled with the |+multi_lang|
4024 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 Comma separated list of languages. Vim will use the first language
4026 for which the desired help can be found. The English help will always
4027 be used as a last resort. You can add "en" to prefer English over
4028 another language, but that will only find tags that exist in that
4029 language and not in the English help.
4030 Example: >
4031 :set helplang=de,it
4032< This will first search German, then Italian and finally English help
4033 files.
4034 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4035 try to find the tag in the current language before using this option.
4036 See |help-translated|.
4037
4038 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4039'hidden' 'hid' boolean (default off)
4040 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041 When off a buffer is unloaded when it is |abandon|ed. When on a
4042 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4043 displayed in another window, it does not become hidden, of course.
4044 The commands that move through the buffer list sometimes make a buffer
4045 hidden although the 'hidden' option is off: When the buffer is
4046 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004047 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004048 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004049 This option is set for one command with ":hide {command}" |:hide|.
4050 WARNING: It's easy to forget that you have changes in hidden buffers.
4051 Think twice when using ":q!" or ":qa!".
4052
4053 *'highlight'* *'hl'*
4054'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004055 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4056 d:Directory,e:ErrorMsg,i:IncSearch,
4057 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004058 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004059 N:CursorLineNr,r:Question,s:StatusLine,
4060 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004061 v:Visual,V:VisualNOS,w:WarningMsg,
4062 W:WildMenu,f:Folded,F:FoldColumn,
4063 A:DiffAdd,C:DiffChange,D:DiffDelete,
4064 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004065 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004066 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004067 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4068 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004069 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004070 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072 This option can be used to set highlighting mode for various
4073 occasions. It is a comma separated list of character pairs. The
4074 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004075 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004077 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4078 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004079 characters from 'showbreak'
4080 |hl-Directory| d directories in CTRL-D listing and other special
4081 things in listings
4082 |hl-ErrorMsg| e error messages
4083 h (obsolete, ignored)
4084 |hl-IncSearch| i 'incsearch' highlighting
4085 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4086 |hl-MoreMsg| m |more-prompt|
4087 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004088 |hl-LineNr| n line number for ":number" and ":#" commands, and
4089 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004090 |hl-LineNrAbove| a line number above the cursor for when the
4091 'relativenumber' option is set.
4092 |hl-LineNrBelow| b line number below the cursor for when the
4093 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004094 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4095 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096 |hl-Question| r |hit-enter| prompt and yes/no questions
4097 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004098 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4100 |hl-VertSplit| c column used to separate vertically split windows
4101 |hl-Visual| v Visual mode
4102 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4103 Selection" Only X11 Gui's |gui-x11| and
4104 |xterm-clipboard|.
4105 |hl-WarningMsg| w warning messages
4106 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4107 |hl-Folded| f line used for closed folds
4108 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004109 |hl-DiffAdd| A added line in diff mode
4110 |hl-DiffChange| C changed line in diff mode
4111 |hl-DiffDelete| D deleted line in diff mode
4112 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004114 |hl-Conceal| - the placeholders used for concealed characters
4115 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004116 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004117 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004118 |hl-SpellRare| R rare word |spell|
4119 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004120 |hl-Pmenu| + popup menu normal line
4121 |hl-PmenuSel| = popup menu selected line
4122 |hl-PmenuSbar| x popup menu scrollbar
4123 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124
4125 The display modes are:
4126 r reverse (termcap entry "mr" and "me")
4127 i italic (termcap entry "ZH" and "ZR")
4128 b bold (termcap entry "md" and "me")
4129 s standout (termcap entry "so" and "se")
4130 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004131 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004132 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 n no highlighting
4134 - no highlighting
4135 : use a highlight group
4136 The default is used for occasions that are not included.
4137 If you want to change what the display modes do, see |dos-colors|
4138 for an example.
4139 When using the ':' display mode, this must be followed by the name of
4140 a highlight group. A highlight group can be used to define any type
4141 of highlighting, including using color. See |:highlight| on how to
4142 define one. The default uses a different group for each occasion.
4143 See |highlight-default| for the default highlight groups.
4144
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004146'history' 'hi' number (Vim default: 50, Vi default: 0,
4147 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004150 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004152 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 NOTE: This option is set to the Vi default value when 'compatible' is
4154 set and to the Vim default value when 'compatible' is reset.
4155
4156 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4157'hkmap' 'hk' boolean (default off)
4158 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159 {only available when compiled with the |+rightleft|
4160 feature}
4161 When on, the keyboard is mapped for the Hebrew character set.
4162 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4163 toggle this option. See |rileft.txt|.
4164 NOTE: This option is reset when 'compatible' is set.
4165
4166 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4167'hkmapp' 'hkp' boolean (default off)
4168 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 {only available when compiled with the |+rightleft|
4170 feature}
4171 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4172 This is useful if you have a non-Hebrew keyboard.
4173 See |rileft.txt|.
4174 NOTE: This option is reset when 'compatible' is set.
4175
Bram Moolenaar036986f2017-03-16 17:41:02 +01004176 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4177'hlsearch' 'hls' boolean (default off)
4178 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004179 {not available when compiled without the
4180 |+extra_search| feature}
4181 When there is a previous search pattern, highlight all its matches.
4182 The type of highlighting used can be set with the 'l' occasion in the
4183 'highlight' option. This uses the "Search" highlight group by
4184 default. Note that only the matching text is highlighted, any offsets
4185 are not applied.
4186 See also: 'incsearch' and |:match|.
4187 When you get bored looking at the highlighted matches, you can turn it
4188 off with |:nohlsearch|. This does not change the option value, as
4189 soon as you use a search command, the highlighting comes back.
4190 'redrawtime' specifies the maximum time spent on finding matches.
4191 When the search pattern can match an end-of-line, Vim will try to
4192 highlight all of the matched text. However, this depends on where the
4193 search starts. This will be the first line in the window or the first
4194 line below a closed fold. A match in a previous line which is not
4195 drawn may not continue in a newly drawn line.
4196 You can specify whether the highlight status is restored on startup
4197 with the 'h' flag in 'viminfo' |viminfo-h|.
4198 NOTE: This option is reset when 'compatible' is set.
4199
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 *'icon'* *'noicon'*
4201'icon' boolean (default off, on when title can be restored)
4202 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 When on, the icon text of the window will be set to the value of
4204 'iconstring' (if it is not empty), or to the name of the file
4205 currently being edited. Only the last part of the name is used.
4206 Overridden by the 'iconstring' option.
4207 Only works if the terminal supports setting window icons (currently
4208 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4209 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4210 builtin termcap).
4211 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004212 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004214 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215
4216 *'iconstring'*
4217'iconstring' string (default "")
4218 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 When this option is not empty, it will be used for the icon text of
4220 the window. This happens only when the 'icon' option is on.
4221 Only works if the terminal supports setting window icon text
4222 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004223 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 When Vim was compiled with HAVE_X11 defined, the original icon will be
4225 restored if possible |X11|.
4226 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004227 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004229 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004230 {not available when compiled without the |+statusline| feature}
4231
4232 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4233'ignorecase' 'ic' boolean (default off)
4234 global
4235 Ignore case in search patterns. Also used when searching in the tags
4236 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004237 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238 Can be overruled by using "\c" or "\C" in the pattern, see
4239 |/ignorecase|.
4240
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004241 *'imactivatefunc'* *'imaf'*
4242'imactivatefunc' 'imaf' string (default "")
4243 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004244 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004245 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004246 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004247 The expression will be evaluated in the |sandbox| when set from a
4248 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004249
4250 Example: >
4251 function ImActivateFunc(active)
4252 if a:active
4253 ... do something
4254 else
4255 ... do something
4256 endif
4257 " return value is not used
4258 endfunction
4259 set imactivatefunc=ImActivateFunc
4260<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 *'imactivatekey'* *'imak'*
4262'imactivatekey' 'imak' string (default "")
4263 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004265 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 Specifies the key that your Input Method in X-Windows uses for
4267 activation. When this is specified correctly, vim can fully control
4268 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4269 You can't use this option to change the activation key, the option
4270 tells Vim what the key is.
4271 Format:
4272 [MODIFIER_FLAG-]KEY_STRING
4273
4274 These characters can be used for MODIFIER_FLAG (case is ignored):
4275 S Shift key
4276 L Lock key
4277 C Control key
4278 1 Mod1 key
4279 2 Mod2 key
4280 3 Mod3 key
4281 4 Mod4 key
4282 5 Mod5 key
4283 Combinations are allowed, for example "S-C-space" or "SC-space" are
4284 both shift+ctrl+space.
4285 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4286
4287 Example: >
4288 :set imactivatekey=S-space
4289< "S-space" means shift+space. This is the activation key for kinput2 +
4290 canna (Japanese), and ami (Korean).
4291
4292 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4293'imcmdline' 'imc' boolean (default off)
4294 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 When set the Input Method is always on when starting to edit a command
4296 line, unless entering a search pattern (see 'imsearch' for that).
4297 Setting this option is useful when your input method allows entering
4298 English characters directly, e.g., when it's used to type accented
4299 characters with dead keys.
4300
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004301 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4303 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004304 When set the Input Method is never used. This is useful to disable
4305 the IM when it doesn't work properly.
4306 Currently this option is on by default for SGI/IRIX machines. This
4307 may change in later releases.
4308
4309 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004310'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 Specifies whether :lmap or an Input Method (IM) is to be used in
4313 Insert mode. Valid values:
4314 0 :lmap is off and IM is off
4315 1 :lmap is ON and IM is off
4316 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 To always reset the option to zero when leaving Insert mode with <Esc>
4318 this can be used: >
4319 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4320< This makes :lmap and IM turn off automatically when leaving Insert
4321 mode.
4322 Note that this option changes when using CTRL-^ in Insert mode
4323 |i_CTRL-^|.
4324 The value is set to 1 when setting 'keymap' to a valid keymap name.
4325 It is also used for the argument of commands like "r" and "f".
4326 The value 0 may not work correctly with Athena and Motif with some XIM
4327 methods. Use 'imdisable' to disable XIM then.
4328
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004329 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004330 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004331 |+multi_byte_ime| or |global-ime|.
4332
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004334'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 Specifies whether :lmap or an Input Method (IM) is to be used when
4337 entering a search pattern. Valid values:
4338 -1 the value of 'iminsert' is used, makes it look like
4339 'iminsert' is also used when typing a search pattern
4340 0 :lmap is off and IM is off
4341 1 :lmap is ON and IM is off
4342 2 :lmap is off and IM is ON
4343 Note that this option changes when using CTRL-^ in Command-line mode
4344 |c_CTRL-^|.
4345 The value is set to 1 when it is not -1 and setting the 'keymap'
4346 option to a valid keymap name.
4347 The value 0 may not work correctly with Athena and Motif with some XIM
4348 methods. Use 'imdisable' to disable XIM then.
4349
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004350 *'imstatusfunc'* *'imsf'*
4351'imstatusfunc' 'imsf' string (default "")
4352 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004353 This option specifies a function that is called to obtain the status
4354 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004355 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004356
4357 Example: >
4358 function ImStatusFunc()
4359 let is_active = ...do something
4360 return is_active ? 1 : 0
4361 endfunction
4362 set imstatusfunc=ImStatusFunc
4363<
4364 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004365 The expression will be evaluated in the |sandbox| when set from a
4366 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004367
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004368 *'imstyle'* *'imst'*
4369'imstyle' 'imst' number (default 1)
4370 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004371 {only available when compiled with |+xim| and
4372 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004373 This option specifies the input style of Input Method:
4374 0 use on-the-spot style
4375 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004376 See: |xim-input-style|
4377
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004378 For a long time on-the-spot style had been used in the GTK version of
4379 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004380 |single-repeat|, etc. Therefore over-the-spot style becomes the
4381 default now. This should work fine for most people, however if you
4382 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004383 The expression will be evaluated in the |sandbox| when set from a
4384 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004385
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 *'include'* *'inc'*
4387'include' 'inc' string (default "^\s*#\s*include")
4388 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 {not available when compiled without the
4390 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004391 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004392 pattern, just like for the "/" command (See |pattern|). The default
4393 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004394 "]I", "[d", etc.
4395 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004396 comes after the matched pattern. But if "\zs" appears in the pattern
4397 then the text matched from "\zs" to the end, or until "\ze" if it
4398 appears, is used as the file name. Use this to include characters
4399 that are not in 'isfname', such as a space. You can then use
4400 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004401 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402
4403 *'includeexpr'* *'inex'*
4404'includeexpr' 'inex' string (default "")
4405 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004407 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004409 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 :set includeexpr=substitute(v:fname,'\\.','/','g')
4411< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004412
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004414 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004415 Also used for |<cfile>|.
4416
Bram Moolenaar30b65812012-07-12 22:01:11 +02004417 The expression will be evaluated in the |sandbox| when set from a
4418 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004419 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004420
4421 It is not allowed to change text or jump to another window while
4422 evaluating 'includeexpr' |textlock|.
4423
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004425'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4426 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004429 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004430 While typing a search command, show where the pattern, as it was typed
4431 so far, matches. The matched string is highlighted. If the pattern
4432 is invalid or not found, nothing is shown. The screen will be updated
4433 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004434 Also applies to the pattern in commands: >
4435 :global
4436 :lvimgrep
4437 :lvimgrepadd
4438 :smagic
4439 :snomagic
4440 :sort
4441 :substitute
4442 :vglobal
4443 :vimgrep
4444 :vimgrepadd
4445< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004446 original position when no match is found and when pressing <Esc>. You
4447 still need to finish the search command with <Enter> to move the
4448 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004449 You can use the CTRL-G and CTRL-T keys to move to the next and
4450 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004451 When compiled with the |+reltime| feature Vim only searches for about
4452 half a second. With a complicated pattern and/or a lot of text the
4453 match may not be found. This is to avoid that Vim hangs while you
4454 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004455 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004456 When 'hlsearch' is on, all matched strings are highlighted too while
4457 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004458 If you don't want to turn 'hlsearch' on, but want to highlight all
4459 matches while searching, you can turn on and off 'hlsearch' with
4460 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004461 augroup vimrc-incsearch-highlight
4462 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004463 autocmd CmdlineEnter /,\? :set hlsearch
4464 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004465 augroup END
4466<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004467 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004468 to the command line. If 'ignorecase' and 'smartcase' are set and the
4469 command line has no uppercase characters, the added character is
4470 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004471 CTRL-R CTRL-W can be used to add the word at the end of the current
4472 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 NOTE: This option is reset when 'compatible' is set.
4474
4475 *'indentexpr'* *'inde'*
4476'indentexpr' 'inde' string (default "")
4477 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478 {not available when compiled without the |+cindent|
4479 or |+eval| features}
4480 Expression which is evaluated to obtain the proper indent for a line.
4481 It is used when a new line is created, for the |=| operator and
4482 in Insert mode as specified with the 'indentkeys' option.
4483 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004484 'smartindent' indenting. When 'lisp' is set, this option is
4485 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 When 'paste' is set this option is not used for indenting.
4487 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004488 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489 when the expression is evaluated (but it may be moved around).
4490 The expression must return the number of spaces worth of indent. It
4491 can return "-1" to keep the current indent (this means 'autoindent' is
4492 used for the indent).
4493 Functions useful for computing the indent are |indent()|, |cindent()|
4494 and |lispindent()|.
4495 The evaluation of the expression must not have side effects! It must
4496 not change the text, jump to another window, etc. Afterwards the
4497 cursor position is always restored, thus the cursor may be moved.
4498 Normally this option would be set to call a function: >
4499 :set indentexpr=GetMyIndent()
4500< Error messages will be suppressed, unless the 'debug' option contains
4501 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004502 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004503 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504
Bram Moolenaar30b65812012-07-12 22:01:11 +02004505 The expression will be evaluated in the |sandbox| when set from a
4506 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004507 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004508
4509 It is not allowed to change text or jump to another window while
4510 evaluating 'indentexpr' |textlock|.
4511
4512
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004514'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 {not available when compiled without the |+cindent|
4517 feature}
4518 A list of keys that, when typed in Insert mode, cause reindenting of
4519 the current line. Only happens if 'indentexpr' isn't empty.
4520 The format is identical to 'cinkeys', see |indentkeys-format|.
4521 See |C-indenting| and |indent-expression|.
4522
4523 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4524'infercase' 'inf' boolean (default off)
4525 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004527 'ignorecase' is also on, the case of the match is adjusted depending
4528 on the typed text. If the typed text contains a lowercase letter
4529 where the match has an upper case letter, the completed part is made
4530 lowercase. If the typed text has no lowercase letters and the match
4531 has a lowercase letter where the typed text has an uppercase letter,
4532 and there is a letter before it, the completed part is made uppercase.
4533 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004534
4535 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4536'insertmode' 'im' boolean (default off)
4537 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538 Makes Vim work in a way that Insert mode is the default mode. Useful
4539 if you want to use Vim as a modeless editor. Used for |evim|.
4540 These Insert mode commands will be useful:
4541 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004542 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 this is a mapping, it is executed as if 'insertmode' was off.
4544 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004546 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4547 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548
4549 These items change when 'insertmode' is set:
4550 - when starting to edit of a file, Vim goes to Insert mode.
4551 - <Esc> in Insert mode is a no-op and beeps.
4552 - <Esc> in Normal mode makes Vim go to Insert mode.
4553 - CTRL-L in Insert mode is a command, it is not inserted.
4554 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4555 However, when <Esc> is used inside a mapping, it behaves like
4556 'insertmode' was not set. This was done to be able to use the same
4557 mappings with 'insertmode' set or not set.
4558 When executing commands with |:normal| 'insertmode' is not used.
4559
4560 NOTE: This option is reset when 'compatible' is set.
4561
4562 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004563'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004564 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4565 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4566 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4567 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4568 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4569 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 The characters specified by this option are included in file names and
4571 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004572 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004573 Multi-byte characters 256 and above are always included, only the
4574 characters up to 255 are specified with this option.
4575 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004576 Think twice before adding white space to this option. Although a
4577 space may appear inside a file name, the effect will be that Vim
4578 doesn't know where a file name starts or ends when doing completion.
4579 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580
4581 Note that on systems using a backslash as path separator, Vim tries to
4582 do its best to make it work as you would expect. That is a bit
4583 tricky, since Vi originally used the backslash to escape special
4584 characters. Vim will not remove a backslash in front of a normal file
4585 name character on these systems, but it will on Unix and alikes. The
4586 '&' and '^' are not included by default, because these are special for
4587 cmd.exe.
4588
4589 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004590 Each part can be a single character number or a range. A range is two
4591 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 decimal number between 0 and 255 or the ASCII character itself (does
4593 not work for digits). Example:
4594 "_,-,128-140,#-43" (include '_' and '-' and the range
4595 128 to 140 and '#' to 43)
4596 If a part starts with '^', the following character number or range
4597 will be excluded from the option. The option is interpreted from left
4598 to right. Put the excluded character after the range where it is
4599 included. To include '^' itself use it as the last character of the
4600 option or the end of a range. Example:
4601 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4602 If the character is '@', all characters where isalpha() returns TRUE
4603 are included. Normally these are the characters a to z and A to Z,
4604 plus accented characters. To include '@' itself use "@-@". Examples:
4605 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004606 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 "a-z,A-Z,@-@" All letters plus the '@' character.
4608 A comma can be included by using it where a character number is
4609 expected. Example:
4610 "48-57,,,_" Digits, comma and underscore.
4611 A comma can be excluded by prepending a '^'. Example:
4612 " -~,^,,9" All characters from space to '~', excluding
4613 comma, plus <Tab>.
4614 See |option-backslash| about including spaces and backslashes.
4615
4616 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004617'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 "@,48-57,_,128-167,224-235"
4619 otherwise: "@,48-57,_,192-255")
4620 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 The characters given by this option are included in identifiers.
4622 Identifiers are used in recognizing environment variables and after a
4623 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004624 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004625 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004627 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4629
4630 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004631'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 "@,48-57,_,128-167,224-235"
4633 otherwise: "@,48-57,_,192-255"
4634 Vi default: "@,48-57,_")
4635 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004637 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004638 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004639 characters above 255 check the "word" character class (any character
4640 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004641 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 For a help file it is set to all non-blank printable characters except
4643 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4644 command).
4645 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004646 This option also influences syntax highlighting, unless the syntax
4647 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648 NOTE: This option is set to the Vi default value when 'compatible' is
4649 set and to the Vim default value when 'compatible' is reset.
4650
4651 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004652'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 "@,~-255"; otherwise: "@,161-255")
4654 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 The characters given by this option are displayed directly on the
4656 screen. It is also used for "\p" in a |pattern|. The characters from
4657 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4658 even when they are not included in 'isprint' or excluded. See
4659 'isfname' for a description of the format of this option.
4660
4661 Non-printable characters are displayed with two characters:
4662 0 - 31 "^@" - "^_"
4663 32 - 126 always single characters
4664 127 "^?"
4665 128 - 159 "~@" - "~_"
4666 160 - 254 "| " - "|~"
4667 255 "~?"
4668 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4669 displayed as <xx>, with the hexadecimal value of the byte.
4670 When 'display' contains "uhex" all unprintable characters are
4671 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004672 The SpecialKey highlighting will be used for unprintable characters.
4673 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004674
4675 Multi-byte characters 256 and above are always included, only the
4676 characters up to 255 are specified with this option. When a character
4677 is printable but it is not available in the current font, a
4678 replacement character will be shown.
4679 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4680 There is no option to specify these characters.
4681
4682 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4683'joinspaces' 'js' boolean (default on)
4684 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685 Insert two spaces after a '.', '?' and '!' with a join command.
4686 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4687 Otherwise only one space is inserted.
4688 NOTE: This option is set when 'compatible' is set.
4689
4690 *'key'*
4691'key' string (default "")
4692 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004693 {only available when compiled with the |+cryptv|
4694 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004696 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697 Careful: Do not set the key value by hand, someone might see the typed
4698 key. Use the |:X| command. But you can make 'key' empty: >
4699 :set key=
4700< It is not possible to get the value of this option with ":set key" or
4701 "echo &key". This is to avoid showing it to someone who shouldn't
4702 know. It also means you cannot see it yourself once you have set it,
4703 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004704 You can use "&key" in an expression to detect whether encryption is
4705 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004706
4707 *'keymap'* *'kmp'* *E544*
4708'keymap' 'kmp' string (default "")
4709 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710 {only available when compiled with the |+keymap|
4711 feature}
4712 Name of a keyboard mapping. See |mbyte-keymap|.
4713 Setting this option to a valid keymap name has the side effect of
4714 setting 'iminsert' to one, so that the keymap becomes effective.
4715 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004716 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004717
4718 *'keymodel'* *'km'*
4719'keymodel' 'km' string (default "")
4720 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721 List of comma separated words, which enable special things that keys
4722 can do. These values can be used:
4723 startsel Using a shifted special key starts selection (either
4724 Select mode or Visual mode, depending on "key" being
4725 present in 'selectmode').
4726 stopsel Using a not-shifted special key stops selection.
4727 Special keys in this context are the cursor keys, <End>, <Home>,
4728 <PageUp> and <PageDown>.
4729 The 'keymodel' option is set by the |:behave| command.
4730
4731 *'keywordprg'* *'kp'*
4732'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004733 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735 Program to use for the |K| command. Environment variables are
4736 expanded |:set_env|. ":help" may be used to access the Vim internal
4737 help. (Note that previously setting the global option to the empty
4738 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004739 When the first character is ":", the command is invoked as a Vim
4740 Ex command prefixed with [count].
4741 When "man", "man -s" or an Ex command is used, Vim will automatically
4742 translate a count for the "K" command and pass it as the first
4743 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 See |option-backslash| about including spaces and backslashes.
4745 Example: >
4746 :set keywordprg=man\ -s
4747< This option cannot be set from a |modeline| or in the |sandbox|, for
4748 security reasons.
4749
4750 *'langmap'* *'lmap'* *E357* *E358*
4751'langmap' 'lmap' string (default "")
4752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 {only available when compiled with the |+langmap|
4754 feature}
4755 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004756 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004757 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758 care of translating these special characters to the original meaning
4759 of the key. This means you don't have to change the keyboard mode to
4760 be able to execute Normal mode commands.
4761 This is the opposite of the 'keymap' option, where characters are
4762 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004763 Also consider setting 'langremap' to off, to prevent 'langmap' from
4764 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004765 This option cannot be set from a |modeline| or in the |sandbox|, for
4766 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004768 Example (for Greek, in UTF-8): *greek* >
4769 :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 +00004770< Example (exchanges meaning of z and y for commands): >
4771 :set langmap=zy,yz,ZY,YZ
4772<
4773 The 'langmap' option is a list of parts, separated with commas. Each
4774 part can be in one of two forms:
4775 1. A list of pairs. Each pair is a "from" character immediately
4776 followed by the "to" character. Examples: "aA", "aAbBcC".
4777 2. A list of "from" characters, a semi-colon and a list of "to"
4778 characters. Example: "abc;ABC"
4779 Example: "aA,fgh;FGH,cCdDeE"
4780 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004781 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782
4783 This will allow you to activate vim actions without having to switch
4784 back and forth between the languages. Your language characters will
4785 be understood as normal vim English characters (according to the
4786 langmap mappings) in the following cases:
4787 o Normal/Visual mode (commands, buffer/register names, user mappings)
4788 o Insert/Replace Mode: Register names after CTRL-R
4789 o Insert/Replace Mode: Mappings
4790 Characters entered in Command-line mode will NOT be affected by
4791 this option. Note that this option can be changed at any time
4792 allowing to switch between mappings for different languages/encodings.
4793 Use a mapping to avoid having to type it each time!
4794
4795 *'langmenu'* *'lm'*
4796'langmenu' 'lm' string (default "")
4797 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 {only available when compiled with the |+menu| and
4799 |+multi_lang| features}
4800 Language to use for menu translation. Tells which file is loaded
4801 from the "lang" directory in 'runtimepath': >
4802 "lang/menu_" . &langmenu . ".vim"
4803< (without the spaces). For example, to always use the Dutch menus, no
4804 matter what $LANG is set to: >
4805 :set langmenu=nl_NL.ISO_8859-1
4806< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004807 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808 If your $LANG is set to a non-English language but you do want to use
4809 the English menus: >
4810 :set langmenu=none
4811< This option must be set before loading menus, switching on filetype
4812 detection or syntax highlighting. Once the menus are defined setting
4813 this option has no effect. But you could do this: >
4814 :source $VIMRUNTIME/delmenu.vim
4815 :set langmenu=de_DE.ISO_8859-1
4816 :source $VIMRUNTIME/menu.vim
4817< Warning: This deletes all menus that you defined yourself!
4818
Bram Moolenaard94464e2015-11-02 15:28:18 +01004819 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004820'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004821 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004822 {only available when compiled with the |+langmap|
4823 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004824 This is just like 'langremap' but with the value inverted. It only
4825 exists for backwards compatibility. When setting 'langremap' then
4826 'langnoremap' is set to the inverted value, and the other way around.
4827
4828 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004829'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004830 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004831 {only available when compiled with the |+langmap|
4832 feature}
4833 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004834 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004835 'langmap' disables some of your mappings, try resetting this option.
4836 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004837 that works for you to avoid mappings to break.
4838
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839 *'laststatus'* *'ls'*
4840'laststatus' 'ls' number (default 1)
4841 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004842 The value of this option influences when the last window will have a
4843 status line:
4844 0: never
4845 1: only if there are at least two windows
4846 2: always
4847 The screen looks nicer with a status line if you have several
4848 windows, but it takes another screen line. |status-line|
4849
4850 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4851'lazyredraw' 'lz' boolean (default off)
4852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 When this option is set, the screen will not be redrawn while
4854 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004855 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856 update use |:redraw|.
4857
4858 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4859'linebreak' 'lbr' boolean (default off)
4860 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004861 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004863 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864 than at the last character that fits on the screen. Unlike
4865 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004866 it only affects the way the file is displayed, not its contents.
4867 If 'breakindent' is set, line is visually indented. Then, the value
4868 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004869 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870 Note that <Tab> characters after an <EOL> are mostly not displayed
4871 with the right amount of white space.
4872
4873 *'lines'* *E593*
4874'lines' number (default 24 or terminal height)
4875 global
4876 Number of lines of the Vim window.
4877 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004878 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879 When Vim is running in the GUI or in a resizable window, setting this
4880 option will cause the window size to be changed. When you only want
4881 to use the size for the GUI, put the command in your |gvimrc| file.
4882 Vim limits the number of lines to what fits on the screen. You can
4883 use this command to get the tallest window possible: >
4884 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004885< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004886 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004887 When you set this option and Vim is unable to change the physical
4888 number of lines of the display, the display may be messed up.
4889
4890 *'linespace'* *'lsp'*
4891'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893 {only in the GUI}
4894 Number of pixel lines inserted between characters. Useful if the font
4895 uses the full character cell height, making lines touch each other.
4896 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004897 With some fonts there can be too much room between lines (to have
4898 space for ascents and descents). Then it makes sense to set
4899 'linespace' to a negative value. This may cause display problems
4900 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901
4902 *'lisp'* *'nolisp'*
4903'lisp' boolean (default off)
4904 local to buffer
4905 {not available when compiled without the |+lispindent|
4906 feature}
4907 Lisp mode: When <Enter> is typed in insert mode set the indent for
4908 the next line to Lisp standards (well, sort of). Also happens with
4909 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4910 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4911 better. Also see 'lispwords'.
4912 The '-' character is included in keyword characters. Redefines the
4913 "=" operator to use this same indentation algorithm rather than
4914 calling an external program if 'equalprg' is empty.
4915 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004916
4917 *'lispwords'* *'lw'*
4918'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004919 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920 {not available when compiled without the |+lispindent|
4921 feature}
4922 Comma separated list of words that influence the Lisp indenting.
4923 |'lisp'|
4924
4925 *'list'* *'nolist'*
4926'list' boolean (default off)
4927 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00004928 List mode: By default show tabs as CTRL-I is displayed, display $
4929 after end of line. Useful to see the difference between tabs and
4930 spaces and for trailing blanks. Further changed by the 'listchars'
4931 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004932
4933 The cursor is displayed at the start of the space a Tab character
4934 occupies, not at the end as usual in Normal mode. To get this cursor
4935 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004936 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004937<
4938 Note that list mode will also affect formatting (set with 'textwidth'
4939 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940 changing the way tabs are displayed.
4941
4942 *'listchars'* *'lcs'*
4943'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004944 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004945 Strings to use in 'list' mode and for the |:list| command. It is a
4946 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004947 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948 eol:c Character to show at the end of each line. When
4949 omitted, there is no extra character at the end of the
4950 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004951 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004952 tab:xy[z] Two or three characters to be used to show a tab.
4953 The third character is optional.
4954
4955 tab:xy The 'x' is always used, then 'y' as many times as will
4956 fit. Thus "tab:>-" displays:
4957 >
4958 >-
4959 >--
4960 etc.
4961
4962 tab:xyz The 'z' is always used, then 'x' is prepended, and
4963 then 'y' is used as many times as will fit. Thus
4964 "tab:<->" displays:
4965 >
4966 <>
4967 <->
4968 <-->
4969 etc.
4970
4971 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004972 *lcs-space*
4973 space:c Character to show for a space. When omitted, spaces
4974 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02004975 *lcs-multispace*
4976 multispace:c...
4977 One or more characters to use cyclically to show for
4978 multiple consecutive spaces. Overrides the "space"
4979 setting, except for single spaces. When omitted, the
4980 "space" setting is used. For example,
4981 `:set listchars=multispace:---+` shows ten consecutive
4982 spaces as:
4983 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01004984 *lcs-lead*
4985 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02004986 leading spaces are blank. Overrides the "space" and
4987 "multispace" settings for leading spaces. You can
4988 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01004989 :set listchars+=tab:>-,lead:.
4990< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004991 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02004992 trailing spaces are blank. Overrides the "space" and
4993 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02004994 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995 extends:c Character to show in the last column, when 'wrap' is
4996 off and the line continues beyond the right of the
4997 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004998 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004999 precedes:c Character to show in the first visible column of the
5000 physical line, when there is text preceding the
5001 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005002 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005003 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005004 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005005 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005006 nbsp:c Character to show for a non-breakable space character
5007 (0xA0 (160 decimal) and U+202F). Left blank when
5008 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005010 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005012 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005014 Each character can be specified as hex: >
5015 set listchars=eol:\\x24
5016 set listchars=eol:\\u21b5
5017 set listchars=eol:\\U000021b5
5018< Note that a double backslash is used. The number of hex characters
5019 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5020
Bram Moolenaar071d4272004-06-13 20:20:40 +00005021 Examples: >
5022 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005023 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005024 :set lcs=extends:>,precedes:<
5025< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005026 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5027 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005028 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005029
5030 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5031'loadplugins' 'lpl' boolean (default on)
5032 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 When on the plugin scripts are loaded when starting up |load-plugins|.
5034 This option can be reset in your |vimrc| file to disable the loading
5035 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005036 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5037 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038
Bram Moolenaard94464e2015-11-02 15:28:18 +01005039 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005040'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005041 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005042 {only available when compiled with the |+lua/dyn|
5043 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005044 Specifies the name of the Lua shared library. The default is
5045 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005046 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005047 This option cannot be set from a |modeline| or in the |sandbox|, for
5048 security reasons.
5049
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005050 *'macatsui'* *'nomacatsui'*
5051'macatsui' boolean (default on)
5052 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005053 {not supported}
5054 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005055
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 *'magic'* *'nomagic'*
5057'magic' boolean (default on)
5058 global
5059 Changes the special characters that can be used in search patterns.
5060 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005061 WARNING: Switching this option off most likely breaks plugins! That
5062 is because many patterns assume it's on and will fail when it's off.
5063 Only switch it off when working with old Vi scripts. In any other
5064 situation write patterns that work when 'magic' is on. Include "\M"
5065 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005066 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5067 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068
5069 *'makeef'* *'mef'*
5070'makeef' 'mef' string (default: "")
5071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072 {not available when compiled without the |+quickfix|
5073 feature}
5074 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5075 and the |:grep| command.
5076 When it is empty, an internally generated temp file will be used.
5077 When "##" is included, it is replaced by a number to make the name
5078 unique. This makes sure that the ":make" command doesn't overwrite an
5079 existing file.
5080 NOT used for the ":cf" command. See 'errorfile' for that.
5081 Environment variables are expanded |:set_env|.
5082 See |option-backslash| about including spaces and backslashes.
5083 This option cannot be set from a |modeline| or in the |sandbox|, for
5084 security reasons.
5085
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005086 *'makeencoding'* *'menc'*
5087'makeencoding' 'menc' string (default "")
5088 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005089 Encoding used for reading the output of external commands. When empty,
5090 encoding is not converted.
5091 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5092 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5093 and `:laddfile`.
5094
5095 This would be mostly useful when you use MS-Windows and set 'encoding'
5096 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5097 'makeencoding' to "char" has the same effect as setting to the system
5098 locale encoding. Example: >
5099 :set encoding=utf-8
5100 :set makeencoding=char " system locale is used
5101<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 *'makeprg'* *'mp'*
5103'makeprg' 'mp' string (default "make", VMS: "MMS")
5104 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005105 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005106 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5107 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005108 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005109 Environment variables are expanded |:set_env|. See |option-backslash|
5110 about including spaces and backslashes.
5111 Note that a '|' must be escaped twice: once for ":set" and once for
5112 the interpretation of a command. When you use a filter called
5113 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005114 :set makeprg=gmake\ \\\|\ myfilter
5115< The placeholder "$*" can be given (even multiple times) to specify
5116 where the arguments will be included, for example: >
5117 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5118< This option cannot be set from a |modeline| or in the |sandbox|, for
5119 security reasons.
5120
5121 *'matchpairs'* *'mps'*
5122'matchpairs' 'mps' string (default "(:),{:},[:]")
5123 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005125 other.
5126 Only character pairs are allowed that are different, thus you cannot
5127 jump between two double quotes.
5128 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005129 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005130 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005131 :set mps+=<:>
5132
5133< A more exotic example, to jump between the '=' and ';' in an
5134 assignment, useful for languages like C and Java: >
5135 :au FileType c,cpp,java set mps+==:;
5136
5137< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005138 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139
5140 *'matchtime'* *'mat'*
5141'matchtime' 'mat' number (default 5)
5142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 Tenths of a second to show the matching paren, when 'showmatch' is
5144 set. Note that this is not in milliseconds, like other options that
5145 set a time. This is to be compatible with Nvi.
5146
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005147 *'maxcombine'* *'mco'*
5148'maxcombine' 'mco' number (default 2)
5149 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005150 The maximum number of combining characters supported for displaying.
5151 Only used when 'encoding' is "utf-8".
5152 The default is OK for most languages. Hebrew may require 4.
5153 Maximum value is 6.
5154 Even when this option is set to 2 you can still edit text with more
5155 combining characters, you just can't see them. Use |g8| or |ga|.
5156 See |mbyte-combining|.
5157
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 *'maxfuncdepth'* *'mfd'*
5159'maxfuncdepth' 'mfd' number (default 100)
5160 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005161 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005162 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163 Maximum depth of function calls for user functions. This normally
5164 catches endless recursion. When using a recursive function with
5165 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5166 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005167 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005168 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 See also |:function|.
5170
5171 *'maxmapdepth'* *'mmd'* *E223*
5172'maxmapdepth' 'mmd' number (default 1000)
5173 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174 Maximum number of times a mapping is done without resulting in a
5175 character to be used. This normally catches endless mappings, like
5176 ":map x y" with ":map y x". It still does not catch ":map g wg",
5177 because the 'w' is used before the next mapping is done. See also
5178 |key-mapping|.
5179
5180 *'maxmem'* *'mm'*
5181'maxmem' 'mm' number (default between 256 to 5120 (system
5182 dependent) or half the amount of memory
5183 available)
5184 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5186 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005187 other memory to be freed.
5188 The maximum usable value is about 2000000. Use this to work without a
5189 limit.
5190 The value is ignored when 'swapfile' is off.
5191 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005193 *'maxmempattern'* *'mmp'*
5194'maxmempattern' 'mmp' number (default 1000)
5195 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005196 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005197 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005198 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005199 When Vim runs into the limit it gives an error message and mostly
5200 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005201 Running into the limit often means that the pattern is very
5202 inefficient or too complex. This may already happen with the pattern
5203 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005204 Might also happen on redraw, when syntax rules try to match a complex
5205 text structure.
5206 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5207 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005208
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 *'maxmemtot'* *'mmt'*
5210'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5211 dependent) or half the amount of memory
5212 available)
5213 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005214 Maximum amount of memory in Kbyte to use for all buffers together.
5215 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005216 without a limit.
5217 On 64 bit machines higher values might work. But hey, do you really
5218 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005219 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005220 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005221 Buffers with 'swapfile' off still count to the total amount of memory
5222 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005223 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224
5225 *'menuitems'* *'mis'*
5226'menuitems' 'mis' number (default 25)
5227 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228 {not available when compiled without the |+menu|
5229 feature}
5230 Maximum number of items to use in a menu. Used for menus that are
5231 generated from a list of items, e.g., the Buffers menu. Changing this
5232 option has no direct effect, the menu must be refreshed first.
5233
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005234 *'mkspellmem'* *'msm'*
5235'mkspellmem' 'msm' string (default "460000,2000,500")
5236 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005237 {not available when compiled without the |+syntax|
5238 feature}
5239 Parameters for |:mkspell|. This tunes when to start compressing the
5240 word tree. Compression can be slow when there are many words, but
5241 it's needed to avoid running out of memory. The amount of memory used
5242 per word depends very much on how similar the words are, that's why
5243 this tuning is complicated.
5244
5245 There are three numbers, separated by commas:
5246 {start},{inc},{added}
5247
5248 For most languages the uncompressed word tree fits in memory. {start}
5249 gives the amount of memory in Kbyte that can be used before any
5250 compression is done. It should be a bit smaller than the amount of
5251 memory that is available to Vim.
5252
5253 When going over the {start} limit the {inc} number specifies the
5254 amount of memory in Kbyte that can be allocated before another
5255 compression is done. A low number means compression is done after
5256 less words are added, which is slow. A high number means more memory
5257 will be allocated.
5258
5259 After doing compression, {added} times 1024 words can be added before
5260 the {inc} limit is ignored and compression is done when any extra
5261 amount of memory is needed. A low number means there is a smaller
5262 chance of hitting the {inc} limit, less memory is used but it's
5263 slower.
5264
5265 The languages for which these numbers are important are Italian and
5266 Hungarian. The default works for when you have about 512 Mbyte. If
5267 you have 1 Gbyte you could use: >
5268 :set mkspellmem=900000,3000,800
5269< If you have less than 512 Mbyte |:mkspell| may fail for some
5270 languages, no matter what you set 'mkspellmem' to.
5271
Bram Moolenaar07607392019-05-26 19:20:43 +02005272 This option cannot be set from a |modeline| or in the |sandbox|.
5273
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005275'modeline' 'ml' boolean (Vim default: on (off for root),
5276 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005278 If 'modeline' is on 'modelines' gives the number of lines that is
5279 checked for set commands. If 'modeline' is off or 'modelines' is zero
5280 no lines are checked. See |modeline|.
5281
5282 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5283'modelineexpr' 'mle' boolean (default: off)
5284 global
5285 When on allow some options that are an expression to be set in the
5286 modeline. Check the option for whether it is affected by
5287 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005288 This option cannot be set from a |modeline| or in the |sandbox|, for
5289 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005290
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291 *'modelines'* *'mls'*
5292'modelines' 'mls' number (default 5)
5293 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 If 'modeline' is on 'modelines' gives the number of lines that is
5295 checked for set commands. If 'modeline' is off or 'modelines' is zero
5296 no lines are checked. See |modeline|.
5297 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5298 set and to the Vim default value when 'compatible' is reset.
5299
5300 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005301 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005302'modifiable' 'ma' boolean (default on)
5303 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005304 When off the buffer contents cannot be changed. The 'fileformat' and
5305 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005306 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005307
5308 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5309'modified' 'mod' boolean (default off)
5310 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 When on, the buffer is considered to be modified. This option is set
5312 when:
5313 1. A change was made to the text since it was last written. Using the
5314 |undo| command to go back to the original text will reset the
5315 option. But undoing changes that were made before writing the
5316 buffer will set the option again, since the text is different from
5317 when it was written.
5318 2. 'fileformat' or 'fileencoding' is different from its original
5319 value. The original value is set when the buffer is read or
5320 written. A ":set nomodified" command also resets the original
5321 values to the current values and the 'modified' option will be
5322 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005323 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005324 This option is not set when a change is made to the buffer as the
5325 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5326 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5327 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5329 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005330 Note that the text may actually be the same, e.g. 'modified' is set
5331 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005332
5333 *'more'* *'nomore'*
5334'more' boolean (Vim default: on, Vi default: off)
5335 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005336 When on, listings pause when the whole screen is filled. You will get
5337 the |more-prompt|. When this option is off there are no pauses, the
5338 listing continues until finished.
5339 NOTE: This option is set to the Vi default value when 'compatible' is
5340 set and to the Vim default value when 'compatible' is reset.
5341
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005342 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005343'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005344 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005345 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005346 Enable the use of the mouse. Works for most terminals (xterm, Win32
5347 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5348 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5349 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005350 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351 v Visual mode
5352 i Insert mode
5353 c Command-line mode
5354 h all previous modes when editing a help file
5355 a all previous modes
5356 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005357 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005358 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005359< If your terminal can't overrule the mouse events going to the
5360 application, use: >
5361 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005362< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005363 back to Vim using the mouse events.
5364 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5365 "xterm".
5366
5367 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005368 modeless selection. This doesn't move the text cursor.
5369
5370 See |mouse-using|. Also see |'clipboard'|.
5371
5372 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005373 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374 the mouse buttons can still be used by keeping the shift key pressed.
5375 Also see the 'clipboard' option.
5376
5377 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5378'mousefocus' 'mousef' boolean (default off)
5379 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005380 {only works in the GUI}
5381 The window that the mouse pointer is on is automatically activated.
5382 When changing the window layout or window focus in another way, the
5383 mouse pointer is moved to the window with keyboard focus. Off is the
5384 default because it makes using the pull down menus a little goofy, as
5385 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005386 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005387 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388
5389 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5390'mousehide' 'mh' boolean (default on)
5391 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392 {only works in the GUI}
5393 When on, the mouse pointer is hidden when characters are typed.
5394 The mouse pointer is restored when the mouse is moved.
5395
5396 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005397'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399 Sets the model to use for the mouse. The name mostly specifies what
5400 the right mouse button is used for:
5401 extend Right mouse button extends a selection. This works
5402 like in an xterm.
5403 popup Right mouse button pops up a menu. The shifted left
5404 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005405 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406 popup_setpos Like "popup", but the cursor will be moved to the
5407 position where the mouse was clicked, and thus the
5408 selected operation will act upon the clicked object.
5409 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005410 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005411 course, that right clicking outside a selection will
5412 end Visual mode.
5413 Overview of what button does what for each model:
5414 mouse extend popup(_setpos) ~
5415 left click place cursor place cursor
5416 left drag start selection start selection
5417 shift-left search word extend selection
5418 right click extend selection popup menu (place cursor)
5419 right drag extend selection -
5420 middle click paste paste
5421
5422 In the "popup" model the right mouse button produces a pop-up menu.
5423 You need to define this first, see |popup-menu|.
5424
5425 Note that you can further refine the meaning of buttons with mappings.
5426 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5427 selection (because that's handled in the GUI code directly).
5428
5429 The 'mousemodel' option is set by the |:behave| command.
5430
5431 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005432'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5433 vs:leftright,vd:lrsizing,m:no,
5434 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 {only available when compiled with the |+mouseshape|
5437 feature}
5438 This option tells Vim what the mouse pointer should look like in
5439 different modes. The option is a comma separated list of parts, much
5440 like used for 'guicursor'. Each part consist of a mode/location-list
5441 and an argument-list:
5442 mode-list:shape,mode-list:shape,..
5443 The mode-list is a dash separated list of these modes/locations:
5444 In a normal window: ~
5445 n Normal mode
5446 v Visual mode
5447 ve Visual mode with 'selection' "exclusive" (same as 'v',
5448 if not specified)
5449 o Operator-pending mode
5450 i Insert mode
5451 r Replace mode
5452
5453 Others: ~
5454 c appending to the command-line
5455 ci inserting in the command-line
5456 cr replacing in the command-line
5457 m at the 'Hit ENTER' or 'More' prompts
5458 ml idem, but cursor in the last line
5459 e any mode, pointer below last window
5460 s any mode, pointer on a status line
5461 sd any mode, while dragging a status line
5462 vs any mode, pointer on a vertical separator line
5463 vd any mode, while dragging a vertical separator line
5464 a everywhere
5465
5466 The shape is one of the following:
5467 avail name looks like ~
5468 w x arrow Normal mouse pointer
5469 w x blank no pointer at all (use with care!)
5470 w x beam I-beam
5471 w x updown up-down sizing arrows
5472 w x leftright left-right sizing arrows
5473 w x busy The system's usual busy pointer
5474 w x no The system's usual 'no input' pointer
5475 x udsizing indicates up-down resizing
5476 x lrsizing indicates left-right resizing
5477 x crosshair like a big thin +
5478 x hand1 black hand
5479 x hand2 white hand
5480 x pencil what you write with
5481 x question big ?
5482 x rightup-arrow arrow pointing right-up
5483 w x up-arrow arrow pointing up
5484 x <number> any X11 pointer number (see X11/cursorfont.h)
5485
5486 The "avail" column contains a 'w' if the shape is available for Win32,
5487 x for X11.
5488 Any modes not specified or shapes not available use the normal mouse
5489 pointer.
5490
5491 Example: >
5492 :set mouseshape=s:udsizing,m:no
5493< will make the mouse turn to a sizing arrow over the status lines and
5494 indicate no input when the hit-enter prompt is displayed (since
5495 clicking the mouse has no effect in this state.)
5496
5497 *'mousetime'* *'mouset'*
5498'mousetime' 'mouset' number (default 500)
5499 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005500 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005501 time in msec between two mouse clicks for the second click to be
5502 recognized as a multi click.
5503
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005504 *'mzschemedll'*
5505'mzschemedll' string (default depends on the build)
5506 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005507 {only available when compiled with the |+mzscheme/dyn|
5508 feature}
5509 Specifies the name of the MzScheme shared library. The default is
5510 DYNAMIC_MZSCH_DLL which was specified at compile time.
5511 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005512 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005513 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005514 This option cannot be set from a |modeline| or in the |sandbox|, for
5515 security reasons.
5516
5517 *'mzschemegcdll'*
5518'mzschemegcdll' string (default depends on the build)
5519 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005520 {only available when compiled with the |+mzscheme/dyn|
5521 feature}
5522 Specifies the name of the MzScheme GC shared library. The default is
5523 DYNAMIC_MZGC_DLL which was specified at compile time.
5524 The value can be equal to 'mzschemedll' if it includes the GC code.
5525 Environment variables are expanded |:set_env|.
5526 This option cannot be set from a |modeline| or in the |sandbox|, for
5527 security reasons.
5528
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005529 *'mzquantum'* *'mzq'*
5530'mzquantum' 'mzq' number (default 100)
5531 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005532 {not available when compiled without the |+mzscheme|
5533 feature}
5534 The number of milliseconds between polls for MzScheme threads.
5535 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005536 NOTE: This option is set to the Vim default value when 'compatible'
5537 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005538
Bram Moolenaar071d4272004-06-13 20:20:40 +00005539 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005540'nrformats' 'nf' string (default "bin,octal,hex",
5541 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005542 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543 This defines what bases Vim will consider for numbers when using the
5544 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5545 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005546 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005548 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005549 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005550 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005551 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005552 considered to be hexadecimal. Example: Using CTRL-X on
5553 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005554 bin If included, numbers starting with "0b" or "0B" will be
5555 considered to be binary. Example: Using CTRL-X on
5556 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005557 unsigned If included, numbers are recognized as unsigned. Thus a
5558 leading dash or negative sign won't be considered as part of
5559 the number. Examples:
5560 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5561 (without "unsigned" it would become "9-2021").
5562 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5563 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005564 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5565 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005566 Numbers which simply begin with a digit in the range 1-9 are always
5567 considered decimal. This also happens for numbers that are not
5568 recognized as octal or hex.
5569
5570 *'number'* *'nu'* *'nonumber'* *'nonu'*
5571'number' 'nu' boolean (default off)
5572 local to window
5573 Print the line number in front of each line. When the 'n' option is
5574 excluded from 'cpoptions' a wrapped line will not use the column of
5575 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005576 The 'numberwidth' option can be used to set the room used for the line
5577 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005578 When a long, wrapped line doesn't start with the first character, '-'
5579 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005580 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5581 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005582 *number_relativenumber*
5583 The 'relativenumber' option changes the displayed number to be
5584 relative to the cursor. Together with 'number' there are these
5585 four combinations (cursor in line 3):
5586
Bram Moolenaar3848e002016-03-19 18:42:29 +01005587 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005588 'nornu' 'nornu' 'rnu' 'rnu'
5589
5590 |apple | 1 apple | 2 apple | 2 apple
5591 |pear | 2 pear | 1 pear | 1 pear
5592 |nobody | 3 nobody | 0 nobody |3 nobody
5593 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005595 *'numberwidth'* *'nuw'*
5596'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5597 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005598 {only available when compiled with the |+linebreak|
5599 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005600 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005601 when the 'number' or 'relativenumber' option is set or printing lines
5602 with a line number. Since one space is always between the number and
5603 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005604 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005605 fit the highest line number in the buffer respectively the number of
5606 rows in the window, depending on whether 'number' or 'relativenumber'
5607 is set. Thus with the Vim default of 4 there is room for a line number
5608 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005609 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005610 NOTE: This option is set to the Vi default value when 'compatible' is
5611 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005612
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005613 *'omnifunc'* *'ofu'*
5614'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005615 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005616 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005617 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005618 This option specifies a function to be used for Insert mode omni
5619 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005620 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005621 invoked and what it should return. The value can be the name of a
5622 function, a |lambda| or a |Funcref|. See |option-value-function| for
5623 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005624 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005625 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005626 This option cannot be set from a |modeline| or in the |sandbox|, for
5627 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005628
5629
Bram Moolenaar02467872007-05-06 13:22:01 +00005630 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005631'opendevice' 'odev' boolean (default off)
5632 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005633 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005634 Enable reading and writing from devices. This may get Vim stuck on a
5635 device that can be opened but doesn't actually do the I/O. Therefore
5636 it is off by default.
5637 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5638 result in editing a device.
5639
5640
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005641 *'operatorfunc'* *'opfunc'*
5642'operatorfunc' 'opfunc' string (default: empty)
5643 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005644 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005645 See |:map-operator| for more info and an example. The value can be
5646 the name of a function, a |lambda| or a |Funcref|. See
5647 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005648
5649 This option cannot be set from a |modeline| or in the |sandbox|, for
5650 security reasons.
5651
5652
Bram Moolenaar251e1912011-06-19 05:09:16 +02005653 *'osfiletype'* *'oft'*
5654'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005656 This option was supported on RISC OS, which has been removed.
5657
Bram Moolenaar071d4272004-06-13 20:20:40 +00005658
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005659 *'packpath'* *'pp'*
5660'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005661 Directories used to find packages. See |packages|.
5662
5663
Bram Moolenaar071d4272004-06-13 20:20:40 +00005664 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005665'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005666 global
5667 Specifies the nroff macros that separate paragraphs. These are pairs
5668 of two letters (see |object-motions|).
5669
5670 *'paste'* *'nopaste'*
5671'paste' boolean (default off)
5672 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005673 Put Vim in Paste mode. This is useful if you want to cut or copy
5674 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 unexpected effects.
5676 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005677 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678 knows about pasting and will mostly do the right thing without 'paste'
5679 being set. The same is true for a terminal where Vim handles the
5680 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005681 This option is reset when starting the GUI. Thus if you set it in
5682 your .vimrc it will work in a terminal, but not in the GUI. Setting
5683 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5684 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 When the 'paste' option is switched on (also when it was already on):
5686 - mapping in Insert mode and Command-line mode is disabled
5687 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005689 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005690 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 - 'revins' is reset
5692 - 'ruler' is reset
5693 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005694 - 'smarttab' is reset
5695 - 'softtabstop' is set to 0
5696 - 'textwidth' is set to 0
5697 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005698 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005701 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005702 - 'indentexpr'
5703 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005704 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705 NOTE: When you start editing another file while the 'paste' option is
5706 on, settings from the modelines or autocommands may change the
5707 settings again, causing trouble when pasting text. You might want to
5708 set the 'paste' option again.
5709 When the 'paste' option is reset the mentioned options are restored to
5710 the value before the moment 'paste' was switched from off to on.
5711 Resetting 'paste' before ever setting it does not have any effect.
5712 Since mapping doesn't work while 'paste' is active, you need to use
5713 the 'pastetoggle' option to toggle the 'paste' option with some key.
5714
5715 *'pastetoggle'* *'pt'*
5716'pastetoggle' 'pt' string (default "")
5717 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005718 When non-empty, specifies the key sequence that toggles the 'paste'
5719 option. This is like specifying a mapping: >
5720 :map {keys} :set invpaste<CR>
5721< Where {keys} is the value of 'pastetoggle'.
5722 The difference is that it will work even when 'paste' is set.
5723 'pastetoggle' works in Insert mode and Normal mode, but not in
5724 Command-line mode.
5725 Mappings are checked first, thus overrule 'pastetoggle'. However,
5726 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5727 this: >
5728 :map <F10> :set paste<CR>
5729 :map <F11> :set nopaste<CR>
5730 :imap <F10> <C-O>:set paste<CR>
5731 :imap <F11> <nop>
5732 :set pastetoggle=<F11>
5733< This will make <F10> start paste mode and <F11> stop paste mode.
5734 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5735 mode everything is inserted literally, except the 'pastetoggle' key
5736 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005737 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005738
5739 *'pex'* *'patchexpr'*
5740'patchexpr' 'pex' string (default "")
5741 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742 {not available when compiled without the |+diff|
5743 feature}
5744 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005745 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746
Bram Moolenaardbc28022014-07-26 13:40:44 +02005747 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748'patchmode' 'pm' string (default "")
5749 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750 When non-empty the oldest version of a file is kept. This can be used
5751 to keep the original version of a file if you are changing files in a
5752 source distribution. Only the first time that a file is written a
5753 copy of the original file will be kept. The name of the copy is the
5754 name of the original file with the string in the 'patchmode' option
5755 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005756 ".orig" or ".org". 'backupdir' must not be empty for this to work
5757 (Detail: The backup file is renamed to the patchmode file after the
5758 new file has been successfully written, that's why it must be possible
5759 to write a backup file). If there was no file to be backed up, an
5760 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761 When the 'backupskip' pattern matches, a patchmode file is not made.
5762 Using 'patchmode' for compressed files appends the extension at the
5763 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5764 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005765 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005767 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005768'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005769 other systems: ".,,")
5770 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005772 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5773 provided that the file being searched for has a relative path (not
5774 starting with "/", "./" or "../"). The directories in the 'path'
5775 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005776 - Use commas to separate directory names: >
5777 :set path=.,/usr/local/include,/usr/include
5778< - Spaces can also be used to separate directory names (for backwards
5779 compatibility with version 3.0). To have a space in a directory
5780 name, precede it with an extra backslash, and escape the space: >
5781 :set path=.,/dir/with\\\ space
5782< - To include a comma in a directory name precede it with an extra
5783 backslash: >
5784 :set path=.,/dir/with\\,comma
5785< - To search relative to the directory of the current file, use: >
5786 :set path=.
5787< - To search in the current directory use an empty string between two
5788 commas: >
5789 :set path=,,
5790< - A directory name may end in a ':' or '/'.
5791 - Environment variables are expanded |:set_env|.
5792 - When using |netrw.vim| URLs can be used. For example, adding
5793 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005794 - Search upwards and downwards in a directory tree using "*", "**" and
5795 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005796 {not available when compiled without the |+path_extra| feature}
5797 - Careful with '\' characters, type two to get one in the option: >
5798 :set path=.,c:\\include
5799< Or just use '/' instead: >
5800 :set path=.,c:/include
5801< Don't forget "." or files won't even be found in the same directory as
5802 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005803 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005804 it is something like 256 or 1024 characters.
5805 You can check if all the include files are found, using the value of
5806 'path', see |:checkpath|.
5807 The use of |:set+=| and |:set-=| is preferred when adding or removing
5808 directories from the list. This avoids problems when a future version
5809 uses another default. To remove the current directory use: >
5810 :set path-=
5811< To add the current directory use: >
5812 :set path+=
5813< To use an environment variable, you probably need to replace the
5814 separator. Here is an example to append $INCL, in which directory
5815 names are separated with a semi-colon: >
5816 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5817< Replace the ';' with a ':' or whatever separator is used. Note that
5818 this doesn't work when $INCL contains a comma or white space.
5819
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005820 *'perldll'*
5821'perldll' string (default depends on the build)
5822 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005823 {only available when compiled with the |+perl/dyn|
5824 feature}
5825 Specifies the name of the Perl shared library. The default is
5826 DYNAMIC_PERL_DLL, which was specified at compile time.
5827 Environment variables are expanded |:set_env|.
5828 This option cannot be set from a |modeline| or in the |sandbox|, for
5829 security reasons.
5830
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5832'preserveindent' 'pi' boolean (default off)
5833 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005834 When changing the indent of the current line, preserve as much of the
5835 indent structure as possible. Normally the indent is replaced by a
5836 series of tabs followed by spaces as required (unless |'expandtab'| is
5837 enabled, in which case only spaces are used). Enabling this option
5838 means the indent will preserve as many existing characters as possible
5839 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005840 'expandtab' does not apply to the preserved white space, a Tab remains
5841 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005842 NOTE: When using ">>" multiple times the resulting indent is a mix of
5843 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005844 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005845 Also see 'copyindent'.
5846 Use |:retab| to clean up white space.
5847
5848 *'previewheight'* *'pvh'*
5849'previewheight' 'pvh' number (default 12)
5850 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005851 {not available when compiled without the |+quickfix|
5852 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005853 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005854 commands. Used for |CTRL-W_}| when no count is given. Not used when
5855 'previewpopup' is set.
5856
5857 *'previewpopup'* *'pvp'*
5858'previewpopup' 'pvp' string (default empty)
5859 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005860 {not available when compiled without the |+textprop|
5861 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005862 When not empty a popup window is used for commands that would open a
5863 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005864 Not used for the insert completion info, add "popup" to
5865 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866
5867 *'previewwindow'* *'nopreviewwindow'*
5868 *'pvw'* *'nopvw'* *E590*
5869'previewwindow' 'pvw' boolean (default off)
5870 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005871 {not available when compiled without the |+quickfix|
5872 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005873 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874 set. It's normally not set directly, but by using one of the commands
5875 |:ptag|, |:pedit|, etc.
5876
5877 *'printdevice'* *'pdev'*
5878'printdevice' 'pdev' string (default empty)
5879 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880 {only available when compiled with the |+printer|
5881 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005882 The name of the printer to be used for |:hardcopy|.
5883 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005884 This option cannot be set from a |modeline| or in the |sandbox|, for
5885 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886
Bram Moolenaar8299df92004-07-10 09:47:34 +00005887 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005888'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005889 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890 {only available when compiled with the |+printer|
5891 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005892 Sets the character encoding used when printing.
5893 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894
5895 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005896'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005898 {only available when compiled with the |+printer|
5899 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005900 Expression used to print the PostScript produced with |:hardcopy|.
5901 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005902 This option cannot be set from a |modeline| or in the |sandbox|, for
5903 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904
Bram Moolenaar8299df92004-07-10 09:47:34 +00005905 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005906'printfont' 'pfn' string (default "courier")
5907 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908 {only available when compiled with the |+printer|
5909 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005910 The name of the font that will be used for |:hardcopy|.
5911 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005912
5913 *'printheader'* *'pheader'*
5914'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5915 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005916 {only available when compiled with the |+printer|
5917 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005918 The format of the header produced in |:hardcopy| output.
5919 See |pheader-option|.
5920
5921 *'printmbcharset'* *'pmbcs'*
5922'printmbcharset' 'pmbcs' string (default "")
5923 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005924 {only available when compiled with the |+printer|
5925 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005926 The CJK character set to be used for CJK output from |:hardcopy|.
5927 See |pmbcs-option|.
5928
5929 *'printmbfont'* *'pmbfn'*
5930'printmbfont' 'pmbfn' string (default "")
5931 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005932 {only available when compiled with the |+printer|
5933 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005934 List of font names to be used for CJK output from |:hardcopy|.
5935 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005936
5937 *'printoptions'* *'popt'*
5938'printoptions' 'popt' string (default "")
5939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005940 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005941 List of items that control the format of the output of |:hardcopy|.
5942 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005943
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005944 *'prompt'* *'noprompt'*
5945'prompt' boolean (default on)
5946 global
5947 When on a ":" prompt is used in Ex mode.
5948
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005949 *'pumheight'* *'ph'*
5950'pumheight' 'ph' number (default 0)
5951 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005952 Determines the maximum number of items to show in the popup menu for
5953 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005954 |ins-completion-menu|.
5955
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005956 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005957'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005958 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005959 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005960 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005961
Bram Moolenaard94464e2015-11-02 15:28:18 +01005962 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005963'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005964 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005965 {only available when compiled with the |+python/dyn|
5966 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005967 Specifies the name of the Python 2.x shared library. The default is
5968 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005969 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005970 This option cannot be set from a |modeline| or in the |sandbox|, for
5971 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005972
Bram Moolenaar94073162018-01-31 21:49:05 +01005973 *'pythonhome'*
5974'pythonhome' string (default "")
5975 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005976 {only available when compiled with the |+python/dyn|
5977 feature}
5978 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5979 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5980 which was specified at compile time, will be used for the Python 2.x
5981 home directory.
5982 Environment variables are expanded |:set_env|.
5983 This option cannot be set from a |modeline| or in the |sandbox|, for
5984 security reasons.
5985
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005986 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005987'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005988 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005989 {only available when compiled with the |+python3/dyn|
5990 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005991 Specifies the name of the Python 3 shared library. The default is
5992 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005993 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005994 This option cannot be set from a |modeline| or in the |sandbox|, for
5995 security reasons.
5996
Bram Moolenaar94073162018-01-31 21:49:05 +01005997 *'pythonthreehome'*
5998'pythonthreehome' string (default "")
5999 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006000 {only available when compiled with the |+python3/dyn|
6001 feature}
6002 Specifies the name of the Python 3 home directory. When
6003 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6004 PYTHON3_HOME, which was specified at compile time, will be used for
6005 the Python 3 home directory.
6006 Environment variables are expanded |:set_env|.
6007 This option cannot be set from a |modeline| or in the |sandbox|, for
6008 security reasons.
6009
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006010 *'pyxversion'* *'pyx'*
6011'pyxversion' 'pyx' number (default depends on the build)
6012 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006013 {only available when compiled with the |+python| or
6014 the |+python3| feature}
6015 Specifies the python version used for pyx* functions and commands
6016 |python_x|. The default value is as follows:
6017
6018 Compiled with Default ~
6019 |+python| and |+python3| 0
6020 only |+python| 2
6021 only |+python3| 3
6022
6023 Available values are 0, 2 and 3.
6024 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6025 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6026 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6027 to 2 if Python 2 is available.
6028 See also: |has-pythonx|
6029
6030 If Vim is compiled with only |+python| or |+python3| setting
6031 'pyxversion' has no effect. The pyx* functions and commands are
6032 always the same as the compiled version.
6033
6034 This option cannot be set from a |modeline| or in the |sandbox|, for
6035 security reasons.
6036
Bram Moolenaar858ba062020-05-31 23:11:59 +02006037 *'quickfixtextfunc'* *'qftf'*
6038'quickfixtextfunc' 'qftf' string (default "")
6039 global
6040 {only available when compiled with the |+quickfix|
6041 feature}
6042 This option specifies a function to be used to get the text to display
6043 in the quickfix and location list windows. This can be used to
6044 customize the information displayed in the quickfix or location window
6045 for each entry in the corresponding quickfix or location list. See
6046 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006047 function and an example. The value can be the name of a function, a
6048 |lambda| or a |Funcref|. See |option-value-function| for more
6049 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006050
6051 This option cannot be set from a |modeline| or in the |sandbox|, for
6052 security reasons.
6053
Bram Moolenaar677ee682005-01-27 14:41:15 +00006054 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006055'quoteescape' 'qe' string (default "\")
6056 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006057 The characters that are used to escape quotes in a string. Used for
6058 objects like a', a" and a` |a'|.
6059 When one of the characters in this option is found inside a string,
6060 the following character will be skipped. The default value makes the
6061 text "foo\"bar\\" considered to be one string.
6062
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6064'readonly' 'ro' boolean (default off)
6065 local to buffer
6066 If on, writes fail unless you use a '!'. Protects you from
6067 accidentally overwriting a file. Default on when Vim is started
6068 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006069 When using ":w!" the 'readonly' option is reset for the current
6070 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006071 When using the ":view" command the 'readonly' option is set for the
6072 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006073 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006075 *'redrawtime'* *'rdt'*
6076'redrawtime' 'rdt' number (default 2000)
6077 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006078 {only available when compiled with the |+reltime|
6079 feature}
6080 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006081 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006082 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006083 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006084 matches will be highlighted.
6085 For syntax highlighting the time applies per window. When over the
6086 limit syntax highlighting is disabled until |CTRL-L| is used.
6087 This is used to avoid that Vim hangs when using a very complicated
6088 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006089
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006090 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006091'regexpengine' 're' number (default 0)
6092 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006093 This selects the default regexp engine. |two-engines|
6094 The possible values are:
6095 0 automatic selection
6096 1 old engine
6097 2 NFA engine
6098 Note that when using the NFA engine and the pattern contains something
6099 that is not supported the pattern will not match. This is only useful
6100 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006101 Using automatic selection enables Vim to switch the engine, if the
6102 default engine becomes too costly. E.g., when the NFA engine uses too
6103 many states. This should prevent Vim from hanging on a combination of
6104 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006105
Bram Moolenaar64486672010-05-16 15:46:46 +02006106 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6107'relativenumber' 'rnu' boolean (default off)
6108 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006109 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006110 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006111 precede some vertical motion commands (e.g. j k + -) with, without
6112 having to calculate it yourself. Especially useful in combination with
6113 other commands (e.g. y d c < > gq gw =).
6114 When the 'n' option is excluded from 'cpoptions' a wrapped
6115 line will not use the column of line numbers (this is the default when
6116 'compatible' isn't set).
6117 The 'numberwidth' option can be used to set the room used for the line
6118 number.
6119 When a long, wrapped line doesn't start with the first character, '-'
6120 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006121 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6122 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006123
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006124 The number in front of the cursor line also depends on the value of
6125 'number', see |number_relativenumber| for all combinations of the two
6126 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006127
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 *'remap'* *'noremap'*
6129'remap' boolean (default on)
6130 global
6131 Allows for mappings to work recursively. If you do not want this for
6132 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006133 NOTE: To avoid portability problems with Vim scripts, always keep
6134 this option at the default "on". Only switch it off when working with
6135 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006137 *'renderoptions'* *'rop'*
6138'renderoptions' 'rop' string (default: empty)
6139 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006140 {only available when compiled with GUI and DIRECTX on
6141 MS-Windows}
6142 Select a text renderer and set its options. The options depend on the
6143 renderer.
6144
6145 Syntax: >
6146 set rop=type:{renderer}(,{name}:{value})*
6147<
6148 Currently, only one optional renderer is available.
6149
6150 render behavior ~
6151 directx Vim will draw text using DirectX (DirectWrite). It makes
6152 drawn glyphs more beautiful than default GDI.
6153 It requires 'encoding' is "utf-8", and only works on
6154 MS-Windows Vista or newer version.
6155
6156 Options:
6157 name meaning type value ~
6158 gamma gamma float 1.0 - 2.2 (maybe)
6159 contrast enhancedContrast float (unknown)
6160 level clearTypeLevel float (unknown)
6161 geom pixelGeometry int 0 - 2 (see below)
6162 renmode renderingMode int 0 - 6 (see below)
6163 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006164 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006165
Bram Moolenaar92467d32017-12-05 13:22:16 +01006166 See this URL for detail (except for scrlines):
6167 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006168
6169 For geom: structure of a device pixel.
6170 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6171 1 - DWRITE_PIXEL_GEOMETRY_RGB
6172 2 - DWRITE_PIXEL_GEOMETRY_BGR
6173
6174 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006175 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006176
6177 For renmode: method of rendering glyphs.
6178 0 - DWRITE_RENDERING_MODE_DEFAULT
6179 1 - DWRITE_RENDERING_MODE_ALIASED
6180 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6181 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6182 4 - DWRITE_RENDERING_MODE_NATURAL
6183 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6184 6 - DWRITE_RENDERING_MODE_OUTLINE
6185
6186 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006187 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006188
6189 For taamode: antialiasing mode used for drawing text.
6190 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6191 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6192 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6193 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6194
6195 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006196 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6197
Bram Moolenaara338adc2018-01-31 20:51:47 +01006198 For scrlines:
6199 This was used for optimizing scrolling behavior, however this
6200 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006201
6202 Example: >
6203 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006204 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006205 set rop=type:directx
6206<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006207 If select a raster font (Courier, Terminal or FixedSys which
6208 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006209 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006210
6211 NOTE: It is known that some fonts and options combination
6212 causes trouble on drawing glyphs.
6213
Bram Moolenaar92467d32017-12-05 13:22:16 +01006214 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006215 special made fonts (True-Type fonts which includes only
6216 bitmap glyphs).
6217 - 'taamode:3' will not work with some vector fonts.
6218
6219 NOTE: With this option, you can display colored emoji
6220 (emoticon) in Windows 8.1 or later. To display colored emoji,
6221 there are some conditions which you should notice.
6222
6223 - If your font includes non-colored emoji already, it will
6224 be used.
6225 - If your font doesn't have emoji, the system chooses an
6226 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6227 will be used.
6228 - When this alternative font didn't have fixed width glyph,
6229 emoji might be rendered beyond the bounding box of drawing
6230 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006231
6232 Other render types are currently not supported.
6233
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234 *'report'*
6235'report' number (default 2)
6236 global
6237 Threshold for reporting number of lines changed. When the number of
6238 changed lines is more than 'report' a message will be given for most
6239 ":" commands. If you want it always, set 'report' to 0.
6240 For the ":substitute" command the number of substitutions is used
6241 instead of the number of lines.
6242
6243 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6244'restorescreen' 'rs' boolean (default on)
6245 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006246 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 When set, the screen contents is restored when exiting Vim. This also
6248 happens when executing external commands.
6249
6250 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6251 options in your .vimrc. To disable restoring:
6252 set t_ti= t_te=
6253 To enable restoring (for an xterm):
6254 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6255 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6256
6257 *'revins'* *'ri'* *'norevins'* *'nori'*
6258'revins' 'ri' boolean (default off)
6259 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 {only available when compiled with the |+rightleft|
6261 feature}
6262 Inserting characters in Insert mode will work backwards. See "typing
6263 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6264 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006265 NOTE: This option is reset when 'compatible' is set.
6266 This option is reset when 'paste' is set and restored when 'paste' is
6267 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268
6269 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6270'rightleft' 'rl' boolean (default off)
6271 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272 {only available when compiled with the |+rightleft|
6273 feature}
6274 When on, display orientation becomes right-to-left, i.e., characters
6275 that are stored in the file appear from the right to the left.
6276 Using this option, it is possible to edit files for languages that
6277 are written from the right to the left such as Hebrew and Arabic.
6278 This option is per window, so it is possible to edit mixed files
6279 simultaneously, or to view the same file in both ways (this is
6280 useful whenever you have a mixed text file with both right-to-left
6281 and left-to-right strings so that both sets are displayed properly
6282 in different windows). Also see |rileft.txt|.
6283
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006284 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285'rightleftcmd' 'rlc' string (default "search")
6286 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006287 {only available when compiled with the |+rightleft|
6288 feature}
6289 Each word in this option enables the command line editing to work in
6290 right-to-left mode for a group of commands:
6291
6292 search "/" and "?" commands
6293
6294 This is useful for languages such as Hebrew, Arabic and Farsi.
6295 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6296
Bram Moolenaard94464e2015-11-02 15:28:18 +01006297 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006298'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006299 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006300 {only available when compiled with the |+ruby/dyn|
6301 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006302 Specifies the name of the Ruby shared library. The default is
6303 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006304 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006305 This option cannot be set from a |modeline| or in the |sandbox|, for
6306 security reasons.
6307
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006309'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006310 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311 {not available when compiled without the
6312 |+cmdline_info| feature}
6313 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006314 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315 text in the file is shown on the far right:
6316 Top first line is visible
6317 Bot last line is visible
6318 All first and last line are visible
6319 45% relative position in the file
6320 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006321 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006323 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 this option takes precedence over 'ruler' and 'rulerformat'
6325 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006326 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006327 the text column (byte number) and the screen column are shown,
6328 separated with a dash.
6329 For an empty line "0-1" is shown.
6330 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006331 This option is reset when 'paste' is set and restored when 'paste' is
6332 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333 If you don't want to see the ruler all the time but want to know where
6334 you are, use "g CTRL-G" |g_CTRL-G|.
6335 NOTE: This option is reset when 'compatible' is set.
6336
6337 *'rulerformat'* *'ruf'*
6338'rulerformat' 'ruf' string (default empty)
6339 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340 {not available when compiled without the |+statusline|
6341 feature}
6342 When this option is not empty, it determines the content of the ruler
6343 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006344 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006345 This option cannot be set in a modeline when 'modelineexpr' is off.
6346
Bram Moolenaar071d4272004-06-13 20:20:40 +00006347 The default ruler width is 17 characters. To make the ruler 15
6348 characters wide, put "%15(" at the start and "%)" at the end.
6349 Example: >
6350 :set rulerformat=%15(%c%V\ %p%%%)
6351<
6352 *'runtimepath'* *'rtp'* *vimfiles*
6353'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006354 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355 $VIM/vimfiles,
6356 $VIMRUNTIME,
6357 $VIM/vimfiles/after,
6358 $HOME/.vim/after"
6359 Amiga: "home:vimfiles,
6360 $VIM/vimfiles,
6361 $VIMRUNTIME,
6362 $VIM/vimfiles/after,
6363 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006364 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006365 $VIM/vimfiles,
6366 $VIMRUNTIME,
6367 $VIM/vimfiles/after,
6368 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006369 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 $VIMRUNTIME,
6371 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006372 Haiku: "$BE_USER_SETTINGS/vim,
6373 $VIM/vimfiles,
6374 $VIMRUNTIME,
6375 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006376 $BE_USER_SETTINGS/vim/after"
6377 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378 $VIM/vimfiles,
6379 $VIMRUNTIME,
6380 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006381 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006382 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383 This is a list of directories which will be searched for runtime
6384 files:
6385 filetype.vim filetypes by file name |new-filetype|
6386 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006387 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 colors/ color scheme files |:colorscheme|
6389 compiler/ compiler files |:compiler|
6390 doc/ documentation |write-local-help|
6391 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006392 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 indent/ indent scripts |indent-expression|
6394 keymap/ key mapping files |mbyte-keymap|
6395 lang/ menu translations |:menutrans|
6396 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006397 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006398 plugin/ plugin scripts |write-plugin|
6399 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006400 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 syntax/ syntax files |mysyntaxfile|
6402 tutor/ files for vimtutor |tutor|
6403
6404 And any other file searched for with the |:runtime| command.
6405
6406 The defaults for most systems are setup to search five locations:
6407 1. In your home directory, for your personal preferences.
6408 2. In a system-wide Vim directory, for preferences from the system
6409 administrator.
6410 3. In $VIMRUNTIME, for files distributed with Vim.
6411 *after-directory*
6412 4. In the "after" directory in the system-wide Vim directory. This is
6413 for the system administrator to overrule or add to the distributed
6414 defaults (rarely needed)
6415 5. In the "after" directory in your home directory. This is for
6416 personal preferences to overrule or add to the distributed defaults
6417 or system-wide settings (rarely needed).
6418
Bram Moolenaard0796902016-09-16 20:02:31 +02006419 More entries are added when using |packages|. If it gets very long
6420 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6421 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006422
Bram Moolenaar071d4272004-06-13 20:20:40 +00006423 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6424 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006425 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426 wildcards.
6427 See |:runtime|.
6428 Example: >
6429 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6430< This will use the directory "~/vimruntime" first (containing your
6431 personal Vim runtime files), then "/mygroup/vim" (shared between a
6432 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6433 files).
6434 You probably should always include $VIMRUNTIME somewhere, to use the
6435 distributed runtime files. You can put a directory before $VIMRUNTIME
6436 to find files which replace a distributed runtime files. You can put
6437 a directory after $VIMRUNTIME to find files which add to distributed
6438 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006439 When Vim is started with |--clean| the home directory entries are not
6440 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441 This option cannot be set from a |modeline| or in the |sandbox|, for
6442 security reasons.
6443
6444 *'scroll'* *'scr'*
6445'scroll' 'scr' number (default: half the window height)
6446 local to window
6447 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6448 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006449 changes. This may happen when enabling the |status-line| or
6450 'tabline' option after setting the 'scroll' option.
6451 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006452 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006453 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454
6455 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6456'scrollbind' 'scb' boolean (default off)
6457 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 See also |scroll-binding|. When this option is set, the current
6459 window scrolls as other scrollbind windows (windows that also have
6460 this option set) scroll. This option is useful for viewing the
6461 differences between two versions of a file, see 'diff'.
6462 See |'scrollopt'| for options that determine how this option should be
6463 interpreted.
6464 This option is mostly reset when splitting a window to edit another
6465 file. This means that ":split | edit file" results in two windows
6466 with scroll-binding, but ":split file" does not.
6467
Bram Moolenaarae20f342019-11-05 21:09:23 +01006468 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6469'scrollfocus' 'scf' boolean (default off)
6470 global
6471 {only for MS-Windows GUI}
6472 When using the scroll wheel and this option is set, the window under
6473 the mouse pointer is scrolled. With this option off the current
6474 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006475 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006476
Bram Moolenaar071d4272004-06-13 20:20:40 +00006477 *'scrolljump'* *'sj'*
6478'scrolljump' 'sj' number (default 1)
6479 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480 Minimal number of lines to scroll when the cursor gets off the
6481 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6482 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006483 When set to a negative number from -1 to -100 this is used as the
6484 percentage of the window height. Thus -50 scrolls half the window
6485 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006486 NOTE: This option is set to 1 when 'compatible' is set.
6487
6488 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006489'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006490 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491 Minimal number of screen lines to keep above and below the cursor.
6492 This will make some context visible around where you are working. If
6493 you set it to a very large value (999) the cursor line will always be
6494 in the middle of the window (except at the start or end of the file or
6495 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006496 After using the local value, go back the global value with one of
6497 these two: >
6498 setlocal scrolloff<
6499 setlocal scrolloff=-1
6500< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501 NOTE: This option is set to 0 when 'compatible' is set.
6502
6503 *'scrollopt'* *'sbo'*
6504'scrollopt' 'sbo' string (default "ver,jump")
6505 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006507 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6508 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006509 The following words are available:
6510 ver Bind vertical scrolling for 'scrollbind' windows
6511 hor Bind horizontal scrolling for 'scrollbind' windows
6512 jump Applies to the offset between two windows for vertical
6513 scrolling. This offset is the difference in the first
6514 displayed line of the bound windows. When moving
6515 around in a window, another 'scrollbind' window may
6516 reach a position before the start or after the end of
6517 the buffer. The offset is not changed though, when
6518 moving back the 'scrollbind' window will try to scroll
6519 to the desired position when possible.
6520 When now making that window the current one, two
6521 things can be done with the relative offset:
6522 1. When "jump" is not included, the relative offset is
6523 adjusted for the scroll position in the new current
6524 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006525 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 2. When "jump" is included, the other windows are
6527 scrolled to keep the same relative offset. When
6528 going back to the other window, it still uses the
6529 same relative offset.
6530 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006531 When 'diff' mode is active there always is vertical scroll binding,
6532 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533
6534 *'sections'* *'sect'*
6535'sections' 'sect' string (default "SHNHH HUnhsh")
6536 global
6537 Specifies the nroff macros that separate sections. These are pairs of
6538 two letters (See |object-motions|). The default makes a section start
6539 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6540
6541 *'secure'* *'nosecure'* *E523*
6542'secure' boolean (default off)
6543 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544 When on, ":autocmd", shell and write commands are not allowed in
6545 ".vimrc" and ".exrc" in the current directory and map commands are
6546 displayed. Switch it off only if you know that you will not run into
6547 problems, or when the 'exrc' option is off. On Unix this option is
6548 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006549 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550 'secure' at the end of your ~/.vimrc then.
6551 This option cannot be set from a |modeline| or in the |sandbox|, for
6552 security reasons.
6553
6554 *'selection'* *'sel'*
6555'selection' 'sel' string (default "inclusive")
6556 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557 This option defines the behavior of the selection. It is only used
6558 in Visual and Select mode.
6559 Possible values:
6560 value past line inclusive ~
6561 old no yes
6562 inclusive yes yes
6563 exclusive yes no
6564 "past line" means that the cursor is allowed to be positioned one
6565 character past the line.
6566 "inclusive" means that the last character of the selection is included
6567 in an operation. For example, when "x" is used to delete the
6568 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006569 When "old" is used and 'virtualedit' allows the cursor to move past
6570 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 Note that when "exclusive" is used and selecting from the end
6572 backwards, you cannot include the last character of a line, when
6573 starting in Normal mode and 'virtualedit' empty.
6574
6575 The 'selection' option is set by the |:behave| command.
6576
6577 *'selectmode'* *'slm'*
6578'selectmode' 'slm' string (default "")
6579 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580 This is a comma separated list of words, which specifies when to start
6581 Select mode instead of Visual mode, when a selection is started.
6582 Possible values:
6583 mouse when using the mouse
6584 key when using shifted special keys
6585 cmd when using "v", "V" or CTRL-V
6586 See |Select-mode|.
6587 The 'selectmode' option is set by the |:behave| command.
6588
6589 *'sessionoptions'* *'ssop'*
6590'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006591 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006593 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 feature}
6595 Changes the effect of the |:mksession| command. It is a comma
6596 separated list of words. Each word enables saving and restoring
6597 something:
6598 word save and restore ~
6599 blank empty windows
6600 buffers hidden and unloaded buffers, not just those in windows
6601 curdir the current directory
6602 folds manually created folds, opened/closed folds and local
6603 fold options
6604 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006605 and contain at least one lowercase letter. Only
6606 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607 help the help window
6608 localoptions options and mappings local to a window or buffer (not
6609 global values for local options)
6610 options all options and mappings (also global values for local
6611 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006612 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613 resize size of the Vim window: 'lines' and 'columns'
6614 sesdir the directory in which the session file is located
6615 will become the current directory (useful with
6616 projects accessed over a network from different
6617 systems)
6618 slash backslashes in file names replaced with forward
6619 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006620 tabpages all tab pages; without this only the current tab page
6621 is restored, so that you can make a session for each
6622 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006623 terminal include terminal windows where the command can be
6624 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006625 unix with Unix end-of-line format (single <NL>), even when
6626 on Windows or DOS
6627 winpos position of the whole Vim window
6628 winsize window sizes
6629
6630 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006631 When neither "curdir" nor "sesdir" is included, file names are stored
6632 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006633 "slash" and "unix" are useful on Windows when sharing session files
6634 with Unix. The Unix version of Vim cannot source dos format scripts,
6635 but the Windows version of Vim can source unix format scripts.
6636
6637 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006638'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 global
6640 Name of the shell to use for ! and :! commands. When changing the
6641 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6642 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006643 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 See |option-backslash| about including spaces and backslashes.
6645 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006646
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006647 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006648 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6650< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006651 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006653 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006655 Example with escaped space (Vim will do this when initializing the
6656 option from $SHELL): >
6657 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006658< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006659 backslashes are consumed by `:set`.
6660
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661 Under MS-Windows, when the executable ends in ".com" it must be
6662 included. Thus setting the shell to "command.com" or "4dos.com"
6663 works, but "command" and "4dos" do not work for all commands (e.g.,
6664 filtering).
6665 For unknown reasons, when using "4dos.com" the current directory is
6666 changed to "C:\". To avoid this set 'shell' like this: >
6667 :set shell=command.com\ /c\ 4dos
6668< This option cannot be set from a |modeline| or in the |sandbox|, for
6669 security reasons.
6670
6671 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006672'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006673 Win32, when 'shell' contains "powershell":
6674 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006675 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006678 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6679 For MS-Windows, the default is set according to the value of 'shell',
6680 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006681 On Unix it can have more than one flag. Each white space separated
6682 part is passed as an argument to the shell command.
6683 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006684 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 This option cannot be set from a |modeline| or in the |sandbox|, for
6686 security reasons.
6687
6688 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006689'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6690 "2>&1| tee", or
6691 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693 {not available when compiled without the |+quickfix|
6694 feature}
6695 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006696 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006697 including spaces and backslashes.
6698 The name of the temporary file can be represented by "%s" if necessary
6699 (the file name is appended automatically if no %s appears in the value
6700 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006701 For the Amiga the default is ">". For MS-Windows using powershell the
6702 default is "2>&1 | Out-File -Encoding default", otherwise the default
6703 is ">%s 2>&1". The output is directly saved in a file and not echoed
6704 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006705 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706 in a file and echoed to the screen. If the 'shell' option is "csh" or
6707 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006708 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006709 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6710 means that stderr is also included. Before using the 'shell' option a
6711 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006712 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6713 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 The initialization of this option is done after reading the ".vimrc"
6715 and the other initializations, so that when the 'shell' option is set
6716 there, the 'shellpipe' option changes automatically, unless it was
6717 explicitly set before.
6718 When 'shellpipe' is set to an empty string, no redirection of the
6719 ":make" output will be done. This is useful if you use a 'makeprg'
6720 that writes to 'makeef' by itself. If you want no piping, but do
6721 want to include the 'makeef', set 'shellpipe' to a single space.
6722 Don't forget to precede the space with a backslash: ":set sp=\ ".
6723 In the future pipes may be used for filtering and this option will
6724 become obsolete (at least for Unix).
6725 This option cannot be set from a |modeline| or in the |sandbox|, for
6726 security reasons.
6727
6728 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006729'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006731 Quoting character(s), put around the command passed to the shell, for
6732 the "!" and ":!" commands. The redirection is kept outside of the
6733 quoting. See 'shellxquote' to include the redirection. It's
6734 probably not useful to set both options.
6735 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006736 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006737 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738 This option cannot be set from a |modeline| or in the |sandbox|, for
6739 security reasons.
6740
6741 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006742'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6743 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006745 String to be used to put the output of a filter command in a temporary
6746 file. See also |:!|. See |option-backslash| about including spaces
6747 and backslashes.
6748 The name of the temporary file can be represented by "%s" if necessary
6749 (the file name is appended automatically if no %s appears in the value
6750 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006751 The default is ">". For Unix, if the 'shell' option is "csh" or
6752 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006753 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006754 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6755 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006756 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6757 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006758 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6759 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006760 The initialization of this option is done after reading the ".vimrc"
6761 and the other initializations, so that when the 'shell' option is set
6762 there, the 'shellredir' option changes automatically unless it was
6763 explicitly set before.
6764 In the future pipes may be used for filtering and this option will
6765 become obsolete (at least for Unix).
6766 This option cannot be set from a |modeline| or in the |sandbox|, for
6767 security reasons.
6768
6769 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6770'shellslash' 'ssl' boolean (default off)
6771 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006772 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006774 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006775 powershell.exe. Backward slashes can still be typed, but they are
6776 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777 Note that setting or resetting this option has no effect for some
6778 existing file names, thus this option needs to be set before opening
6779 any file for best results. This might change in the future.
6780 'shellslash' only works when a backslash can be used as a path
6781 separator. To test if this is so use: >
6782 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006783< Also see 'completeslash'.
6784
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006785 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6786'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6787 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006788 When on, use temp files for shell commands. When off use a pipe.
6789 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006790 Currently a pipe is only supported on Unix and MS-Windows 2K and
6791 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006792 :if has("filterpipe")
6793< The advantage of using a pipe is that nobody can read the temp file
6794 and the 'shell' command does not need to support redirection.
6795 The advantage of using a temp file is that the file type and encoding
6796 can be detected.
6797 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6798 |FilterWritePost| autocommands event are not triggered when
6799 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006800 The `system()` function does not respect this option and always uses
6801 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006802 NOTE: This option is set to the Vim default value when 'compatible'
6803 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006804
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 *'shelltype'* *'st'*
6806'shelltype' 'st' number (default 0)
6807 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006808 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 On the Amiga this option influences the way how the commands work
6810 which use a shell.
6811 0 and 1: always use the shell
6812 2 and 3: use the shell only to filter lines
6813 4 and 5: use shell only for ':sh' command
6814 When not using the shell, the command is executed directly.
6815
6816 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6817 1 and 3: use "shell cmd" to start external commands
6818
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006819 *'shellxescape'* *'sxe'*
6820'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006821 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006822 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006823 When 'shellxquote' is set to "(" then the characters listed in this
6824 option will be escaped with a '^' character. This makes it possible
6825 to execute most external commands with cmd.exe.
6826
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827 *'shellxquote'* *'sxq'*
6828'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006829 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006830 for Win32, when 'shell' is
6831 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006832 for Win32, when 'shell' contains "sh"
6833 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834 for Unix, when using system(): "\"")
6835 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 Quoting character(s), put around the command passed to the shell, for
6837 the "!" and ":!" commands. Includes the redirection. See
6838 'shellquote' to exclude the redirection. It's probably not useful
6839 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006840 When the value is '(' then ')' is appended. When the value is '"('
6841 then ')"' is appended.
6842 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006843 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006844 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6845 pwsh.exe which automatically strips off the first and last quote on a
6846 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6847 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006848 'shell', to reduce the need to set this option by the user. See
6849 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006850 This option cannot be set from a |modeline| or in the |sandbox|, for
6851 security reasons.
6852
6853 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6854'shiftround' 'sr' boolean (default off)
6855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856 Round indent to multiple of 'shiftwidth'. Applies to > and <
6857 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6858 a multiple of 'shiftwidth' (this is Vi compatible).
6859 NOTE: This option is reset when 'compatible' is set.
6860
6861 *'shiftwidth'* *'sw'*
6862'shiftwidth' 'sw' number (default 8)
6863 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006864 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006865 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006866 When zero the 'ts' value will be used. Use the |shiftwidth()|
6867 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868
6869 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006870'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6871 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006873 This option helps to avoid all the |hit-enter| prompts caused by file
6874 messages, for example with CTRL-G, and to avoid some other messages.
6875 It is a list of flags:
6876 flag meaning when present ~
6877 f use "(3 of 5)" instead of "(file 3 of 5)"
6878 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006879 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 m use "[+]" instead of "[Modified]"
6881 n use "[New]" instead of "[New File]"
6882 r use "[RO]" instead of "[readonly]"
6883 w use "[w]" instead of "written" for file write message
6884 and "[a]" instead of "appended" for ':w >> file' command
6885 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6886 "[unix format]" and "[mac]" instead of "[mac format]".
6887 a all of the above abbreviations
6888
6889 o overwrite message for writing a file with subsequent message
6890 for reading a file (useful for ":wn" or when 'autowrite' on)
6891 O message for reading a file overwrites any previous message.
6892 Also for quickfix message (e.g., ":cn").
6893 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006894 hit TOP, continuing at BOTTOM" messages; when using the search
6895 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896 t truncate file message at the start if it is too long to fit
6897 on the command-line, "<" will appear in the left most column.
6898 Ignored in Ex mode.
6899 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006900 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901 Ignored in Ex mode.
6902 W don't give "written" or "[w]" when writing a file
6903 A don't give the "ATTENTION" message when an existing swap file
6904 is found.
6905 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006906 c don't give |ins-completion-menu| messages. For example,
6907 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6908 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006909 q use "recording" instead of "recording @a"
6910 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006911 was used for the command; note that this also affects messages
6912 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006913 S do not show search count message when searching, e.g.
6914 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915
6916 This gives you the opportunity to avoid that a change between buffers
6917 requires you to hit <Enter>, but still gives as useful a message as
6918 possible for the space available. To get the whole message that you
6919 would have got with 'shm' empty, use ":file!"
6920 Useful values:
6921 shm= No abbreviation of message.
6922 shm=a Abbreviation, but no loss of information.
6923 shm=at Abbreviation, and truncate message when necessary.
6924
6925 NOTE: This option is set to the Vi default value when 'compatible' is
6926 set and to the Vim default value when 'compatible' is reset.
6927
6928 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6929'shortname' 'sn' boolean (default off)
6930 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 Filenames are assumed to be 8 characters plus one extension of 3
6932 characters. Multiple dots in file names are not allowed. When this
6933 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006934 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006936 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937
6938 *'showbreak'* *'sbr'* *E595*
6939'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006940 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006941 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006942 feature}
6943 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006944 values are "> " or "+++ ": >
6945 :set showbreak=>\
6946< Note the backslash to escape the trailing space. It's easier like
6947 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006948 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006949< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006950 comma (in a future version the comma might be used to separate the
6951 part that is shown at the end and at the start of a line).
6952 The characters are highlighted according to the '@' flag in
6953 'highlight'.
6954 Note that tabs after the showbreak will be displayed differently.
6955 If you want the 'showbreak' to appear in between line numbers, add the
6956 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006957 A window-local value overrules a global value. If the global value is
6958 set and you want no value in the current window use NONE: >
6959 :setlocal showbreak=NONE
6960<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006961 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006962'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6963 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965 {not available when compiled without the
6966 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006967 Show (partial) command in the last line of the screen. Set this
6968 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 In Visual mode the size of the selected area is shown:
6970 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006971 If the number of bytes is different it is also displayed: "2-6"
6972 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006974 - When selecting a block, the size in screen characters:
6975 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006976 NOTE: This option is set to the Vi default value when 'compatible' is
6977 set and to the Vim default value when 'compatible' is reset.
6978
6979 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6980'showfulltag' 'sft' boolean (default off)
6981 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982 When completing a word in insert mode (see |ins-completion|) from the
6983 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006984 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 matched a C function, you can see a template for what arguments are
6986 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006987 Note that this doesn't work well together with having "longest" in
6988 'completeopt', because the completion from the search pattern may not
6989 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006990
6991 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6992'showmatch' 'sm' boolean (default off)
6993 global
6994 When a bracket is inserted, briefly jump to the matching one. The
6995 jump is only done if the match can be seen on the screen. The time to
6996 show the match can be set with 'matchtime'.
6997 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006998 seen or not).
6999 This option is reset when 'paste' is set and restored when 'paste' is
7000 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001 When the 'm' flag is not included in 'cpoptions', typing a character
7002 will immediately move the cursor back to where it belongs.
7003 See the "sm" field in 'guicursor' for setting the cursor shape and
7004 blinking when showing the match.
7005 The 'matchpairs' option can be used to specify the characters to show
7006 matches for. 'rightleft' and 'revins' are used to look for opposite
7007 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007008 Also see the matchparen plugin for highlighting the match when moving
7009 around |pi_paren.txt|.
7010 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011
7012 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7013'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7014 global
7015 If in Insert, Replace or Visual mode put a message on the last line.
7016 Use the 'M' flag in 'highlight' to set the type of highlighting for
7017 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007018 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019 doesn't mean XIM is really active, especially when 'imactivatekey' is
7020 not set.
7021 NOTE: This option is set to the Vi default value when 'compatible' is
7022 set and to the Vim default value when 'compatible' is reset.
7023
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007024 *'showtabline'* *'stal'*
7025'showtabline' 'stal' number (default 1)
7026 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007027 The value of this option specifies when the line with tab page labels
7028 will be displayed:
7029 0: never
7030 1: only if there are at least two tab pages
7031 2: always
7032 This is both for the GUI and non-GUI implementation of the tab pages
7033 line.
7034 See |tab-page| for more information about tab pages.
7035
Bram Moolenaar071d4272004-06-13 20:20:40 +00007036 *'sidescroll'* *'ss'*
7037'sidescroll' 'ss' number (default 0)
7038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007039 The minimal number of columns to scroll horizontally. Used only when
7040 the 'wrap' option is off and the cursor is moved off of the screen.
7041 When it is zero the cursor will be put in the middle of the screen.
7042 When using a slow terminal set it to a large number or 0. When using
7043 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7044 commands.
7045
7046 *'sidescrolloff'* *'siso'*
7047'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007048 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007050 right of the cursor if 'nowrap' is set. Setting this option to a
7051 value greater than 0 while having |'sidescroll'| also at a non-zero
7052 value makes some context visible in the line you are scrolling in
7053 horizontally (except at beginning of the line). Setting this option
7054 to a large value (like 999) has the effect of keeping the cursor
7055 horizontally centered in the window, as long as one does not come too
7056 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007057 After using the local value, go back the global value with one of
7058 these two: >
7059 setlocal sidescrolloff<
7060 setlocal sidescrolloff=-1
7061< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007062
7063 Example: Try this together with 'sidescroll' and 'listchars' as
7064 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007065 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066
7067 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7068 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007069<
7070 *'signcolumn'* *'scl'*
7071'signcolumn' 'scl' string (default "auto")
7072 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007073 {not available when compiled without the |+signs|
7074 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007075 Whether or not to draw the signcolumn. Valid values are:
7076 "auto" only when there is a sign to display
7077 "no" never
7078 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007079 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007080 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081
7082
7083 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7084'smartcase' 'scs' boolean (default off)
7085 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007086 Override the 'ignorecase' option if the search pattern contains upper
7087 case characters. Only used when the search pattern is typed and
7088 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007089 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7091 recalling the search pattern from history and hitting <Enter>.
7092 NOTE: This option is reset when 'compatible' is set.
7093
7094 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7095'smartindent' 'si' boolean (default off)
7096 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097 {not available when compiled without the
7098 |+smartindent| feature}
7099 Do smart autoindenting when starting a new line. Works for C-like
7100 programs, but can also be used for other languages. 'cindent' does
7101 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007102 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007103 setting 'si' has no effect. 'indentexpr' is a more advanced
7104 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 Normally 'autoindent' should also be on when using 'smartindent'.
7106 An indent is automatically inserted:
7107 - After a line ending in '{'.
7108 - After a line starting with a keyword from 'cinwords'.
7109 - Before a line starting with '}' (only with the "O" command).
7110 When typing '}' as the first character in a new line, that line is
7111 given the same indent as the matching '{'.
7112 When typing '#' as the first character in a new line, the indent for
7113 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007114 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7116 When using the ">>" command, lines starting with '#' are not shifted
7117 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007118 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007119 This option is reset when 'paste' is set and restored when 'paste' is
7120 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121
7122 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7123'smarttab' 'sta' boolean (default off)
7124 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007126 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7127 <BS> will delete a 'shiftwidth' worth of space at the start of the
7128 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007129 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007130 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7131 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007132 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007134 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007135 This option is reset when 'paste' is set and restored when 'paste' is
7136 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137 NOTE: This option is reset when 'compatible' is set.
7138
7139 *'softtabstop'* *'sts'*
7140'softtabstop' 'sts' number (default 0)
7141 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142 Number of spaces that a <Tab> counts for while performing editing
7143 operations, like inserting a <Tab> or using <BS>. It "feels" like
7144 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7145 used. This is useful to keep the 'ts' setting at its standard value
7146 of 8, while being able to edit like it is set to 'sts'. However,
7147 commands like "x" still work on the actual characters.
7148 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007149 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007150 'softtabstop' is set to 0 when the 'paste' option is set and restored
7151 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7153 spaces is minimized by using <Tab>s.
7154 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7155 set.
7156 NOTE: This option is set to 0 when 'compatible' is set.
7157
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007158 If Vim is compiled with the |+vartabs| feature then the value of
7159 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7160 anything other than an empty string.
7161
Bram Moolenaar217ad922005-03-20 22:37:15 +00007162 *'spell'* *'nospell'*
7163'spell' boolean (default off)
7164 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007165 {not available when compiled without the |+syntax|
7166 feature}
7167 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007168 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007169
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007170 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007171'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007172 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007173 {not available when compiled without the |+syntax|
7174 feature}
7175 Pattern to locate the end of a sentence. The following word will be
7176 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007177 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007178 When this check is not wanted make this option empty.
7179 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007180 Be careful with special characters, see |option-backslash| about
7181 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007182 To set this option automatically depending on the language, see
7183 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007184
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007185 *'spellfile'* *'spf'*
7186'spellfile' 'spf' string (default empty)
7187 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007188 {not available when compiled without the |+syntax|
7189 feature}
7190 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007191 commands. It must end in ".{encoding}.add". You need to include the
7192 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007193 *E765*
7194 It may also be a comma separated list of names. A count before the
7195 |zg| and |zw| commands can be used to access each. This allows using
7196 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007197 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007198 you: Using the first directory in 'runtimepath' that is writable. If
7199 there is no "spell" directory yet it will be created. For the file
7200 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007201 ignoring the region.
7202 The resulting ".spl" file will be used for spell checking, it does not
7203 have to appear in 'spelllang'.
7204 Normally one file is used for all regions, but you can add the region
7205 name if you want to. However, it will then only be used when
7206 'spellfile' is set to it, for entries in 'spelllang' only files
7207 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007208 This option cannot be set from a |modeline| or in the |sandbox|, for
7209 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007210
Bram Moolenaar217ad922005-03-20 22:37:15 +00007211 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007212'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007213 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007214 {not available when compiled without the |+syntax|
7215 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007216 A comma separated list of word list names. When the 'spell' option is
7217 on spellchecking will be done for these languages. Example: >
7218 set spelllang=en_us,nl,medical
7219< This means US English, Dutch and medical words are recognized. Words
7220 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007221 The word list name must consist of alphanumeric characters, a dash or
7222 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007223 recommended to separate the two letter language name from a
7224 specification. Thus "en-rare" is used for rare English words.
7225 A region name must come last and have the form "_xx", where "xx" is
7226 the two-letter, lower case region name. You can use more than one
7227 region by listing them: "en_us,en_ca" supports both US and Canadian
7228 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007229 Britain. (Note: currently en_au and en_nz dictionaries are older than
7230 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007231 If the name "cjk" is included East Asian characters are excluded from
7232 spell checking. This is useful when editing text that also has Asian
7233 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007234 Note that the "medical" dictionary does not exist, it is just an
7235 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007236 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007237 As a special case the name of a .spl file can be given as-is. The
7238 first "_xx" in the name is removed and used as the region name
7239 (_xx is an underscore, two letters and followed by a non-letter).
7240 This is mainly for testing purposes. You must make sure the correct
7241 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007242 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007243 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7244 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007245 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007246
Bram Moolenaar98692072006-02-04 00:57:42 +00007247 If the |spellfile.vim| plugin is active and you use a language name
7248 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7249 will ask you if you want to download the file.
7250
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007251 After this option has been set successfully, Vim will source the files
7252 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007253 up to the first character that is not an ASCII letter or number and
7254 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007255
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007256 *'spelloptions'* *'spo'*
7257'spelloptions' 'spo' string (default "")
7258 local to buffer
7259 {not available when compiled without the |+syntax|
7260 feature}
7261 A comma separated list of options for spell checking:
7262 camel When a word is CamelCased, assume "Cased" is a
7263 separate word: every upper-case character in a word
7264 that comes after a lower case character indicates the
7265 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007266
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007267 *'spellsuggest'* *'sps'*
7268'spellsuggest' 'sps' string (default "best")
7269 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007270 {not available when compiled without the |+syntax|
7271 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007272 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007273 the |spellsuggest()| function. This is a comma-separated list of
7274 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007275
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007276 best Internal method that works best for English. Finds
7277 changes like "fast" and uses a bit of sound-a-like
7278 scoring to improve the ordering.
7279
7280 double Internal method that uses two methods and mixes the
7281 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007282 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007283 word. That only works when the language specifies
7284 sound folding. Can be slow and doesn't always give
7285 better results.
7286
7287 fast Internal method that only checks for simple changes:
7288 character inserts/deletes/swaps. Works well for
7289 simple typing mistakes.
7290
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007291 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007292 Not used for |spellsuggest()|. The number of
7293 suggestions is never more than the value of 'lines'
7294 minus two.
7295
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007296 file:{filename} Read file {filename}, which must have two columns,
7297 separated by a slash. The first column contains the
7298 bad word, the second column the suggested good word.
7299 Example:
7300 theribal/terrible ~
7301 Use this for common mistakes that do not appear at the
7302 top of the suggestion list with the internal methods.
7303 Lines without a slash are ignored, use this for
7304 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007305 The word in the second column must be correct,
7306 otherwise it will not be used. Add the word to an
7307 ".add" file if it is currently flagged as a spelling
7308 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007309 The file is used for all languages.
7310
7311 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7312 trouble with spaces. |v:val| holds the badly spelled
7313 word. The expression must evaluate to a List of
7314 Lists, each with a suggestion and a score.
7315 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007316 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007317 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007318 internal methods use. A lower score is better.
7319 This may invoke |spellsuggest()| if you temporarily
7320 set 'spellsuggest' to exclude the "expr:" part.
7321 Errors are silently ignored, unless you set the
7322 'verbose' option to a non-zero value.
7323
7324 Only one of "best", "double" or "fast" may be used. The others may
7325 appear several times in any order. Example: >
7326 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7327<
7328 This option cannot be set from a |modeline| or in the |sandbox|, for
7329 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007330
7331
Bram Moolenaar071d4272004-06-13 20:20:40 +00007332 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7333'splitbelow' 'sb' boolean (default off)
7334 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 When on, splitting a window will put the new window below the current
7336 one. |:split|
7337
7338 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7339'splitright' 'spr' boolean (default off)
7340 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007341 When on, splitting a window will put the new window right of the
7342 current one. |:vsplit|
7343
7344 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7345'startofline' 'sol' boolean (default on)
7346 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007347 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007348 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007349 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007350 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 with a linewise operator, with "%" with a count and to buffer changing
7352 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7353 only has a line number, e.g., ":25" or ":+".
7354 In case of buffer changing commands the cursor is placed at the column
7355 where it was the last time the buffer was edited.
7356 NOTE: This option is set when 'compatible' is set.
7357
Bram Moolenaar00654022011-02-25 14:42:19 +01007358 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007360 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361 {not available when compiled without the |+statusline|
7362 feature}
7363 When nonempty, this option determines the content of the status line.
7364 Also see |status-line|.
7365
7366 The option consists of printf style '%' items interspersed with
7367 normal text. Each status line item is of the form:
7368 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007369 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007370 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371
Bram Moolenaar238a5642006-02-21 22:12:05 +00007372 When the option starts with "%!" then it is used as an expression,
7373 evaluated and the result is used as the option value. Example: >
7374 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007375< The *g:statusline_winid* variable will be set to the |window-ID| of the
7376 window that the status line belongs to.
7377 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007378 Note that the "%!" expression is evaluated in the context of the
7379 current window and buffer, while %{} items are evaluated in the
7380 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007381
7382 When there is error while evaluating the option then it will be made
7383 empty to avoid further errors. Otherwise screen updating would loop.
7384
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385 Note that the only effect of 'ruler' when this option is set (and
7386 'laststatus' is 2) is controlling the output of |CTRL-G|.
7387
7388 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007389 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007390 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007391 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007392 minwid Minimum width of the item, padding as set by '-' & '0'.
7393 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007394 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395 on the left for text items. Numeric items will be
7396 shifted down to maxwid-2 digits followed by '>'number
7397 where number is the amount of missing digits, much like
7398 an exponential notation.
7399 item A one letter code as described below.
7400
7401 Following is a description of the possible statusline items. The
7402 second character in "item" is the type:
7403 N for number
7404 S for string
7405 F for flags as described below
7406 - not applicable
7407
7408 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007409 f S Path to the file in the buffer, as typed or relative to current
7410 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007411 F S Full path to the file in the buffer.
7412 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007413 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007415 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007417 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007419 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007420 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007421 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007423 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7425 being used: "<keymap>"
7426 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007427 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428 B N As above, in hexadecimal.
7429 o N Byte number in file of byte under cursor, first byte is 1.
7430 Mnemonic: Offset from start of file (with one added)
7431 {not available when compiled without |+byte_offset| feature}
7432 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007433 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434 l N Line number.
7435 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007436 c N Column number (byte index).
7437 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007438 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 p N Percentage through file in lines as in |CTRL-G|.
7440 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007441 percentage described for 'ruler'. Always 3 in length, unless
7442 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007443 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007444 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007445 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007446 Note that there is no '%' before the closing '}'. The
7447 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007448 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007449 {% - This is almost same as { except the result of the expression is
7450 re-evaluated as a statusline format string. Thus if the
7451 return value of expr contains % items they will get expanded.
7452 The expression can contain the } character, the end of
7453 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007454 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007455 func! Stl_filename() abort
7456 return "%t"
7457 endfunc
7458< `stl=%{Stl_filename()}` results in `"%t"`
7459 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007460 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461 ( - Start of item group. Can be used for setting the width and
7462 alignment of a section. Must be followed by %) somewhere.
7463 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007464 T N For 'tabline': start of tab page N label. Use %T after the last
7465 label. This information is used for mouse clicks.
7466 X N For 'tabline': start of close tab N label. Use %X after the
7467 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7468 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469 < - Where to truncate line if too long. Default is at the start.
7470 No width fields allowed.
7471 = - Separation point between left and right aligned items.
7472 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007473 # - Set highlight group. The name must follow and then a # again.
7474 Thus use %#HLname# for highlight group HLname. The same
7475 highlighting is used, also for the statusline of non-current
7476 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007478 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007479 The difference between User{N} and StatusLine will be applied
7480 to StatusLineNC for the statusline of non-current windows.
7481 The number N must be between 1 and 9. See |hl-User1..9|
7482
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007483 When displaying a flag, Vim removes the leading comma, if any, when
7484 that flag comes right after plaintext. This will make a nice display
7485 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486
Bram Moolenaar582fd852005-03-28 20:58:01 +00007487 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 not set) and a minwid is not set for the group, the whole group will
7489 become empty. This will make a group like the following disappear
7490 completely from the statusline when none of the flags are set. >
7491 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007492< Beware that an expression is evaluated each and every time the status
7493 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007494 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007495 While evaluating %{} the current buffer and current window will be set
7496 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007497 currently being drawn. The expression will evaluate in this context.
7498 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7499 real current buffer and "g:actual_curwin" to the |window-ID| of the
7500 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007501
Bram Moolenaar30b65812012-07-12 22:01:11 +02007502 The 'statusline' option will be evaluated in the |sandbox| if set from
7503 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007504 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007505
7506 It is not allowed to change text or jump to another window while
7507 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508
7509 If the statusline is not updated when you want it (e.g., after setting
7510 a variable that's used in an expression), you can force an update by
7511 setting an option without changing its value. Example: >
7512 :let &ro = &ro
7513
7514< A result of all digits is regarded a number for display purposes.
7515 Otherwise the result is taken as flag text and applied to the rules
7516 described above.
7517
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007518 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007520 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007521
7522 Examples:
7523 Emulate standard status line with 'ruler' set >
7524 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7525< Similar, but add ASCII value of char under the cursor (like "ga") >
7526 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7527< Display byte count and byte value, modified flag in red. >
7528 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7529 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7530< Display a ,GZ flag if a compressed file is loaded >
7531 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7532< In the |:autocmd|'s: >
7533 :let b:gzflag = 1
7534< And: >
7535 :unlet b:gzflag
7536< And define this function: >
7537 :function VarExists(var, val)
7538 : if exists(a:var) | return a:val | else | return '' | endif
7539 :endfunction
7540<
7541 *'suffixes'* *'su'*
7542'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7543 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 Files with these suffixes get a lower priority when multiple files
7545 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007546 suffixes. Spaces after the comma are ignored. A dot is also seen as
7547 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548 separator, precede it with a backslash (see |option-backslash| about
7549 including spaces and backslashes).
7550 See 'wildignore' for completely ignoring files.
7551 The use of |:set+=| and |:set-=| is preferred when adding or removing
7552 suffixes from the list. This avoids problems when a future version
7553 uses another default.
7554
7555 *'suffixesadd'* *'sua'*
7556'suffixesadd' 'sua' string (default "")
7557 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 {not available when compiled without the
7559 |+file_in_path| feature}
7560 Comma separated list of suffixes, which are used when searching for a
7561 file for the "gf", "[I", etc. commands. Example: >
7562 :set suffixesadd=.java
7563<
7564 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7565'swapfile' 'swf' boolean (default on)
7566 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007567 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 swapfile is not wanted for a specific buffer. For example, with
7569 confidential information that even root must not be able to access.
7570 Careful: All text will be in memory:
7571 - Don't use this for big files.
7572 - Recovery will be impossible!
7573 A swapfile will only be present when |'updatecount'| is non-zero and
7574 'swapfile' is set.
7575 When 'swapfile' is reset, the swap file for the current buffer is
7576 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7577 non-zero, a swap file is immediately created.
7578 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007579 If you want to open a new buffer without creating a swap file for it,
7580 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007581 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582
7583 This option is used together with 'bufhidden' and 'buftype' to
7584 specify special kinds of buffers. See |special-buffers|.
7585
7586 *'swapsync'* *'sws'*
7587'swapsync' 'sws' string (default "fsync")
7588 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007590 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 When this option is empty parts of the swap file may be in memory and
7592 not written to disk. When the system crashes you may lose more work.
7593 On Unix the system does a sync now and then without Vim asking for it,
7594 so the disadvantage of setting this option off is small. On some
7595 systems the swap file will not be written at all. For a unix system
7596 setting it to "sync" will use the sync() call instead of the default
7597 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007598 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599
7600 *'switchbuf'* *'swb'*
7601'switchbuf' 'swb' string (default "")
7602 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007604 Mostly for |quickfix| commands some values are also used for other
7605 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007606 Possible values (comma separated list):
7607 useopen If included, jump to the first open window that
7608 contains the specified buffer (if there is one).
7609 Otherwise: Do not examine other windows.
7610 This setting is checked with |quickfix| commands, when
7611 jumping to errors (":cc", ":cn", "cp", etc.). It is
7612 also used in all buffer related split commands, for
7613 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007614 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007615 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007617 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007618 Otherwise: do not split, use current window (when used
7619 in the quickfix window: the previously used window or
7620 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007621 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007622 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007623 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007624 uselast If included, jump to the previously used window when
7625 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007626
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007627 *'synmaxcol'* *'smc'*
7628'synmaxcol' 'smc' number (default 3000)
7629 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007630 {not available when compiled without the |+syntax|
7631 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007632 Maximum column in which to search for syntax items. In long lines the
7633 text after this column is not highlighted and following lines may not
7634 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007635 This helps to avoid very slow redrawing for an XML file that is one
7636 long line.
7637 Set to zero to remove the limit.
7638
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639 *'syntax'* *'syn'*
7640'syntax' 'syn' string (default empty)
7641 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642 {not available when compiled without the |+syntax|
7643 feature}
7644 When this option is set, the syntax with this name is loaded, unless
7645 syntax highlighting has been switched off with ":syntax off".
7646 Otherwise this option does not always reflect the current syntax (the
7647 b:current_syntax variable does).
7648 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007649 not automatically recognized. Example, in an IDL file:
7650 /* vim: set syntax=idl : */ ~
7651 When a dot appears in the value then this separates two filetype
7652 names. Example:
7653 /* vim: set syntax=c.doxygen : */ ~
7654 This will use the "c" syntax first, then the "doxygen" syntax.
7655 Note that the second one must be prepared to be loaded as an addition,
7656 otherwise it will be skipped. More than one dot may appear.
7657 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007658 :set syntax=OFF
7659< To switch syntax highlighting on according to the current value of the
7660 'filetype' option: >
7661 :set syntax=ON
7662< What actually happens when setting the 'syntax' option is that the
7663 Syntax autocommand event is triggered with the value as argument.
7664 This option is not copied to another buffer, independent of the 's' or
7665 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007666 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007667
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007668 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007669'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007670 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007671 When nonempty, this option determines the content of the tab pages
7672 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007673 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007674
7675 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007676 option and only when there is no GUI tab line. When 'e' is in
7677 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007678 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007679
7680 The value is evaluated like with 'statusline'. You can use
7681 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007682 the text to be displayed. Use "%1T" for the first label, "%2T" for
7683 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007684
Bram Moolenaare12bab32019-01-08 22:02:56 +01007685 When changing something that is used in 'tabline' that does not
7686 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007687 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007688
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007689 Keep in mind that only one of the tab pages is the current one, others
7690 are invisible and you can't jump to their windows.
7691
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007692
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007693 *'tabpagemax'* *'tpm'*
7694'tabpagemax' 'tpm' number (default 10)
7695 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007696 Maximum number of tab pages to be opened by the |-p| command line
7697 argument or the ":tab all" command. |tabpage|
7698
7699
7700 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007701'tabstop' 'ts' number (default 8)
7702 local to buffer
7703 Number of spaces that a <Tab> in the file counts for. Also see
7704 |:retab| command, and 'softtabstop' option.
7705
7706 Note: Setting 'tabstop' to any other value than 8 can make your file
7707 appear wrong in many places (e.g., when printing it).
7708
7709 There are four main ways to use tabs in Vim:
7710 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7711 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007712 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007713 behave like a tab appears every 4 (or 3) characters.
7714 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7715 'expandtab'. This way you will always insert spaces. The
7716 formatting will never be messed up when 'tabstop' is changed.
7717 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007718 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719 works when using Vim to edit the file.
7720 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7721 'noexpandtab'. This should then work (for initial indents only)
7722 for any tabstop setting that people use. It might be nice to have
7723 tabs after the first non-blank inserted as spaces if you do this
7724 though. Otherwise aligned comments will be wrong when 'tabstop' is
7725 changed.
7726
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007727 If Vim is compiled with the |+vartabs| feature then the value of
7728 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7729 than an empty string.
7730
Bram Moolenaar071d4272004-06-13 20:20:40 +00007731 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7732'tagbsearch' 'tbs' boolean (default on)
7733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007734 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007735 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007736 searching makes searching for a tag a LOT faster, but a linear search
7737 will find more tags if the tags file wasn't properly sorted.
7738 Vim normally assumes that your tags files are sorted, or indicate that
7739 they are not sorted. Only when this is not the case does the
7740 'tagbsearch' option need to be switched off.
7741
7742 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007743 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007744 certain files, or retry all files with a linear search. When
7745 'tagbsearch' is off, only a linear search is done.
7746
7747 Linear searching is done anyway, for one file, when Vim finds a line
7748 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007749 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007750< [The whitespace before and after the '0' must be a single <Tab>]
7751
7752 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007753 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007754 instead of a normal tag name, a retry is done with a linear search.
7755 Tags in unsorted tags files, and matches with different case will only
7756 be found in the retry.
7757
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007758 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007759 linear search can be avoided when case is ignored. Use a value of '2'
7760 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7761 sorted with the -f switch to "sort" in most unices, as in the command:
7762 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7763 (at least 5.5) the --sort=foldcase switch can be used for this as
7764 well. Note that case must be folded to uppercase for this to work.
7765
7766 By default, tag searches are case-sensitive. Case is ignored when
7767 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7768 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007769 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7770 'tagcase' is "smart", and the pattern contains only lowercase
7771 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007772
7773 When 'tagbsearch' is off, tags searching is slower when a full match
7774 exists, but faster when no full match exists. Tags in unsorted tags
7775 files may only be found with 'tagbsearch' off.
7776 When the tags file is not sorted, or sorted in a wrong way (not on
7777 ASCII byte value), 'tagbsearch' should be off, or the line given above
7778 must be included in the tags file.
7779 This option doesn't affect commands that find all matching tags (e.g.,
7780 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007781
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007782 *'tagcase'* *'tc'*
7783'tagcase' 'tc' string (default "followic")
7784 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007785 This option specifies how case is handled when searching the tags
7786 file:
7787 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007788 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007789 ignore Ignore case
7790 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007791 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007792 NOTE: This option is set to the Vi default value when 'compatible' is
7793 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007794
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007795 *'tagfunc'* *'tfu'*
7796'tagfunc' 'tfu' string (default: empty)
7797 local to buffer
7798 {not available when compiled without the |+eval|
7799 feature}
7800 This option specifies a function to be used to perform tag searches.
7801 The function gets the tag pattern and should return a List of matching
7802 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007803 function and an example. The value can be the name of a function, a
7804 |lambda| or a |Funcref|. See |option-value-function| for more
7805 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007806
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 *'taglength'* *'tl'*
7808'taglength' 'tl' number (default 0)
7809 global
7810 If non-zero, tags are significant up to this number of characters.
7811
7812 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7813'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7814 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007815 If on and using a tags file in another directory, file names in that
7816 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007817 NOTE: This option is set to the Vi default value when 'compatible' is
7818 set and to the Vim default value when 'compatible' is reset.
7819
7820 *'tags'* *'tag'* *E433*
7821'tags' 'tag' string (default "./tags,tags", when compiled with
7822 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7823 global or local to buffer |global-local|
7824 Filenames for the tag command, separated by spaces or commas. To
7825 include a space or comma in a file name, precede it with a backslash
7826 (see |option-backslash| about including spaces and backslashes).
7827 When a file name starts with "./", the '.' is replaced with the path
7828 of the current file. But only when the 'd' flag is not included in
7829 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7830 |tags-option|.
7831 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007832 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7833 find all files named "tags" below "/lib". The filename itself cannot
7834 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7835 files called "tags?". {not available when compiled without the
7836 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007837 The |tagfiles()| function can be used to get a list of the file names
7838 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007839 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7840 files are also supported. They are automatically recognized. The
7841 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7842 differences are ignored (MS-Windows). |emacs-tags|
7843 The use of |:set+=| and |:set-=| is preferred when adding or removing
7844 file names from the list. This avoids problems when a future version
7845 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007846
7847 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7848'tagstack' 'tgst' boolean (default on)
7849 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850 When on, the |tagstack| is used normally. When off, a ":tag" or
7851 ":tselect" command with an argument will not push the tag onto the
7852 tagstack. A following ":tag" without an argument, a ":pop" command or
7853 any other command that uses the tagstack will use the unmodified
7854 tagstack, but does change the pointer to the active entry.
7855 Resetting this option is useful when using a ":tag" command in a
7856 mapping which should not change the tagstack.
7857
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007858 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007859'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007860 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007861 {only available when compiled with the |+tcl/dyn|
7862 feature}
7863 Specifies the name of the Tcl shared library. The default is
7864 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007865 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007866 This option cannot be set from a |modeline| or in the |sandbox|, for
7867 security reasons.
7868
Bram Moolenaar071d4272004-06-13 20:20:40 +00007869 *'term'* *E529* *E530* *E531*
7870'term' string (default is $TERM, if that fails:
7871 in the GUI: "builtin_gui"
7872 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007873 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007874 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875 on Unix: "ansi"
7876 on VMS: "ansi"
7877 on Win 32: "win32")
7878 global
7879 Name of the terminal. Used for choosing the terminal control
7880 characters. Environment variables are expanded |:set_env|.
7881 For example: >
7882 :set term=$TERM
7883< See |termcap|.
7884
7885 *'termbidi'* *'tbidi'*
7886 *'notermbidi'* *'notbidi'*
7887'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 {only available when compiled with the |+arabic|
7890 feature}
7891 The terminal is in charge of Bi-directionality of text (as specified
7892 by Unicode). The terminal is also expected to do the required shaping
7893 that some languages (such as Arabic) require.
7894 Setting this option implies that 'rightleft' will not be set when
7895 'arabic' is set and the value of 'arabicshape' will be ignored.
7896 Note that setting 'termbidi' has the immediate effect that
7897 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7898 This option is reset when the GUI is started.
7899 For further details see |arabic.txt|.
7900
7901 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007902'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007904 Encoding used for the terminal. This specifies what character
7905 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007906 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007907 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007908 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007909 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007910 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7911 Any attempts to set a different value will be rejected, and an error
7912 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007913 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 because the Win32 system always passes Unicode characters.
7915 When empty, the same encoding is used as for the 'encoding' option.
7916 This is the normal value.
7917 Not all combinations for 'termencoding' and 'encoding' are valid. See
7918 |encoding-table|.
7919 The value for this option must be supported by internal conversions or
7920 iconv(). When this is not possible no conversion will be done and you
7921 will probably experience problems with non-ASCII characters.
7922 Example: You are working with the locale set to euc-jp (Japanese) and
7923 want to edit a UTF-8 file: >
7924 :let &termencoding = &encoding
7925 :set encoding=utf-8
7926< You need to do this when your system has no locale support for UTF-8.
7927
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007928 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007929'termguicolors' 'tgc' boolean (default off)
7930 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007931 {not available when compiled without the
7932 |+termguicolors| feature}
7933 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007934 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007935
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007936 Requires a ISO-8613-3 compatible terminal. If setting this option
7937 does not work (produces a colorless UI) reading |xterm-true-color|
7938 might help.
7939
7940 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7941 is required. Use this check to find out: >
7942 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007943< This requires Vim to be built with the |+vtp| feature.
7944
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007945 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007946 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007947
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007948 *'termwinkey'* *'twk'*
7949'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007950 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007951 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007952 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007953 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007954 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007955< The string must be one key stroke but can be multiple bytes.
7956 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007957 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007958 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007959
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007960 *'termwinscroll'* *'twsl'*
7961'termwinscroll' 'twsl' number (default 10000)
7962 local to buffer
7963 {not available when compiled without the
7964 |+terminal| feature}
7965 Number of scrollback lines to keep. When going over this limit the
7966 first 10% of the scrollback lines are deleted. This is just to reduce
7967 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00007968 Also used as a limit for text sent to the terminal in one write,
7969 multiplied by the number of columns times 3 (average number of bytes
7970 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007971
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007972 *'termwinsize'* *'tws'*
7973'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007974 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007975 Size used when opening the |terminal| window. Format:
7976 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007977 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007978 - When set with a "x" (e.g., "24x80") the terminal size is not
7979 adjusted to the window size. If the window is smaller only the
7980 top-left part is displayed.
7981 - When set with a "*" (e.g., "10*50") the terminal size follows the
7982 window size, but will not be smaller than the specified rows and/or
7983 columns.
7984 - When rows is zero then use the height of the window.
7985 - When columns is zero then use the width of the window.
7986 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007987 - Can be overruled in the |term_start()| options with "term_rows" and
7988 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02007989
7990 Examples:
7991 "30x0" uses 30 rows and the current window width.
7992 "20*0" uses at least 20 rows and the current window width.
7993 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007994 Note that the command running in the terminal window may still change
7995 the size of the terminal. In that case the Vim window will be
7996 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007997
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007998 *'termwintype'* *'twt'*
7999'termwintype' 'twt' string (default "")
8000 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008001 {only available when compiled with the |terminal|
8002 feature on MS-Windows}
8003 Specify the virtual console (pty) used when opening the terminal
8004 window.
8005
8006 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008007 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008008 "winpty" use winpty, fail if not supported
8009 "conpty" use |ConPTY|, fail if not supported
8010
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008011 |ConPTY| support depends on the platform. Windows 10 October 2018
8012 Update is the first version that supports ConPTY, however it is still
8013 considered unstable. ConPTY might become stable in the next release
8014 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008015 supported then you cannot open a terminal window.
8016
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017 *'terse'* *'noterse'*
8018'terse' boolean (default off)
8019 global
8020 When set: Add 's' flag to 'shortmess' option (this makes the message
8021 for a search that hits the start or end of the file not being
8022 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8023 shortens a lot of messages}
8024
8025 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8026'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8027 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028 This option is obsolete. Use 'fileformats'.
8029 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8030 set to the default value for the current system. When 'textauto' is
8031 reset, 'fileformats' is made empty.
8032 NOTE: This option is set to the Vi default value when 'compatible' is
8033 set and to the Vim default value when 'compatible' is reset.
8034
8035 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008036'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008037 others: default off)
8038 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 This option is obsolete. Use 'fileformat'.
8040 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8041 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8042 "unix".
8043
8044 *'textwidth'* *'tw'*
8045'textwidth' 'tw' number (default 0)
8046 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047 Maximum width of text that is being inserted. A longer line will be
8048 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008049 this.
8050 'textwidth' is set to 0 when the 'paste' option is set and restored
8051 when 'paste' is reset.
8052 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008053 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008054 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055 NOTE: This option is set to 0 when 'compatible' is set.
8056
8057 *'thesaurus'* *'tsr'*
8058'thesaurus' 'tsr' string (default "")
8059 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008061 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8062 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008063
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008064 This option is not used if 'thesaurusfunc' is set, either for the
8065 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008066
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008067 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008068 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008069 name. See |option-backslash| about using backslashes. The use of
8070 |:set+=| and |:set-=| is preferred when adding or removing directories
8071 from the list. This avoids problems when a future version uses
8072 another default. Backticks cannot be used in this option for security
8073 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008075 *'thesaurusfunc'* *tsrfu'*
8076'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008077 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008078 {not available when compiled without the |+eval|
8079 feature}
8080 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008081 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008082 The value can be the name of a function, a |lambda| or a |Funcref|.
8083 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008084
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008085 This option cannot be set from a |modeline| or in the |sandbox|, for
8086 security reasons.
8087
Bram Moolenaar071d4272004-06-13 20:20:40 +00008088 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8089'tildeop' 'top' boolean (default off)
8090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008091 When on: The tilde command "~" behaves like an operator.
8092 NOTE: This option is reset when 'compatible' is set.
8093
8094 *'timeout'* *'to'* *'notimeout'* *'noto'*
8095'timeout' 'to' boolean (default on)
8096 global
8097 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008098'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008099 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008100 These two options together determine the behavior when part of a
8101 mapped key sequence or keyboard code has been received:
8102
8103 'timeout' 'ttimeout' action ~
8104 off off do not time out
8105 on on or off time out on :mappings and key codes
8106 off on time out on key codes
8107
8108 If both options are off, Vim will wait until either the complete
8109 mapping or key sequence has been received, or it is clear that there
8110 is no mapping or key sequence for the received characters. For
8111 example: if you have mapped "vl" and Vim has received 'v', the next
8112 character is needed to see if the 'v' is followed by an 'l'.
8113 When one of the options is on, Vim will wait for about 1 second for
8114 the next character to arrive. After that the already received
8115 characters are interpreted as single characters. The waiting time can
8116 be changed with the 'timeoutlen' option.
8117 On slow terminals or very busy systems timing out may cause
8118 malfunctioning cursor keys. If both options are off, Vim waits
8119 forever after an entered <Esc> if there are key codes that start
8120 with <Esc>. You will have to type <Esc> twice. If you do not have
8121 problems with key codes, but would like to have :mapped key
8122 sequences not timing out in 1 second, set the 'ttimeout' option and
8123 reset the 'timeout' option.
8124
8125 NOTE: 'ttimeout' is reset when 'compatible' is set.
8126
8127 *'timeoutlen'* *'tm'*
8128'timeoutlen' 'tm' number (default 1000)
8129 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008130
Bram Moolenaar071d4272004-06-13 20:20:40 +00008131 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008132'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008133 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008134 The time in milliseconds that is waited for a key code or mapped key
8135 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8136 when part of a command has been typed.
8137 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8138 different timeout value for key codes is desired set 'ttimeoutlen' to
8139 a non-negative number.
8140
8141 ttimeoutlen mapping delay key code delay ~
8142 < 0 'timeoutlen' 'timeoutlen'
8143 >= 0 'timeoutlen' 'ttimeoutlen'
8144
8145 The timeout only happens when the 'timeout' and 'ttimeout' options
8146 tell so. A useful setting would be >
8147 :set timeout timeoutlen=3000 ttimeoutlen=100
8148< (time out on mapping after three seconds, time out on key codes after
8149 a tenth of a second).
8150
8151 *'title'* *'notitle'*
8152'title' boolean (default off, on when title can be restored)
8153 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008154 When on, the title of the window will be set to the value of
8155 'titlestring' (if it is not empty), or to:
8156 filename [+=-] (path) - VIM
8157 Where:
8158 filename the name of the file being edited
8159 - indicates the file cannot be modified, 'ma' off
8160 + indicates the file was modified
8161 = indicates the file is read-only
8162 =+ indicates the file is read-only and modified
8163 (path) is the path of the file being edited
8164 - VIM the server name |v:servername| or "VIM"
8165 Only works if the terminal supports setting window titles
8166 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008167 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008168 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8169 *X11*
8170 When Vim was compiled with HAVE_X11 defined, the original title will
8171 be restored if possible. The output of ":version" will include "+X11"
8172 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8173 works for the icon name |'icon'|.
8174 But: When Vim was started with the |-X| argument, restoring the title
8175 will not work (except in the GUI).
8176 If the title cannot be restored, it is set to the value of 'titleold'.
8177 You might want to restore the title outside of Vim then.
8178 When using an xterm from a remote machine you can use this command:
8179 rsh machine_name xterm -display $DISPLAY &
8180 then the WINDOWID environment variable should be inherited and the
8181 title of the window should change back to what it should be after
8182 exiting Vim.
8183
8184 *'titlelen'*
8185'titlelen' number (default 85)
8186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008187 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008188 title. When the title is longer, only the end of the path name is
8189 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008190 Using a percentage makes this adapt to the width of the window. But
8191 it won't work perfectly, because the actual number of characters
8192 available also depends on the font used and other things in the title
8193 bar. When 'titlelen' is zero the full path is used. Otherwise,
8194 values from 1 to 30000 percent can be used.
8195 'titlelen' is also used for the 'titlestring' option.
8196
8197 *'titleold'*
8198'titleold' string (default "Thanks for flying Vim")
8199 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008200 This option will be used for the window title when exiting Vim if the
8201 original title cannot be restored. Only happens if 'title' is on or
8202 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008203 This option cannot be set from a |modeline| or in the |sandbox|, for
8204 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008205 *'titlestring'*
8206'titlestring' string (default "")
8207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008208 When this option is not empty, it will be used for the title of the
8209 window. This happens only when the 'title' option is on.
8210 Only works if the terminal supports setting window titles (currently
8211 Amiga console, Win32 console, all GUI versions and terminals with a
8212 non-empty 't_ts' option).
8213 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008214 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008215
Bram Moolenaar071d4272004-06-13 20:20:40 +00008216 When this option contains printf-style '%' items, they will be
8217 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008218 This option cannot be set in a modeline when 'modelineexpr' is off.
8219
Bram Moolenaar071d4272004-06-13 20:20:40 +00008220 Example: >
8221 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8222 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8223< The value of 'titlelen' is used to align items in the middle or right
8224 of the available space.
8225 Some people prefer to have the file name first: >
8226 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8227< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008228 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008229 separating space only when needed.
8230 NOTE: Use of special characters in 'titlestring' may cause the display
8231 to be garbled (e.g., when it contains a CR or NL character).
8232 {not available when compiled without the |+statusline| feature}
8233
8234 *'toolbar'* *'tb'*
8235'toolbar' 'tb' string (default "icons,tooltips")
8236 global
8237 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8238 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008239 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008240 possible values are:
8241 icons Toolbar buttons are shown with icons.
8242 text Toolbar buttons shown with text.
8243 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008244 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008245 tooltips Tooltips are active for toolbar buttons.
8246 Tooltips refer to the popup help text which appears after the mouse
8247 cursor is placed over a toolbar button for a brief moment.
8248
8249 If you want the toolbar to be shown with icons as well as text, do the
8250 following: >
8251 :set tb=icons,text
8252< Motif and Athena cannot display icons and text at the same time. They
8253 will show icons if both are requested.
8254
8255 If none of the strings specified in 'toolbar' are valid or if
8256 'toolbar' is empty, this option is ignored. If you want to disable
8257 the toolbar, you need to set the 'guioptions' option. For example: >
8258 :set guioptions-=T
8259< Also see |gui-toolbar|.
8260
8261 *'toolbariconsize'* *'tbis'*
8262'toolbariconsize' 'tbis' string (default "small")
8263 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008264 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008265 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008266 tiny Use tiny icons.
8267 small Use small icons (default).
8268 medium Use medium-sized icons.
8269 large Use large icons.
8270 huge Use even larger icons.
8271 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008272 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008273 the current theme. Common dimensions are giant=48x48, huge=32x32,
8274 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008275
8276 If 'toolbariconsize' is empty, the global default size as determined
8277 by user preferences or the current theme is used.
8278
8279 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8280'ttybuiltin' 'tbi' boolean (default on)
8281 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008282 When on, the builtin termcaps are searched before the external ones.
8283 When off the builtin termcaps are searched after the external ones.
8284 When this option is changed, you should set the 'term' option next for
8285 the change to take effect, for example: >
8286 :set notbi term=$TERM
8287< See also |termcap|.
8288 Rationale: The default for this option is "on", because the builtin
8289 termcap entries are generally better (many systems contain faulty
8290 xterm entries...).
8291
8292 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8293'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8294 sun-cmd, screen, rxvt, dtterm or
8295 iris-ansi; also on when running Vim in
8296 a DOS console)
8297 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008298 Indicates a fast terminal connection. More characters will be sent to
8299 the screen for redrawing, instead of using insert/delete line
8300 commands. Improves smoothness of redrawing when there are multiple
8301 windows and the terminal does not support a scrolling region.
8302 Also enables the extra writing of characters at the end of each screen
8303 line for lines that wrap. This helps when using copy/paste with the
8304 mouse in an xterm and other terminals.
8305
8306 *'ttymouse'* *'ttym'*
8307'ttymouse' 'ttym' string (default depends on 'term')
8308 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008309 {only in Unix and VMS, doesn't work in the GUI; not
8310 available when compiled without |+mouse|}
8311 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008312 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008313 *xterm-mouse*
8314 xterm xterm-like mouse handling. The mouse generates
8315 "<Esc>[Mscr", where "scr" is three bytes:
8316 "s" = button state
8317 "c" = column plus 33
8318 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008319 This only works up to 223 columns! See "dec",
8320 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008321 xterm2 Works like "xterm", but with the xterm reporting the
8322 mouse position while the mouse is dragged. This works
8323 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008324 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008325 work. See below for how Vim detects this
8326 automatically.
8327 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008328 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008329 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008330 for the row and column. No other mouse events are
8331 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008332 *dec-mouse*
8333 dec DEC terminal mouse handling. The mouse generates a
8334 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008335 This is also available for an Xterm, if it was
8336 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008337 *jsbterm-mouse*
8338 jsbterm JSB term mouse handling.
8339 *pterm-mouse*
8340 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008341 *urxvt-mouse*
8342 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008343 The mouse works only if the terminal supports this
8344 encoding style, but it does not have 223 columns limit
8345 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008346 *sgr-mouse*
8347 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008348 mouse reporting. The mouse works even in columns
8349 beyond 223. This option is backward compatible with
8350 "xterm2" because it can also decode "xterm2" style
8351 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008352
8353 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008354 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8355 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008356 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8357 recognized, if enabled at compile time. DEC terminal mouse codes
8358 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008359 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8360 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008361 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008362 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8363 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8364 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008365 Additionally, if vim is compiled with the |+termresponse| feature and
8366 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008367 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008369 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8370 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8371 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008372 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8373 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008374 :set t_RV=
8375<
8376 *'ttyscroll'* *'tsl'*
8377'ttyscroll' 'tsl' number (default 999)
8378 global
8379 Maximum number of lines to scroll the screen. If there are more lines
8380 to scroll the window is redrawn. For terminals where scrolling is
8381 very slow and redrawing is not slow this can be set to a small number,
8382 e.g., 3, to speed up displaying.
8383
8384 *'ttytype'* *'tty'*
8385'ttytype' 'tty' string (default from $TERM)
8386 global
8387 Alias for 'term', see above.
8388
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008389 *'undodir'* *'udir'*
8390'undodir' 'udir' string (default ".")
8391 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008392 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008393 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008394 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008395 "." means using the directory of the file. The undo file name for
8396 "file.txt" is ".file.txt.un~".
8397 For other directories the file name is the full path of the edited
8398 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008399 When writing: The first directory that exists is used. "." always
8400 works, no directories after "." will be used for writing.
8401 When reading all entries are tried to find an undo file. The first
8402 undo file that exists is used. When it cannot be read an error is
8403 given, no further entry is used.
8404 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008405 This option cannot be set from a |modeline| or in the |sandbox|, for
8406 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008407
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008408 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008409'undofile' 'udf' boolean (default off)
8410 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008411 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008412 When on, Vim automatically saves undo history to an undo file when
8413 writing a buffer to a file, and restores undo history from the same
8414 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008415 The directory where the undo file is stored is specified by 'undodir'.
8416 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008417 The undo file is not read when 'undoreload' causes the buffer from
8418 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008419 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008420 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008421
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008423'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008424 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008425 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008426 is kept in memory, higher numbers will cause more memory to be used.
8427 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8429 itself: >
8430 set ul=0
8431< But you can also get Vi compatibility by including the 'u' flag in
8432 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008433 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008434 Set to -1 for no undo at all. You might want to do this only for the
8435 current buffer: >
8436 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008437< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008438
8439 The local value is set to -123456 when the global value is to be used.
8440
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008441 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008443 *'undoreload'* *'ur'*
8444'undoreload' 'ur' number (default 10000)
8445 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008446 Save the whole buffer for undo when reloading it. This applies to the
8447 ":e!" command and reloading for when the buffer changed outside of
8448 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008449 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008450 of lines is smaller than the value of this option.
8451 Set this option to zero to disable undo for a reload.
8452
8453 When saving undo for a reload, any undo file is not read.
8454
8455 Note that this causes the whole buffer to be stored in memory. Set
8456 this option to a lower value if you run out of memory.
8457
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 *'updatecount'* *'uc'*
8459'updatecount' 'uc' number (default: 200)
8460 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008461 After typing this many characters the swap file will be written to
8462 disk. When zero, no swap file will be created at all (see chapter on
8463 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8464 Vim with the "-n" option, see |startup|. When editing in readonly
8465 mode this option will be initialized to 10000.
8466 The swapfile can be disabled per buffer with |'swapfile'|.
8467 When 'updatecount' is set from zero to non-zero, swap files are
8468 created for all buffers that have 'swapfile' set. When 'updatecount'
8469 is set to zero, existing swap files are not deleted.
8470 Also see |'swapsync'|.
8471 This option has no meaning in buffers where |'buftype'| is "nofile"
8472 or "nowrite".
8473
8474 *'updatetime'* *'ut'*
8475'updatetime' 'ut' number (default 4000)
8476 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008477 If this many milliseconds nothing is typed the swap file will be
8478 written to disk (see |crash-recovery|). Also used for the
8479 |CursorHold| autocommand event.
8480
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008481 *'varsofttabstop'* *'vsts'*
8482'varsofttabstop' 'vsts' string (default "")
8483 local to buffer
8484 {only available when compiled with the |+vartabs|
8485 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008486 A list of the number of spaces that a <Tab> counts for while editing,
8487 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8488 width <Tab>s are being inserted, while in fact a mixture of spaces
8489 and <Tab>s is used. Tab widths are separated with commas, with the
8490 final value applying to all subsequent tabs.
8491
8492 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008493 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008494 to use the following: >
8495 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008496< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8497 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008498
8499 Note that the value of |'softtabstop'| will be ignored while
8500 'varsofttabstop' is set.
8501
8502 *'vartabstop'* *'vts'*
8503'vartabstop' 'vts' string (default "")
8504 local to buffer
8505 {only available when compiled with the |+vartabs|
8506 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008507 A list of the number of spaces that a <Tab> in the file counts for,
8508 separated by commas. Each value corresponds to one tab, with the
8509 final value applying to all subsequent tabs. For example: >
8510 :set vartabstop=4,20,10,8
8511< This will make the first tab 4 spaces wide, the second 20 spaces,
8512 the third 10 spaces, and all following tabs 8 spaces.
8513
8514 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8515 is set.
8516
Bram Moolenaar071d4272004-06-13 20:20:40 +00008517 *'verbose'* *'vbs'*
8518'verbose' 'vbs' number (default 0)
8519 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008520 When bigger than zero, Vim will give messages about what it is doing.
8521 Currently, these messages are given:
8522 >= 1 When the viminfo file is read or written.
8523 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008524 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008525 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008526 >= 8 Files for which a group of autocommands is executed.
8527 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008528 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529 >= 12 Every executed function.
8530 >= 13 When an exception is thrown, caught, finished, or discarded.
8531 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008532 >= 15 Every executed Ex command from a script (truncated at 200
8533 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008534 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008535
8536 This option can also be set with the "-V" argument. See |-V|.
8537 This option is also set by the |:verbose| command.
8538
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008539 When the 'verbosefile' option is set then the verbose messages are not
8540 displayed.
8541
8542 *'verbosefile'* *'vfile'*
8543'verbosefile' 'vfile' string (default empty)
8544 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008545 When not empty all messages are written in a file with this name.
8546 When the file exists messages are appended.
8547 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008548 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008549 Setting 'verbosefile' to a new value is like making it empty first.
8550 The difference with |:redir| is that verbose messages are not
8551 displayed when 'verbosefile' is set.
8552
Bram Moolenaar071d4272004-06-13 20:20:40 +00008553 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008554'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008555 "$VIM/vimfiles/view",
8556 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008557 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008558 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008560 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008561 feature}
8562 Name of the directory where to store files for |:mkview|.
8563 This option cannot be set from a |modeline| or in the |sandbox|, for
8564 security reasons.
8565
8566 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008567'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008568 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008569 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008570 feature}
8571 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008572 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008573 word save and restore ~
8574 cursor cursor position in file and in window
8575 folds manually created folds, opened/closed folds and local
8576 fold options
8577 options options and mappings local to a window or buffer (not
8578 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008579 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008580 slash backslashes in file names replaced with forward
8581 slashes
8582 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008583 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008584 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008585
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008586 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008587 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008588 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589
8590 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008591'viminfo' 'vi' string (Vi default: "", Vim default for
8592 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008593 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8594 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008595 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008596 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008597 feature}
8598 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008599 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8600 "NONE".
8601 The string should be a comma separated list of parameters, each
8602 consisting of a single character identifying the particular parameter,
8603 followed by a number or string which specifies the value of that
8604 parameter. If a particular character is left out, then the default
8605 value is used for that parameter. The following is a list of the
8606 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008607 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008608 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008609 ! When included, save and restore global variables that start
8610 with an uppercase letter, and don't contain a lowercase
8611 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008612 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008613 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008614 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008615 " Maximum number of lines saved for each register. Old name of
8616 the '<' item, with the disadvantage that you need to put a
8617 backslash before the ", otherwise it will be recognized as the
8618 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008619 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008620 % When included, save and restore the buffer list. If Vim is
8621 started with a file name argument, the buffer list is not
8622 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008623 buffer list is restored from the viminfo file. Quickfix
8624 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8625 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008626 When followed by a number, the number specifies the maximum
8627 number of buffers that are stored. Without a number all
8628 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008629 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008630 ' Maximum number of previously edited files for which the marks
8631 are remembered. This parameter must always be included when
8632 'viminfo' is non-empty.
8633 Including this item also means that the |jumplist| and the
8634 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008635 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008636 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008637 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008638 patterns are also saved. When not included, the value of
8639 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008640 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008641 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008642 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008643 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008644 < Maximum number of lines saved for each register. If zero then
8645 registers are not saved. When not included, all lines are
8646 saved. '"' is the old name for this item.
8647 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008648 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008649 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008650 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008651 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008652 c When included, convert the text in the viminfo file from the
8653 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008654 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008655 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 f Whether file marks need to be stored. If zero, file marks ('0
8657 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008658 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008659 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008660 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661 h Disable the effect of 'hlsearch' when loading the viminfo
8662 file. When not included, it depends on whether ":nohlsearch"
8663 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008664 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008665 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008666 the 'n'. Must be at the end of the option! If the
8667 'viminfofile' option is set, that file name overrides the one
8668 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008669 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008670 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008671 r Removable media. The argument is a string (up to the next
8672 ','). This parameter can be given several times. Each
8673 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008674 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008675 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8676 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8677 ignored. Maximum length of each 'r' argument is 50
8678 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008679 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008680 s Maximum size of an item in Kbyte. If zero then registers are
8681 not saved. Currently only applies to registers. The default
8682 "s10" will exclude registers with more than 10 Kbyte of text.
8683 Also see the '<' item above: line count limit.
8684
8685 Example: >
8686 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8687<
8688 '50 Marks will be remembered for the last 50 files you
8689 edited.
8690 <1000 Contents of registers (up to 1000 lines each) will be
8691 remembered.
8692 s100 Registers with more than 100 Kbyte text are skipped.
8693 :0 Command-line history will not be saved.
8694 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8695 no / Since '/' is not specified, the default will be used,
8696 that is, save all of the search history, and also the
8697 previous search and substitute patterns.
8698 no % The buffer list will not be saved nor read back.
8699 no h 'hlsearch' highlighting will be restored.
8700
8701 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8702 load the contents of the file, this is not done automatically.
8703
8704 This option cannot be set from a |modeline| or in the |sandbox|, for
8705 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008706 NOTE: This option is set to the Vim default value when 'compatible'
8707 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008708
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008709 *'viminfofile'* *'vif'*
8710'viminfofile' 'vif' string (default: "")
8711 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008712 {not available when compiled without the |+viminfo|
8713 feature}
8714 When non-empty, overrides the file name used for viminfo.
8715 When equal to "NONE" no viminfo file will be read or written.
8716 This option can be set with the |-i| command line flag. The |--clean|
8717 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008718 This option cannot be set from a |modeline| or in the |sandbox|, for
8719 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008720
Bram Moolenaar071d4272004-06-13 20:20:40 +00008721 *'virtualedit'* *'ve'*
8722'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008723 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008724 A comma separated list of these words:
8725 block Allow virtual editing in Visual block mode.
8726 insert Allow virtual editing in Insert mode.
8727 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008728 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008729 none When used as the local value, do not allow virtual
8730 editing even when the global value is set. When used
8731 as the global value, "none" is the same as "".
8732 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008733
Bram Moolenaar071d4272004-06-13 20:20:40 +00008734 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008735 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736 of the line. Useful for selecting a rectangle in Visual mode and
8737 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008738 "onemore" is not the same, it will only allow moving the cursor just
8739 after the last character of the line. This makes some commands more
8740 consistent. Previously the cursor was always past the end of the line
8741 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008742 break some plugins or Vim scripts. For example because |l| can move
8743 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008744 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008745 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008746 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008747 It doesn't make sense to combine "all" with "onemore", but you will
8748 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008749 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008750 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751
8752 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8753'visualbell' 'vb' boolean (default off)
8754 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008755 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008756 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008757 use: >
8758 :set vb t_vb=
8759< If you want a short flash, you can use this on many terminals: >
8760 :set vb t_vb=[?5h$<100>[?5l
8761< Here $<100> specifies the time, you can use a smaller or bigger value
8762 to get a shorter or longer flash.
8763
8764 Note: Vim will limit the bell to once per half a second. This avoids
8765 having to wait for the flashing to finish when there are lots of
8766 bells, e.g. on key repeat. This also happens without 'visualbell'
8767 set.
8768
Bram Moolenaar071d4272004-06-13 20:20:40 +00008769 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8770 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8771 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008772
8773 Note: When the GUI starts, 't_vb' is reset to its default value. You
8774 might want to set it again in your |gvimrc|.
8775
Bram Moolenaar071d4272004-06-13 20:20:40 +00008776 Does not work on the Amiga, you always get a screen flash.
8777 Also see 'errorbells'.
8778
8779 *'warn'* *'nowarn'*
8780'warn' boolean (default on)
8781 global
8782 Give a warning message when a shell command is used while the buffer
8783 has been changed.
8784
8785 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8786'weirdinvert' 'wiv' boolean (default off)
8787 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008788 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008789 It is provided for backwards compatibility with version 4.x.
8790 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8791 vice versa. Has no effect when the GUI is running.
8792
8793 *'whichwrap'* *'ww'*
8794'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8795 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008796 Allow specified keys that move the cursor left/right to move to the
8797 previous/next line when the cursor is on the first/last character in
8798 the line. Concatenate characters to allow this for these keys:
8799 char key mode ~
8800 b <BS> Normal and Visual
8801 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008802 h "h" Normal and Visual (not recommended)
8803 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008804 < <Left> Normal and Visual
8805 > <Right> Normal and Visual
8806 ~ "~" Normal
8807 [ <Left> Insert and Replace
8808 ] <Right> Insert and Replace
8809 For example: >
8810 :set ww=<,>,[,]
8811< allows wrap only when cursor keys are used.
8812 When the movement keys are used in combination with a delete or change
8813 operator, the <EOL> also counts for a character. This makes "3h"
8814 different from "3dh" when the cursor crosses the end of a line. This
8815 is also true for "x" and "X", because they do the same as "dl" and
8816 "dh". If you use this, you may also want to use the mapping
8817 ":map <BS> X" to make backspace delete the character in front of the
8818 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008819 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008820 line (not an empty line) then it will not move to the next line. This
8821 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008822 NOTE: This option is set to the Vi default value when 'compatible' is
8823 set and to the Vim default value when 'compatible' is reset.
8824
8825 *'wildchar'* *'wc'*
8826'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8827 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008828 Character you have to type to start wildcard expansion in the
8829 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008830 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008831 The character is not recognized when used inside a macro. See
8832 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008833 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008834 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008835 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008836< NOTE: This option is set to the Vi default value when 'compatible' is
8837 set and to the Vim default value when 'compatible' is reset.
8838
8839 *'wildcharm'* *'wcm'*
8840'wildcharm' 'wcm' number (default: none (0))
8841 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008842 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008843 recognized when used inside a macro. You can find "spare" command-line
8844 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008845 you'll never actually type 'wildcharm', just use it in mappings that
8846 automatically invoke completion mode, e.g.: >
8847 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008848 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008849< Then after typing :ss you can use CTRL-P & CTRL-N.
8850
8851 *'wildignore'* *'wig'*
8852'wildignore' 'wig' string (default "")
8853 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 {not available when compiled without the |+wildignore|
8855 feature}
8856 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008857 patterns is ignored when expanding |wildcards|, completing file or
8858 directory names, and influences the result of |expand()|, |glob()| and
8859 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008860 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8861 Also see 'suffixes'.
8862 Example: >
8863 :set wildignore=*.o,*.obj
8864< The use of |:set+=| and |:set-=| is preferred when adding or removing
8865 a pattern from the list. This avoids problems when a future version
8866 uses another default.
8867
Bram Moolenaar94950a92010-12-02 16:01:29 +01008868
Bram Moolenaar81af9252010-12-10 20:35:50 +01008869 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008870'wildignorecase' 'wic' boolean (default off)
8871 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008872 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008873 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008874 Does not apply when the shell is used to expand wildcards, which
8875 happens when there are special characters.
8876
8877
Bram Moolenaar071d4272004-06-13 20:20:40 +00008878 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008879'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008880 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008881 {not available if compiled without the |+wildmenu|
8882 feature}
8883 When 'wildmenu' is on, command-line completion operates in an enhanced
8884 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8885 the possible matches are shown just above the command line, with the
8886 first match highlighted (overwriting the status line, if there is
8887 one). Keys that show the previous/next match, such as <Tab> or
8888 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8889 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8890 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008891 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008892 If there are more matches than can fit in the line, a ">" is shown on
8893 the right and/or a "<" is shown on the left. The status line scrolls
8894 as needed.
8895 The "wildmenu" mode is abandoned when a key is hit that is not used
8896 for selecting a completion.
8897 While the "wildmenu" is active the following keys have special
8898 meanings:
8899
8900 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8901 <Down> - in filename/menu name completion: move into a
8902 subdirectory or submenu.
8903 <CR> - in menu completion, when the cursor is just after a
8904 dot: move into a submenu.
8905 <Up> - in filename/menu name completion: move up into
8906 parent directory or parent menu.
8907
8908 This makes the menus accessible from the console |console-menus|.
8909
8910 If you prefer the <Left> and <Right> keys to move the cursor instead
8911 of selecting a different match, use this: >
8912 :cnoremap <Left> <Space><BS><Left>
8913 :cnoremap <Right> <Space><BS><Right>
8914<
8915 The "WildMenu" highlighting is used for displaying the current match
8916 |hl-WildMenu|.
8917
8918 *'wildmode'* *'wim'*
8919'wildmode' 'wim' string (Vim default: "full")
8920 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008922 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008923 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008924 first part specifies the behavior for the first use of 'wildchar',
8925 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008926
8927 Each part consists of a colon separated list consisting of the
8928 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008929 "" Complete only the first match.
8930 "full" Complete the next full match. After the last match,
8931 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008932 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008933 "longest" Complete till longest common string. If this doesn't
8934 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008935 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008936 "lastused" When completing buffer names and more than one buffer
8937 matches, sort buffers by time last used (other than
8938 the current buffer).
8939 When there is only a single match, it is fully completed in all cases.
8940
8941 Examples of useful colon-separated values:
8942 "longest:full" Like "longest", but also start 'wildmenu' if it is
8943 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008944 "list:full" When more than one match, list all matches and
8945 complete first match.
8946 "list:longest" When more than one match, list all matches and
8947 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008948 "list:lastused" When more than one buffer matches, list all matches
8949 and sort buffers by time last used (other than the
8950 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008951
8952 Examples: >
8953 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008954< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008955 :set wildmode=longest,full
8956< Complete longest common string, then each full match >
8957 :set wildmode=list:full
8958< List all matches and complete each full match >
8959 :set wildmode=list,full
8960< List all matches without completing, then each full match >
8961 :set wildmode=longest,list
8962< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008963 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008964
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008965 *'wildoptions'* *'wop'*
8966'wildoptions' 'wop' string (default "")
8967 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008968 {not available when compiled without the |+wildignore|
8969 feature}
8970 A list of words that change how command line completion is done.
8971 Currently only one word is allowed:
8972 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008973 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008974 is displayed per line. Often used tag kinds are:
8975 d #define
8976 f function
8977 Also see |cmdline-completion|.
8978
Bram Moolenaar071d4272004-06-13 20:20:40 +00008979 *'winaltkeys'* *'wak'*
8980'winaltkeys' 'wak' string (default "menu")
8981 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008982 {only used in Win32, Motif, GTK and Photon GUI}
8983 Some GUI versions allow the access to menu entries by using the ALT
8984 key in combination with a character that appears underlined in the
8985 menu. This conflicts with the use of the ALT key for mappings and
8986 entering special characters. This option tells what to do:
8987 no Don't use ALT keys for menus. ALT key combinations can be
8988 mapped, but there is no automatic handling. This can then be
8989 done with the |:simalt| command.
8990 yes ALT key handling is done by the windowing system. ALT key
8991 combinations cannot be mapped.
8992 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008993 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008994 keys can be mapped.
8995 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8996 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008997 This option is not used for <F10>; on Win32 and with GTK <F10> will
8998 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008999
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009000 *'wincolor'* *'wcr'*
9001'wincolor' 'wcr' string (default empty)
9002 local to window
9003 Highlight group name to use for this window instead of the Normal
9004 color |hl-Normal|.
9005
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009006 *'window'* *'wi'*
9007'window' 'wi' number (default screen height - 1)
9008 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009009 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9010 window and the value is smaller than 'lines' minus one. The screen
9011 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009012 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9013 in a much smarter way, taking care of wrapping lines.
9014 When resizing the Vim window, the value is smaller than 1 or more than
9015 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009016 Note: Do not confuse this with the height of the Vim window, use
9017 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009018
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019 *'winheight'* *'wh'* *E591*
9020'winheight' 'wh' number (default 1)
9021 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009022 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009023 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009024 focus goes to a window that is smaller, its size is increased, at the
9025 cost of the height of other windows.
9026 Set 'winheight' to a small number for normal editing.
9027 Set it to 999 to make the current window fill most of the screen.
9028 Other windows will be only 'winminheight' high. This has the drawback
9029 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9030 to create only two windows, set the option after startup is done,
9031 using the |VimEnter| event: >
9032 au VimEnter * set winheight=999
9033< Minimum value is 1.
9034 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009035 height of the current window.
9036 'winheight' applies to the current window. Use 'winminheight' to set
9037 the minimal height for other windows.
9038
9039 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9040'winfixheight' 'wfh' boolean (default off)
9041 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009042 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009043 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9044 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009045 The height may be changed anyway when running out of room.
9046
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009047 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9048'winfixwidth' 'wfw' boolean (default off)
9049 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009050 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009051 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009052 The width may be changed anyway when running out of room.
9053
Bram Moolenaar071d4272004-06-13 20:20:40 +00009054 *'winminheight'* *'wmh'*
9055'winminheight' 'wmh' number (default 1)
9056 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009057 The minimal height of a window, when it's not the current window.
9058 This is a hard minimum, windows will never become smaller.
9059 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9060 status bar) if necessary. They will return to at least one line when
9061 they become active (since the cursor has to have somewhere to go.)
9062 Use 'winheight' to set the minimal height of the current window.
9063 This option is only checked when making a window smaller. Don't use a
9064 large number, it will cause errors when opening more than a few
9065 windows. A value of 0 to 3 is reasonable.
9066
9067 *'winminwidth'* *'wmw'*
9068'winminwidth' 'wmw' number (default 1)
9069 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009070 The minimal width of a window, when it's not the current window.
9071 This is a hard minimum, windows will never become smaller.
9072 When set to zero, windows may be "squashed" to zero columns (i.e. just
9073 a vertical separator) if necessary. They will return to at least one
9074 line when they become active (since the cursor has to have somewhere
9075 to go.)
9076 Use 'winwidth' to set the minimal width of the current window.
9077 This option is only checked when making a window smaller. Don't use a
9078 large number, it will cause errors when opening more than a few
9079 windows. A value of 0 to 12 is reasonable.
9080
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009081 *'winptydll'*
9082'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9083 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009084 {only available when compiled with the |terminal|
9085 feature on MS-Windows}
9086 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009087 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009088 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009089 a fallback.
9090 Environment variables are expanded |:set_env|.
9091 This option cannot be set from a |modeline| or in the |sandbox|, for
9092 security reasons.
9093
Bram Moolenaar071d4272004-06-13 20:20:40 +00009094 *'winwidth'* *'wiw'* *E592*
9095'winwidth' 'wiw' number (default 20)
9096 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009097 Minimal number of columns for the current window. This is not a hard
9098 minimum, Vim will use fewer columns if there is not enough room. If
9099 the current window is smaller, its size is increased, at the cost of
9100 the width of other windows. Set it to 999 to make the current window
9101 always fill the screen. Set it to a small number for normal editing.
9102 The width is not adjusted after one of the commands to change the
9103 width of the current window.
9104 'winwidth' applies to the current window. Use 'winminwidth' to set
9105 the minimal width for other windows.
9106
9107 *'wrap'* *'nowrap'*
9108'wrap' boolean (default on)
9109 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009110 This option changes how text is displayed. It doesn't change the text
9111 in the buffer, see 'textwidth' for that.
9112 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009113 displaying continues on the next line. When off lines will not wrap
9114 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009115 moved to a part that is not shown, the screen will scroll
9116 horizontally.
9117 The line will be broken in the middle of a word if necessary. See
9118 'linebreak' to get the break at a word boundary.
9119 To make scrolling horizontally a bit more useful, try this: >
9120 :set sidescroll=5
9121 :set listchars+=precedes:<,extends:>
9122< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009123 This option can't be set from a |modeline| when the 'diff' option is
9124 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009125
9126 *'wrapmargin'* *'wm'*
9127'wrapmargin' 'wm' number (default 0)
9128 local to buffer
9129 Number of characters from the right window border where wrapping
9130 starts. When typing text beyond this limit, an <EOL> will be inserted
9131 and inserting continues on the next line.
9132 Options that add a margin, such as 'number' and 'foldcolumn', cause
9133 the text width to be further reduced. This is Vi compatible.
9134 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009135 This option is set to 0 when 'paste' is set and restored when 'paste'
9136 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009137 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009138
9139 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9140'wrapscan' 'ws' boolean (default on) *E384* *E385*
9141 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009142 Searches wrap around the end of the file. Also applies to |]s| and
9143 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009144
9145 *'write'* *'nowrite'*
9146'write' boolean (default on)
9147 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009148 Allows writing files. When not set, writing a file is not allowed.
9149 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009150 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009151 argument. Filtering text is still possible, even though this requires
9152 writing a temporary file.
9153
9154 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9155'writeany' 'wa' boolean (default off)
9156 global
9157 Allows writing to any file with no need for "!" override.
9158
9159 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9160'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9161 otherwise)
9162 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009163 Make a backup before overwriting a file. The backup is removed after
9164 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009165 also on.
9166 WARNING: Switching this option off means that when Vim fails to write
9167 your buffer correctly and then, for whatever reason, Vim exits, you
9168 lose both the original file and what you were writing. Only reset
9169 this option if your file system is almost full and it makes the write
9170 fail (and make sure not to exit Vim until the write was successful).
9171 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009172 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009173 Depending on 'backupcopy' the backup is a new file or the original
9174 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009175 NOTE: This option is set to the default value when 'compatible' is
9176 set.
9177
9178 *'writedelay'* *'wd'*
9179'writedelay' 'wd' number (default 0)
9180 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009181 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009182 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009183 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009184
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009185 vim:tw=78:ts=8:noet:ft=help:norl: