blob: 73c92122f97ca1ebd39daf4da6ae3c9190a665af [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
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004245 activate or deactivate the Input Method. The value can be the name of
4246 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4247 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004248 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004249 The expression will be evaluated in the |sandbox| when set from a
4250 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004251
4252 Example: >
4253 function ImActivateFunc(active)
4254 if a:active
4255 ... do something
4256 else
4257 ... do something
4258 endif
4259 " return value is not used
4260 endfunction
4261 set imactivatefunc=ImActivateFunc
4262<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 *'imactivatekey'* *'imak'*
4264'imactivatekey' 'imak' string (default "")
4265 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004267 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268 Specifies the key that your Input Method in X-Windows uses for
4269 activation. When this is specified correctly, vim can fully control
4270 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4271 You can't use this option to change the activation key, the option
4272 tells Vim what the key is.
4273 Format:
4274 [MODIFIER_FLAG-]KEY_STRING
4275
4276 These characters can be used for MODIFIER_FLAG (case is ignored):
4277 S Shift key
4278 L Lock key
4279 C Control key
4280 1 Mod1 key
4281 2 Mod2 key
4282 3 Mod3 key
4283 4 Mod4 key
4284 5 Mod5 key
4285 Combinations are allowed, for example "S-C-space" or "SC-space" are
4286 both shift+ctrl+space.
4287 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4288
4289 Example: >
4290 :set imactivatekey=S-space
4291< "S-space" means shift+space. This is the activation key for kinput2 +
4292 canna (Japanese), and ami (Korean).
4293
4294 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4295'imcmdline' 'imc' boolean (default off)
4296 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297 When set the Input Method is always on when starting to edit a command
4298 line, unless entering a search pattern (see 'imsearch' for that).
4299 Setting this option is useful when your input method allows entering
4300 English characters directly, e.g., when it's used to type accented
4301 characters with dead keys.
4302
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004303 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004304'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4305 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306 When set the Input Method is never used. This is useful to disable
4307 the IM when it doesn't work properly.
4308 Currently this option is on by default for SGI/IRIX machines. This
4309 may change in later releases.
4310
4311 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004312'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 Specifies whether :lmap or an Input Method (IM) is to be used in
4315 Insert mode. Valid values:
4316 0 :lmap is off and IM is off
4317 1 :lmap is ON and IM is off
4318 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319 To always reset the option to zero when leaving Insert mode with <Esc>
4320 this can be used: >
4321 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4322< This makes :lmap and IM turn off automatically when leaving Insert
4323 mode.
4324 Note that this option changes when using CTRL-^ in Insert mode
4325 |i_CTRL-^|.
4326 The value is set to 1 when setting 'keymap' to a valid keymap name.
4327 It is also used for the argument of commands like "r" and "f".
4328 The value 0 may not work correctly with Athena and Motif with some XIM
4329 methods. Use 'imdisable' to disable XIM then.
4330
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004331 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004332 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004333 |+multi_byte_ime| or |global-ime|.
4334
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004336'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 Specifies whether :lmap or an Input Method (IM) is to be used when
4339 entering a search pattern. Valid values:
4340 -1 the value of 'iminsert' is used, makes it look like
4341 'iminsert' is also used when typing a search pattern
4342 0 :lmap is off and IM is off
4343 1 :lmap is ON and IM is off
4344 2 :lmap is off and IM is ON
4345 Note that this option changes when using CTRL-^ in Command-line mode
4346 |c_CTRL-^|.
4347 The value is set to 1 when it is not -1 and setting the 'keymap'
4348 option to a valid keymap name.
4349 The value 0 may not work correctly with Athena and Motif with some XIM
4350 methods. Use 'imdisable' to disable XIM then.
4351
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004352 *'imstatusfunc'* *'imsf'*
4353'imstatusfunc' 'imsf' string (default "")
4354 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004355 This option specifies a function that is called to obtain the status
4356 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004357 The value can be the name of a function, a |lambda| or a |Funcref|.
4358 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004359 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004360
4361 Example: >
4362 function ImStatusFunc()
4363 let is_active = ...do something
4364 return is_active ? 1 : 0
4365 endfunction
4366 set imstatusfunc=ImStatusFunc
4367<
4368 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004369 The expression will be evaluated in the |sandbox| when set from a
4370 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004371
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004372 *'imstyle'* *'imst'*
4373'imstyle' 'imst' number (default 1)
4374 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004375 {only available when compiled with |+xim| and
4376 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004377 This option specifies the input style of Input Method:
4378 0 use on-the-spot style
4379 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004380 See: |xim-input-style|
4381
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004382 For a long time on-the-spot style had been used in the GTK version of
4383 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004384 |single-repeat|, etc. Therefore over-the-spot style becomes the
4385 default now. This should work fine for most people, however if you
4386 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004387 The expression will be evaluated in the |sandbox| when set from a
4388 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004389
Bram Moolenaar071d4272004-06-13 20:20:40 +00004390 *'include'* *'inc'*
4391'include' 'inc' string (default "^\s*#\s*include")
4392 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 {not available when compiled without the
4394 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004395 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 pattern, just like for the "/" command (See |pattern|). The default
4397 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004398 "]I", "[d", etc.
4399 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004400 comes after the matched pattern. But if "\zs" appears in the pattern
4401 then the text matched from "\zs" to the end, or until "\ze" if it
4402 appears, is used as the file name. Use this to include characters
4403 that are not in 'isfname', such as a space. You can then use
4404 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004405 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406
4407 *'includeexpr'* *'inex'*
4408'includeexpr' 'inex' string (default "")
4409 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004411 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004413 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004414 :set includeexpr=substitute(v:fname,'\\.','/','g')
4415< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004416
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004418 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419 Also used for |<cfile>|.
4420
Bram Moolenaar30b65812012-07-12 22:01:11 +02004421 The expression will be evaluated in the |sandbox| when set from a
4422 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004423 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004424
4425 It is not allowed to change text or jump to another window while
4426 evaluating 'includeexpr' |textlock|.
4427
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004429'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4430 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004433 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004434 While typing a search command, show where the pattern, as it was typed
4435 so far, matches. The matched string is highlighted. If the pattern
4436 is invalid or not found, nothing is shown. The screen will be updated
4437 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004438 Also applies to the pattern in commands: >
4439 :global
4440 :lvimgrep
4441 :lvimgrepadd
4442 :smagic
4443 :snomagic
4444 :sort
4445 :substitute
4446 :vglobal
4447 :vimgrep
4448 :vimgrepadd
4449< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004450 original position when no match is found and when pressing <Esc>. You
4451 still need to finish the search command with <Enter> to move the
4452 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004453 You can use the CTRL-G and CTRL-T keys to move to the next and
4454 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004455 When compiled with the |+reltime| feature Vim only searches for about
4456 half a second. With a complicated pattern and/or a lot of text the
4457 match may not be found. This is to avoid that Vim hangs while you
4458 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004459 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004460 When 'hlsearch' is on, all matched strings are highlighted too while
4461 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004462 If you don't want to turn 'hlsearch' on, but want to highlight all
4463 matches while searching, you can turn on and off 'hlsearch' with
4464 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004465 augroup vimrc-incsearch-highlight
4466 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004467 autocmd CmdlineEnter /,\? :set hlsearch
4468 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004469 augroup END
4470<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004471 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004472 to the command line. If 'ignorecase' and 'smartcase' are set and the
4473 command line has no uppercase characters, the added character is
4474 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004475 CTRL-R CTRL-W can be used to add the word at the end of the current
4476 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 NOTE: This option is reset when 'compatible' is set.
4478
4479 *'indentexpr'* *'inde'*
4480'indentexpr' 'inde' string (default "")
4481 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482 {not available when compiled without the |+cindent|
4483 or |+eval| features}
4484 Expression which is evaluated to obtain the proper indent for a line.
4485 It is used when a new line is created, for the |=| operator and
4486 in Insert mode as specified with the 'indentkeys' option.
4487 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004488 'smartindent' indenting. When 'lisp' is set, this option is
4489 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 When 'paste' is set this option is not used for indenting.
4491 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004492 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004493 when the expression is evaluated (but it may be moved around).
4494 The expression must return the number of spaces worth of indent. It
4495 can return "-1" to keep the current indent (this means 'autoindent' is
4496 used for the indent).
4497 Functions useful for computing the indent are |indent()|, |cindent()|
4498 and |lispindent()|.
4499 The evaluation of the expression must not have side effects! It must
4500 not change the text, jump to another window, etc. Afterwards the
4501 cursor position is always restored, thus the cursor may be moved.
4502 Normally this option would be set to call a function: >
4503 :set indentexpr=GetMyIndent()
4504< Error messages will be suppressed, unless the 'debug' option contains
4505 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004506 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004507 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508
Bram Moolenaar30b65812012-07-12 22:01:11 +02004509 The expression will be evaluated in the |sandbox| when set from a
4510 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004511 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004512
4513 It is not allowed to change text or jump to another window while
4514 evaluating 'indentexpr' |textlock|.
4515
4516
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004518'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 {not available when compiled without the |+cindent|
4521 feature}
4522 A list of keys that, when typed in Insert mode, cause reindenting of
4523 the current line. Only happens if 'indentexpr' isn't empty.
4524 The format is identical to 'cinkeys', see |indentkeys-format|.
4525 See |C-indenting| and |indent-expression|.
4526
4527 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4528'infercase' 'inf' boolean (default off)
4529 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004531 'ignorecase' is also on, the case of the match is adjusted depending
4532 on the typed text. If the typed text contains a lowercase letter
4533 where the match has an upper case letter, the completed part is made
4534 lowercase. If the typed text has no lowercase letters and the match
4535 has a lowercase letter where the typed text has an uppercase letter,
4536 and there is a letter before it, the completed part is made uppercase.
4537 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538
4539 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4540'insertmode' 'im' boolean (default off)
4541 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 Makes Vim work in a way that Insert mode is the default mode. Useful
4543 if you want to use Vim as a modeless editor. Used for |evim|.
4544 These Insert mode commands will be useful:
4545 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004546 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 this is a mapping, it is executed as if 'insertmode' was off.
4548 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004550 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4551 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552
4553 These items change when 'insertmode' is set:
4554 - when starting to edit of a file, Vim goes to Insert mode.
4555 - <Esc> in Insert mode is a no-op and beeps.
4556 - <Esc> in Normal mode makes Vim go to Insert mode.
4557 - CTRL-L in Insert mode is a command, it is not inserted.
4558 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4559 However, when <Esc> is used inside a mapping, it behaves like
4560 'insertmode' was not set. This was done to be able to use the same
4561 mappings with 'insertmode' set or not set.
4562 When executing commands with |:normal| 'insertmode' is not used.
4563
4564 NOTE: This option is reset when 'compatible' is set.
4565
4566 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004567'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4569 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4570 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4571 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4572 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4573 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574 The characters specified by this option are included in file names and
4575 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004576 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577 Multi-byte characters 256 and above are always included, only the
4578 characters up to 255 are specified with this option.
4579 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004580 Think twice before adding white space to this option. Although a
4581 space may appear inside a file name, the effect will be that Vim
4582 doesn't know where a file name starts or ends when doing completion.
4583 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584
4585 Note that on systems using a backslash as path separator, Vim tries to
4586 do its best to make it work as you would expect. That is a bit
4587 tricky, since Vi originally used the backslash to escape special
4588 characters. Vim will not remove a backslash in front of a normal file
4589 name character on these systems, but it will on Unix and alikes. The
4590 '&' and '^' are not included by default, because these are special for
4591 cmd.exe.
4592
4593 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004594 Each part can be a single character number or a range. A range is two
4595 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596 decimal number between 0 and 255 or the ASCII character itself (does
4597 not work for digits). Example:
4598 "_,-,128-140,#-43" (include '_' and '-' and the range
4599 128 to 140 and '#' to 43)
4600 If a part starts with '^', the following character number or range
4601 will be excluded from the option. The option is interpreted from left
4602 to right. Put the excluded character after the range where it is
4603 included. To include '^' itself use it as the last character of the
4604 option or the end of a range. Example:
4605 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4606 If the character is '@', all characters where isalpha() returns TRUE
4607 are included. Normally these are the characters a to z and A to Z,
4608 plus accented characters. To include '@' itself use "@-@". Examples:
4609 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004610 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 "a-z,A-Z,@-@" All letters plus the '@' character.
4612 A comma can be included by using it where a character number is
4613 expected. Example:
4614 "48-57,,,_" Digits, comma and underscore.
4615 A comma can be excluded by prepending a '^'. Example:
4616 " -~,^,,9" All characters from space to '~', excluding
4617 comma, plus <Tab>.
4618 See |option-backslash| about including spaces and backslashes.
4619
4620 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004621'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 "@,48-57,_,128-167,224-235"
4623 otherwise: "@,48-57,_,192-255")
4624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 The characters given by this option are included in identifiers.
4626 Identifiers are used in recognizing environment variables and after a
4627 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004628 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004629 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004631 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4633
4634 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004635'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 "@,48-57,_,128-167,224-235"
4637 otherwise: "@,48-57,_,192-255"
4638 Vi default: "@,48-57,_")
4639 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004641 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004642 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004643 characters above 255 check the "word" character class (any character
4644 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004645 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646 For a help file it is set to all non-blank printable characters except
4647 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4648 command).
4649 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004650 This option also influences syntax highlighting, unless the syntax
4651 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 NOTE: This option is set to the Vi default value when 'compatible' is
4653 set and to the Vim default value when 'compatible' is reset.
4654
4655 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004656'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657 "@,~-255"; otherwise: "@,161-255")
4658 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659 The characters given by this option are displayed directly on the
4660 screen. It is also used for "\p" in a |pattern|. The characters from
4661 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4662 even when they are not included in 'isprint' or excluded. See
4663 'isfname' for a description of the format of this option.
4664
4665 Non-printable characters are displayed with two characters:
4666 0 - 31 "^@" - "^_"
4667 32 - 126 always single characters
4668 127 "^?"
4669 128 - 159 "~@" - "~_"
4670 160 - 254 "| " - "|~"
4671 255 "~?"
4672 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4673 displayed as <xx>, with the hexadecimal value of the byte.
4674 When 'display' contains "uhex" all unprintable characters are
4675 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004676 The SpecialKey highlighting will be used for unprintable characters.
4677 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678
4679 Multi-byte characters 256 and above are always included, only the
4680 characters up to 255 are specified with this option. When a character
4681 is printable but it is not available in the current font, a
4682 replacement character will be shown.
4683 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4684 There is no option to specify these characters.
4685
4686 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4687'joinspaces' 'js' boolean (default on)
4688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 Insert two spaces after a '.', '?' and '!' with a join command.
4690 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4691 Otherwise only one space is inserted.
4692 NOTE: This option is set when 'compatible' is set.
4693
4694 *'key'*
4695'key' string (default "")
4696 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004697 {only available when compiled with the |+cryptv|
4698 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004699 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004700 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 Careful: Do not set the key value by hand, someone might see the typed
4702 key. Use the |:X| command. But you can make 'key' empty: >
4703 :set key=
4704< It is not possible to get the value of this option with ":set key" or
4705 "echo &key". This is to avoid showing it to someone who shouldn't
4706 know. It also means you cannot see it yourself once you have set it,
4707 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004708 You can use "&key" in an expression to detect whether encryption is
4709 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710
4711 *'keymap'* *'kmp'* *E544*
4712'keymap' 'kmp' string (default "")
4713 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714 {only available when compiled with the |+keymap|
4715 feature}
4716 Name of a keyboard mapping. See |mbyte-keymap|.
4717 Setting this option to a valid keymap name has the side effect of
4718 setting 'iminsert' to one, so that the keymap becomes effective.
4719 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004720 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721
4722 *'keymodel'* *'km'*
4723'keymodel' 'km' string (default "")
4724 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 List of comma separated words, which enable special things that keys
4726 can do. These values can be used:
4727 startsel Using a shifted special key starts selection (either
4728 Select mode or Visual mode, depending on "key" being
4729 present in 'selectmode').
4730 stopsel Using a not-shifted special key stops selection.
4731 Special keys in this context are the cursor keys, <End>, <Home>,
4732 <PageUp> and <PageDown>.
4733 The 'keymodel' option is set by the |:behave| command.
4734
4735 *'keywordprg'* *'kp'*
4736'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004737 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739 Program to use for the |K| command. Environment variables are
4740 expanded |:set_env|. ":help" may be used to access the Vim internal
4741 help. (Note that previously setting the global option to the empty
4742 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004743 When the first character is ":", the command is invoked as a Vim
4744 Ex command prefixed with [count].
4745 When "man", "man -s" or an Ex command is used, Vim will automatically
4746 translate a count for the "K" command and pass it as the first
4747 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 See |option-backslash| about including spaces and backslashes.
4749 Example: >
4750 :set keywordprg=man\ -s
4751< This option cannot be set from a |modeline| or in the |sandbox|, for
4752 security reasons.
4753
4754 *'langmap'* *'lmap'* *E357* *E358*
4755'langmap' 'lmap' string (default "")
4756 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757 {only available when compiled with the |+langmap|
4758 feature}
4759 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004760 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004761 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762 care of translating these special characters to the original meaning
4763 of the key. This means you don't have to change the keyboard mode to
4764 be able to execute Normal mode commands.
4765 This is the opposite of the 'keymap' option, where characters are
4766 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004767 Also consider setting 'langremap' to off, to prevent 'langmap' from
4768 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004769 This option cannot be set from a |modeline| or in the |sandbox|, for
4770 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004772 Example (for Greek, in UTF-8): *greek* >
4773 :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 +00004774< Example (exchanges meaning of z and y for commands): >
4775 :set langmap=zy,yz,ZY,YZ
4776<
4777 The 'langmap' option is a list of parts, separated with commas. Each
4778 part can be in one of two forms:
4779 1. A list of pairs. Each pair is a "from" character immediately
4780 followed by the "to" character. Examples: "aA", "aAbBcC".
4781 2. A list of "from" characters, a semi-colon and a list of "to"
4782 characters. Example: "abc;ABC"
4783 Example: "aA,fgh;FGH,cCdDeE"
4784 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004785 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786
4787 This will allow you to activate vim actions without having to switch
4788 back and forth between the languages. Your language characters will
4789 be understood as normal vim English characters (according to the
4790 langmap mappings) in the following cases:
4791 o Normal/Visual mode (commands, buffer/register names, user mappings)
4792 o Insert/Replace Mode: Register names after CTRL-R
4793 o Insert/Replace Mode: Mappings
4794 Characters entered in Command-line mode will NOT be affected by
4795 this option. Note that this option can be changed at any time
4796 allowing to switch between mappings for different languages/encodings.
4797 Use a mapping to avoid having to type it each time!
4798
4799 *'langmenu'* *'lm'*
4800'langmenu' 'lm' string (default "")
4801 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 {only available when compiled with the |+menu| and
4803 |+multi_lang| features}
4804 Language to use for menu translation. Tells which file is loaded
4805 from the "lang" directory in 'runtimepath': >
4806 "lang/menu_" . &langmenu . ".vim"
4807< (without the spaces). For example, to always use the Dutch menus, no
4808 matter what $LANG is set to: >
4809 :set langmenu=nl_NL.ISO_8859-1
4810< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004811 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 If your $LANG is set to a non-English language but you do want to use
4813 the English menus: >
4814 :set langmenu=none
4815< This option must be set before loading menus, switching on filetype
4816 detection or syntax highlighting. Once the menus are defined setting
4817 this option has no effect. But you could do this: >
4818 :source $VIMRUNTIME/delmenu.vim
4819 :set langmenu=de_DE.ISO_8859-1
4820 :source $VIMRUNTIME/menu.vim
4821< Warning: This deletes all menus that you defined yourself!
4822
Bram Moolenaard94464e2015-11-02 15:28:18 +01004823 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004824'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004825 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004826 {only available when compiled with the |+langmap|
4827 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004828 This is just like 'langremap' but with the value inverted. It only
4829 exists for backwards compatibility. When setting 'langremap' then
4830 'langnoremap' is set to the inverted value, and the other way around.
4831
4832 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004833'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004834 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004835 {only available when compiled with the |+langmap|
4836 feature}
4837 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004838 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004839 'langmap' disables some of your mappings, try resetting this option.
4840 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004841 that works for you to avoid mappings to break.
4842
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843 *'laststatus'* *'ls'*
4844'laststatus' 'ls' number (default 1)
4845 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 The value of this option influences when the last window will have a
4847 status line:
4848 0: never
4849 1: only if there are at least two windows
4850 2: always
4851 The screen looks nicer with a status line if you have several
4852 windows, but it takes another screen line. |status-line|
4853
4854 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4855'lazyredraw' 'lz' boolean (default off)
4856 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857 When this option is set, the screen will not be redrawn while
4858 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004859 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 update use |:redraw|.
4861
4862 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4863'linebreak' 'lbr' boolean (default off)
4864 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004865 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004867 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868 than at the last character that fits on the screen. Unlike
4869 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004870 it only affects the way the file is displayed, not its contents.
4871 If 'breakindent' is set, line is visually indented. Then, the value
4872 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004873 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 Note that <Tab> characters after an <EOL> are mostly not displayed
4875 with the right amount of white space.
4876
4877 *'lines'* *E593*
4878'lines' number (default 24 or terminal height)
4879 global
4880 Number of lines of the Vim window.
4881 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004882 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004883 When Vim is running in the GUI or in a resizable window, setting this
4884 option will cause the window size to be changed. When you only want
4885 to use the size for the GUI, put the command in your |gvimrc| file.
4886 Vim limits the number of lines to what fits on the screen. You can
4887 use this command to get the tallest window possible: >
4888 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004889< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004890 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 When you set this option and Vim is unable to change the physical
4892 number of lines of the display, the display may be messed up.
4893
4894 *'linespace'* *'lsp'*
4895'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4896 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 {only in the GUI}
4898 Number of pixel lines inserted between characters. Useful if the font
4899 uses the full character cell height, making lines touch each other.
4900 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004901 With some fonts there can be too much room between lines (to have
4902 space for ascents and descents). Then it makes sense to set
4903 'linespace' to a negative value. This may cause display problems
4904 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905
4906 *'lisp'* *'nolisp'*
4907'lisp' boolean (default off)
4908 local to buffer
4909 {not available when compiled without the |+lispindent|
4910 feature}
4911 Lisp mode: When <Enter> is typed in insert mode set the indent for
4912 the next line to Lisp standards (well, sort of). Also happens with
4913 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4914 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4915 better. Also see 'lispwords'.
4916 The '-' character is included in keyword characters. Redefines the
4917 "=" operator to use this same indentation algorithm rather than
4918 calling an external program if 'equalprg' is empty.
4919 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920
4921 *'lispwords'* *'lw'*
4922'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004923 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004924 {not available when compiled without the |+lispindent|
4925 feature}
4926 Comma separated list of words that influence the Lisp indenting.
4927 |'lisp'|
4928
4929 *'list'* *'nolist'*
4930'list' boolean (default off)
4931 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00004932 List mode: By default show tabs as CTRL-I is displayed, display $
4933 after end of line. Useful to see the difference between tabs and
4934 spaces and for trailing blanks. Further changed by the 'listchars'
4935 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004936
4937 The cursor is displayed at the start of the space a Tab character
4938 occupies, not at the end as usual in Normal mode. To get this cursor
4939 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004940 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004941<
4942 Note that list mode will also affect formatting (set with 'textwidth'
4943 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 changing the way tabs are displayed.
4945
4946 *'listchars'* *'lcs'*
4947'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004948 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004949 Strings to use in 'list' mode and for the |:list| command. It is a
4950 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004951 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004952 eol:c Character to show at the end of each line. When
4953 omitted, there is no extra character at the end of the
4954 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004955 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004956 tab:xy[z] Two or three characters to be used to show a tab.
4957 The third character is optional.
4958
4959 tab:xy The 'x' is always used, then 'y' as many times as will
4960 fit. Thus "tab:>-" displays:
4961 >
4962 >-
4963 >--
4964 etc.
4965
4966 tab:xyz The 'z' is always used, then 'x' is prepended, and
4967 then 'y' is used as many times as will fit. Thus
4968 "tab:<->" displays:
4969 >
4970 <>
4971 <->
4972 <-->
4973 etc.
4974
4975 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004976 *lcs-space*
4977 space:c Character to show for a space. When omitted, spaces
4978 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02004979 *lcs-multispace*
4980 multispace:c...
4981 One or more characters to use cyclically to show for
4982 multiple consecutive spaces. Overrides the "space"
4983 setting, except for single spaces. When omitted, the
4984 "space" setting is used. For example,
4985 `:set listchars=multispace:---+` shows ten consecutive
4986 spaces as:
4987 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01004988 *lcs-lead*
4989 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02004990 leading spaces are blank. Overrides the "space" and
4991 "multispace" settings for leading spaces. You can
4992 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01004993 :set listchars+=tab:>-,lead:.
4994< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004995 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02004996 trailing spaces are blank. Overrides the "space" and
4997 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02004998 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999 extends:c Character to show in the last column, when 'wrap' is
5000 off and the line continues beyond the right of the
5001 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005002 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005003 precedes:c Character to show in the first visible column of the
5004 physical line, when there is text preceding the
5005 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005006 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005007 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005008 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005009 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005010 nbsp:c Character to show for a non-breakable space character
5011 (0xA0 (160 decimal) and U+202F). Left blank when
5012 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005014 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005016 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005017
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005018 Each character can be specified as hex: >
5019 set listchars=eol:\\x24
5020 set listchars=eol:\\u21b5
5021 set listchars=eol:\\U000021b5
5022< Note that a double backslash is used. The number of hex characters
5023 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5024
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025 Examples: >
5026 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005027 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005028 :set lcs=extends:>,precedes:<
5029< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005030 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5031 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005032 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033
5034 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5035'loadplugins' 'lpl' boolean (default on)
5036 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005037 When on the plugin scripts are loaded when starting up |load-plugins|.
5038 This option can be reset in your |vimrc| file to disable the loading
5039 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005040 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5041 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042
Bram Moolenaard94464e2015-11-02 15:28:18 +01005043 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005044'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005045 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005046 {only available when compiled with the |+lua/dyn|
5047 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005048 Specifies the name of the Lua shared library. The default is
5049 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005050 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005051 This option cannot be set from a |modeline| or in the |sandbox|, for
5052 security reasons.
5053
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005054 *'macatsui'* *'nomacatsui'*
5055'macatsui' boolean (default on)
5056 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005057 {not supported}
5058 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005059
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 *'magic'* *'nomagic'*
5061'magic' boolean (default on)
5062 global
5063 Changes the special characters that can be used in search patterns.
5064 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005065 WARNING: Switching this option off most likely breaks plugins! That
5066 is because many patterns assume it's on and will fail when it's off.
5067 Only switch it off when working with old Vi scripts. In any other
5068 situation write patterns that work when 'magic' is on. Include "\M"
5069 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005070 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5071 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072
5073 *'makeef'* *'mef'*
5074'makeef' 'mef' string (default: "")
5075 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076 {not available when compiled without the |+quickfix|
5077 feature}
5078 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5079 and the |:grep| command.
5080 When it is empty, an internally generated temp file will be used.
5081 When "##" is included, it is replaced by a number to make the name
5082 unique. This makes sure that the ":make" command doesn't overwrite an
5083 existing file.
5084 NOT used for the ":cf" command. See 'errorfile' for that.
5085 Environment variables are expanded |:set_env|.
5086 See |option-backslash| about including spaces and backslashes.
5087 This option cannot be set from a |modeline| or in the |sandbox|, for
5088 security reasons.
5089
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005090 *'makeencoding'* *'menc'*
5091'makeencoding' 'menc' string (default "")
5092 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005093 Encoding used for reading the output of external commands. When empty,
5094 encoding is not converted.
5095 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5096 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5097 and `:laddfile`.
5098
5099 This would be mostly useful when you use MS-Windows and set 'encoding'
5100 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5101 'makeencoding' to "char" has the same effect as setting to the system
5102 locale encoding. Example: >
5103 :set encoding=utf-8
5104 :set makeencoding=char " system locale is used
5105<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 *'makeprg'* *'mp'*
5107'makeprg' 'mp' string (default "make", VMS: "MMS")
5108 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005109 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005110 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5111 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005112 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005113 Environment variables are expanded |:set_env|. See |option-backslash|
5114 about including spaces and backslashes.
5115 Note that a '|' must be escaped twice: once for ":set" and once for
5116 the interpretation of a command. When you use a filter called
5117 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005118 :set makeprg=gmake\ \\\|\ myfilter
5119< The placeholder "$*" can be given (even multiple times) to specify
5120 where the arguments will be included, for example: >
5121 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5122< This option cannot be set from a |modeline| or in the |sandbox|, for
5123 security reasons.
5124
5125 *'matchpairs'* *'mps'*
5126'matchpairs' 'mps' string (default "(:),{:},[:]")
5127 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005128 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005129 other.
5130 Only character pairs are allowed that are different, thus you cannot
5131 jump between two double quotes.
5132 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005133 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005134 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005135 :set mps+=<:>
5136
5137< A more exotic example, to jump between the '=' and ';' in an
5138 assignment, useful for languages like C and Java: >
5139 :au FileType c,cpp,java set mps+==:;
5140
5141< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005142 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143
5144 *'matchtime'* *'mat'*
5145'matchtime' 'mat' number (default 5)
5146 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147 Tenths of a second to show the matching paren, when 'showmatch' is
5148 set. Note that this is not in milliseconds, like other options that
5149 set a time. This is to be compatible with Nvi.
5150
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005151 *'maxcombine'* *'mco'*
5152'maxcombine' 'mco' number (default 2)
5153 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005154 The maximum number of combining characters supported for displaying.
5155 Only used when 'encoding' is "utf-8".
5156 The default is OK for most languages. Hebrew may require 4.
5157 Maximum value is 6.
5158 Even when this option is set to 2 you can still edit text with more
5159 combining characters, you just can't see them. Use |g8| or |ga|.
5160 See |mbyte-combining|.
5161
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 *'maxfuncdepth'* *'mfd'*
5163'maxfuncdepth' 'mfd' number (default 100)
5164 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005165 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005166 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 Maximum depth of function calls for user functions. This normally
5168 catches endless recursion. When using a recursive function with
5169 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5170 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005171 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005172 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173 See also |:function|.
5174
5175 *'maxmapdepth'* *'mmd'* *E223*
5176'maxmapdepth' 'mmd' number (default 1000)
5177 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178 Maximum number of times a mapping is done without resulting in a
5179 character to be used. This normally catches endless mappings, like
5180 ":map x y" with ":map y x". It still does not catch ":map g wg",
5181 because the 'w' is used before the next mapping is done. See also
5182 |key-mapping|.
5183
5184 *'maxmem'* *'mm'*
5185'maxmem' 'mm' number (default between 256 to 5120 (system
5186 dependent) or half the amount of memory
5187 available)
5188 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5190 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005191 other memory to be freed.
5192 The maximum usable value is about 2000000. Use this to work without a
5193 limit.
5194 The value is ignored when 'swapfile' is off.
5195 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005197 *'maxmempattern'* *'mmp'*
5198'maxmempattern' 'mmp' number (default 1000)
5199 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005200 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005201 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005202 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005203 When Vim runs into the limit it gives an error message and mostly
5204 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005205 Running into the limit often means that the pattern is very
5206 inefficient or too complex. This may already happen with the pattern
5207 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005208 Might also happen on redraw, when syntax rules try to match a complex
5209 text structure.
5210 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5211 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005212
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213 *'maxmemtot'* *'mmt'*
5214'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5215 dependent) or half the amount of memory
5216 available)
5217 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005218 Maximum amount of memory in Kbyte to use for all buffers together.
5219 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005220 without a limit.
5221 On 64 bit machines higher values might work. But hey, do you really
5222 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005223 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005224 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005225 Buffers with 'swapfile' off still count to the total amount of memory
5226 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005227 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228
5229 *'menuitems'* *'mis'*
5230'menuitems' 'mis' number (default 25)
5231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232 {not available when compiled without the |+menu|
5233 feature}
5234 Maximum number of items to use in a menu. Used for menus that are
5235 generated from a list of items, e.g., the Buffers menu. Changing this
5236 option has no direct effect, the menu must be refreshed first.
5237
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005238 *'mkspellmem'* *'msm'*
5239'mkspellmem' 'msm' string (default "460000,2000,500")
5240 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005241 {not available when compiled without the |+syntax|
5242 feature}
5243 Parameters for |:mkspell|. This tunes when to start compressing the
5244 word tree. Compression can be slow when there are many words, but
5245 it's needed to avoid running out of memory. The amount of memory used
5246 per word depends very much on how similar the words are, that's why
5247 this tuning is complicated.
5248
5249 There are three numbers, separated by commas:
5250 {start},{inc},{added}
5251
5252 For most languages the uncompressed word tree fits in memory. {start}
5253 gives the amount of memory in Kbyte that can be used before any
5254 compression is done. It should be a bit smaller than the amount of
5255 memory that is available to Vim.
5256
5257 When going over the {start} limit the {inc} number specifies the
5258 amount of memory in Kbyte that can be allocated before another
5259 compression is done. A low number means compression is done after
5260 less words are added, which is slow. A high number means more memory
5261 will be allocated.
5262
5263 After doing compression, {added} times 1024 words can be added before
5264 the {inc} limit is ignored and compression is done when any extra
5265 amount of memory is needed. A low number means there is a smaller
5266 chance of hitting the {inc} limit, less memory is used but it's
5267 slower.
5268
5269 The languages for which these numbers are important are Italian and
5270 Hungarian. The default works for when you have about 512 Mbyte. If
5271 you have 1 Gbyte you could use: >
5272 :set mkspellmem=900000,3000,800
5273< If you have less than 512 Mbyte |:mkspell| may fail for some
5274 languages, no matter what you set 'mkspellmem' to.
5275
Bram Moolenaar07607392019-05-26 19:20:43 +02005276 This option cannot be set from a |modeline| or in the |sandbox|.
5277
Bram Moolenaar071d4272004-06-13 20:20:40 +00005278 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005279'modeline' 'ml' boolean (Vim default: on (off for root),
5280 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005282 If 'modeline' is on 'modelines' gives the number of lines that is
5283 checked for set commands. If 'modeline' is off or 'modelines' is zero
5284 no lines are checked. See |modeline|.
5285
5286 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5287'modelineexpr' 'mle' boolean (default: off)
5288 global
5289 When on allow some options that are an expression to be set in the
5290 modeline. Check the option for whether it is affected by
5291 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005292 This option cannot be set from a |modeline| or in the |sandbox|, for
5293 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005294
Bram Moolenaar071d4272004-06-13 20:20:40 +00005295 *'modelines'* *'mls'*
5296'modelines' 'mls' number (default 5)
5297 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298 If 'modeline' is on 'modelines' gives the number of lines that is
5299 checked for set commands. If 'modeline' is off or 'modelines' is zero
5300 no lines are checked. See |modeline|.
5301 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5302 set and to the Vim default value when 'compatible' is reset.
5303
5304 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005305 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005306'modifiable' 'ma' boolean (default on)
5307 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 When off the buffer contents cannot be changed. The 'fileformat' and
5309 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005310 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311
5312 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5313'modified' 'mod' boolean (default off)
5314 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315 When on, the buffer is considered to be modified. This option is set
5316 when:
5317 1. A change was made to the text since it was last written. Using the
5318 |undo| command to go back to the original text will reset the
5319 option. But undoing changes that were made before writing the
5320 buffer will set the option again, since the text is different from
5321 when it was written.
5322 2. 'fileformat' or 'fileencoding' is different from its original
5323 value. The original value is set when the buffer is read or
5324 written. A ":set nomodified" command also resets the original
5325 values to the current values and the 'modified' option will be
5326 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005327 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005328 This option is not set when a change is made to the buffer as the
5329 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5330 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5331 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005332 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5333 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005334 Note that the text may actually be the same, e.g. 'modified' is set
5335 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005336
5337 *'more'* *'nomore'*
5338'more' boolean (Vim default: on, Vi default: off)
5339 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340 When on, listings pause when the whole screen is filled. You will get
5341 the |more-prompt|. When this option is off there are no pauses, the
5342 listing continues until finished.
5343 NOTE: This option is set to the Vi default value when 'compatible' is
5344 set and to the Vim default value when 'compatible' is reset.
5345
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005346 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005347'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005348 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005349 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005350 Enable the use of the mouse. Works for most terminals (xterm, Win32
5351 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5352 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5353 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005354 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 v Visual mode
5356 i Insert mode
5357 c Command-line mode
5358 h all previous modes when editing a help file
5359 a all previous modes
5360 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005361 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005363< If your terminal can't overrule the mouse events going to the
5364 application, use: >
5365 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005366< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005367 back to Vim using the mouse events.
5368 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5369 "xterm".
5370
5371 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 modeless selection. This doesn't move the text cursor.
5373
5374 See |mouse-using|. Also see |'clipboard'|.
5375
5376 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005377 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378 the mouse buttons can still be used by keeping the shift key pressed.
5379 Also see the 'clipboard' option.
5380
5381 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5382'mousefocus' 'mousef' boolean (default off)
5383 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384 {only works in the GUI}
5385 The window that the mouse pointer is on is automatically activated.
5386 When changing the window layout or window focus in another way, the
5387 mouse pointer is moved to the window with keyboard focus. Off is the
5388 default because it makes using the pull down menus a little goofy, as
5389 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005390 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005391 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392
5393 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5394'mousehide' 'mh' boolean (default on)
5395 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396 {only works in the GUI}
5397 When on, the mouse pointer is hidden when characters are typed.
5398 The mouse pointer is restored when the mouse is moved.
5399
5400 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005401'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005402 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005403 Sets the model to use for the mouse. The name mostly specifies what
5404 the right mouse button is used for:
5405 extend Right mouse button extends a selection. This works
5406 like in an xterm.
5407 popup Right mouse button pops up a menu. The shifted left
5408 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005409 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410 popup_setpos Like "popup", but the cursor will be moved to the
5411 position where the mouse was clicked, and thus the
5412 selected operation will act upon the clicked object.
5413 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005414 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 course, that right clicking outside a selection will
5416 end Visual mode.
5417 Overview of what button does what for each model:
5418 mouse extend popup(_setpos) ~
5419 left click place cursor place cursor
5420 left drag start selection start selection
5421 shift-left search word extend selection
5422 right click extend selection popup menu (place cursor)
5423 right drag extend selection -
5424 middle click paste paste
5425
5426 In the "popup" model the right mouse button produces a pop-up menu.
5427 You need to define this first, see |popup-menu|.
5428
5429 Note that you can further refine the meaning of buttons with mappings.
5430 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5431 selection (because that's handled in the GUI code directly).
5432
5433 The 'mousemodel' option is set by the |:behave| command.
5434
5435 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005436'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5437 vs:leftright,vd:lrsizing,m:no,
5438 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 {only available when compiled with the |+mouseshape|
5441 feature}
5442 This option tells Vim what the mouse pointer should look like in
5443 different modes. The option is a comma separated list of parts, much
5444 like used for 'guicursor'. Each part consist of a mode/location-list
5445 and an argument-list:
5446 mode-list:shape,mode-list:shape,..
5447 The mode-list is a dash separated list of these modes/locations:
5448 In a normal window: ~
5449 n Normal mode
5450 v Visual mode
5451 ve Visual mode with 'selection' "exclusive" (same as 'v',
5452 if not specified)
5453 o Operator-pending mode
5454 i Insert mode
5455 r Replace mode
5456
5457 Others: ~
5458 c appending to the command-line
5459 ci inserting in the command-line
5460 cr replacing in the command-line
5461 m at the 'Hit ENTER' or 'More' prompts
5462 ml idem, but cursor in the last line
5463 e any mode, pointer below last window
5464 s any mode, pointer on a status line
5465 sd any mode, while dragging a status line
5466 vs any mode, pointer on a vertical separator line
5467 vd any mode, while dragging a vertical separator line
5468 a everywhere
5469
5470 The shape is one of the following:
5471 avail name looks like ~
5472 w x arrow Normal mouse pointer
5473 w x blank no pointer at all (use with care!)
5474 w x beam I-beam
5475 w x updown up-down sizing arrows
5476 w x leftright left-right sizing arrows
5477 w x busy The system's usual busy pointer
5478 w x no The system's usual 'no input' pointer
5479 x udsizing indicates up-down resizing
5480 x lrsizing indicates left-right resizing
5481 x crosshair like a big thin +
5482 x hand1 black hand
5483 x hand2 white hand
5484 x pencil what you write with
5485 x question big ?
5486 x rightup-arrow arrow pointing right-up
5487 w x up-arrow arrow pointing up
5488 x <number> any X11 pointer number (see X11/cursorfont.h)
5489
5490 The "avail" column contains a 'w' if the shape is available for Win32,
5491 x for X11.
5492 Any modes not specified or shapes not available use the normal mouse
5493 pointer.
5494
5495 Example: >
5496 :set mouseshape=s:udsizing,m:no
5497< will make the mouse turn to a sizing arrow over the status lines and
5498 indicate no input when the hit-enter prompt is displayed (since
5499 clicking the mouse has no effect in this state.)
5500
5501 *'mousetime'* *'mouset'*
5502'mousetime' 'mouset' number (default 500)
5503 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005504 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505 time in msec between two mouse clicks for the second click to be
5506 recognized as a multi click.
5507
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005508 *'mzschemedll'*
5509'mzschemedll' string (default depends on the build)
5510 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005511 {only available when compiled with the |+mzscheme/dyn|
5512 feature}
5513 Specifies the name of the MzScheme shared library. The default is
5514 DYNAMIC_MZSCH_DLL which was specified at compile time.
5515 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005516 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005517 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005518 This option cannot be set from a |modeline| or in the |sandbox|, for
5519 security reasons.
5520
5521 *'mzschemegcdll'*
5522'mzschemegcdll' string (default depends on the build)
5523 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005524 {only available when compiled with the |+mzscheme/dyn|
5525 feature}
5526 Specifies the name of the MzScheme GC shared library. The default is
5527 DYNAMIC_MZGC_DLL which was specified at compile time.
5528 The value can be equal to 'mzschemedll' if it includes the GC code.
5529 Environment variables are expanded |:set_env|.
5530 This option cannot be set from a |modeline| or in the |sandbox|, for
5531 security reasons.
5532
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005533 *'mzquantum'* *'mzq'*
5534'mzquantum' 'mzq' number (default 100)
5535 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005536 {not available when compiled without the |+mzscheme|
5537 feature}
5538 The number of milliseconds between polls for MzScheme threads.
5539 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005540 NOTE: This option is set to the Vim default value when 'compatible'
5541 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005542
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005544'nrformats' 'nf' string (default "bin,octal,hex",
5545 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005546 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547 This defines what bases Vim will consider for numbers when using the
5548 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5549 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005550 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005552 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005553 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005554 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005555 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 considered to be hexadecimal. Example: Using CTRL-X on
5557 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005558 bin If included, numbers starting with "0b" or "0B" will be
5559 considered to be binary. Example: Using CTRL-X on
5560 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005561 unsigned If included, numbers are recognized as unsigned. Thus a
5562 leading dash or negative sign won't be considered as part of
5563 the number. Examples:
5564 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5565 (without "unsigned" it would become "9-2021").
5566 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5567 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005568 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5569 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005570 Numbers which simply begin with a digit in the range 1-9 are always
5571 considered decimal. This also happens for numbers that are not
5572 recognized as octal or hex.
5573
5574 *'number'* *'nu'* *'nonumber'* *'nonu'*
5575'number' 'nu' boolean (default off)
5576 local to window
5577 Print the line number in front of each line. When the 'n' option is
5578 excluded from 'cpoptions' a wrapped line will not use the column of
5579 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005580 The 'numberwidth' option can be used to set the room used for the line
5581 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582 When a long, wrapped line doesn't start with the first character, '-'
5583 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005584 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5585 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005586 *number_relativenumber*
5587 The 'relativenumber' option changes the displayed number to be
5588 relative to the cursor. Together with 'number' there are these
5589 four combinations (cursor in line 3):
5590
Bram Moolenaar3848e002016-03-19 18:42:29 +01005591 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005592 'nornu' 'nornu' 'rnu' 'rnu'
5593
5594 |apple | 1 apple | 2 apple | 2 apple
5595 |pear | 2 pear | 1 pear | 1 pear
5596 |nobody | 3 nobody | 0 nobody |3 nobody
5597 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005598
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005599 *'numberwidth'* *'nuw'*
5600'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5601 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005602 {only available when compiled with the |+linebreak|
5603 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005604 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005605 when the 'number' or 'relativenumber' option is set or printing lines
5606 with a line number. Since one space is always between the number and
5607 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005608 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005609 fit the highest line number in the buffer respectively the number of
5610 rows in the window, depending on whether 'number' or 'relativenumber'
5611 is set. Thus with the Vim default of 4 there is room for a line number
5612 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005613 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005614 NOTE: This option is set to the Vi default value when 'compatible' is
5615 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005616
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005617 *'omnifunc'* *'ofu'*
5618'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005619 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005620 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005621 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005622 This option specifies a function to be used for Insert mode omni
5623 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005624 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005625 invoked and what it should return. The value can be the name of a
5626 function, a |lambda| or a |Funcref|. See |option-value-function| for
5627 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005628 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005629 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005630 This option cannot be set from a |modeline| or in the |sandbox|, for
5631 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005632
5633
Bram Moolenaar02467872007-05-06 13:22:01 +00005634 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005635'opendevice' 'odev' boolean (default off)
5636 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005637 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005638 Enable reading and writing from devices. This may get Vim stuck on a
5639 device that can be opened but doesn't actually do the I/O. Therefore
5640 it is off by default.
5641 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5642 result in editing a device.
5643
5644
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005645 *'operatorfunc'* *'opfunc'*
5646'operatorfunc' 'opfunc' string (default: empty)
5647 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005648 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005649 See |:map-operator| for more info and an example. The value can be
5650 the name of a function, a |lambda| or a |Funcref|. See
5651 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005652
5653 This option cannot be set from a |modeline| or in the |sandbox|, for
5654 security reasons.
5655
5656
Bram Moolenaar251e1912011-06-19 05:09:16 +02005657 *'osfiletype'* *'oft'*
5658'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005660 This option was supported on RISC OS, which has been removed.
5661
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005663 *'packpath'* *'pp'*
5664'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005665 Directories used to find packages. See |packages|.
5666
5667
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005669'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005670 global
5671 Specifies the nroff macros that separate paragraphs. These are pairs
5672 of two letters (see |object-motions|).
5673
5674 *'paste'* *'nopaste'*
5675'paste' boolean (default off)
5676 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005677 Put Vim in Paste mode. This is useful if you want to cut or copy
5678 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 unexpected effects.
5680 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005681 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005682 knows about pasting and will mostly do the right thing without 'paste'
5683 being set. The same is true for a terminal where Vim handles the
5684 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005685 This option is reset when starting the GUI. Thus if you set it in
5686 your .vimrc it will work in a terminal, but not in the GUI. Setting
5687 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5688 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689 When the 'paste' option is switched on (also when it was already on):
5690 - mapping in Insert mode and Command-line mode is disabled
5691 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005693 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005694 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 - 'revins' is reset
5696 - 'ruler' is reset
5697 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005698 - 'smarttab' is reset
5699 - 'softtabstop' is set to 0
5700 - 'textwidth' is set to 0
5701 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005702 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005705 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005706 - 'indentexpr'
5707 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005708 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 NOTE: When you start editing another file while the 'paste' option is
5710 on, settings from the modelines or autocommands may change the
5711 settings again, causing trouble when pasting text. You might want to
5712 set the 'paste' option again.
5713 When the 'paste' option is reset the mentioned options are restored to
5714 the value before the moment 'paste' was switched from off to on.
5715 Resetting 'paste' before ever setting it does not have any effect.
5716 Since mapping doesn't work while 'paste' is active, you need to use
5717 the 'pastetoggle' option to toggle the 'paste' option with some key.
5718
5719 *'pastetoggle'* *'pt'*
5720'pastetoggle' 'pt' string (default "")
5721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 When non-empty, specifies the key sequence that toggles the 'paste'
5723 option. This is like specifying a mapping: >
5724 :map {keys} :set invpaste<CR>
5725< Where {keys} is the value of 'pastetoggle'.
5726 The difference is that it will work even when 'paste' is set.
5727 'pastetoggle' works in Insert mode and Normal mode, but not in
5728 Command-line mode.
5729 Mappings are checked first, thus overrule 'pastetoggle'. However,
5730 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5731 this: >
5732 :map <F10> :set paste<CR>
5733 :map <F11> :set nopaste<CR>
5734 :imap <F10> <C-O>:set paste<CR>
5735 :imap <F11> <nop>
5736 :set pastetoggle=<F11>
5737< This will make <F10> start paste mode and <F11> stop paste mode.
5738 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5739 mode everything is inserted literally, except the 'pastetoggle' key
5740 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005741 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742
5743 *'pex'* *'patchexpr'*
5744'patchexpr' 'pex' string (default "")
5745 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746 {not available when compiled without the |+diff|
5747 feature}
5748 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005749 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750
Bram Moolenaardbc28022014-07-26 13:40:44 +02005751 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752'patchmode' 'pm' string (default "")
5753 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005754 When non-empty the oldest version of a file is kept. This can be used
5755 to keep the original version of a file if you are changing files in a
5756 source distribution. Only the first time that a file is written a
5757 copy of the original file will be kept. The name of the copy is the
5758 name of the original file with the string in the 'patchmode' option
5759 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005760 ".orig" or ".org". 'backupdir' must not be empty for this to work
5761 (Detail: The backup file is renamed to the patchmode file after the
5762 new file has been successfully written, that's why it must be possible
5763 to write a backup file). If there was no file to be backed up, an
5764 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005765 When the 'backupskip' pattern matches, a patchmode file is not made.
5766 Using 'patchmode' for compressed files appends the extension at the
5767 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5768 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005769 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005771 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 other systems: ".,,")
5774 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005776 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5777 provided that the file being searched for has a relative path (not
5778 starting with "/", "./" or "../"). The directories in the 'path'
5779 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780 - Use commas to separate directory names: >
5781 :set path=.,/usr/local/include,/usr/include
5782< - Spaces can also be used to separate directory names (for backwards
5783 compatibility with version 3.0). To have a space in a directory
5784 name, precede it with an extra backslash, and escape the space: >
5785 :set path=.,/dir/with\\\ space
5786< - To include a comma in a directory name precede it with an extra
5787 backslash: >
5788 :set path=.,/dir/with\\,comma
5789< - To search relative to the directory of the current file, use: >
5790 :set path=.
5791< - To search in the current directory use an empty string between two
5792 commas: >
5793 :set path=,,
5794< - A directory name may end in a ':' or '/'.
5795 - Environment variables are expanded |:set_env|.
5796 - When using |netrw.vim| URLs can be used. For example, adding
5797 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005798 - Search upwards and downwards in a directory tree using "*", "**" and
5799 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005800 {not available when compiled without the |+path_extra| feature}
5801 - Careful with '\' characters, type two to get one in the option: >
5802 :set path=.,c:\\include
5803< Or just use '/' instead: >
5804 :set path=.,c:/include
5805< Don't forget "." or files won't even be found in the same directory as
5806 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005807 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005808 it is something like 256 or 1024 characters.
5809 You can check if all the include files are found, using the value of
5810 'path', see |:checkpath|.
5811 The use of |:set+=| and |:set-=| is preferred when adding or removing
5812 directories from the list. This avoids problems when a future version
5813 uses another default. To remove the current directory use: >
5814 :set path-=
5815< To add the current directory use: >
5816 :set path+=
5817< To use an environment variable, you probably need to replace the
5818 separator. Here is an example to append $INCL, in which directory
5819 names are separated with a semi-colon: >
5820 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5821< Replace the ';' with a ':' or whatever separator is used. Note that
5822 this doesn't work when $INCL contains a comma or white space.
5823
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005824 *'perldll'*
5825'perldll' string (default depends on the build)
5826 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005827 {only available when compiled with the |+perl/dyn|
5828 feature}
5829 Specifies the name of the Perl shared library. The default is
5830 DYNAMIC_PERL_DLL, which was specified at compile time.
5831 Environment variables are expanded |:set_env|.
5832 This option cannot be set from a |modeline| or in the |sandbox|, for
5833 security reasons.
5834
Bram Moolenaar071d4272004-06-13 20:20:40 +00005835 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5836'preserveindent' 'pi' boolean (default off)
5837 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005838 When changing the indent of the current line, preserve as much of the
5839 indent structure as possible. Normally the indent is replaced by a
5840 series of tabs followed by spaces as required (unless |'expandtab'| is
5841 enabled, in which case only spaces are used). Enabling this option
5842 means the indent will preserve as many existing characters as possible
5843 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005844 'expandtab' does not apply to the preserved white space, a Tab remains
5845 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846 NOTE: When using ">>" multiple times the resulting indent is a mix of
5847 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005848 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849 Also see 'copyindent'.
5850 Use |:retab| to clean up white space.
5851
5852 *'previewheight'* *'pvh'*
5853'previewheight' 'pvh' number (default 12)
5854 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005855 {not available when compiled without the |+quickfix|
5856 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005857 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005858 commands. Used for |CTRL-W_}| when no count is given. Not used when
5859 'previewpopup' is set.
5860
5861 *'previewpopup'* *'pvp'*
5862'previewpopup' 'pvp' string (default empty)
5863 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005864 {not available when compiled without the |+textprop|
5865 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005866 When not empty a popup window is used for commands that would open a
5867 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005868 Not used for the insert completion info, add "popup" to
5869 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005870
5871 *'previewwindow'* *'nopreviewwindow'*
5872 *'pvw'* *'nopvw'* *E590*
5873'previewwindow' 'pvw' boolean (default off)
5874 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005875 {not available when compiled without the |+quickfix|
5876 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005877 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005878 set. It's normally not set directly, but by using one of the commands
5879 |:ptag|, |:pedit|, etc.
5880
5881 *'printdevice'* *'pdev'*
5882'printdevice' 'pdev' string (default empty)
5883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884 {only available when compiled with the |+printer|
5885 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005886 The name of the printer to be used for |:hardcopy|.
5887 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005888 This option cannot be set from a |modeline| or in the |sandbox|, for
5889 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890
Bram Moolenaar8299df92004-07-10 09:47:34 +00005891 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005892'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894 {only available when compiled with the |+printer|
5895 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005896 Sets the character encoding used when printing.
5897 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005898
5899 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005900'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902 {only available when compiled with the |+printer|
5903 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005904 Expression used to print the PostScript produced with |:hardcopy|.
5905 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005906 This option cannot be set from a |modeline| or in the |sandbox|, for
5907 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908
Bram Moolenaar8299df92004-07-10 09:47:34 +00005909 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910'printfont' 'pfn' string (default "courier")
5911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005912 {only available when compiled with the |+printer|
5913 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005914 The name of the font that will be used for |:hardcopy|.
5915 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005916
5917 *'printheader'* *'pheader'*
5918'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5919 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920 {only available when compiled with the |+printer|
5921 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005922 The format of the header produced in |:hardcopy| output.
5923 See |pheader-option|.
5924
5925 *'printmbcharset'* *'pmbcs'*
5926'printmbcharset' 'pmbcs' string (default "")
5927 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005928 {only available when compiled with the |+printer|
5929 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005930 The CJK character set to be used for CJK output from |:hardcopy|.
5931 See |pmbcs-option|.
5932
5933 *'printmbfont'* *'pmbfn'*
5934'printmbfont' 'pmbfn' string (default "")
5935 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005936 {only available when compiled with the |+printer|
5937 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005938 List of font names to be used for CJK output from |:hardcopy|.
5939 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005940
5941 *'printoptions'* *'popt'*
5942'printoptions' 'popt' string (default "")
5943 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005944 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005945 List of items that control the format of the output of |:hardcopy|.
5946 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005948 *'prompt'* *'noprompt'*
5949'prompt' boolean (default on)
5950 global
5951 When on a ":" prompt is used in Ex mode.
5952
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005953 *'pumheight'* *'ph'*
5954'pumheight' 'ph' number (default 0)
5955 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005956 Determines the maximum number of items to show in the popup menu for
5957 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005958 |ins-completion-menu|.
5959
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005960 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005961'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005962 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005963 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005964 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005965
Bram Moolenaard94464e2015-11-02 15:28:18 +01005966 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005967'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005968 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005969 {only available when compiled with the |+python/dyn|
5970 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005971 Specifies the name of the Python 2.x shared library. The default is
5972 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005973 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005974 This option cannot be set from a |modeline| or in the |sandbox|, for
5975 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005976
Bram Moolenaar94073162018-01-31 21:49:05 +01005977 *'pythonhome'*
5978'pythonhome' string (default "")
5979 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005980 {only available when compiled with the |+python/dyn|
5981 feature}
5982 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5983 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5984 which was specified at compile time, will be used for the Python 2.x
5985 home directory.
5986 Environment variables are expanded |:set_env|.
5987 This option cannot be set from a |modeline| or in the |sandbox|, for
5988 security reasons.
5989
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005990 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005991'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005992 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005993 {only available when compiled with the |+python3/dyn|
5994 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005995 Specifies the name of the Python 3 shared library. The default is
5996 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005997 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005998 This option cannot be set from a |modeline| or in the |sandbox|, for
5999 security reasons.
6000
Bram Moolenaar94073162018-01-31 21:49:05 +01006001 *'pythonthreehome'*
6002'pythonthreehome' string (default "")
6003 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006004 {only available when compiled with the |+python3/dyn|
6005 feature}
6006 Specifies the name of the Python 3 home directory. When
6007 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6008 PYTHON3_HOME, which was specified at compile time, will be used for
6009 the Python 3 home directory.
6010 Environment variables are expanded |:set_env|.
6011 This option cannot be set from a |modeline| or in the |sandbox|, for
6012 security reasons.
6013
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006014 *'pyxversion'* *'pyx'*
6015'pyxversion' 'pyx' number (default depends on the build)
6016 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006017 {only available when compiled with the |+python| or
6018 the |+python3| feature}
6019 Specifies the python version used for pyx* functions and commands
6020 |python_x|. The default value is as follows:
6021
6022 Compiled with Default ~
6023 |+python| and |+python3| 0
6024 only |+python| 2
6025 only |+python3| 3
6026
6027 Available values are 0, 2 and 3.
6028 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6029 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6030 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6031 to 2 if Python 2 is available.
6032 See also: |has-pythonx|
6033
6034 If Vim is compiled with only |+python| or |+python3| setting
6035 'pyxversion' has no effect. The pyx* functions and commands are
6036 always the same as the compiled version.
6037
6038 This option cannot be set from a |modeline| or in the |sandbox|, for
6039 security reasons.
6040
Bram Moolenaar858ba062020-05-31 23:11:59 +02006041 *'quickfixtextfunc'* *'qftf'*
6042'quickfixtextfunc' 'qftf' string (default "")
6043 global
6044 {only available when compiled with the |+quickfix|
6045 feature}
6046 This option specifies a function to be used to get the text to display
6047 in the quickfix and location list windows. This can be used to
6048 customize the information displayed in the quickfix or location window
6049 for each entry in the corresponding quickfix or location list. See
6050 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006051 function and an example. The value can be the name of a function, a
6052 |lambda| or a |Funcref|. See |option-value-function| for more
6053 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006054
6055 This option cannot be set from a |modeline| or in the |sandbox|, for
6056 security reasons.
6057
Bram Moolenaar677ee682005-01-27 14:41:15 +00006058 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006059'quoteescape' 'qe' string (default "\")
6060 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006061 The characters that are used to escape quotes in a string. Used for
6062 objects like a', a" and a` |a'|.
6063 When one of the characters in this option is found inside a string,
6064 the following character will be skipped. The default value makes the
6065 text "foo\"bar\\" considered to be one string.
6066
Bram Moolenaar071d4272004-06-13 20:20:40 +00006067 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6068'readonly' 'ro' boolean (default off)
6069 local to buffer
6070 If on, writes fail unless you use a '!'. Protects you from
6071 accidentally overwriting a file. Default on when Vim is started
6072 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006073 When using ":w!" the 'readonly' option is reset for the current
6074 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006075 When using the ":view" command the 'readonly' option is set for the
6076 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006077 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006078
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006079 *'redrawtime'* *'rdt'*
6080'redrawtime' 'rdt' number (default 2000)
6081 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006082 {only available when compiled with the |+reltime|
6083 feature}
6084 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006085 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006086 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006087 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006088 matches will be highlighted.
6089 For syntax highlighting the time applies per window. When over the
6090 limit syntax highlighting is disabled until |CTRL-L| is used.
6091 This is used to avoid that Vim hangs when using a very complicated
6092 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006093
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006094 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006095'regexpengine' 're' number (default 0)
6096 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006097 This selects the default regexp engine. |two-engines|
6098 The possible values are:
6099 0 automatic selection
6100 1 old engine
6101 2 NFA engine
6102 Note that when using the NFA engine and the pattern contains something
6103 that is not supported the pattern will not match. This is only useful
6104 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006105 Using automatic selection enables Vim to switch the engine, if the
6106 default engine becomes too costly. E.g., when the NFA engine uses too
6107 many states. This should prevent Vim from hanging on a combination of
6108 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006109
Bram Moolenaar64486672010-05-16 15:46:46 +02006110 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6111'relativenumber' 'rnu' boolean (default off)
6112 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006113 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006114 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006115 precede some vertical motion commands (e.g. j k + -) with, without
6116 having to calculate it yourself. Especially useful in combination with
6117 other commands (e.g. y d c < > gq gw =).
6118 When the 'n' option is excluded from 'cpoptions' a wrapped
6119 line will not use the column of line numbers (this is the default when
6120 'compatible' isn't set).
6121 The 'numberwidth' option can be used to set the room used for the line
6122 number.
6123 When a long, wrapped line doesn't start with the first character, '-'
6124 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006125 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6126 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006127
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006128 The number in front of the cursor line also depends on the value of
6129 'number', see |number_relativenumber| for all combinations of the two
6130 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006131
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132 *'remap'* *'noremap'*
6133'remap' boolean (default on)
6134 global
6135 Allows for mappings to work recursively. If you do not want this for
6136 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006137 NOTE: To avoid portability problems with Vim scripts, always keep
6138 this option at the default "on". Only switch it off when working with
6139 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006140
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006141 *'renderoptions'* *'rop'*
6142'renderoptions' 'rop' string (default: empty)
6143 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006144 {only available when compiled with GUI and DIRECTX on
6145 MS-Windows}
6146 Select a text renderer and set its options. The options depend on the
6147 renderer.
6148
6149 Syntax: >
6150 set rop=type:{renderer}(,{name}:{value})*
6151<
6152 Currently, only one optional renderer is available.
6153
6154 render behavior ~
6155 directx Vim will draw text using DirectX (DirectWrite). It makes
6156 drawn glyphs more beautiful than default GDI.
6157 It requires 'encoding' is "utf-8", and only works on
6158 MS-Windows Vista or newer version.
6159
6160 Options:
6161 name meaning type value ~
6162 gamma gamma float 1.0 - 2.2 (maybe)
6163 contrast enhancedContrast float (unknown)
6164 level clearTypeLevel float (unknown)
6165 geom pixelGeometry int 0 - 2 (see below)
6166 renmode renderingMode int 0 - 6 (see below)
6167 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006168 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006169
Bram Moolenaar92467d32017-12-05 13:22:16 +01006170 See this URL for detail (except for scrlines):
6171 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006172
6173 For geom: structure of a device pixel.
6174 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6175 1 - DWRITE_PIXEL_GEOMETRY_RGB
6176 2 - DWRITE_PIXEL_GEOMETRY_BGR
6177
6178 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006179 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006180
6181 For renmode: method of rendering glyphs.
6182 0 - DWRITE_RENDERING_MODE_DEFAULT
6183 1 - DWRITE_RENDERING_MODE_ALIASED
6184 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6185 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6186 4 - DWRITE_RENDERING_MODE_NATURAL
6187 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6188 6 - DWRITE_RENDERING_MODE_OUTLINE
6189
6190 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006191 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006192
6193 For taamode: antialiasing mode used for drawing text.
6194 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6195 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6196 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6197 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6198
6199 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006200 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6201
Bram Moolenaara338adc2018-01-31 20:51:47 +01006202 For scrlines:
6203 This was used for optimizing scrolling behavior, however this
6204 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006205
6206 Example: >
6207 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006208 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006209 set rop=type:directx
6210<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006211 If select a raster font (Courier, Terminal or FixedSys which
6212 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006213 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006214
6215 NOTE: It is known that some fonts and options combination
6216 causes trouble on drawing glyphs.
6217
Bram Moolenaar92467d32017-12-05 13:22:16 +01006218 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006219 special made fonts (True-Type fonts which includes only
6220 bitmap glyphs).
6221 - 'taamode:3' will not work with some vector fonts.
6222
6223 NOTE: With this option, you can display colored emoji
6224 (emoticon) in Windows 8.1 or later. To display colored emoji,
6225 there are some conditions which you should notice.
6226
6227 - If your font includes non-colored emoji already, it will
6228 be used.
6229 - If your font doesn't have emoji, the system chooses an
6230 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6231 will be used.
6232 - When this alternative font didn't have fixed width glyph,
6233 emoji might be rendered beyond the bounding box of drawing
6234 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006235
6236 Other render types are currently not supported.
6237
Bram Moolenaar071d4272004-06-13 20:20:40 +00006238 *'report'*
6239'report' number (default 2)
6240 global
6241 Threshold for reporting number of lines changed. When the number of
6242 changed lines is more than 'report' a message will be given for most
6243 ":" commands. If you want it always, set 'report' to 0.
6244 For the ":substitute" command the number of substitutions is used
6245 instead of the number of lines.
6246
6247 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6248'restorescreen' 'rs' boolean (default on)
6249 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006250 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 When set, the screen contents is restored when exiting Vim. This also
6252 happens when executing external commands.
6253
6254 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6255 options in your .vimrc. To disable restoring:
6256 set t_ti= t_te=
6257 To enable restoring (for an xterm):
6258 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6259 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6260
6261 *'revins'* *'ri'* *'norevins'* *'nori'*
6262'revins' 'ri' boolean (default off)
6263 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006264 {only available when compiled with the |+rightleft|
6265 feature}
6266 Inserting characters in Insert mode will work backwards. See "typing
6267 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6268 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006269 NOTE: This option is reset when 'compatible' is set.
6270 This option is reset when 'paste' is set and restored when 'paste' is
6271 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272
6273 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6274'rightleft' 'rl' boolean (default off)
6275 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006276 {only available when compiled with the |+rightleft|
6277 feature}
6278 When on, display orientation becomes right-to-left, i.e., characters
6279 that are stored in the file appear from the right to the left.
6280 Using this option, it is possible to edit files for languages that
6281 are written from the right to the left such as Hebrew and Arabic.
6282 This option is per window, so it is possible to edit mixed files
6283 simultaneously, or to view the same file in both ways (this is
6284 useful whenever you have a mixed text file with both right-to-left
6285 and left-to-right strings so that both sets are displayed properly
6286 in different windows). Also see |rileft.txt|.
6287
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006288 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289'rightleftcmd' 'rlc' string (default "search")
6290 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006291 {only available when compiled with the |+rightleft|
6292 feature}
6293 Each word in this option enables the command line editing to work in
6294 right-to-left mode for a group of commands:
6295
6296 search "/" and "?" commands
6297
6298 This is useful for languages such as Hebrew, Arabic and Farsi.
6299 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6300
Bram Moolenaard94464e2015-11-02 15:28:18 +01006301 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006302'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006303 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006304 {only available when compiled with the |+ruby/dyn|
6305 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006306 Specifies the name of the Ruby shared library. The default is
6307 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006308 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006309 This option cannot be set from a |modeline| or in the |sandbox|, for
6310 security reasons.
6311
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006313'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006314 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315 {not available when compiled without the
6316 |+cmdline_info| feature}
6317 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006318 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006319 text in the file is shown on the far right:
6320 Top first line is visible
6321 Bot last line is visible
6322 All first and last line are visible
6323 45% relative position in the file
6324 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006325 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006326 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006327 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006328 this option takes precedence over 'ruler' and 'rulerformat'
6329 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006330 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331 the text column (byte number) and the screen column are shown,
6332 separated with a dash.
6333 For an empty line "0-1" is shown.
6334 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006335 This option is reset when 'paste' is set and restored when 'paste' is
6336 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337 If you don't want to see the ruler all the time but want to know where
6338 you are, use "g CTRL-G" |g_CTRL-G|.
6339 NOTE: This option is reset when 'compatible' is set.
6340
6341 *'rulerformat'* *'ruf'*
6342'rulerformat' 'ruf' string (default empty)
6343 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344 {not available when compiled without the |+statusline|
6345 feature}
6346 When this option is not empty, it determines the content of the ruler
6347 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006348 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006349 This option cannot be set in a modeline when 'modelineexpr' is off.
6350
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351 The default ruler width is 17 characters. To make the ruler 15
6352 characters wide, put "%15(" at the start and "%)" at the end.
6353 Example: >
6354 :set rulerformat=%15(%c%V\ %p%%%)
6355<
6356 *'runtimepath'* *'rtp'* *vimfiles*
6357'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006358 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 $VIM/vimfiles,
6360 $VIMRUNTIME,
6361 $VIM/vimfiles/after,
6362 $HOME/.vim/after"
6363 Amiga: "home:vimfiles,
6364 $VIM/vimfiles,
6365 $VIMRUNTIME,
6366 $VIM/vimfiles/after,
6367 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006368 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006369 $VIM/vimfiles,
6370 $VIMRUNTIME,
6371 $VIM/vimfiles/after,
6372 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006373 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 $VIMRUNTIME,
6375 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006376 Haiku: "$BE_USER_SETTINGS/vim,
6377 $VIM/vimfiles,
6378 $VIMRUNTIME,
6379 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006380 $BE_USER_SETTINGS/vim/after"
6381 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006382 $VIM/vimfiles,
6383 $VIMRUNTIME,
6384 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006385 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 This is a list of directories which will be searched for runtime
6388 files:
6389 filetype.vim filetypes by file name |new-filetype|
6390 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006391 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 colors/ color scheme files |:colorscheme|
6393 compiler/ compiler files |:compiler|
6394 doc/ documentation |write-local-help|
6395 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006396 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397 indent/ indent scripts |indent-expression|
6398 keymap/ key mapping files |mbyte-keymap|
6399 lang/ menu translations |:menutrans|
6400 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006401 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 plugin/ plugin scripts |write-plugin|
6403 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006404 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405 syntax/ syntax files |mysyntaxfile|
6406 tutor/ files for vimtutor |tutor|
6407
6408 And any other file searched for with the |:runtime| command.
6409
6410 The defaults for most systems are setup to search five locations:
6411 1. In your home directory, for your personal preferences.
6412 2. In a system-wide Vim directory, for preferences from the system
6413 administrator.
6414 3. In $VIMRUNTIME, for files distributed with Vim.
6415 *after-directory*
6416 4. In the "after" directory in the system-wide Vim directory. This is
6417 for the system administrator to overrule or add to the distributed
6418 defaults (rarely needed)
6419 5. In the "after" directory in your home directory. This is for
6420 personal preferences to overrule or add to the distributed defaults
6421 or system-wide settings (rarely needed).
6422
Bram Moolenaard0796902016-09-16 20:02:31 +02006423 More entries are added when using |packages|. If it gets very long
6424 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6425 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006426
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6428 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006429 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 wildcards.
6431 See |:runtime|.
6432 Example: >
6433 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6434< This will use the directory "~/vimruntime" first (containing your
6435 personal Vim runtime files), then "/mygroup/vim" (shared between a
6436 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6437 files).
6438 You probably should always include $VIMRUNTIME somewhere, to use the
6439 distributed runtime files. You can put a directory before $VIMRUNTIME
6440 to find files which replace a distributed runtime files. You can put
6441 a directory after $VIMRUNTIME to find files which add to distributed
6442 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006443 When Vim is started with |--clean| the home directory entries are not
6444 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445 This option cannot be set from a |modeline| or in the |sandbox|, for
6446 security reasons.
6447
6448 *'scroll'* *'scr'*
6449'scroll' 'scr' number (default: half the window height)
6450 local to window
6451 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6452 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006453 changes. This may happen when enabling the |status-line| or
6454 'tabline' option after setting the 'scroll' option.
6455 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006456 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006457 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458
6459 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6460'scrollbind' 'scb' boolean (default off)
6461 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006462 See also |scroll-binding|. When this option is set, the current
6463 window scrolls as other scrollbind windows (windows that also have
6464 this option set) scroll. This option is useful for viewing the
6465 differences between two versions of a file, see 'diff'.
6466 See |'scrollopt'| for options that determine how this option should be
6467 interpreted.
6468 This option is mostly reset when splitting a window to edit another
6469 file. This means that ":split | edit file" results in two windows
6470 with scroll-binding, but ":split file" does not.
6471
Bram Moolenaarae20f342019-11-05 21:09:23 +01006472 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6473'scrollfocus' 'scf' boolean (default off)
6474 global
6475 {only for MS-Windows GUI}
6476 When using the scroll wheel and this option is set, the window under
6477 the mouse pointer is scrolled. With this option off the current
6478 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006479 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006480
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481 *'scrolljump'* *'sj'*
6482'scrolljump' 'sj' number (default 1)
6483 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 Minimal number of lines to scroll when the cursor gets off the
6485 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6486 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006487 When set to a negative number from -1 to -100 this is used as the
6488 percentage of the window height. Thus -50 scrolls half the window
6489 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 NOTE: This option is set to 1 when 'compatible' is set.
6491
6492 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006493'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006494 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 Minimal number of screen lines to keep above and below the cursor.
6496 This will make some context visible around where you are working. If
6497 you set it to a very large value (999) the cursor line will always be
6498 in the middle of the window (except at the start or end of the file or
6499 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006500 After using the local value, go back the global value with one of
6501 these two: >
6502 setlocal scrolloff<
6503 setlocal scrolloff=-1
6504< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505 NOTE: This option is set to 0 when 'compatible' is set.
6506
6507 *'scrollopt'* *'sbo'*
6508'scrollopt' 'sbo' string (default "ver,jump")
6509 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006510 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006511 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6512 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513 The following words are available:
6514 ver Bind vertical scrolling for 'scrollbind' windows
6515 hor Bind horizontal scrolling for 'scrollbind' windows
6516 jump Applies to the offset between two windows for vertical
6517 scrolling. This offset is the difference in the first
6518 displayed line of the bound windows. When moving
6519 around in a window, another 'scrollbind' window may
6520 reach a position before the start or after the end of
6521 the buffer. The offset is not changed though, when
6522 moving back the 'scrollbind' window will try to scroll
6523 to the desired position when possible.
6524 When now making that window the current one, two
6525 things can be done with the relative offset:
6526 1. When "jump" is not included, the relative offset is
6527 adjusted for the scroll position in the new current
6528 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006529 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 2. When "jump" is included, the other windows are
6531 scrolled to keep the same relative offset. When
6532 going back to the other window, it still uses the
6533 same relative offset.
6534 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006535 When 'diff' mode is active there always is vertical scroll binding,
6536 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537
6538 *'sections'* *'sect'*
6539'sections' 'sect' string (default "SHNHH HUnhsh")
6540 global
6541 Specifies the nroff macros that separate sections. These are pairs of
6542 two letters (See |object-motions|). The default makes a section start
6543 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6544
6545 *'secure'* *'nosecure'* *E523*
6546'secure' boolean (default off)
6547 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 When on, ":autocmd", shell and write commands are not allowed in
6549 ".vimrc" and ".exrc" in the current directory and map commands are
6550 displayed. Switch it off only if you know that you will not run into
6551 problems, or when the 'exrc' option is off. On Unix this option is
6552 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006553 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 'secure' at the end of your ~/.vimrc then.
6555 This option cannot be set from a |modeline| or in the |sandbox|, for
6556 security reasons.
6557
6558 *'selection'* *'sel'*
6559'selection' 'sel' string (default "inclusive")
6560 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561 This option defines the behavior of the selection. It is only used
6562 in Visual and Select mode.
6563 Possible values:
6564 value past line inclusive ~
6565 old no yes
6566 inclusive yes yes
6567 exclusive yes no
6568 "past line" means that the cursor is allowed to be positioned one
6569 character past the line.
6570 "inclusive" means that the last character of the selection is included
6571 in an operation. For example, when "x" is used to delete the
6572 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006573 When "old" is used and 'virtualedit' allows the cursor to move past
6574 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006575 Note that when "exclusive" is used and selecting from the end
6576 backwards, you cannot include the last character of a line, when
6577 starting in Normal mode and 'virtualedit' empty.
6578
6579 The 'selection' option is set by the |:behave| command.
6580
6581 *'selectmode'* *'slm'*
6582'selectmode' 'slm' string (default "")
6583 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584 This is a comma separated list of words, which specifies when to start
6585 Select mode instead of Visual mode, when a selection is started.
6586 Possible values:
6587 mouse when using the mouse
6588 key when using shifted special keys
6589 cmd when using "v", "V" or CTRL-V
6590 See |Select-mode|.
6591 The 'selectmode' option is set by the |:behave| command.
6592
6593 *'sessionoptions'* *'ssop'*
6594'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006595 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006597 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006598 feature}
6599 Changes the effect of the |:mksession| command. It is a comma
6600 separated list of words. Each word enables saving and restoring
6601 something:
6602 word save and restore ~
6603 blank empty windows
6604 buffers hidden and unloaded buffers, not just those in windows
6605 curdir the current directory
6606 folds manually created folds, opened/closed folds and local
6607 fold options
6608 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006609 and contain at least one lowercase letter. Only
6610 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611 help the help window
6612 localoptions options and mappings local to a window or buffer (not
6613 global values for local options)
6614 options all options and mappings (also global values for local
6615 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006616 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 resize size of the Vim window: 'lines' and 'columns'
6618 sesdir the directory in which the session file is located
6619 will become the current directory (useful with
6620 projects accessed over a network from different
6621 systems)
6622 slash backslashes in file names replaced with forward
6623 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006624 tabpages all tab pages; without this only the current tab page
6625 is restored, so that you can make a session for each
6626 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006627 terminal include terminal windows where the command can be
6628 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 unix with Unix end-of-line format (single <NL>), even when
6630 on Windows or DOS
6631 winpos position of the whole Vim window
6632 winsize window sizes
6633
6634 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006635 When neither "curdir" nor "sesdir" is included, file names are stored
6636 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 "slash" and "unix" are useful on Windows when sharing session files
6638 with Unix. The Unix version of Vim cannot source dos format scripts,
6639 but the Windows version of Vim can source unix format scripts.
6640
6641 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006642'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006643 global
6644 Name of the shell to use for ! and :! commands. When changing the
6645 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6646 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006647 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 See |option-backslash| about including spaces and backslashes.
6649 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006650
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006651 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006652 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6654< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006655 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006657 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006659 Example with escaped space (Vim will do this when initializing the
6660 option from $SHELL): >
6661 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006662< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006663 backslashes are consumed by `:set`.
6664
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 Under MS-Windows, when the executable ends in ".com" it must be
6666 included. Thus setting the shell to "command.com" or "4dos.com"
6667 works, but "command" and "4dos" do not work for all commands (e.g.,
6668 filtering).
6669 For unknown reasons, when using "4dos.com" the current directory is
6670 changed to "C:\". To avoid this set 'shell' like this: >
6671 :set shell=command.com\ /c\ 4dos
6672< This option cannot be set from a |modeline| or in the |sandbox|, for
6673 security reasons.
6674
6675 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006676'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006677 Win32, when 'shell' contains "powershell":
6678 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006679 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006682 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6683 For MS-Windows, the default is set according to the value of 'shell',
6684 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006685 On Unix it can have more than one flag. Each white space separated
6686 part is passed as an argument to the shell command.
6687 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006688 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 This option cannot be set from a |modeline| or in the |sandbox|, for
6690 security reasons.
6691
6692 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006693'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6694 "2>&1| tee", or
6695 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006697 {not available when compiled without the |+quickfix|
6698 feature}
6699 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006700 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 including spaces and backslashes.
6702 The name of the temporary file can be represented by "%s" if necessary
6703 (the file name is appended automatically if no %s appears in the value
6704 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006705 For the Amiga the default is ">". For MS-Windows using powershell the
6706 default is "2>&1 | Out-File -Encoding default", otherwise the default
6707 is ">%s 2>&1". The output is directly saved in a file and not echoed
6708 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006709 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006710 in a file and echoed to the screen. If the 'shell' option is "csh" or
6711 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006712 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006713 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6714 means that stderr is also included. Before using the 'shell' option a
6715 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006716 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6717 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 The initialization of this option is done after reading the ".vimrc"
6719 and the other initializations, so that when the 'shell' option is set
6720 there, the 'shellpipe' option changes automatically, unless it was
6721 explicitly set before.
6722 When 'shellpipe' is set to an empty string, no redirection of the
6723 ":make" output will be done. This is useful if you use a 'makeprg'
6724 that writes to 'makeef' by itself. If you want no piping, but do
6725 want to include the 'makeef', set 'shellpipe' to a single space.
6726 Don't forget to precede the space with a backslash: ":set sp=\ ".
6727 In the future pipes may be used for filtering and this option will
6728 become obsolete (at least for Unix).
6729 This option cannot be set from a |modeline| or in the |sandbox|, for
6730 security reasons.
6731
6732 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006733'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735 Quoting character(s), put around the command passed to the shell, for
6736 the "!" and ":!" commands. The redirection is kept outside of the
6737 quoting. See 'shellxquote' to include the redirection. It's
6738 probably not useful to set both options.
6739 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006740 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006741 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742 This option cannot be set from a |modeline| or in the |sandbox|, for
6743 security reasons.
6744
6745 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006746'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6747 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006748 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006749 String to be used to put the output of a filter command in a temporary
6750 file. See also |:!|. See |option-backslash| about including spaces
6751 and backslashes.
6752 The name of the temporary file can be represented by "%s" if necessary
6753 (the file name is appended automatically if no %s appears in the value
6754 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006755 The default is ">". For Unix, if the 'shell' option is "csh" or
6756 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006757 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006758 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6759 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006760 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6761 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006762 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6763 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 The initialization of this option is done after reading the ".vimrc"
6765 and the other initializations, so that when the 'shell' option is set
6766 there, the 'shellredir' option changes automatically unless it was
6767 explicitly set before.
6768 In the future pipes may be used for filtering and this option will
6769 become obsolete (at least for Unix).
6770 This option cannot be set from a |modeline| or in the |sandbox|, for
6771 security reasons.
6772
6773 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6774'shellslash' 'ssl' boolean (default off)
6775 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006776 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006778 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006779 powershell.exe. Backward slashes can still be typed, but they are
6780 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781 Note that setting or resetting this option has no effect for some
6782 existing file names, thus this option needs to be set before opening
6783 any file for best results. This might change in the future.
6784 'shellslash' only works when a backslash can be used as a path
6785 separator. To test if this is so use: >
6786 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006787< Also see 'completeslash'.
6788
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006789 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6790'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6791 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006792 When on, use temp files for shell commands. When off use a pipe.
6793 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006794 Currently a pipe is only supported on Unix and MS-Windows 2K and
6795 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006796 :if has("filterpipe")
6797< The advantage of using a pipe is that nobody can read the temp file
6798 and the 'shell' command does not need to support redirection.
6799 The advantage of using a temp file is that the file type and encoding
6800 can be detected.
6801 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6802 |FilterWritePost| autocommands event are not triggered when
6803 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006804 The `system()` function does not respect this option and always uses
6805 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006806 NOTE: This option is set to the Vim default value when 'compatible'
6807 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006808
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 *'shelltype'* *'st'*
6810'shelltype' 'st' number (default 0)
6811 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006812 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 On the Amiga this option influences the way how the commands work
6814 which use a shell.
6815 0 and 1: always use the shell
6816 2 and 3: use the shell only to filter lines
6817 4 and 5: use shell only for ':sh' command
6818 When not using the shell, the command is executed directly.
6819
6820 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6821 1 and 3: use "shell cmd" to start external commands
6822
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006823 *'shellxescape'* *'sxe'*
6824'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006825 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006826 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006827 When 'shellxquote' is set to "(" then the characters listed in this
6828 option will be escaped with a '^' character. This makes it possible
6829 to execute most external commands with cmd.exe.
6830
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831 *'shellxquote'* *'sxq'*
6832'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006833 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006834 for Win32, when 'shell' is
6835 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006836 for Win32, when 'shell' contains "sh"
6837 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 for Unix, when using system(): "\"")
6839 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840 Quoting character(s), put around the command passed to the shell, for
6841 the "!" and ":!" commands. Includes the redirection. See
6842 'shellquote' to exclude the redirection. It's probably not useful
6843 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006844 When the value is '(' then ')' is appended. When the value is '"('
6845 then ')"' is appended.
6846 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006847 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006848 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6849 pwsh.exe which automatically strips off the first and last quote on a
6850 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6851 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006852 'shell', to reduce the need to set this option by the user. See
6853 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854 This option cannot be set from a |modeline| or in the |sandbox|, for
6855 security reasons.
6856
6857 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6858'shiftround' 'sr' boolean (default off)
6859 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 Round indent to multiple of 'shiftwidth'. Applies to > and <
6861 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6862 a multiple of 'shiftwidth' (this is Vi compatible).
6863 NOTE: This option is reset when 'compatible' is set.
6864
6865 *'shiftwidth'* *'sw'*
6866'shiftwidth' 'sw' number (default 8)
6867 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006868 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006870 When zero the 'ts' value will be used. Use the |shiftwidth()|
6871 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872
6873 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006874'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6875 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 This option helps to avoid all the |hit-enter| prompts caused by file
6878 messages, for example with CTRL-G, and to avoid some other messages.
6879 It is a list of flags:
6880 flag meaning when present ~
6881 f use "(3 of 5)" instead of "(file 3 of 5)"
6882 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006883 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 m use "[+]" instead of "[Modified]"
6885 n use "[New]" instead of "[New File]"
6886 r use "[RO]" instead of "[readonly]"
6887 w use "[w]" instead of "written" for file write message
6888 and "[a]" instead of "appended" for ':w >> file' command
6889 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6890 "[unix format]" and "[mac]" instead of "[mac format]".
6891 a all of the above abbreviations
6892
6893 o overwrite message for writing a file with subsequent message
6894 for reading a file (useful for ":wn" or when 'autowrite' on)
6895 O message for reading a file overwrites any previous message.
6896 Also for quickfix message (e.g., ":cn").
6897 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006898 hit TOP, continuing at BOTTOM" messages; when using the search
6899 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006900 t truncate file message at the start if it is too long to fit
6901 on the command-line, "<" will appear in the left most column.
6902 Ignored in Ex mode.
6903 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006904 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905 Ignored in Ex mode.
6906 W don't give "written" or "[w]" when writing a file
6907 A don't give the "ATTENTION" message when an existing swap file
6908 is found.
6909 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006910 c don't give |ins-completion-menu| messages. For example,
6911 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6912 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006913 q use "recording" instead of "recording @a"
6914 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006915 was used for the command; note that this also affects messages
6916 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006917 S do not show search count message when searching, e.g.
6918 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919
6920 This gives you the opportunity to avoid that a change between buffers
6921 requires you to hit <Enter>, but still gives as useful a message as
6922 possible for the space available. To get the whole message that you
6923 would have got with 'shm' empty, use ":file!"
6924 Useful values:
6925 shm= No abbreviation of message.
6926 shm=a Abbreviation, but no loss of information.
6927 shm=at Abbreviation, and truncate message when necessary.
6928
6929 NOTE: This option is set to the Vi default value when 'compatible' is
6930 set and to the Vim default value when 'compatible' is reset.
6931
6932 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6933'shortname' 'sn' boolean (default off)
6934 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 Filenames are assumed to be 8 characters plus one extension of 3
6936 characters. Multiple dots in file names are not allowed. When this
6937 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006938 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006939 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006940 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941
6942 *'showbreak'* *'sbr'* *E595*
6943'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006944 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006945 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946 feature}
6947 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006948 values are "> " or "+++ ": >
6949 :set showbreak=>\
6950< Note the backslash to escape the trailing space. It's easier like
6951 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006952 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006953< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006954 comma (in a future version the comma might be used to separate the
6955 part that is shown at the end and at the start of a line).
6956 The characters are highlighted according to the '@' flag in
6957 'highlight'.
6958 Note that tabs after the showbreak will be displayed differently.
6959 If you want the 'showbreak' to appear in between line numbers, add the
6960 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006961 A window-local value overrules a global value. If the global value is
6962 set and you want no value in the current window use NONE: >
6963 :setlocal showbreak=NONE
6964<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006966'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6967 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 {not available when compiled without the
6970 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006971 Show (partial) command in the last line of the screen. Set this
6972 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 In Visual mode the size of the selected area is shown:
6974 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006975 If the number of bytes is different it is also displayed: "2-6"
6976 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006977 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006978 - When selecting a block, the size in screen characters:
6979 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006980 NOTE: This option is set to the Vi default value when 'compatible' is
6981 set and to the Vim default value when 'compatible' is reset.
6982
6983 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6984'showfulltag' 'sft' boolean (default off)
6985 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 When completing a word in insert mode (see |ins-completion|) from the
6987 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006988 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989 matched a C function, you can see a template for what arguments are
6990 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006991 Note that this doesn't work well together with having "longest" in
6992 'completeopt', because the completion from the search pattern may not
6993 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006994
6995 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6996'showmatch' 'sm' boolean (default off)
6997 global
6998 When a bracket is inserted, briefly jump to the matching one. The
6999 jump is only done if the match can be seen on the screen. The time to
7000 show the match can be set with 'matchtime'.
7001 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007002 seen or not).
7003 This option is reset when 'paste' is set and restored when 'paste' is
7004 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005 When the 'm' flag is not included in 'cpoptions', typing a character
7006 will immediately move the cursor back to where it belongs.
7007 See the "sm" field in 'guicursor' for setting the cursor shape and
7008 blinking when showing the match.
7009 The 'matchpairs' option can be used to specify the characters to show
7010 matches for. 'rightleft' and 'revins' are used to look for opposite
7011 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007012 Also see the matchparen plugin for highlighting the match when moving
7013 around |pi_paren.txt|.
7014 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015
7016 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7017'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7018 global
7019 If in Insert, Replace or Visual mode put a message on the last line.
7020 Use the 'M' flag in 'highlight' to set the type of highlighting for
7021 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007022 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007023 doesn't mean XIM is really active, especially when 'imactivatekey' is
7024 not set.
7025 NOTE: This option is set to the Vi default value when 'compatible' is
7026 set and to the Vim default value when 'compatible' is reset.
7027
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007028 *'showtabline'* *'stal'*
7029'showtabline' 'stal' number (default 1)
7030 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007031 The value of this option specifies when the line with tab page labels
7032 will be displayed:
7033 0: never
7034 1: only if there are at least two tab pages
7035 2: always
7036 This is both for the GUI and non-GUI implementation of the tab pages
7037 line.
7038 See |tab-page| for more information about tab pages.
7039
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040 *'sidescroll'* *'ss'*
7041'sidescroll' 'ss' number (default 0)
7042 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 The minimal number of columns to scroll horizontally. Used only when
7044 the 'wrap' option is off and the cursor is moved off of the screen.
7045 When it is zero the cursor will be put in the middle of the screen.
7046 When using a slow terminal set it to a large number or 0. When using
7047 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7048 commands.
7049
7050 *'sidescrolloff'* *'siso'*
7051'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007052 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007054 right of the cursor if 'nowrap' is set. Setting this option to a
7055 value greater than 0 while having |'sidescroll'| also at a non-zero
7056 value makes some context visible in the line you are scrolling in
7057 horizontally (except at beginning of the line). Setting this option
7058 to a large value (like 999) has the effect of keeping the cursor
7059 horizontally centered in the window, as long as one does not come too
7060 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007061 After using the local value, go back the global value with one of
7062 these two: >
7063 setlocal sidescrolloff<
7064 setlocal sidescrolloff=-1
7065< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066
7067 Example: Try this together with 'sidescroll' and 'listchars' as
7068 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007069 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070
7071 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7072 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007073<
7074 *'signcolumn'* *'scl'*
7075'signcolumn' 'scl' string (default "auto")
7076 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007077 {not available when compiled without the |+signs|
7078 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007079 Whether or not to draw the signcolumn. Valid values are:
7080 "auto" only when there is a sign to display
7081 "no" never
7082 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007083 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007084 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007085
7086
7087 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7088'smartcase' 'scs' boolean (default off)
7089 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090 Override the 'ignorecase' option if the search pattern contains upper
7091 case characters. Only used when the search pattern is typed and
7092 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007093 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7095 recalling the search pattern from history and hitting <Enter>.
7096 NOTE: This option is reset when 'compatible' is set.
7097
7098 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7099'smartindent' 'si' boolean (default off)
7100 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007101 {not available when compiled without the
7102 |+smartindent| feature}
7103 Do smart autoindenting when starting a new line. Works for C-like
7104 programs, but can also be used for other languages. 'cindent' does
7105 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007106 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007107 setting 'si' has no effect. 'indentexpr' is a more advanced
7108 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109 Normally 'autoindent' should also be on when using 'smartindent'.
7110 An indent is automatically inserted:
7111 - After a line ending in '{'.
7112 - After a line starting with a keyword from 'cinwords'.
7113 - Before a line starting with '}' (only with the "O" command).
7114 When typing '}' as the first character in a new line, that line is
7115 given the same indent as the matching '{'.
7116 When typing '#' as the first character in a new line, the indent for
7117 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007118 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7120 When using the ">>" command, lines starting with '#' are not shifted
7121 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007122 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007123 This option is reset when 'paste' is set and restored when 'paste' is
7124 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125
7126 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7127'smarttab' 'sta' boolean (default off)
7128 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007130 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7131 <BS> will delete a 'shiftwidth' worth of space at the start of the
7132 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007133 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007134 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7135 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007136 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007138 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007139 This option is reset when 'paste' is set and restored when 'paste' is
7140 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 NOTE: This option is reset when 'compatible' is set.
7142
7143 *'softtabstop'* *'sts'*
7144'softtabstop' 'sts' number (default 0)
7145 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 Number of spaces that a <Tab> counts for while performing editing
7147 operations, like inserting a <Tab> or using <BS>. It "feels" like
7148 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7149 used. This is useful to keep the 'ts' setting at its standard value
7150 of 8, while being able to edit like it is set to 'sts'. However,
7151 commands like "x" still work on the actual characters.
7152 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007153 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007154 'softtabstop' is set to 0 when the 'paste' option is set and restored
7155 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7157 spaces is minimized by using <Tab>s.
7158 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7159 set.
7160 NOTE: This option is set to 0 when 'compatible' is set.
7161
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007162 If Vim is compiled with the |+vartabs| feature then the value of
7163 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7164 anything other than an empty string.
7165
Bram Moolenaar217ad922005-03-20 22:37:15 +00007166 *'spell'* *'nospell'*
7167'spell' boolean (default off)
7168 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007169 {not available when compiled without the |+syntax|
7170 feature}
7171 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007172 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007173
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007174 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007175'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007176 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007177 {not available when compiled without the |+syntax|
7178 feature}
7179 Pattern to locate the end of a sentence. The following word will be
7180 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007181 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007182 When this check is not wanted make this option empty.
7183 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007184 Be careful with special characters, see |option-backslash| about
7185 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007186 To set this option automatically depending on the language, see
7187 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007188
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007189 *'spellfile'* *'spf'*
7190'spellfile' 'spf' string (default empty)
7191 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007192 {not available when compiled without the |+syntax|
7193 feature}
7194 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007195 commands. It must end in ".{encoding}.add". You need to include the
7196 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007197 *E765*
7198 It may also be a comma separated list of names. A count before the
7199 |zg| and |zw| commands can be used to access each. This allows using
7200 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007201 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007202 you: Using the first directory in 'runtimepath' that is writable. If
7203 there is no "spell" directory yet it will be created. For the file
7204 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007205 ignoring the region.
7206 The resulting ".spl" file will be used for spell checking, it does not
7207 have to appear in 'spelllang'.
7208 Normally one file is used for all regions, but you can add the region
7209 name if you want to. However, it will then only be used when
7210 'spellfile' is set to it, for entries in 'spelllang' only files
7211 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007212 This option cannot be set from a |modeline| or in the |sandbox|, for
7213 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007214
Bram Moolenaar217ad922005-03-20 22:37:15 +00007215 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007216'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007217 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007218 {not available when compiled without the |+syntax|
7219 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007220 A comma separated list of word list names. When the 'spell' option is
7221 on spellchecking will be done for these languages. Example: >
7222 set spelllang=en_us,nl,medical
7223< This means US English, Dutch and medical words are recognized. Words
7224 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007225 The word list name must consist of alphanumeric characters, a dash or
7226 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007227 recommended to separate the two letter language name from a
7228 specification. Thus "en-rare" is used for rare English words.
7229 A region name must come last and have the form "_xx", where "xx" is
7230 the two-letter, lower case region name. You can use more than one
7231 region by listing them: "en_us,en_ca" supports both US and Canadian
7232 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007233 Britain. (Note: currently en_au and en_nz dictionaries are older than
7234 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007235 If the name "cjk" is included East Asian characters are excluded from
7236 spell checking. This is useful when editing text that also has Asian
7237 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007238 Note that the "medical" dictionary does not exist, it is just an
7239 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007240 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007241 As a special case the name of a .spl file can be given as-is. The
7242 first "_xx" in the name is removed and used as the region name
7243 (_xx is an underscore, two letters and followed by a non-letter).
7244 This is mainly for testing purposes. You must make sure the correct
7245 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007246 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007247 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7248 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007249 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007250
Bram Moolenaar98692072006-02-04 00:57:42 +00007251 If the |spellfile.vim| plugin is active and you use a language name
7252 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7253 will ask you if you want to download the file.
7254
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007255 After this option has been set successfully, Vim will source the files
7256 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007257 up to the first character that is not an ASCII letter or number and
7258 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007259
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007260 *'spelloptions'* *'spo'*
7261'spelloptions' 'spo' string (default "")
7262 local to buffer
7263 {not available when compiled without the |+syntax|
7264 feature}
7265 A comma separated list of options for spell checking:
7266 camel When a word is CamelCased, assume "Cased" is a
7267 separate word: every upper-case character in a word
7268 that comes after a lower case character indicates the
7269 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007270
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007271 *'spellsuggest'* *'sps'*
7272'spellsuggest' 'sps' string (default "best")
7273 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007274 {not available when compiled without the |+syntax|
7275 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007276 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007277 the |spellsuggest()| function. This is a comma-separated list of
7278 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007279
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007280 best Internal method that works best for English. Finds
7281 changes like "fast" and uses a bit of sound-a-like
7282 scoring to improve the ordering.
7283
7284 double Internal method that uses two methods and mixes the
7285 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007286 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007287 word. That only works when the language specifies
7288 sound folding. Can be slow and doesn't always give
7289 better results.
7290
7291 fast Internal method that only checks for simple changes:
7292 character inserts/deletes/swaps. Works well for
7293 simple typing mistakes.
7294
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007295 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007296 Not used for |spellsuggest()|. The number of
7297 suggestions is never more than the value of 'lines'
7298 minus two.
7299
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007300 file:{filename} Read file {filename}, which must have two columns,
7301 separated by a slash. The first column contains the
7302 bad word, the second column the suggested good word.
7303 Example:
7304 theribal/terrible ~
7305 Use this for common mistakes that do not appear at the
7306 top of the suggestion list with the internal methods.
7307 Lines without a slash are ignored, use this for
7308 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007309 The word in the second column must be correct,
7310 otherwise it will not be used. Add the word to an
7311 ".add" file if it is currently flagged as a spelling
7312 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007313 The file is used for all languages.
7314
7315 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7316 trouble with spaces. |v:val| holds the badly spelled
7317 word. The expression must evaluate to a List of
7318 Lists, each with a suggestion and a score.
7319 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007320 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007321 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007322 internal methods use. A lower score is better.
7323 This may invoke |spellsuggest()| if you temporarily
7324 set 'spellsuggest' to exclude the "expr:" part.
7325 Errors are silently ignored, unless you set the
7326 'verbose' option to a non-zero value.
7327
7328 Only one of "best", "double" or "fast" may be used. The others may
7329 appear several times in any order. Example: >
7330 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7331<
7332 This option cannot be set from a |modeline| or in the |sandbox|, for
7333 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007334
7335
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7337'splitbelow' 'sb' boolean (default off)
7338 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007339 When on, splitting a window will put the new window below the current
7340 one. |:split|
7341
7342 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7343'splitright' 'spr' boolean (default off)
7344 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345 When on, splitting a window will put the new window right of the
7346 current one. |:vsplit|
7347
7348 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7349'startofline' 'sol' boolean (default on)
7350 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007352 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007353 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007354 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355 with a linewise operator, with "%" with a count and to buffer changing
7356 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7357 only has a line number, e.g., ":25" or ":+".
7358 In case of buffer changing commands the cursor is placed at the column
7359 where it was the last time the buffer was edited.
7360 NOTE: This option is set when 'compatible' is set.
7361
Bram Moolenaar00654022011-02-25 14:42:19 +01007362 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007364 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007365 {not available when compiled without the |+statusline|
7366 feature}
7367 When nonempty, this option determines the content of the status line.
7368 Also see |status-line|.
7369
7370 The option consists of printf style '%' items interspersed with
7371 normal text. Each status line item is of the form:
7372 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007373 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007374 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375
Bram Moolenaar238a5642006-02-21 22:12:05 +00007376 When the option starts with "%!" then it is used as an expression,
7377 evaluated and the result is used as the option value. Example: >
7378 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007379< The *g:statusline_winid* variable will be set to the |window-ID| of the
7380 window that the status line belongs to.
7381 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007382 Note that the "%!" expression is evaluated in the context of the
7383 current window and buffer, while %{} items are evaluated in the
7384 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007385
7386 When there is error while evaluating the option then it will be made
7387 empty to avoid further errors. Otherwise screen updating would loop.
7388
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389 Note that the only effect of 'ruler' when this option is set (and
7390 'laststatus' is 2) is controlling the output of |CTRL-G|.
7391
7392 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007393 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007395 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 minwid Minimum width of the item, padding as set by '-' & '0'.
7397 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007398 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399 on the left for text items. Numeric items will be
7400 shifted down to maxwid-2 digits followed by '>'number
7401 where number is the amount of missing digits, much like
7402 an exponential notation.
7403 item A one letter code as described below.
7404
7405 Following is a description of the possible statusline items. The
7406 second character in "item" is the type:
7407 N for number
7408 S for string
7409 F for flags as described below
7410 - not applicable
7411
7412 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007413 f S Path to the file in the buffer, as typed or relative to current
7414 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007415 F S Full path to the file in the buffer.
7416 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007417 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007419 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007420 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007421 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007423 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007425 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007426 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007427 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7429 being used: "<keymap>"
7430 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007431 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 B N As above, in hexadecimal.
7433 o N Byte number in file of byte under cursor, first byte is 1.
7434 Mnemonic: Offset from start of file (with one added)
7435 {not available when compiled without |+byte_offset| feature}
7436 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007437 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007438 l N Line number.
7439 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007440 c N Column number (byte index).
7441 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007442 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 p N Percentage through file in lines as in |CTRL-G|.
7444 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007445 percentage described for 'ruler'. Always 3 in length, unless
7446 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007447 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007449 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007450 Note that there is no '%' before the closing '}'. The
7451 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007452 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007453 {% - This is almost same as { except the result of the expression is
7454 re-evaluated as a statusline format string. Thus if the
7455 return value of expr contains % items they will get expanded.
7456 The expression can contain the } character, the end of
7457 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007458 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007459 func! Stl_filename() abort
7460 return "%t"
7461 endfunc
7462< `stl=%{Stl_filename()}` results in `"%t"`
7463 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007464 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465 ( - Start of item group. Can be used for setting the width and
7466 alignment of a section. Must be followed by %) somewhere.
7467 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007468 T N For 'tabline': start of tab page N label. Use %T after the last
7469 label. This information is used for mouse clicks.
7470 X N For 'tabline': start of close tab N label. Use %X after the
7471 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7472 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007473 < - Where to truncate line if too long. Default is at the start.
7474 No width fields allowed.
7475 = - Separation point between left and right aligned items.
7476 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007477 # - Set highlight group. The name must follow and then a # again.
7478 Thus use %#HLname# for highlight group HLname. The same
7479 highlighting is used, also for the statusline of non-current
7480 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007482 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007483 The difference between User{N} and StatusLine will be applied
7484 to StatusLineNC for the statusline of non-current windows.
7485 The number N must be between 1 and 9. See |hl-User1..9|
7486
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007487 When displaying a flag, Vim removes the leading comma, if any, when
7488 that flag comes right after plaintext. This will make a nice display
7489 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490
Bram Moolenaar582fd852005-03-28 20:58:01 +00007491 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492 not set) and a minwid is not set for the group, the whole group will
7493 become empty. This will make a group like the following disappear
7494 completely from the statusline when none of the flags are set. >
7495 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007496< Beware that an expression is evaluated each and every time the status
7497 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007498 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007499 While evaluating %{} the current buffer and current window will be set
7500 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007501 currently being drawn. The expression will evaluate in this context.
7502 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7503 real current buffer and "g:actual_curwin" to the |window-ID| of the
7504 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007505
Bram Moolenaar30b65812012-07-12 22:01:11 +02007506 The 'statusline' option will be evaluated in the |sandbox| if set from
7507 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007508 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007509
7510 It is not allowed to change text or jump to another window while
7511 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007512
7513 If the statusline is not updated when you want it (e.g., after setting
7514 a variable that's used in an expression), you can force an update by
7515 setting an option without changing its value. Example: >
7516 :let &ro = &ro
7517
7518< A result of all digits is regarded a number for display purposes.
7519 Otherwise the result is taken as flag text and applied to the rules
7520 described above.
7521
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007522 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007524 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525
7526 Examples:
7527 Emulate standard status line with 'ruler' set >
7528 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7529< Similar, but add ASCII value of char under the cursor (like "ga") >
7530 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7531< Display byte count and byte value, modified flag in red. >
7532 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7533 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7534< Display a ,GZ flag if a compressed file is loaded >
7535 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7536< In the |:autocmd|'s: >
7537 :let b:gzflag = 1
7538< And: >
7539 :unlet b:gzflag
7540< And define this function: >
7541 :function VarExists(var, val)
7542 : if exists(a:var) | return a:val | else | return '' | endif
7543 :endfunction
7544<
7545 *'suffixes'* *'su'*
7546'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7547 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548 Files with these suffixes get a lower priority when multiple files
7549 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007550 suffixes. Spaces after the comma are ignored. A dot is also seen as
7551 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 separator, precede it with a backslash (see |option-backslash| about
7553 including spaces and backslashes).
7554 See 'wildignore' for completely ignoring files.
7555 The use of |:set+=| and |:set-=| is preferred when adding or removing
7556 suffixes from the list. This avoids problems when a future version
7557 uses another default.
7558
7559 *'suffixesadd'* *'sua'*
7560'suffixesadd' 'sua' string (default "")
7561 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 {not available when compiled without the
7563 |+file_in_path| feature}
7564 Comma separated list of suffixes, which are used when searching for a
7565 file for the "gf", "[I", etc. commands. Example: >
7566 :set suffixesadd=.java
7567<
7568 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7569'swapfile' 'swf' boolean (default on)
7570 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007571 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007572 swapfile is not wanted for a specific buffer. For example, with
7573 confidential information that even root must not be able to access.
7574 Careful: All text will be in memory:
7575 - Don't use this for big files.
7576 - Recovery will be impossible!
7577 A swapfile will only be present when |'updatecount'| is non-zero and
7578 'swapfile' is set.
7579 When 'swapfile' is reset, the swap file for the current buffer is
7580 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7581 non-zero, a swap file is immediately created.
7582 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007583 If you want to open a new buffer without creating a swap file for it,
7584 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007585 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586
7587 This option is used together with 'bufhidden' and 'buftype' to
7588 specify special kinds of buffers. See |special-buffers|.
7589
7590 *'swapsync'* *'sws'*
7591'swapsync' 'sws' string (default "fsync")
7592 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007593 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007594 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595 When this option is empty parts of the swap file may be in memory and
7596 not written to disk. When the system crashes you may lose more work.
7597 On Unix the system does a sync now and then without Vim asking for it,
7598 so the disadvantage of setting this option off is small. On some
7599 systems the swap file will not be written at all. For a unix system
7600 setting it to "sync" will use the sync() call instead of the default
7601 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007602 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603
7604 *'switchbuf'* *'swb'*
7605'switchbuf' 'swb' string (default "")
7606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007607 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007608 Mostly for |quickfix| commands some values are also used for other
7609 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007610 Possible values (comma separated list):
7611 useopen If included, jump to the first open window that
7612 contains the specified buffer (if there is one).
7613 Otherwise: Do not examine other windows.
7614 This setting is checked with |quickfix| commands, when
7615 jumping to errors (":cc", ":cn", "cp", etc.). It is
7616 also used in all buffer related split commands, for
7617 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007618 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007619 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007621 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007622 Otherwise: do not split, use current window (when used
7623 in the quickfix window: the previously used window or
7624 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007625 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007626 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007627 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007628 uselast If included, jump to the previously used window when
7629 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007630
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007631 *'synmaxcol'* *'smc'*
7632'synmaxcol' 'smc' number (default 3000)
7633 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007634 {not available when compiled without the |+syntax|
7635 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007636 Maximum column in which to search for syntax items. In long lines the
7637 text after this column is not highlighted and following lines may not
7638 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007639 This helps to avoid very slow redrawing for an XML file that is one
7640 long line.
7641 Set to zero to remove the limit.
7642
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643 *'syntax'* *'syn'*
7644'syntax' 'syn' string (default empty)
7645 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 {not available when compiled without the |+syntax|
7647 feature}
7648 When this option is set, the syntax with this name is loaded, unless
7649 syntax highlighting has been switched off with ":syntax off".
7650 Otherwise this option does not always reflect the current syntax (the
7651 b:current_syntax variable does).
7652 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007653 not automatically recognized. Example, in an IDL file:
7654 /* vim: set syntax=idl : */ ~
7655 When a dot appears in the value then this separates two filetype
7656 names. Example:
7657 /* vim: set syntax=c.doxygen : */ ~
7658 This will use the "c" syntax first, then the "doxygen" syntax.
7659 Note that the second one must be prepared to be loaded as an addition,
7660 otherwise it will be skipped. More than one dot may appear.
7661 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007662 :set syntax=OFF
7663< To switch syntax highlighting on according to the current value of the
7664 'filetype' option: >
7665 :set syntax=ON
7666< What actually happens when setting the 'syntax' option is that the
7667 Syntax autocommand event is triggered with the value as argument.
7668 This option is not copied to another buffer, independent of the 's' or
7669 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007670 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007671
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007672 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007673'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007674 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007675 When nonempty, this option determines the content of the tab pages
7676 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007677 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007678
7679 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007680 option and only when there is no GUI tab line. When 'e' is in
7681 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007682 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007683
7684 The value is evaluated like with 'statusline'. You can use
7685 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007686 the text to be displayed. Use "%1T" for the first label, "%2T" for
7687 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007688
Bram Moolenaare12bab32019-01-08 22:02:56 +01007689 When changing something that is used in 'tabline' that does not
7690 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007691 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007692
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007693 Keep in mind that only one of the tab pages is the current one, others
7694 are invisible and you can't jump to their windows.
7695
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007696
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007697 *'tabpagemax'* *'tpm'*
7698'tabpagemax' 'tpm' number (default 10)
7699 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007700 Maximum number of tab pages to be opened by the |-p| command line
7701 argument or the ":tab all" command. |tabpage|
7702
7703
7704 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007705'tabstop' 'ts' number (default 8)
7706 local to buffer
7707 Number of spaces that a <Tab> in the file counts for. Also see
7708 |:retab| command, and 'softtabstop' option.
7709
7710 Note: Setting 'tabstop' to any other value than 8 can make your file
7711 appear wrong in many places (e.g., when printing it).
7712
7713 There are four main ways to use tabs in Vim:
7714 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7715 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007716 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007717 behave like a tab appears every 4 (or 3) characters.
7718 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7719 'expandtab'. This way you will always insert spaces. The
7720 formatting will never be messed up when 'tabstop' is changed.
7721 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007722 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723 works when using Vim to edit the file.
7724 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7725 'noexpandtab'. This should then work (for initial indents only)
7726 for any tabstop setting that people use. It might be nice to have
7727 tabs after the first non-blank inserted as spaces if you do this
7728 though. Otherwise aligned comments will be wrong when 'tabstop' is
7729 changed.
7730
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007731 If Vim is compiled with the |+vartabs| feature then the value of
7732 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7733 than an empty string.
7734
Bram Moolenaar071d4272004-06-13 20:20:40 +00007735 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7736'tagbsearch' 'tbs' boolean (default on)
7737 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007738 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007739 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740 searching makes searching for a tag a LOT faster, but a linear search
7741 will find more tags if the tags file wasn't properly sorted.
7742 Vim normally assumes that your tags files are sorted, or indicate that
7743 they are not sorted. Only when this is not the case does the
7744 'tagbsearch' option need to be switched off.
7745
7746 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007747 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007748 certain files, or retry all files with a linear search. When
7749 'tagbsearch' is off, only a linear search is done.
7750
7751 Linear searching is done anyway, for one file, when Vim finds a line
7752 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007753 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007754< [The whitespace before and after the '0' must be a single <Tab>]
7755
7756 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007757 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758 instead of a normal tag name, a retry is done with a linear search.
7759 Tags in unsorted tags files, and matches with different case will only
7760 be found in the retry.
7761
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007762 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007763 linear search can be avoided when case is ignored. Use a value of '2'
7764 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7765 sorted with the -f switch to "sort" in most unices, as in the command:
7766 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7767 (at least 5.5) the --sort=foldcase switch can be used for this as
7768 well. Note that case must be folded to uppercase for this to work.
7769
7770 By default, tag searches are case-sensitive. Case is ignored when
7771 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7772 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007773 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7774 'tagcase' is "smart", and the pattern contains only lowercase
7775 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007776
7777 When 'tagbsearch' is off, tags searching is slower when a full match
7778 exists, but faster when no full match exists. Tags in unsorted tags
7779 files may only be found with 'tagbsearch' off.
7780 When the tags file is not sorted, or sorted in a wrong way (not on
7781 ASCII byte value), 'tagbsearch' should be off, or the line given above
7782 must be included in the tags file.
7783 This option doesn't affect commands that find all matching tags (e.g.,
7784 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007785
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007786 *'tagcase'* *'tc'*
7787'tagcase' 'tc' string (default "followic")
7788 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007789 This option specifies how case is handled when searching the tags
7790 file:
7791 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007792 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007793 ignore Ignore case
7794 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007795 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007796 NOTE: This option is set to the Vi default value when 'compatible' is
7797 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007798
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007799 *'tagfunc'* *'tfu'*
7800'tagfunc' 'tfu' string (default: empty)
7801 local to buffer
7802 {not available when compiled without the |+eval|
7803 feature}
7804 This option specifies a function to be used to perform tag searches.
7805 The function gets the tag pattern and should return a List of matching
7806 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007807 function and an example. The value can be the name of a function, a
7808 |lambda| or a |Funcref|. See |option-value-function| for more
7809 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007810
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811 *'taglength'* *'tl'*
7812'taglength' 'tl' number (default 0)
7813 global
7814 If non-zero, tags are significant up to this number of characters.
7815
7816 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7817'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7818 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007819 If on and using a tags file in another directory, file names in that
7820 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821 NOTE: This option is set to the Vi default value when 'compatible' is
7822 set and to the Vim default value when 'compatible' is reset.
7823
7824 *'tags'* *'tag'* *E433*
7825'tags' 'tag' string (default "./tags,tags", when compiled with
7826 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7827 global or local to buffer |global-local|
7828 Filenames for the tag command, separated by spaces or commas. To
7829 include a space or comma in a file name, precede it with a backslash
7830 (see |option-backslash| about including spaces and backslashes).
7831 When a file name starts with "./", the '.' is replaced with the path
7832 of the current file. But only when the 'd' flag is not included in
7833 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7834 |tags-option|.
7835 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007836 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7837 find all files named "tags" below "/lib". The filename itself cannot
7838 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7839 files called "tags?". {not available when compiled without the
7840 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007841 The |tagfiles()| function can be used to get a list of the file names
7842 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007843 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7844 files are also supported. They are automatically recognized. The
7845 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7846 differences are ignored (MS-Windows). |emacs-tags|
7847 The use of |:set+=| and |:set-=| is preferred when adding or removing
7848 file names from the list. This avoids problems when a future version
7849 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850
7851 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7852'tagstack' 'tgst' boolean (default on)
7853 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854 When on, the |tagstack| is used normally. When off, a ":tag" or
7855 ":tselect" command with an argument will not push the tag onto the
7856 tagstack. A following ":tag" without an argument, a ":pop" command or
7857 any other command that uses the tagstack will use the unmodified
7858 tagstack, but does change the pointer to the active entry.
7859 Resetting this option is useful when using a ":tag" command in a
7860 mapping which should not change the tagstack.
7861
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007862 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007863'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007864 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007865 {only available when compiled with the |+tcl/dyn|
7866 feature}
7867 Specifies the name of the Tcl shared library. The default is
7868 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007869 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007870 This option cannot be set from a |modeline| or in the |sandbox|, for
7871 security reasons.
7872
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873 *'term'* *E529* *E530* *E531*
7874'term' string (default is $TERM, if that fails:
7875 in the GUI: "builtin_gui"
7876 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007877 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 on Unix: "ansi"
7880 on VMS: "ansi"
7881 on Win 32: "win32")
7882 global
7883 Name of the terminal. Used for choosing the terminal control
7884 characters. Environment variables are expanded |:set_env|.
7885 For example: >
7886 :set term=$TERM
7887< See |termcap|.
7888
7889 *'termbidi'* *'tbidi'*
7890 *'notermbidi'* *'notbidi'*
7891'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007893 {only available when compiled with the |+arabic|
7894 feature}
7895 The terminal is in charge of Bi-directionality of text (as specified
7896 by Unicode). The terminal is also expected to do the required shaping
7897 that some languages (such as Arabic) require.
7898 Setting this option implies that 'rightleft' will not be set when
7899 'arabic' is set and the value of 'arabicshape' will be ignored.
7900 Note that setting 'termbidi' has the immediate effect that
7901 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7902 This option is reset when the GUI is started.
7903 For further details see |arabic.txt|.
7904
7905 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007906'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007908 Encoding used for the terminal. This specifies what character
7909 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007910 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007911 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007912 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007913 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7915 Any attempts to set a different value will be rejected, and an error
7916 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007917 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918 because the Win32 system always passes Unicode characters.
7919 When empty, the same encoding is used as for the 'encoding' option.
7920 This is the normal value.
7921 Not all combinations for 'termencoding' and 'encoding' are valid. See
7922 |encoding-table|.
7923 The value for this option must be supported by internal conversions or
7924 iconv(). When this is not possible no conversion will be done and you
7925 will probably experience problems with non-ASCII characters.
7926 Example: You are working with the locale set to euc-jp (Japanese) and
7927 want to edit a UTF-8 file: >
7928 :let &termencoding = &encoding
7929 :set encoding=utf-8
7930< You need to do this when your system has no locale support for UTF-8.
7931
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007932 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007933'termguicolors' 'tgc' boolean (default off)
7934 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007935 {not available when compiled without the
7936 |+termguicolors| feature}
7937 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007938 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007939
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007940 Requires a ISO-8613-3 compatible terminal. If setting this option
7941 does not work (produces a colorless UI) reading |xterm-true-color|
7942 might help.
7943
7944 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7945 is required. Use this check to find out: >
7946 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007947< This requires Vim to be built with the |+vtp| feature.
7948
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007949 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007950 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007951
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007952 *'termwinkey'* *'twk'*
7953'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007954 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007955 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007956 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007957 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007958 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007959< The string must be one key stroke but can be multiple bytes.
7960 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007961 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007962 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007963
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007964 *'termwinscroll'* *'twsl'*
7965'termwinscroll' 'twsl' number (default 10000)
7966 local to buffer
7967 {not available when compiled without the
7968 |+terminal| feature}
7969 Number of scrollback lines to keep. When going over this limit the
7970 first 10% of the scrollback lines are deleted. This is just to reduce
7971 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00007972 Also used as a limit for text sent to the terminal in one write,
7973 multiplied by the number of columns times 3 (average number of bytes
7974 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007975
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007976 *'termwinsize'* *'tws'*
7977'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007978 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007979 Size used when opening the |terminal| window. Format:
7980 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007981 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007982 - When set with a "x" (e.g., "24x80") the terminal size is not
7983 adjusted to the window size. If the window is smaller only the
7984 top-left part is displayed.
7985 - When set with a "*" (e.g., "10*50") the terminal size follows the
7986 window size, but will not be smaller than the specified rows and/or
7987 columns.
7988 - When rows is zero then use the height of the window.
7989 - When columns is zero then use the width of the window.
7990 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007991 - Can be overruled in the |term_start()| options with "term_rows" and
7992 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02007993
7994 Examples:
7995 "30x0" uses 30 rows and the current window width.
7996 "20*0" uses at least 20 rows and the current window width.
7997 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007998 Note that the command running in the terminal window may still change
7999 the size of the terminal. In that case the Vim window will be
8000 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008001
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008002 *'termwintype'* *'twt'*
8003'termwintype' 'twt' string (default "")
8004 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008005 {only available when compiled with the |terminal|
8006 feature on MS-Windows}
8007 Specify the virtual console (pty) used when opening the terminal
8008 window.
8009
8010 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008011 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008012 "winpty" use winpty, fail if not supported
8013 "conpty" use |ConPTY|, fail if not supported
8014
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008015 |ConPTY| support depends on the platform. Windows 10 October 2018
8016 Update is the first version that supports ConPTY, however it is still
8017 considered unstable. ConPTY might become stable in the next release
8018 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008019 supported then you cannot open a terminal window.
8020
Bram Moolenaar071d4272004-06-13 20:20:40 +00008021 *'terse'* *'noterse'*
8022'terse' boolean (default off)
8023 global
8024 When set: Add 's' flag to 'shortmess' option (this makes the message
8025 for a search that hits the start or end of the file not being
8026 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8027 shortens a lot of messages}
8028
8029 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8030'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032 This option is obsolete. Use 'fileformats'.
8033 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8034 set to the default value for the current system. When 'textauto' is
8035 reset, 'fileformats' is made empty.
8036 NOTE: This option is set to the Vi default value when 'compatible' is
8037 set and to the Vim default value when 'compatible' is reset.
8038
8039 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008040'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008041 others: default off)
8042 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043 This option is obsolete. Use 'fileformat'.
8044 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8045 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8046 "unix".
8047
8048 *'textwidth'* *'tw'*
8049'textwidth' 'tw' number (default 0)
8050 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008051 Maximum width of text that is being inserted. A longer line will be
8052 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008053 this.
8054 'textwidth' is set to 0 when the 'paste' option is set and restored
8055 when 'paste' is reset.
8056 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008057 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008058 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008059 NOTE: This option is set to 0 when 'compatible' is set.
8060
8061 *'thesaurus'* *'tsr'*
8062'thesaurus' 'tsr' string (default "")
8063 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008065 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8066 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008067
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008068 This option is not used if 'thesaurusfunc' is set, either for the
8069 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008070
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008071 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008072 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008073 name. See |option-backslash| about using backslashes. The use of
8074 |:set+=| and |:set-=| is preferred when adding or removing directories
8075 from the list. This avoids problems when a future version uses
8076 another default. Backticks cannot be used in this option for security
8077 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008079 *'thesaurusfunc'* *tsrfu'*
8080'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008081 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008082 {not available when compiled without the |+eval|
8083 feature}
8084 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008085 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008086 The value can be the name of a function, a |lambda| or a |Funcref|.
8087 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008088
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008089 This option cannot be set from a |modeline| or in the |sandbox|, for
8090 security reasons.
8091
Bram Moolenaar071d4272004-06-13 20:20:40 +00008092 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8093'tildeop' 'top' boolean (default off)
8094 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008095 When on: The tilde command "~" behaves like an operator.
8096 NOTE: This option is reset when 'compatible' is set.
8097
8098 *'timeout'* *'to'* *'notimeout'* *'noto'*
8099'timeout' 'to' boolean (default on)
8100 global
8101 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008102'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008103 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008104 These two options together determine the behavior when part of a
8105 mapped key sequence or keyboard code has been received:
8106
8107 'timeout' 'ttimeout' action ~
8108 off off do not time out
8109 on on or off time out on :mappings and key codes
8110 off on time out on key codes
8111
8112 If both options are off, Vim will wait until either the complete
8113 mapping or key sequence has been received, or it is clear that there
8114 is no mapping or key sequence for the received characters. For
8115 example: if you have mapped "vl" and Vim has received 'v', the next
8116 character is needed to see if the 'v' is followed by an 'l'.
8117 When one of the options is on, Vim will wait for about 1 second for
8118 the next character to arrive. After that the already received
8119 characters are interpreted as single characters. The waiting time can
8120 be changed with the 'timeoutlen' option.
8121 On slow terminals or very busy systems timing out may cause
8122 malfunctioning cursor keys. If both options are off, Vim waits
8123 forever after an entered <Esc> if there are key codes that start
8124 with <Esc>. You will have to type <Esc> twice. If you do not have
8125 problems with key codes, but would like to have :mapped key
8126 sequences not timing out in 1 second, set the 'ttimeout' option and
8127 reset the 'timeout' option.
8128
8129 NOTE: 'ttimeout' is reset when 'compatible' is set.
8130
8131 *'timeoutlen'* *'tm'*
8132'timeoutlen' 'tm' number (default 1000)
8133 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008134
Bram Moolenaar071d4272004-06-13 20:20:40 +00008135 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008136'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008137 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008138 The time in milliseconds that is waited for a key code or mapped key
8139 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8140 when part of a command has been typed.
8141 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8142 different timeout value for key codes is desired set 'ttimeoutlen' to
8143 a non-negative number.
8144
8145 ttimeoutlen mapping delay key code delay ~
8146 < 0 'timeoutlen' 'timeoutlen'
8147 >= 0 'timeoutlen' 'ttimeoutlen'
8148
8149 The timeout only happens when the 'timeout' and 'ttimeout' options
8150 tell so. A useful setting would be >
8151 :set timeout timeoutlen=3000 ttimeoutlen=100
8152< (time out on mapping after three seconds, time out on key codes after
8153 a tenth of a second).
8154
8155 *'title'* *'notitle'*
8156'title' boolean (default off, on when title can be restored)
8157 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008158 When on, the title of the window will be set to the value of
8159 'titlestring' (if it is not empty), or to:
8160 filename [+=-] (path) - VIM
8161 Where:
8162 filename the name of the file being edited
8163 - indicates the file cannot be modified, 'ma' off
8164 + indicates the file was modified
8165 = indicates the file is read-only
8166 =+ indicates the file is read-only and modified
8167 (path) is the path of the file being edited
8168 - VIM the server name |v:servername| or "VIM"
8169 Only works if the terminal supports setting window titles
8170 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008171 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008172 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8173 *X11*
8174 When Vim was compiled with HAVE_X11 defined, the original title will
8175 be restored if possible. The output of ":version" will include "+X11"
8176 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8177 works for the icon name |'icon'|.
8178 But: When Vim was started with the |-X| argument, restoring the title
8179 will not work (except in the GUI).
8180 If the title cannot be restored, it is set to the value of 'titleold'.
8181 You might want to restore the title outside of Vim then.
8182 When using an xterm from a remote machine you can use this command:
8183 rsh machine_name xterm -display $DISPLAY &
8184 then the WINDOWID environment variable should be inherited and the
8185 title of the window should change back to what it should be after
8186 exiting Vim.
8187
8188 *'titlelen'*
8189'titlelen' number (default 85)
8190 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008191 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008192 title. When the title is longer, only the end of the path name is
8193 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008194 Using a percentage makes this adapt to the width of the window. But
8195 it won't work perfectly, because the actual number of characters
8196 available also depends on the font used and other things in the title
8197 bar. When 'titlelen' is zero the full path is used. Otherwise,
8198 values from 1 to 30000 percent can be used.
8199 'titlelen' is also used for the 'titlestring' option.
8200
8201 *'titleold'*
8202'titleold' string (default "Thanks for flying Vim")
8203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008204 This option will be used for the window title when exiting Vim if the
8205 original title cannot be restored. Only happens if 'title' is on or
8206 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008207 This option cannot be set from a |modeline| or in the |sandbox|, for
8208 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008209 *'titlestring'*
8210'titlestring' string (default "")
8211 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008212 When this option is not empty, it will be used for the title of the
8213 window. This happens only when the 'title' option is on.
8214 Only works if the terminal supports setting window titles (currently
8215 Amiga console, Win32 console, all GUI versions and terminals with a
8216 non-empty 't_ts' option).
8217 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008218 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008219
Bram Moolenaar071d4272004-06-13 20:20:40 +00008220 When this option contains printf-style '%' items, they will be
8221 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008222 This option cannot be set in a modeline when 'modelineexpr' is off.
8223
Bram Moolenaar071d4272004-06-13 20:20:40 +00008224 Example: >
8225 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8226 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8227< The value of 'titlelen' is used to align items in the middle or right
8228 of the available space.
8229 Some people prefer to have the file name first: >
8230 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8231< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008232 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008233 separating space only when needed.
8234 NOTE: Use of special characters in 'titlestring' may cause the display
8235 to be garbled (e.g., when it contains a CR or NL character).
8236 {not available when compiled without the |+statusline| feature}
8237
8238 *'toolbar'* *'tb'*
8239'toolbar' 'tb' string (default "icons,tooltips")
8240 global
8241 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8242 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008243 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008244 possible values are:
8245 icons Toolbar buttons are shown with icons.
8246 text Toolbar buttons shown with text.
8247 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008248 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008249 tooltips Tooltips are active for toolbar buttons.
8250 Tooltips refer to the popup help text which appears after the mouse
8251 cursor is placed over a toolbar button for a brief moment.
8252
8253 If you want the toolbar to be shown with icons as well as text, do the
8254 following: >
8255 :set tb=icons,text
8256< Motif and Athena cannot display icons and text at the same time. They
8257 will show icons if both are requested.
8258
8259 If none of the strings specified in 'toolbar' are valid or if
8260 'toolbar' is empty, this option is ignored. If you want to disable
8261 the toolbar, you need to set the 'guioptions' option. For example: >
8262 :set guioptions-=T
8263< Also see |gui-toolbar|.
8264
8265 *'toolbariconsize'* *'tbis'*
8266'toolbariconsize' 'tbis' string (default "small")
8267 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008268 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008269 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008270 tiny Use tiny icons.
8271 small Use small icons (default).
8272 medium Use medium-sized icons.
8273 large Use large icons.
8274 huge Use even larger icons.
8275 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008276 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008277 the current theme. Common dimensions are giant=48x48, huge=32x32,
8278 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008279
8280 If 'toolbariconsize' is empty, the global default size as determined
8281 by user preferences or the current theme is used.
8282
8283 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8284'ttybuiltin' 'tbi' boolean (default on)
8285 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008286 When on, the builtin termcaps are searched before the external ones.
8287 When off the builtin termcaps are searched after the external ones.
8288 When this option is changed, you should set the 'term' option next for
8289 the change to take effect, for example: >
8290 :set notbi term=$TERM
8291< See also |termcap|.
8292 Rationale: The default for this option is "on", because the builtin
8293 termcap entries are generally better (many systems contain faulty
8294 xterm entries...).
8295
8296 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8297'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8298 sun-cmd, screen, rxvt, dtterm or
8299 iris-ansi; also on when running Vim in
8300 a DOS console)
8301 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 Indicates a fast terminal connection. More characters will be sent to
8303 the screen for redrawing, instead of using insert/delete line
8304 commands. Improves smoothness of redrawing when there are multiple
8305 windows and the terminal does not support a scrolling region.
8306 Also enables the extra writing of characters at the end of each screen
8307 line for lines that wrap. This helps when using copy/paste with the
8308 mouse in an xterm and other terminals.
8309
8310 *'ttymouse'* *'ttym'*
8311'ttymouse' 'ttym' string (default depends on 'term')
8312 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008313 {only in Unix and VMS, doesn't work in the GUI; not
8314 available when compiled without |+mouse|}
8315 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008316 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008317 *xterm-mouse*
8318 xterm xterm-like mouse handling. The mouse generates
8319 "<Esc>[Mscr", where "scr" is three bytes:
8320 "s" = button state
8321 "c" = column plus 33
8322 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008323 This only works up to 223 columns! See "dec",
8324 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008325 xterm2 Works like "xterm", but with the xterm reporting the
8326 mouse position while the mouse is dragged. This works
8327 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008328 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008329 work. See below for how Vim detects this
8330 automatically.
8331 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008332 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008333 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008334 for the row and column. No other mouse events are
8335 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008336 *dec-mouse*
8337 dec DEC terminal mouse handling. The mouse generates a
8338 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008339 This is also available for an Xterm, if it was
8340 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008341 *jsbterm-mouse*
8342 jsbterm JSB term mouse handling.
8343 *pterm-mouse*
8344 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008345 *urxvt-mouse*
8346 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008347 The mouse works only if the terminal supports this
8348 encoding style, but it does not have 223 columns limit
8349 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008350 *sgr-mouse*
8351 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008352 mouse reporting. The mouse works even in columns
8353 beyond 223. This option is backward compatible with
8354 "xterm2" because it can also decode "xterm2" style
8355 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008356
8357 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008358 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8359 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8361 recognized, if enabled at compile time. DEC terminal mouse codes
8362 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008363 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8364 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008366 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8367 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8368 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008369 Additionally, if vim is compiled with the |+termresponse| feature and
8370 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008371 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008373 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8374 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8375 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008376 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8377 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378 :set t_RV=
8379<
8380 *'ttyscroll'* *'tsl'*
8381'ttyscroll' 'tsl' number (default 999)
8382 global
8383 Maximum number of lines to scroll the screen. If there are more lines
8384 to scroll the window is redrawn. For terminals where scrolling is
8385 very slow and redrawing is not slow this can be set to a small number,
8386 e.g., 3, to speed up displaying.
8387
8388 *'ttytype'* *'tty'*
8389'ttytype' 'tty' string (default from $TERM)
8390 global
8391 Alias for 'term', see above.
8392
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008393 *'undodir'* *'udir'*
8394'undodir' 'udir' string (default ".")
8395 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008396 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008397 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008398 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008399 "." means using the directory of the file. The undo file name for
8400 "file.txt" is ".file.txt.un~".
8401 For other directories the file name is the full path of the edited
8402 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008403 When writing: The first directory that exists is used. "." always
8404 works, no directories after "." will be used for writing.
8405 When reading all entries are tried to find an undo file. The first
8406 undo file that exists is used. When it cannot be read an error is
8407 given, no further entry is used.
8408 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008409 This option cannot be set from a |modeline| or in the |sandbox|, for
8410 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008411
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008412 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008413'undofile' 'udf' boolean (default off)
8414 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008415 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008416 When on, Vim automatically saves undo history to an undo file when
8417 writing a buffer to a file, and restores undo history from the same
8418 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008419 The directory where the undo file is stored is specified by 'undodir'.
8420 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008421 The undo file is not read when 'undoreload' causes the buffer from
8422 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008423 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008424 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008425
Bram Moolenaar071d4272004-06-13 20:20:40 +00008426 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008427'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008428 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008429 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008430 is kept in memory, higher numbers will cause more memory to be used.
8431 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008432 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8433 itself: >
8434 set ul=0
8435< But you can also get Vi compatibility by including the 'u' flag in
8436 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008437 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008438 Set to -1 for no undo at all. You might want to do this only for the
8439 current buffer: >
8440 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008441< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008442
8443 The local value is set to -123456 when the global value is to be used.
8444
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008445 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008446
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008447 *'undoreload'* *'ur'*
8448'undoreload' 'ur' number (default 10000)
8449 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008450 Save the whole buffer for undo when reloading it. This applies to the
8451 ":e!" command and reloading for when the buffer changed outside of
8452 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008453 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008454 of lines is smaller than the value of this option.
8455 Set this option to zero to disable undo for a reload.
8456
8457 When saving undo for a reload, any undo file is not read.
8458
8459 Note that this causes the whole buffer to be stored in memory. Set
8460 this option to a lower value if you run out of memory.
8461
Bram Moolenaar071d4272004-06-13 20:20:40 +00008462 *'updatecount'* *'uc'*
8463'updatecount' 'uc' number (default: 200)
8464 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008465 After typing this many characters the swap file will be written to
8466 disk. When zero, no swap file will be created at all (see chapter on
8467 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8468 Vim with the "-n" option, see |startup|. When editing in readonly
8469 mode this option will be initialized to 10000.
8470 The swapfile can be disabled per buffer with |'swapfile'|.
8471 When 'updatecount' is set from zero to non-zero, swap files are
8472 created for all buffers that have 'swapfile' set. When 'updatecount'
8473 is set to zero, existing swap files are not deleted.
8474 Also see |'swapsync'|.
8475 This option has no meaning in buffers where |'buftype'| is "nofile"
8476 or "nowrite".
8477
8478 *'updatetime'* *'ut'*
8479'updatetime' 'ut' number (default 4000)
8480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008481 If this many milliseconds nothing is typed the swap file will be
8482 written to disk (see |crash-recovery|). Also used for the
8483 |CursorHold| autocommand event.
8484
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008485 *'varsofttabstop'* *'vsts'*
8486'varsofttabstop' 'vsts' string (default "")
8487 local to buffer
8488 {only available when compiled with the |+vartabs|
8489 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008490 A list of the number of spaces that a <Tab> counts for while editing,
8491 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8492 width <Tab>s are being inserted, while in fact a mixture of spaces
8493 and <Tab>s is used. Tab widths are separated with commas, with the
8494 final value applying to all subsequent tabs.
8495
8496 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008497 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008498 to use the following: >
8499 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008500< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8501 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008502
8503 Note that the value of |'softtabstop'| will be ignored while
8504 'varsofttabstop' is set.
8505
8506 *'vartabstop'* *'vts'*
8507'vartabstop' 'vts' string (default "")
8508 local to buffer
8509 {only available when compiled with the |+vartabs|
8510 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008511 A list of the number of spaces that a <Tab> in the file counts for,
8512 separated by commas. Each value corresponds to one tab, with the
8513 final value applying to all subsequent tabs. For example: >
8514 :set vartabstop=4,20,10,8
8515< This will make the first tab 4 spaces wide, the second 20 spaces,
8516 the third 10 spaces, and all following tabs 8 spaces.
8517
8518 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8519 is set.
8520
Bram Moolenaar071d4272004-06-13 20:20:40 +00008521 *'verbose'* *'vbs'*
8522'verbose' 'vbs' number (default 0)
8523 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008524 When bigger than zero, Vim will give messages about what it is doing.
8525 Currently, these messages are given:
8526 >= 1 When the viminfo file is read or written.
8527 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008528 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008529 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008530 >= 8 Files for which a group of autocommands is executed.
8531 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008532 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008533 >= 12 Every executed function.
8534 >= 13 When an exception is thrown, caught, finished, or discarded.
8535 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008536 >= 15 Every executed Ex command from a script (truncated at 200
8537 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008538 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008539
8540 This option can also be set with the "-V" argument. See |-V|.
8541 This option is also set by the |:verbose| command.
8542
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008543 When the 'verbosefile' option is set then the verbose messages are not
8544 displayed.
8545
8546 *'verbosefile'* *'vfile'*
8547'verbosefile' 'vfile' string (default empty)
8548 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008549 When not empty all messages are written in a file with this name.
8550 When the file exists messages are appended.
8551 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008552 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008553 Setting 'verbosefile' to a new value is like making it empty first.
8554 The difference with |:redir| is that verbose messages are not
8555 displayed when 'verbosefile' is set.
8556
Bram Moolenaar071d4272004-06-13 20:20:40 +00008557 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008558'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559 "$VIM/vimfiles/view",
8560 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008561 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008562 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008563 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008564 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008565 feature}
8566 Name of the directory where to store files for |:mkview|.
8567 This option cannot be set from a |modeline| or in the |sandbox|, for
8568 security reasons.
8569
8570 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008571'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008572 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008573 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008574 feature}
8575 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008576 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008577 word save and restore ~
8578 cursor cursor position in file and in window
8579 folds manually created folds, opened/closed folds and local
8580 fold options
8581 options options and mappings local to a window or buffer (not
8582 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008583 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008584 slash backslashes in file names replaced with forward
8585 slashes
8586 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008587 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008588 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008590 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008591 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008592 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008593
8594 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008595'viminfo' 'vi' string (Vi default: "", Vim default for
8596 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008597 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8598 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008599 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008600 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 feature}
8602 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008603 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8604 "NONE".
8605 The string should be a comma separated list of parameters, each
8606 consisting of a single character identifying the particular parameter,
8607 followed by a number or string which specifies the value of that
8608 parameter. If a particular character is left out, then the default
8609 value is used for that parameter. The following is a list of the
8610 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008611 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008612 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008613 ! When included, save and restore global variables that start
8614 with an uppercase letter, and don't contain a lowercase
8615 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008616 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008617 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008618 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619 " Maximum number of lines saved for each register. Old name of
8620 the '<' item, with the disadvantage that you need to put a
8621 backslash before the ", otherwise it will be recognized as the
8622 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008623 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008624 % When included, save and restore the buffer list. If Vim is
8625 started with a file name argument, the buffer list is not
8626 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008627 buffer list is restored from the viminfo file. Quickfix
8628 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8629 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008630 When followed by a number, the number specifies the maximum
8631 number of buffers that are stored. Without a number all
8632 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008633 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008634 ' Maximum number of previously edited files for which the marks
8635 are remembered. This parameter must always be included when
8636 'viminfo' is non-empty.
8637 Including this item also means that the |jumplist| and the
8638 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008639 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008640 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008641 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008642 patterns are also saved. When not included, the value of
8643 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008644 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008646 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008647 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008648 < Maximum number of lines saved for each register. If zero then
8649 registers are not saved. When not included, all lines are
8650 saved. '"' is the old name for this item.
8651 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008652 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008654 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008655 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 c When included, convert the text in the viminfo file from the
8657 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008658 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008659 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008660 f Whether file marks need to be stored. If zero, file marks ('0
8661 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008662 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008663 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008664 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008665 h Disable the effect of 'hlsearch' when loading the viminfo
8666 file. When not included, it depends on whether ":nohlsearch"
8667 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008668 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008669 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008670 the 'n'. Must be at the end of the option! If the
8671 'viminfofile' option is set, that file name overrides the one
8672 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008673 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008674 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008675 r Removable media. The argument is a string (up to the next
8676 ','). This parameter can be given several times. Each
8677 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008678 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008679 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8680 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8681 ignored. Maximum length of each 'r' argument is 50
8682 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008683 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008684 s Maximum size of an item in Kbyte. If zero then registers are
8685 not saved. Currently only applies to registers. The default
8686 "s10" will exclude registers with more than 10 Kbyte of text.
8687 Also see the '<' item above: line count limit.
8688
8689 Example: >
8690 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8691<
8692 '50 Marks will be remembered for the last 50 files you
8693 edited.
8694 <1000 Contents of registers (up to 1000 lines each) will be
8695 remembered.
8696 s100 Registers with more than 100 Kbyte text are skipped.
8697 :0 Command-line history will not be saved.
8698 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8699 no / Since '/' is not specified, the default will be used,
8700 that is, save all of the search history, and also the
8701 previous search and substitute patterns.
8702 no % The buffer list will not be saved nor read back.
8703 no h 'hlsearch' highlighting will be restored.
8704
8705 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8706 load the contents of the file, this is not done automatically.
8707
8708 This option cannot be set from a |modeline| or in the |sandbox|, for
8709 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008710 NOTE: This option is set to the Vim default value when 'compatible'
8711 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008712
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008713 *'viminfofile'* *'vif'*
8714'viminfofile' 'vif' string (default: "")
8715 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008716 {not available when compiled without the |+viminfo|
8717 feature}
8718 When non-empty, overrides the file name used for viminfo.
8719 When equal to "NONE" no viminfo file will be read or written.
8720 This option can be set with the |-i| command line flag. The |--clean|
8721 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008722 This option cannot be set from a |modeline| or in the |sandbox|, for
8723 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008724
Bram Moolenaar071d4272004-06-13 20:20:40 +00008725 *'virtualedit'* *'ve'*
8726'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008727 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 A comma separated list of these words:
8729 block Allow virtual editing in Visual block mode.
8730 insert Allow virtual editing in Insert mode.
8731 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008732 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008733 none When used as the local value, do not allow virtual
8734 editing even when the global value is set. When used
8735 as the global value, "none" is the same as "".
8736 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008737
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008739 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008740 of the line. Useful for selecting a rectangle in Visual mode and
8741 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008742 "onemore" is not the same, it will only allow moving the cursor just
8743 after the last character of the line. This makes some commands more
8744 consistent. Previously the cursor was always past the end of the line
8745 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008746 break some plugins or Vim scripts. For example because |l| can move
8747 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008748 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008749 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008750 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008751 It doesn't make sense to combine "all" with "onemore", but you will
8752 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008753 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008754 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008755
8756 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8757'visualbell' 'vb' boolean (default off)
8758 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008759 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008761 use: >
8762 :set vb t_vb=
8763< If you want a short flash, you can use this on many terminals: >
8764 :set vb t_vb=[?5h$<100>[?5l
8765< Here $<100> specifies the time, you can use a smaller or bigger value
8766 to get a shorter or longer flash.
8767
8768 Note: Vim will limit the bell to once per half a second. This avoids
8769 having to wait for the flashing to finish when there are lots of
8770 bells, e.g. on key repeat. This also happens without 'visualbell'
8771 set.
8772
Bram Moolenaar071d4272004-06-13 20:20:40 +00008773 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8774 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8775 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008776
8777 Note: When the GUI starts, 't_vb' is reset to its default value. You
8778 might want to set it again in your |gvimrc|.
8779
Bram Moolenaar071d4272004-06-13 20:20:40 +00008780 Does not work on the Amiga, you always get a screen flash.
8781 Also see 'errorbells'.
8782
8783 *'warn'* *'nowarn'*
8784'warn' boolean (default on)
8785 global
8786 Give a warning message when a shell command is used while the buffer
8787 has been changed.
8788
8789 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8790'weirdinvert' 'wiv' boolean (default off)
8791 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008792 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008793 It is provided for backwards compatibility with version 4.x.
8794 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8795 vice versa. Has no effect when the GUI is running.
8796
8797 *'whichwrap'* *'ww'*
8798'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8799 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800 Allow specified keys that move the cursor left/right to move to the
8801 previous/next line when the cursor is on the first/last character in
8802 the line. Concatenate characters to allow this for these keys:
8803 char key mode ~
8804 b <BS> Normal and Visual
8805 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008806 h "h" Normal and Visual (not recommended)
8807 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008808 < <Left> Normal and Visual
8809 > <Right> Normal and Visual
8810 ~ "~" Normal
8811 [ <Left> Insert and Replace
8812 ] <Right> Insert and Replace
8813 For example: >
8814 :set ww=<,>,[,]
8815< allows wrap only when cursor keys are used.
8816 When the movement keys are used in combination with a delete or change
8817 operator, the <EOL> also counts for a character. This makes "3h"
8818 different from "3dh" when the cursor crosses the end of a line. This
8819 is also true for "x" and "X", because they do the same as "dl" and
8820 "dh". If you use this, you may also want to use the mapping
8821 ":map <BS> X" to make backspace delete the character in front of the
8822 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008823 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008824 line (not an empty line) then it will not move to the next line. This
8825 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826 NOTE: This option is set to the Vi default value when 'compatible' is
8827 set and to the Vim default value when 'compatible' is reset.
8828
8829 *'wildchar'* *'wc'*
8830'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8831 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008832 Character you have to type to start wildcard expansion in the
8833 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008834 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008835 The character is not recognized when used inside a macro. See
8836 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008837 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008839 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008840< NOTE: This option is set to the Vi default value when 'compatible' is
8841 set and to the Vim default value when 'compatible' is reset.
8842
8843 *'wildcharm'* *'wcm'*
8844'wildcharm' 'wcm' number (default: none (0))
8845 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008846 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008847 recognized when used inside a macro. You can find "spare" command-line
8848 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008849 you'll never actually type 'wildcharm', just use it in mappings that
8850 automatically invoke completion mode, e.g.: >
8851 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008852 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008853< Then after typing :ss you can use CTRL-P & CTRL-N.
8854
8855 *'wildignore'* *'wig'*
8856'wildignore' 'wig' string (default "")
8857 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008858 {not available when compiled without the |+wildignore|
8859 feature}
8860 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008861 patterns is ignored when expanding |wildcards|, completing file or
8862 directory names, and influences the result of |expand()|, |glob()| and
8863 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008864 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8865 Also see 'suffixes'.
8866 Example: >
8867 :set wildignore=*.o,*.obj
8868< The use of |:set+=| and |:set-=| is preferred when adding or removing
8869 a pattern from the list. This avoids problems when a future version
8870 uses another default.
8871
Bram Moolenaar94950a92010-12-02 16:01:29 +01008872
Bram Moolenaar81af9252010-12-10 20:35:50 +01008873 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008874'wildignorecase' 'wic' boolean (default off)
8875 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008876 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008877 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008878 Does not apply when the shell is used to expand wildcards, which
8879 happens when there are special characters.
8880
8881
Bram Moolenaar071d4272004-06-13 20:20:40 +00008882 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008883'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008884 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008885 {not available if compiled without the |+wildmenu|
8886 feature}
8887 When 'wildmenu' is on, command-line completion operates in an enhanced
8888 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8889 the possible matches are shown just above the command line, with the
8890 first match highlighted (overwriting the status line, if there is
8891 one). Keys that show the previous/next match, such as <Tab> or
8892 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8893 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8894 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008895 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008896 If there are more matches than can fit in the line, a ">" is shown on
8897 the right and/or a "<" is shown on the left. The status line scrolls
8898 as needed.
8899 The "wildmenu" mode is abandoned when a key is hit that is not used
8900 for selecting a completion.
8901 While the "wildmenu" is active the following keys have special
8902 meanings:
8903
8904 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8905 <Down> - in filename/menu name completion: move into a
8906 subdirectory or submenu.
8907 <CR> - in menu completion, when the cursor is just after a
8908 dot: move into a submenu.
8909 <Up> - in filename/menu name completion: move up into
8910 parent directory or parent menu.
8911
8912 This makes the menus accessible from the console |console-menus|.
8913
8914 If you prefer the <Left> and <Right> keys to move the cursor instead
8915 of selecting a different match, use this: >
8916 :cnoremap <Left> <Space><BS><Left>
8917 :cnoremap <Right> <Space><BS><Right>
8918<
8919 The "WildMenu" highlighting is used for displaying the current match
8920 |hl-WildMenu|.
8921
8922 *'wildmode'* *'wim'*
8923'wildmode' 'wim' string (Vim default: "full")
8924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008925 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008926 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008927 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008928 first part specifies the behavior for the first use of 'wildchar',
8929 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008930
8931 Each part consists of a colon separated list consisting of the
8932 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008933 "" Complete only the first match.
8934 "full" Complete the next full match. After the last match,
8935 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008936 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008937 "longest" Complete till longest common string. If this doesn't
8938 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008939 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008940 "lastused" When completing buffer names and more than one buffer
8941 matches, sort buffers by time last used (other than
8942 the current buffer).
8943 When there is only a single match, it is fully completed in all cases.
8944
8945 Examples of useful colon-separated values:
8946 "longest:full" Like "longest", but also start 'wildmenu' if it is
8947 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008948 "list:full" When more than one match, list all matches and
8949 complete first match.
8950 "list:longest" When more than one match, list all matches and
8951 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008952 "list:lastused" When more than one buffer matches, list all matches
8953 and sort buffers by time last used (other than the
8954 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008955
8956 Examples: >
8957 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008958< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008959 :set wildmode=longest,full
8960< Complete longest common string, then each full match >
8961 :set wildmode=list:full
8962< List all matches and complete each full match >
8963 :set wildmode=list,full
8964< List all matches without completing, then each full match >
8965 :set wildmode=longest,list
8966< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008967 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008968
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008969 *'wildoptions'* *'wop'*
8970'wildoptions' 'wop' string (default "")
8971 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008972 {not available when compiled without the |+wildignore|
8973 feature}
8974 A list of words that change how command line completion is done.
8975 Currently only one word is allowed:
8976 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008977 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008978 is displayed per line. Often used tag kinds are:
8979 d #define
8980 f function
8981 Also see |cmdline-completion|.
8982
Bram Moolenaar071d4272004-06-13 20:20:40 +00008983 *'winaltkeys'* *'wak'*
8984'winaltkeys' 'wak' string (default "menu")
8985 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008986 {only used in Win32, Motif, GTK and Photon GUI}
8987 Some GUI versions allow the access to menu entries by using the ALT
8988 key in combination with a character that appears underlined in the
8989 menu. This conflicts with the use of the ALT key for mappings and
8990 entering special characters. This option tells what to do:
8991 no Don't use ALT keys for menus. ALT key combinations can be
8992 mapped, but there is no automatic handling. This can then be
8993 done with the |:simalt| command.
8994 yes ALT key handling is done by the windowing system. ALT key
8995 combinations cannot be mapped.
8996 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008997 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008998 keys can be mapped.
8999 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9000 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009001 This option is not used for <F10>; on Win32 and with GTK <F10> will
9002 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009003
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009004 *'wincolor'* *'wcr'*
9005'wincolor' 'wcr' string (default empty)
9006 local to window
9007 Highlight group name to use for this window instead of the Normal
9008 color |hl-Normal|.
9009
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009010 *'window'* *'wi'*
9011'window' 'wi' number (default screen height - 1)
9012 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009013 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9014 window and the value is smaller than 'lines' minus one. The screen
9015 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009016 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9017 in a much smarter way, taking care of wrapping lines.
9018 When resizing the Vim window, the value is smaller than 1 or more than
9019 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009020 Note: Do not confuse this with the height of the Vim window, use
9021 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009022
Bram Moolenaar071d4272004-06-13 20:20:40 +00009023 *'winheight'* *'wh'* *E591*
9024'winheight' 'wh' number (default 1)
9025 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009026 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009027 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009028 focus goes to a window that is smaller, its size is increased, at the
9029 cost of the height of other windows.
9030 Set 'winheight' to a small number for normal editing.
9031 Set it to 999 to make the current window fill most of the screen.
9032 Other windows will be only 'winminheight' high. This has the drawback
9033 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9034 to create only two windows, set the option after startup is done,
9035 using the |VimEnter| event: >
9036 au VimEnter * set winheight=999
9037< Minimum value is 1.
9038 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009039 height of the current window.
9040 'winheight' applies to the current window. Use 'winminheight' to set
9041 the minimal height for other windows.
9042
9043 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9044'winfixheight' 'wfh' boolean (default off)
9045 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009046 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009047 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9048 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009049 The height may be changed anyway when running out of room.
9050
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009051 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9052'winfixwidth' 'wfw' boolean (default off)
9053 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009054 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009055 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009056 The width may be changed anyway when running out of room.
9057
Bram Moolenaar071d4272004-06-13 20:20:40 +00009058 *'winminheight'* *'wmh'*
9059'winminheight' 'wmh' number (default 1)
9060 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009061 The minimal height of a window, when it's not the current window.
9062 This is a hard minimum, windows will never become smaller.
9063 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9064 status bar) if necessary. They will return to at least one line when
9065 they become active (since the cursor has to have somewhere to go.)
9066 Use 'winheight' to set the minimal height of the current window.
9067 This option is only checked when making a window smaller. Don't use a
9068 large number, it will cause errors when opening more than a few
9069 windows. A value of 0 to 3 is reasonable.
9070
9071 *'winminwidth'* *'wmw'*
9072'winminwidth' 'wmw' number (default 1)
9073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009074 The minimal width of a window, when it's not the current window.
9075 This is a hard minimum, windows will never become smaller.
9076 When set to zero, windows may be "squashed" to zero columns (i.e. just
9077 a vertical separator) if necessary. They will return to at least one
9078 line when they become active (since the cursor has to have somewhere
9079 to go.)
9080 Use 'winwidth' to set the minimal width of the current window.
9081 This option is only checked when making a window smaller. Don't use a
9082 large number, it will cause errors when opening more than a few
9083 windows. A value of 0 to 12 is reasonable.
9084
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009085 *'winptydll'*
9086'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9087 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009088 {only available when compiled with the |terminal|
9089 feature on MS-Windows}
9090 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009091 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009092 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009093 a fallback.
9094 Environment variables are expanded |:set_env|.
9095 This option cannot be set from a |modeline| or in the |sandbox|, for
9096 security reasons.
9097
Bram Moolenaar071d4272004-06-13 20:20:40 +00009098 *'winwidth'* *'wiw'* *E592*
9099'winwidth' 'wiw' number (default 20)
9100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009101 Minimal number of columns for the current window. This is not a hard
9102 minimum, Vim will use fewer columns if there is not enough room. If
9103 the current window is smaller, its size is increased, at the cost of
9104 the width of other windows. Set it to 999 to make the current window
9105 always fill the screen. Set it to a small number for normal editing.
9106 The width is not adjusted after one of the commands to change the
9107 width of the current window.
9108 'winwidth' applies to the current window. Use 'winminwidth' to set
9109 the minimal width for other windows.
9110
9111 *'wrap'* *'nowrap'*
9112'wrap' boolean (default on)
9113 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009114 This option changes how text is displayed. It doesn't change the text
9115 in the buffer, see 'textwidth' for that.
9116 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009117 displaying continues on the next line. When off lines will not wrap
9118 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009119 moved to a part that is not shown, the screen will scroll
9120 horizontally.
9121 The line will be broken in the middle of a word if necessary. See
9122 'linebreak' to get the break at a word boundary.
9123 To make scrolling horizontally a bit more useful, try this: >
9124 :set sidescroll=5
9125 :set listchars+=precedes:<,extends:>
9126< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009127 This option can't be set from a |modeline| when the 'diff' option is
9128 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009129
9130 *'wrapmargin'* *'wm'*
9131'wrapmargin' 'wm' number (default 0)
9132 local to buffer
9133 Number of characters from the right window border where wrapping
9134 starts. When typing text beyond this limit, an <EOL> will be inserted
9135 and inserting continues on the next line.
9136 Options that add a margin, such as 'number' and 'foldcolumn', cause
9137 the text width to be further reduced. This is Vi compatible.
9138 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009139 This option is set to 0 when 'paste' is set and restored when 'paste'
9140 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009141 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009142
9143 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9144'wrapscan' 'ws' boolean (default on) *E384* *E385*
9145 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009146 Searches wrap around the end of the file. Also applies to |]s| and
9147 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009148
9149 *'write'* *'nowrite'*
9150'write' boolean (default on)
9151 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009152 Allows writing files. When not set, writing a file is not allowed.
9153 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009154 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009155 argument. Filtering text is still possible, even though this requires
9156 writing a temporary file.
9157
9158 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9159'writeany' 'wa' boolean (default off)
9160 global
9161 Allows writing to any file with no need for "!" override.
9162
9163 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9164'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9165 otherwise)
9166 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009167 Make a backup before overwriting a file. The backup is removed after
9168 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009169 also on.
9170 WARNING: Switching this option off means that when Vim fails to write
9171 your buffer correctly and then, for whatever reason, Vim exits, you
9172 lose both the original file and what you were writing. Only reset
9173 this option if your file system is almost full and it makes the write
9174 fail (and make sure not to exit Vim until the write was successful).
9175 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009176 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009177 Depending on 'backupcopy' the backup is a new file or the original
9178 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009179 NOTE: This option is set to the default value when 'compatible' is
9180 set.
9181
9182 *'writedelay'* *'wd'*
9183'writedelay' 'wd' number (default 0)
9184 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009185 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009186 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009187 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009188
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009189 vim:tw=78:ts=8:noet:ft=help:norl: