blob: b0000adf9e2da3d9588b5ea28a9c7f45edec1143 [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',
376'operatorfunc', 'quickfixtextfunc' and 'tagfunc') are set to a function name
377or a function reference or a lambda function. Examples:
378>
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
1942 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001943 This option cannot be set from a |modeline| or in the |sandbox|, for
1944 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001945
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001946 *'completeslash'* *'csl'*
1947'completeslash' 'csl' string (default: "")
1948 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001949 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001950 When this option is set it overrules 'shellslash' for completion:
1951 - When this option is set to "slash", a forward slash is used for path
1952 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001953 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001954 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001955 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001956 - When this option is empty, same character is used as for
1957 'shellslash'.
1958 For Insert mode completion the buffer-local value is used. For
1959 command line completion the global value is used.
1960
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001961 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001962'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001963 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001964 A comma separated list of options for Insert mode completion
1965 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001966
1967 menu Use a popup menu to show the possible completions. The
1968 menu is only shown when there is more than one match and
1969 sufficient colors are available. |ins-completion-menu|
1970
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001971 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001972 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001973 match, e.g., what file it comes from.
1974
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001975 longest Only insert the longest common text of the matches. If
1976 the menu is displayed you can use CTRL-L to add more
1977 characters. Whether case is ignored depends on the kind
1978 of completion. For buffer text the 'ignorecase' option is
1979 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001980
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001981 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001982 completion in the preview window. Only works in
1983 combination with "menu" or "menuone".
1984
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001985 popup Show extra information about the currently selected
1986 completion in a popup window. Only works in combination
1987 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001988 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001989 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001990
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001991 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001992 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001993 |CompleteChanged| autocommand to fetch the info and call
1994 |popup_show()| once the popup has been filled.
1995 See the example at |complete-popuphidden|.
1996 {only works when compiled with the |+textprop| feature}
1997
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001998 noinsert Do not insert any text for a match until the user selects
1999 a match from the menu. Only works in combination with
2000 "menu" or "menuone". No effect if "longest" is present.
2001
2002 noselect Do not select a match in the menu, force the user to
2003 select one from the menu. Only works in combination with
2004 "menu" or "menuone".
2005
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002006
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002007 *'completepopup'* *'cpp'*
2008'completepopup' 'cpp' string (default empty)
2009 global
2010 {not available when compiled without the |+textprop|
2011 or |+quickfix| feature}
2012 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002013 properties of the info popup when it is created. If an info popup
2014 window already exists it is closed, so that the option value is
2015 applied when it is created again.
2016 You can also use |popup_findinfo()| and then set properties for an
2017 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002018
2019
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002020 *'concealcursor'* *'cocu'*
2021'concealcursor' 'cocu' string (default: "")
2022 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002023 {not available when compiled without the |+conceal|
2024 feature}
2025 Sets the modes in which text in the cursor line can also be concealed.
2026 When the current mode is listed then concealing happens just like in
2027 other lines.
2028 n Normal mode
2029 v Visual mode
2030 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002031 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002032
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002033 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002034 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002035 are moving around text is concealed, but when starting to insert text
2036 or selecting a Visual area the concealed text is displayed, so that
2037 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002038 Keep in mind that the cursor position is not always where it's
2039 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002040
2041
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002042 *'conceallevel'* *'cole'*
2043'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002044 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002045 {not available when compiled without the |+conceal|
2046 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002047 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2048 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002049
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002050 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002051 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002052 1 Each block of concealed text is replaced with one
2053 character. If the syntax item does not have a custom
2054 replacement character defined (see |:syn-cchar|) the
2055 character defined in 'listchars' is used (default is a
2056 space).
2057 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002058 2 Concealed text is completely hidden unless it has a
2059 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002060 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002061 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002062
Bram Moolenaara7781e02010-07-19 20:13:22 +02002063 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002064 edit and copy the text. This can be changed with the 'concealcursor'
2065 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002066
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2068'confirm' 'cf' boolean (default off)
2069 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002070 When 'confirm' is on, certain operations that would normally
2071 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2072 instead raise a |dialog| asking if you wish to save the current
2073 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2074 If 'confirm' is off you can still activate confirmation for one
2075 command only (this is most useful in mappings) with the |:confirm|
2076 command.
2077 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2078
2079 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2080'conskey' 'consk' boolean (default off)
2081 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002082 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083
2084 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2085'copyindent' 'ci' boolean (default off)
2086 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087 Copy the structure of the existing lines indent when autoindenting a
2088 new line. Normally the new indent is reconstructed by a series of
2089 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2090 in which case only spaces are used). Enabling this option makes the
2091 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002092 existing line. 'expandtab' has no effect on these characters, a Tab
2093 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002095 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096 Also see 'preserveindent'.
2097
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002098 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099'cpoptions' 'cpo' string (Vim default: "aABceFs",
2100 Vi default: all flags)
2101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002103 this indicates Vi-compatible behavior. This is used for things where
2104 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 'cpoptions' stands for "compatible-options".
2106 Commas can be added for readability.
2107 To avoid problems with flags that are added in the future, use the
2108 "+=" and "-=" feature of ":set" |add-option-flags|.
2109 NOTE: This option is set to the Vi default value when 'compatible' is
2110 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002111 NOTE: This option is set to the POSIX default value at startup when
2112 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002113 variable exists |posix|. This means Vim tries to behave like the
2114 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002115
2116 contains behavior ~
2117 *cpo-a*
2118 a When included, a ":read" command with a file name
2119 argument will set the alternate file name for the
2120 current window.
2121 *cpo-A*
2122 A When included, a ":write" command with a file name
2123 argument will set the alternate file name for the
2124 current window.
2125 *cpo-b*
2126 b "\|" in a ":map" command is recognized as the end of
2127 the map command. The '\' is included in the mapping,
2128 the text after the '|' is interpreted as the next
2129 command. Use a CTRL-V instead of a backslash to
2130 include the '|' in the mapping. Applies to all
2131 mapping, abbreviation, menu and autocmd commands.
2132 See also |map_bar|.
2133 *cpo-B*
2134 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002135 abbreviations, user commands and the "to" part of the
2136 menu commands. Remove this flag to be able to use a
2137 backslash like a CTRL-V. For example, the command
2138 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002139 'B' included: "\^[" (^[ is a real <Esc>)
2140 'B' excluded: "<Esc>" (5 characters)
2141 ('<' excluded in both cases)
2142 *cpo-c*
2143 c Searching continues at the end of any match at the
2144 cursor position, but not further than the start of the
2145 next line. When not present searching continues
2146 one character from the cursor position. With 'c'
2147 "abababababab" only gets three matches when repeating
2148 "/abab", without 'c' there are five matches.
2149 *cpo-C*
2150 C Do not concatenate sourced lines that start with a
2151 backslash. See |line-continuation|.
2152 *cpo-d*
2153 d Using "./" in the 'tags' option doesn't mean to use
2154 the tags file relative to the current file, but the
2155 tags file in the current directory.
2156 *cpo-D*
2157 D Can't use CTRL-K to enter a digraph after Normal mode
2158 commands with a character argument, like |r|, |f| and
2159 |t|.
2160 *cpo-e*
2161 e When executing a register with ":@r", always add a
2162 <CR> to the last line, also when the register is not
2163 linewise. If this flag is not present, the register
2164 is not linewise and the last line does not end in a
2165 <CR>, then the last line is put on the command-line
2166 and can be edited before hitting <CR>.
2167 *cpo-E*
2168 E It is an error when using "y", "d", "c", "g~", "gu" or
2169 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002170 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 This makes "y0" fail in the first column.
2172 *cpo-f*
2173 f When included, a ":read" command with a file name
2174 argument will set the file name for the current buffer,
2175 if the current buffer doesn't have a file name yet.
2176 *cpo-F*
2177 F When included, a ":write" command with a file name
2178 argument will set the file name for the current
2179 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002180 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 *cpo-g*
2182 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002183 *cpo-H*
2184 H When using "I" on a line with only blanks, insert
2185 before the last blank. Without this flag insert after
2186 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 *cpo-i*
2188 i When included, interrupting the reading of a file will
2189 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002190 *cpo-I*
2191 I When moving the cursor up or down just after inserting
2192 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193 *cpo-j*
2194 j When joining lines, only add two spaces after a '.',
2195 not after '!' or '?'. Also see 'joinspaces'.
2196 *cpo-J*
2197 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002198 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199 white space.
2200 *cpo-k*
2201 k Disable the recognition of raw key codes in
2202 mappings, abbreviations, and the "to" part of menu
2203 commands. For example, if <Key> sends ^[OA (where ^[
2204 is <Esc>), the command ":map X ^[OA" results in X
2205 being mapped to:
2206 'k' included: "^[OA" (3 characters)
2207 'k' excluded: "<Key>" (one key code)
2208 Also see the '<' flag below.
2209 *cpo-K*
2210 K Don't wait for a key code to complete when it is
2211 halfway a mapping. This breaks mapping <F1><F1> when
2212 only part of the second <F1> has been read. It
2213 enables cancelling the mapping by typing <F1><Esc>.
2214 *cpo-l*
2215 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002216 literally, only "\]", "\^", "\-" and "\\" are special.
2217 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2219 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002220 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 *cpo-L*
2222 L When the 'list' option is set, 'wrapmargin',
2223 'textwidth', 'softtabstop' and Virtual Replace mode
2224 (see |gR|) count a <Tab> as two characters, instead of
2225 the normal behavior of a <Tab>.
2226 *cpo-m*
2227 m When included, a showmatch will always wait half a
2228 second. When not included, a showmatch will wait half
2229 a second or until a character is typed. |'showmatch'|
2230 *cpo-M*
2231 M When excluded, "%" matching will take backslashes into
2232 account. Thus in "( \( )" and "\( ( \)" the outer
2233 parenthesis match. When included "%" ignores
2234 backslashes, which is Vi compatible.
2235 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002236 n When included, the column used for 'number' and
2237 'relativenumber' will also be used for text of wrapped
2238 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 *cpo-o*
2240 o Line offset to search command is not remembered for
2241 next search.
2242 *cpo-O*
2243 O Don't complain if a file is being overwritten, even
2244 when it didn't exist when editing it. This is a
2245 protection against a file unexpectedly created by
2246 someone else. Vi didn't complain about this.
2247 *cpo-p*
2248 p Vi compatible Lisp indenting. When not present, a
2249 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002250 *cpo-P*
2251 P When included, a ":write" command that appends to a
2252 file will set the file name for the current buffer, if
2253 the current buffer doesn't have a file name yet and
2254 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002255 *cpo-q*
2256 q When joining multiple lines leave the cursor at the
2257 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 *cpo-r*
2259 r Redo ("." command) uses "/" to repeat a search
2260 command, instead of the actually used search string.
2261 *cpo-R*
2262 R Remove marks from filtered lines. Without this flag
2263 marks are kept like |:keepmarks| was used.
2264 *cpo-s*
2265 s Set buffer options when entering the buffer for the
2266 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002267 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 set when the buffer is created.
2269 *cpo-S*
2270 S Set buffer options always when entering a buffer
2271 (except 'readonly', 'fileformat', 'filetype' and
2272 'syntax'). This is the (most) Vi compatible setting.
2273 The options are set to the values in the current
2274 buffer. When you change an option and go to another
2275 buffer, the value is copied. Effectively makes the
2276 buffer options global to all buffers.
2277
2278 's' 'S' copy buffer options
2279 no no when buffer created
2280 yes no when buffer first entered (default)
2281 X yes each time when buffer entered (vi comp.)
2282 *cpo-t*
2283 t Search pattern for the tag command is remembered for
2284 "n" command. Otherwise Vim only puts the pattern in
2285 the history for search pattern, but doesn't change the
2286 last used search pattern.
2287 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002288 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289 *cpo-v*
2290 v Backspaced characters remain visible on the screen in
2291 Insert mode. Without this flag the characters are
2292 erased from the screen right away. With this flag the
2293 screen newly typed text overwrites backspaced
2294 characters.
2295 *cpo-w*
2296 w When using "cw" on a blank character, only change one
2297 character and not all blanks until the start of the
2298 next word.
2299 *cpo-W*
2300 W Don't overwrite a readonly file. When omitted, ":w!"
2301 overwrites a readonly file, if possible.
2302 *cpo-x*
2303 x <Esc> on the command-line executes the command-line.
2304 The default in Vim is to abandon the command-line,
2305 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002306 *cpo-X*
2307 X When using a count with "R" the replaced text is
2308 deleted only once. Also when repeating "R" with "."
2309 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002310 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002311 y A yank command can be redone with ".". Think twice if
2312 you really want to use this, it may break some
2313 plugins, since most people expect "." to only repeat a
2314 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002315 *cpo-Z*
2316 Z When using "w!" while the 'readonly' option is set,
2317 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318 *cpo-!*
2319 ! When redoing a filter command, use the last used
2320 external command, whatever it was. Otherwise the last
2321 used -filter- command is used.
2322 *cpo-$*
2323 $ When making a change to one line, don't redisplay the
2324 line, but put a '$' at the end of the changed text.
2325 The changed text will be overwritten when you type the
2326 new text. The line is redisplayed if you type any
2327 command that moves the cursor from the insertion
2328 point.
2329 *cpo-%*
2330 % Vi-compatible matching is done for the "%" command.
2331 Does not recognize "#if", "#endif", etc.
2332 Does not recognize "/*" and "*/".
2333 Parens inside single and double quotes are also
2334 counted, causing a string that contains a paren to
2335 disturb the matching. For example, in a line like
2336 "if (strcmp("foo(", s))" the first paren does not
2337 match the last one. When this flag is not included,
2338 parens inside single and double quotes are treated
2339 specially. When matching a paren outside of quotes,
2340 everything inside quotes is ignored. When matching a
2341 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002342 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002343 This flag is also used for other features, such as
2344 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002345 *cpo--*
2346 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002347 it would go above the first line or below the last
2348 line. Without it the cursor moves to the first or
2349 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002350 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002351 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002352 *cpo-+*
2353 + When included, a ":write file" command will reset the
2354 'modified' flag of the buffer, even though the buffer
2355 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002356 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357 * Use ":*" in the same way as ":@". When not included,
2358 ":*" is an alias for ":'<,'>", select the Visual area.
2359 *cpo-<*
2360 < Disable the recognition of special key codes in |<>|
2361 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002362 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 ":map X <Tab>" results in X being mapped to:
2364 '<' included: "<Tab>" (5 characters)
2365 '<' excluded: "^I" (^I is a real <Tab>)
2366 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002367 *cpo->*
2368 > When appending to a register, put a line break before
2369 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002370 *cpo-;*
2371 ; When using |,| or |;| to repeat the last |t| search
2372 and the cursor is right in front of the searched
2373 character, the cursor won't move. When not included,
2374 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002375 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002376
2377 POSIX flags. These are not included in the Vi default value, except
2378 when $VIM_POSIX was set on startup. |posix|
2379
2380 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002381 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002382 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002383 *cpo-&*
2384 & When ":preserve" was used keep the swap file when
2385 exiting normally while this buffer is still loaded.
2386 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002387 *cpo-\*
2388 \ Backslash in a [] range in a search pattern is taken
2389 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002390 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2391 '\' excluded: "/[ \-]" finds <Space> and '-'
2392 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002393 *cpo-/*
2394 / When "%" is used as the replacement string in a |:s|
2395 command, use the previous replacement string. |:s%|
2396 *cpo-{*
2397 { The |{| and |}| commands also stop at a "{" character
2398 at the start of a line.
2399 *cpo-.*
2400 . The ":chdir" and ":cd" commands fail if the current
2401 buffer is modified, unless ! is used. Vim doesn't
2402 need this, since it remembers the full path of an
2403 opened file.
2404 *cpo-bar*
2405 | The value of the $LINES and $COLUMNS environment
2406 variables overrule the terminal size values obtained
2407 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002408
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002410 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002411'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002412 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002413 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002414 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002415 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002416 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002417 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002418 blowfish Blowfish method. Medium strong encryption but it has
2419 an implementation flaw. Requires Vim 7.3 or later,
2420 files can NOT be read by Vim 7.2 and older. This adds
2421 a "seed" to the file, every time you write the file
2422 the encrypted bytes will be different.
2423 *blowfish2*
2424 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002425 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002426 and older. This adds a "seed" to the file, every time
2427 you write the file the encrypted bytes will be
2428 different. The whole undo file is encrypted, not just
2429 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002430 *E1193* *E1194* *E1195* *E1196*
2431 *E1197* *E1198* *E1199* *E1200* *E1201*
2432 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2433 Code. Medium strong till strong encryption.
2434 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002435 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002436 It adds a seed and a message authentication code (MAC)
2437 to the file. This needs at least a Vim 8.2.3022 to
2438 read the encrypted file.
2439 Encryption of swap files is not supported, therefore
2440 no swap file will be used when xchacha20 encryption is
2441 enabled.
2442 Encryption of undo files is not yet supported,
2443 therefore no undo file will currently be written.
2444 CURRENTLY EXPERIMENTAL: Files written with this method
2445 might have to be read back with the same version of
2446 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002447
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002448 You should use "blowfish2", also to re-encrypt older files.
2449
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002450 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002451 to the detected method of the file being read. Thus if you write it
2452 without changing 'cryptmethod' the same method will be used.
2453 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002454 explicitly write it, you don't get a warning unless there are other
2455 modifications. Also see |:X|.
2456
2457 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002458 the value "blowfish2". When setting the local value to an empty
2459 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002460
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002461 When a new encryption method is added in a later version of Vim, and
2462 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002463 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002464
2465
Bram Moolenaar071d4272004-06-13 20:20:40 +00002466 *'cscopepathcomp'* *'cspc'*
2467'cscopepathcomp' 'cspc' number (default 0)
2468 global
2469 {not available when compiled without the |+cscope|
2470 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471 Determines how many components of the path to show in a list of tags.
2472 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002473 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474
2475 *'cscopeprg'* *'csprg'*
2476'cscopeprg' 'csprg' string (default "cscope")
2477 global
2478 {not available when compiled without the |+cscope|
2479 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002480 Specifies the command to execute cscope. See |cscopeprg|.
2481 This option cannot be set from a |modeline| or in the |sandbox|, for
2482 security reasons.
2483
2484 *'cscopequickfix'* *'csqf'*
2485'cscopequickfix' 'csqf' string (default "")
2486 global
2487 {not available when compiled without the |+cscope|
2488 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002489 Specifies whether to use quickfix window to show cscope results.
2490 See |cscopequickfix|.
2491
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002492 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002493'cscoperelative' 'csre' boolean (default off)
2494 global
2495 {not available when compiled without the |+cscope|
2496 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002497 In the absence of a prefix (-P) for cscope. setting this option enables
2498 to use the basename of cscope.out path as the prefix.
2499 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002500 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002501
Bram Moolenaar071d4272004-06-13 20:20:40 +00002502 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2503'cscopetag' 'cst' boolean (default off)
2504 global
2505 {not available when compiled without the |+cscope|
2506 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507 Use cscope for tag commands. See |cscope-options|.
2508 NOTE: This option is reset when 'compatible' is set.
2509
2510 *'cscopetagorder'* *'csto'*
2511'cscopetagorder' 'csto' number (default 0)
2512 global
2513 {not available when compiled without the |+cscope|
2514 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 Determines the order in which ":cstag" performs a search. See
2516 |cscopetagorder|.
2517 NOTE: This option is set to 0 when 'compatible' is set.
2518
2519 *'cscopeverbose'* *'csverb'*
2520 *'nocscopeverbose'* *'nocsverb'*
2521'cscopeverbose' 'csverb' boolean (default off)
2522 global
2523 {not available when compiled without the |+cscope|
2524 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 Give messages when adding a cscope database. See |cscopeverbose|.
2526 NOTE: This option is reset when 'compatible' is set.
2527
Bram Moolenaar860cae12010-06-05 23:22:07 +02002528 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2529'cursorbind' 'crb' boolean (default off)
2530 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002531 When this option is set, as the cursor in the current
2532 window moves other cursorbound windows (windows that also have
2533 this option set) move their cursors to the corresponding line and
2534 column. This option is useful for viewing the
2535 differences between two versions of a file (see 'diff'); in diff mode,
2536 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002537 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002538
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002539
2540 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2541'cursorcolumn' 'cuc' boolean (default off)
2542 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002543 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002544 feature}
2545 Highlight the screen column of the cursor with CursorColumn
2546 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2547 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002548 If you only want the highlighting in the current window you can use
2549 these autocommands: >
2550 au WinLeave * set nocursorline nocursorcolumn
2551 au WinEnter * set cursorline cursorcolumn
2552<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002553
2554 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2555'cursorline' 'cul' boolean (default off)
2556 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002557 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002558 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002559 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2560 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002561 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002562 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002563
2564
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002565 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002566'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002567 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002568 {not available when compiled without the |+syntax|
2569 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002570 Comma separated list of settings for how 'cursorline' is displayed.
2571 Valid values:
2572 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002573 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002574 "screenline" Highlight only the screen line of the cursor with
2575 CursorLine |hl-CursorLine|.
2576 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002577 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002578
2579 Special value:
2580 "both" Alias for the values "line,number".
2581
2582 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002583
2584
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585 *'debug'*
2586'debug' string (default "")
2587 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002588 These values can be used:
2589 msg Error messages that would otherwise be omitted will be given
2590 anyway.
2591 throw Error messages that would otherwise be omitted will be given
2592 anyway and also throw an exception and set |v:errmsg|.
2593 beep A message will be given when otherwise only a beep would be
2594 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002595 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002596 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2597 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598
2599 *'define'* *'def'*
2600'define' 'def' string (default "^\s*#\s*define")
2601 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002602 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002603 pattern, just like for the "/" command. This option is used for the
2604 commands like "[i" and "[d" |include-search|. The 'isident' option is
2605 used to recognize the defined name after the match:
2606 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2607 See |option-backslash| about inserting backslashes to include a space
2608 or backslash.
2609 The default value is for C programs. For C++ this value would be
2610 useful, to include const type declarations: >
2611 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002612< You can also use "\ze" just before the name and continue the pattern
2613 to check what is following. E.g. for Javascript, if a function is
2614 defined with "func_name = function(args)": >
2615 ^\s*\ze\i\+\s*=\s*function(
2616< If the function is defined with "func_name : function() {...": >
2617 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002619 To avoid that use `:let` with a single quote string: >
2620 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002621<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622
2623 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2624'delcombine' 'deco' boolean (default off)
2625 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626 If editing Unicode and this option is set, backspace and Normal mode
2627 "x" delete each combining character on its own. When it is off (the
2628 default) the character along with its combining characters are
2629 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002630 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631
2632 This is useful for Arabic, Hebrew and many other languages where one
2633 may have combining characters overtop of base characters, and want
2634 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002635 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636
2637 *'dictionary'* *'dict'*
2638'dictionary' 'dict' string (default "")
2639 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640 List of file names, separated by commas, that are used to lookup words
2641 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2642 contain a list of words. This can be one word per line, or several
2643 words per line, separated by non-keyword characters (white space is
2644 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002645
2646 When this option is empty or an entry "spell" is present, and spell
2647 checking is enabled, words in the word lists for the currently active
2648 'spelllang' are used. See |spell|.
2649
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002650 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651 after a comma are ignored, otherwise spaces are included in the file
2652 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002653 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002654 Where to find a list of words?
2655 - On FreeBSD, there is the file "/usr/share/dict/words".
2656 - In the Simtel archive, look in the "msdos/linguist" directory.
2657 - In "miscfiles" of the GNU collection.
2658 The use of |:set+=| and |:set-=| is preferred when adding or removing
2659 directories from the list. This avoids problems when a future version
2660 uses another default.
2661 Backticks cannot be used in this option for security reasons.
2662
2663 *'diff'* *'nodiff'*
2664'diff' boolean (default off)
2665 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002666 {not available when compiled without the |+diff|
2667 feature}
2668 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002669 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670
2671 *'dex'* *'diffexpr'*
2672'diffexpr' 'dex' string (default "")
2673 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 {not available when compiled without the |+diff|
2675 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002676 Expression which is evaluated to obtain a diff file (either ed-style
2677 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 This option cannot be set from a |modeline| or in the |sandbox|, for
2679 security reasons.
2680
2681 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002682'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684 {not available when compiled without the |+diff|
2685 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002686 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 All are optional. Items must be separated by a comma.
2688
2689 filler Show filler lines, to keep the text
2690 synchronized with a window that has inserted
2691 lines at the same position. Mostly useful
2692 when windows are side-by-side and 'scrollbind'
2693 is set.
2694
2695 context:{n} Use a context of {n} lines between a change
2696 and a fold that contains unchanged lines.
2697 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002698 When using zero the context is actually one,
2699 since folds require a line in between, also
2700 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 See |fold-diff|.
2702
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002703 iblank Ignore changes where lines are all blank. Adds
2704 the "-B" flag to the "diff" command if
2705 'diffexpr' is empty. Check the documentation
2706 of the "diff" command for what this does
2707 exactly.
2708 NOTE: the diff windows will get out of sync,
2709 because no differences between blank lines are
2710 taken into account.
2711
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 icase Ignore changes in case of text. "a" and "A"
2713 are considered the same. Adds the "-i" flag
2714 to the "diff" command if 'diffexpr' is empty.
2715
2716 iwhite Ignore changes in amount of white space. Adds
2717 the "-b" flag to the "diff" command if
2718 'diffexpr' is empty. Check the documentation
2719 of the "diff" command for what this does
2720 exactly. It should ignore adding trailing
2721 white space, but not leading white space.
2722
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002723 iwhiteall Ignore all white space changes. Adds
2724 the "-w" flag to the "diff" command if
2725 'diffexpr' is empty. Check the documentation
2726 of the "diff" command for what this does
2727 exactly.
2728
2729 iwhiteeol Ignore white space changes at end of line.
2730 Adds the "-Z" flag to the "diff" command if
2731 'diffexpr' is empty. Check the documentation
2732 of the "diff" command for what this does
2733 exactly.
2734
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002735 horizontal Start diff mode with horizontal splits (unless
2736 explicitly specified otherwise).
2737
2738 vertical Start diff mode with vertical splits (unless
2739 explicitly specified otherwise).
2740
Bram Moolenaarc8234772019-11-10 21:00:27 +01002741 closeoff When a window is closed where 'diff' is set
2742 and there is only one window remaining in the
2743 same tab page with 'diff' set, execute
2744 `:diffoff` in that window. This undoes a
2745 `:diffsplit` command.
2746
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002747 hiddenoff Do not use diff mode for a buffer when it
2748 becomes hidden.
2749
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002750 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2751 starting diff mode. Without this 2 is used.
2752
Bram Moolenaar4223d432021-02-10 13:18:17 +01002753 followwrap Follow the 'wrap' option and leave as it is.
2754
Bram Moolenaare828b762018-09-10 17:51:58 +02002755 internal Use the internal diff library. This is
2756 ignored when 'diffexpr' is set. *E960*
2757 When running out of memory when writing a
2758 buffer this item will be ignored for diffs
2759 involving that buffer. Set the 'verbose'
2760 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761
Bram Moolenaare828b762018-09-10 17:51:58 +02002762 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002763 Use the indent heuristic for the internal
2764 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002765
2766 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002767 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002768 algorithms are:
2769 myers the default algorithm
2770 minimal spend extra time to generate the
2771 smallest possible diff
2772 patience patience diff algorithm
2773 histogram histogram diff algorithm
2774
2775 Examples: >
2776 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002778 :set diffopt=internal,filler,foldcolumn:3
2779 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780<
2781 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2782'digraph' 'dg' boolean (default off)
2783 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 {not available when compiled without the |+digraphs|
2785 feature}
2786 Enable the entering of digraphs in Insert mode with {char1} <BS>
2787 {char2}. See |digraphs|.
2788 NOTE: This option is reset when 'compatible' is set.
2789
2790 *'directory'* *'dir'*
2791'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002792 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793 for Unix: ".,~/tmp,/var/tmp,/tmp")
2794 global
2795 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002796 Recommended value: ".,~/vimswap//" - this will put the swap file next
2797 to the edited file if possible, and in your personal swap directory
2798 otherwise. Make sure "~/vimswap//" is only readable for you.
2799
2800 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002801 - The swap file will be created in the first directory where this is
2802 possible.
2803 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002804 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805 - A directory "." means to put the swap file in the same directory as
2806 the edited file. On Unix, a dot is prepended to the file name, so
2807 it doesn't show in a directory listing. On MS-Windows the "hidden"
2808 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002809 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2810 the swap file relative to where the edited file is. The leading "."
2811 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002812 - For Unix and Win32, if a directory ends in two path separators "//",
2813 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002814 with all path separators replaced by percent '%' signs (including
2815 the colon following the drive letter on Win32). This will ensure
2816 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002817 On Win32, it is also possible to end with "\\". However, When a
2818 separating comma is following, you must use "//", since "\\" will
2819 include the comma in the file name. Therefore it is recommended to
2820 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821 - Spaces after the comma are ignored, other spaces are considered part
2822 of the directory name. To have a space at the start of a directory
2823 name, precede it with a backslash.
2824 - To include a comma in a directory name precede it with a backslash.
2825 - A directory name may end in an ':' or '/'.
2826 - Environment variables are expanded |:set_env|.
2827 - Careful with '\' characters, type one before a space, type two to
2828 get one in the option (see |option-backslash|), for example: >
2829 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2830< - For backwards compatibility with Vim version 3.0 a '>' at the start
2831 of the option is removed.
2832 Using "." first in the list is recommended. This means that editing
2833 the same file twice will result in a warning. Using "/tmp" on Unix is
2834 discouraged: When the system crashes you lose the swap file.
2835 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002836 choice than "/tmp". But others on the computer may be able to see the
2837 files, and it can contain a lot of files, your swap files get lost in
2838 the crowd. That is why a "tmp" directory in your home directory is
2839 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840 The use of |:set+=| and |:set-=| is preferred when adding or removing
2841 directories from the list. This avoids problems when a future version
2842 uses another default.
2843 This option cannot be set from a |modeline| or in the |sandbox|, for
2844 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845
2846 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002847'display' 'dy' string (default "", set to "truncate" in
2848 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850 Change the way text is displayed. This is comma separated list of
2851 flags:
2852 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002853 in a window will be displayed. "@@@" is put in the
2854 last columns of the last screen line to indicate the
2855 rest of the line is not displayed.
2856 truncate Like "lastline", but "@@@" is displayed in the first
2857 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858 uhex Show unprintable characters hexadecimal as <xx>
2859 instead of using ^C and ~C.
2860
Bram Moolenaard0796902016-09-16 20:02:31 +02002861 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002862 doesn't fit is replaced with "@" lines.
2863
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864 *'eadirection'* *'ead'*
2865'eadirection' 'ead' string (default "both")
2866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 Tells when the 'equalalways' option applies:
2868 ver vertically, width of windows is not affected
2869 hor horizontally, height of windows is not affected
2870 both width and height of windows is affected
2871
2872 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2873'edcompatible' 'ed' boolean (default off)
2874 global
2875 Makes the 'g' and 'c' flags of the ":substitute" command to be
2876 toggled each time the flag is given. See |complex-change|. See
2877 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002878 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002879 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880
Bram Moolenaar03413f42016-04-12 21:07:15 +02002881 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002882'emoji' 'emo' boolean (default: on)
2883 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002884 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002885 This excludes "text emoji" characters, which are normally displayed as
2886 single width. Unfortunately there is no good specification for this
2887 and it has been determined on trial-and-error basis. Use the
2888 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002889
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002891'encoding' 'enc' string (default for MS-Windows: "utf-8",
2892 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894 Sets the character encoding used inside Vim. It applies to text in
2895 the buffers, registers, Strings in expressions, text stored in the
2896 viminfo file, etc. It sets the kind of characters which Vim can work
2897 with. See |encoding-names| for the possible values.
2898
2899 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002900 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002902 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903
Bram Moolenaar865242e2010-07-14 21:12:05 +02002904 This option cannot be set from a |modeline|. It would most likely
2905 corrupt the text.
2906
Bram Moolenaar3df01732017-02-17 22:47:16 +01002907 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2908 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 'encoding', "utf-8" is the natural choice for the environment and
2910 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002911 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912 versions, and to avoid changing the encoding of newly created files
2913 without your knowledge (in case 'fileencodings' is empty).
2914
2915 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002916 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917 iconv() or as specified with 'charconvert'.
2918
Bram Moolenaar207f0092020-08-30 17:20:20 +02002919 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002920 can use: >
2921 if has("multi_byte_encoding")
2922<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 Normally 'encoding' will be equal to your current locale. This will
2924 be the default if Vim recognizes your environment settings. If
2925 'encoding' is not set to the current locale, 'termencoding' must be
2926 set to convert typed and displayed text. See |encoding-table|.
2927
2928 When you set this option, it fires the |EncodingChanged| autocommand
2929 event so that you can set up fonts if necessary.
2930
2931 When the option is set, the value is converted to lowercase. Thus
2932 you can set it with uppercase values too. Underscores are translated
2933 to '-' signs.
2934 When the encoding is recognized, it is changed to the standard name.
2935 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2936 "iso-8859-2" and "utf8" becomes "utf-8".
2937
2938 Note: "latin1" is also used when the encoding could not be detected.
2939 This only works when editing files in the same encoding! When the
2940 actual character set is not latin1, make sure 'fileencoding' and
2941 'fileencodings' are empty. When conversion is needed, switch to using
2942 utf-8.
2943
2944 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2945 You don't notice this while editing, but it does matter for the
2946 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2947 setting 'encoding' to one of these values instead of utf-8 only has
2948 effect for encoding used for files when 'fileencoding' is empty.
2949
Bram Moolenaar661b1822005-07-28 22:36:45 +00002950 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2951 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952
2953 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2954'endofline' 'eol' boolean (default on)
2955 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002957 is on, or 'fixeol' option is off, no <EOL> will be written for the
2958 last line in the file. This option is automatically set or reset when
2959 starting to edit a new file, depending on whether file has an <EOL>
2960 for the last line in the file. Normally you don't have to set or
2961 reset this option.
2962 When 'binary' is off and 'fixeol' is on the value is not used when
2963 writing the file. When 'binary' is on or 'fixeol' is off it is used
2964 to remember the presence of a <EOL> for the last line in the file, so
2965 that when you write the file the situation from the original file can
2966 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967
2968 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2969'equalalways' 'ea' boolean (default on)
2970 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002972 splitting or closing a window. This also happens the moment the
2973 option is switched on. When off, splitting a window will reduce the
2974 size of the current window and leave the other windows the same. When
2975 closing a window the extra lines are given to the window next to it
2976 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 When mixing vertically and horizontally split windows, a minimal size
2978 is computed and some windows may be larger if there is room. The
2979 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002980 Changing the height and width of a window can be avoided by setting
2981 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002982 If a window size is specified when creating a new window sizes are
2983 currently not equalized (it's complicated, but may be implemented in
2984 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985
2986 *'equalprg'* *'ep'*
2987'equalprg' 'ep' string (default "")
2988 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002990 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002991 or 'indentexpr'. When Vim was compiled without internal formatting,
2992 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002993 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 about including spaces and backslashes.
2995 This option cannot be set from a |modeline| or in the |sandbox|, for
2996 security reasons.
2997
2998 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2999'errorbells' 'eb' boolean (default off)
3000 global
3001 Ring the bell (beep or screen flash) for error messages. This only
3002 makes a difference for error messages, the bell will be used always
3003 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003004 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003005 screen flash or do nothing. See 'belloff' to finetune when to ring the
3006 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007
3008 *'errorfile'* *'ef'*
3009'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3010 others: "errors.err")
3011 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 {not available when compiled without the |+quickfix|
3013 feature}
3014 Name of the errorfile for the QuickFix mode (see |:cf|).
3015 When the "-q" command-line argument is used, 'errorfile' is set to the
3016 following argument. See |-q|.
3017 NOT used for the ":make" command. See 'makeef' for that.
3018 Environment variables are expanded |:set_env|.
3019 See |option-backslash| about including spaces and backslashes.
3020 This option cannot be set from a |modeline| or in the |sandbox|, for
3021 security reasons.
3022
3023 *'errorformat'* *'efm'*
3024'errorformat' 'efm' string (default is very long)
3025 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 {not available when compiled without the |+quickfix|
3027 feature}
3028 Scanf-like description of the format for the lines in the error file
3029 (see |errorformat|).
3030
3031 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3032'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3033 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 Function keys that start with an <Esc> are recognized in Insert
3035 mode. When this option is off, the cursor and function keys cannot be
3036 used in Insert mode if they start with an <Esc>. The advantage of
3037 this is that the single <Esc> is recognized immediately, instead of
3038 after one second. Instead of resetting this option, you might want to
3039 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3040 when 'esckeys' is off, you can still map anything, but the cursor keys
3041 won't work by default.
3042 NOTE: This option is set to the Vi default value when 'compatible' is
3043 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003044 NOTE: when this option is off then the |modifyOtherKeys| functionality
3045 is disabled while in Insert mode to avoid ending Insert mode with any
3046 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047
3048 *'eventignore'* *'ei'*
3049'eventignore' 'ei' string (default "")
3050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003052 When set to "all" or when "all" is one of the items, all autocommand
3053 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054 Otherwise this is a comma separated list of event names. Example: >
3055 :set ei=WinEnter,WinLeave
3056<
3057 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3058'expandtab' 'et' boolean (default off)
3059 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003061 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3063 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003064 This option is reset when the 'paste' option is set and restored when
3065 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 NOTE: This option is reset when 'compatible' is set.
3067
3068 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3069'exrc' 'ex' boolean (default off)
3070 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003072 directory.
3073
3074 Setting this option is a potential security leak. E.g., consider
3075 unpacking a package or fetching files from github, a .vimrc in there
3076 might be a trojan horse. BETTER NOT SET THIS OPTION!
3077 Instead, define an autocommand in your .vimrc to set options for a
3078 matching directory.
3079
3080 If you do switch this option on you should also consider setting the
3081 'secure' option (see |initialization|).
3082 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 This option cannot be set from a |modeline| or in the |sandbox|, for
3084 security reasons.
3085
3086 *'fileencoding'* *'fenc'* *E213*
3087'fileencoding' 'fenc' string (default: "")
3088 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003090
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003092 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 When 'fileencoding' is empty, the same value as 'encoding' will be
3094 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003095 No error will be given when the value is set, only when it is used,
3096 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003097 Conversion will also be done when 'encoding' and 'fileencoding' are
3098 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3099 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003101 'encoding' is "utf-8" or another Unicode encoding, conversion
3102 is most likely done in a way that the reverse conversion
3103 results in the same text. When 'encoding' is not "utf-8" some
3104 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003105
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 See 'encoding' for the possible values. Additionally, values may be
3107 specified that can be handled by the converter, see
3108 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003109
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 When reading a file 'fileencoding' will be set from 'fileencodings'.
3111 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003112 'fileencoding', use the |++enc| argument. One exception: when
3113 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003114 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003115
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3117 When the option is set, the value is converted to lowercase. Thus
3118 you can set it with uppercase values too. '_' characters are
3119 replaced with '-'. If a name is recognized from the list for
3120 'encoding', it is replaced by the standard name. For example
3121 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003122
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 When this option is set, after starting to edit a file, the 'modified'
3124 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003125
3126 Keep in mind that changing 'fenc' from a modeline happens
3127 AFTER the text has been read, thus it applies to when the file will be
3128 written. If you do set 'fenc' in a modeline, you might want to set
3129 'nomodified' to avoid not being able to ":q".
3130
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 This option can not be changed when 'modifiable' is off.
3132
3133 *'fe'*
3134 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003135 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136 old short name was 'fe', which is no longer used.
3137
3138 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003139'fileencodings' 'fencs' string (default: "ucs-bom",
3140 "ucs-bom,utf-8,default,latin1" when
3141 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 This is a list of character encodings considered when starting to edit
3144 an existing file. When a file is read, Vim tries to use the first
3145 mentioned character encoding. If an error is detected, the next one
3146 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003147 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 an empty string, which means the value of 'encoding' is used.
3149 WARNING: Conversion can cause loss of information! When
3150 'encoding' is "utf-8" (or one of the other Unicode variants)
3151 conversion is most likely done in a way that the reverse
3152 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003153 "utf-8" some non-ASCII characters may be lost! You can use
3154 the |++bad| argument to specify what is done with characters
3155 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 For an empty file or a file with only ASCII characters most encodings
3157 will work and the first entry of 'fileencodings' will be used (except
3158 "ucs-bom", which requires the BOM to be present). If you prefer
3159 another encoding use an BufReadPost autocommand event to test if your
3160 preferred encoding is to be used. Example: >
3161 au BufReadPost * if search('\S', 'w') == 0 |
3162 \ set fenc=iso-2022-jp | endif
3163< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3164 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003165 When the |++enc| argument is used then the value of 'fileencodings' is
3166 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003167 Note that 'fileencodings' is not used for a new file, the global value
3168 of 'fileencoding' is used instead. You can set it with: >
3169 :setglobal fenc=iso-8859-2
3170< This means that a non-existing file may get a different encoding than
3171 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 The special value "ucs-bom" can be used to check for a Unicode BOM
3173 (Byte Order Mark) at the start of the file. It must not be preceded
3174 by "utf-8" or another Unicode encoding for this to work properly.
3175 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3176 because Vim cannot detect an error, thus the encoding is always
3177 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003178 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003179 environment. On MS-Windows this is the system encoding. Otherwise
3180 this is the default value for 'encoding'. It is useful when
3181 'encoding' is set to "utf-8" and your environment uses a non-latin1
3182 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003183 When 'encoding' is "utf-8" and a file contains an illegal byte
3184 sequence it won't be recognized as UTF-8. You can use the |8g8|
3185 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 WRONG VALUES: WHAT'S WRONG:
3187 latin1,utf-8 "latin1" will always be used
3188 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3189 file
3190 cp1250,latin1 "cp1250" will always be used
3191 If 'fileencodings' is empty, 'fileencoding' is not modified.
3192 See 'fileencoding' for the possible values.
3193 Setting this option does not have an effect until the next time a file
3194 is read.
3195
3196 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003197'fileformat' 'ff' string (MS-Windows default: "dos",
3198 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003199 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 This gives the <EOL> of the current buffer, which is used for
3201 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003202 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 unix <NL>
3204 mac <CR>
3205 When "dos" is used, CTRL-Z at the end of a file is ignored.
3206 See |file-formats| and |file-read|.
3207 For the character encoding of the file see 'fileencoding'.
3208 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003209 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 This option is set automatically when starting to edit a file and
3211 'fileformats' is not empty and 'binary' is off.
3212 When this option is set, after starting to edit a file, the 'modified'
3213 option is set, because the file would be different when written.
3214 This option can not be changed when 'modifiable' is off.
3215 For backwards compatibility: When this option is set to "dos",
3216 'textmode' is set, otherwise 'textmode' is reset.
3217
3218 *'fileformats'* *'ffs'*
3219'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003220 Vim+Vi MS-Windows: "dos,unix",
3221 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222 Vi Cygwin: "unix,dos",
3223 Vi others: "")
3224 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 This gives the end-of-line (<EOL>) formats that will be tried when
3226 starting to edit a new buffer and when reading a file into an existing
3227 buffer:
3228 - When empty, the format defined with 'fileformat' will be used
3229 always. It is not set automatically.
3230 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003231 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 'fileformats' name will be used when a file is read into an existing
3233 buffer, no matter what 'fileformat' for that buffer is set to.
3234 - When more than one name is present, separated by commas, automatic
3235 <EOL> detection will be done when reading a file. When starting to
3236 edit a file, a check is done for the <EOL>:
3237 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3238 'fileformat' is set to "dos".
3239 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003240 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003242 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3243 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003244 This means that "mac" is only chosen when:
3245 "unix" is not present or no <NL> is found in the file, and
3246 "dos" is not present or no <CR><NL> is found in the file.
3247 Except: if "unix" was chosen, but there is a <CR> before
3248 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003249 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250 4. If 'fileformat' is still not set, the first name from
3251 'fileformats' is used.
3252 When reading a file into an existing buffer, the same is done, but
3253 this happens like 'fileformat' has been set appropriately for that
3254 file only, the option is not changed.
3255 When 'binary' is set, the value of 'fileformats' is not used.
3256
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003257 When Vim starts up with an empty buffer the first item is used. You
3258 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003259
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3261 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3262 done:
3263 - When 'fileformats' is empty, there is no automatic detection. Dos
3264 format will be used.
3265 - When 'fileformats' is set to one or more names, automatic detection
3266 is done. This is based on the first <NL> in the file: If there is a
3267 <CR> in front of it, Dos format is used, otherwise Unix format is
3268 used.
3269 Also see |file-formats|.
3270 For backwards compatibility: When this option is set to an empty
3271 string or one format (no comma is included), 'textauto' is reset,
3272 otherwise 'textauto' is set.
3273 NOTE: This option is set to the Vi default value when 'compatible' is
3274 set and to the Vim default value when 'compatible' is reset.
3275
Bram Moolenaarbf884932013-04-05 22:26:15 +02003276 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3277'fileignorecase' 'fic' boolean (default on for systems where case in file
3278 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003279 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003280 When set case is ignored when using file names and directories.
3281 See 'wildignorecase' for only ignoring case when doing completion.
3282
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283 *'filetype'* *'ft'*
3284'filetype' 'ft' string (default: "")
3285 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 When this option is set, the FileType autocommand event is triggered.
3287 All autocommands that match with the value of this option will be
3288 executed. Thus the value of 'filetype' is used in place of the file
3289 name.
3290 Otherwise this option does not always reflect the current file type.
3291 This option is normally set when the file type is detected. To enable
3292 this use the ":filetype on" command. |:filetype|
3293 Setting this option to a different value is most useful in a modeline,
3294 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003295 Example, for in an IDL file:
3296 /* vim: set filetype=idl : */ ~
3297 |FileType| |filetypes|
3298 When a dot appears in the value then this separates two filetype
3299 names. Example:
3300 /* vim: set filetype=c.doxygen : */ ~
3301 This will use the "c" filetype first, then the "doxygen" filetype.
3302 This works both for filetype plugins and for syntax files. More than
3303 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304 This option is not copied to another buffer, independent of the 's' or
3305 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003306 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307
3308 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003309'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003311 {not available when compiled without the |+folding|
3312 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 Characters to fill the statuslines and vertical separators.
3314 It is a comma separated list of items:
3315
3316 item default Used for ~
3317 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003318 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 vert:c '|' vertical separators |:vsplit|
3320 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003321 foldopen:c '-' mark the beginning of a fold
3322 foldclose:c '+' show a closed fold
3323 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003325 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003327 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003328 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 otherwise.
3330
3331 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003332 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003333< This is similar to the default, except that these characters will also
3334 be used when there is highlighting.
3335
Bram Moolenaar008bff92021-03-04 21:55:58 +01003336 For "stl" and "stlnc" single-byte and multibyte characters are
3337 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003338
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 The highlighting used for these items:
3340 item highlight group ~
3341 stl:c StatusLine |hl-StatusLine|
3342 stlnc:c StatusLineNC |hl-StatusLineNC|
3343 vert:c VertSplit |hl-VertSplit|
3344 fold:c Folded |hl-Folded|
3345 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003346 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003348 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3349'fixendofline' 'fixeol' boolean (default on)
3350 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003351 When writing a file and this option is on, <EOL> at the end of file
3352 will be restored if missing. Turn this option off if you want to
3353 preserve the situation from the original file.
3354 When the 'binary' option is set the value of this option doesn't
3355 matter.
3356 See the 'endofline' option.
3357
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003359'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 {only available when compiled with the |+rightleft|
3362 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003363 This option was for using Farsi, which has been removed. See
3364 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365
3366 *'foldclose'* *'fcl'*
3367'foldclose' 'fcl' string (default "")
3368 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 {not available when compiled without the |+folding|
3370 feature}
3371 When set to "all", a fold is closed when the cursor isn't in it and
3372 its level is higher than 'foldlevel'. Useful if you want folds to
3373 automatically close when moving out of them.
3374
3375 *'foldcolumn'* *'fdc'*
3376'foldcolumn' 'fdc' number (default 0)
3377 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 {not available when compiled without the |+folding|
3379 feature}
3380 When non-zero, a column with the specified width is shown at the side
3381 of the window which indicates open and closed folds. The maximum
3382 value is 12.
3383 See |folding|.
3384
3385 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3386'foldenable' 'fen' boolean (default on)
3387 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 {not available when compiled without the |+folding|
3389 feature}
3390 When off, all folds are open. This option can be used to quickly
3391 switch between showing all text unfolded and viewing the text with
3392 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003393 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 'foldenable' is off.
3395 This option is set by commands that create a new fold or close a fold.
3396 See |folding|.
3397
3398 *'foldexpr'* *'fde'*
3399'foldexpr' 'fde' string (default: "0")
3400 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003402 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003404 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003405
Bram Moolenaar30b65812012-07-12 22:01:11 +02003406 The expression will be evaluated in the |sandbox| if set from a
3407 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003408 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003409 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003410
3411 It is not allowed to change text or jump to another window while
3412 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413
3414 *'foldignore'* *'fdi'*
3415'foldignore' 'fdi' string (default: "#")
3416 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 {not available when compiled without the |+folding|
3418 feature}
3419 Used only when 'foldmethod' is "indent". Lines starting with
3420 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003421 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003422 The default "#" works well for C programs. See |fold-indent|.
3423
3424 *'foldlevel'* *'fdl'*
3425'foldlevel' 'fdl' number (default: 0)
3426 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 {not available when compiled without the |+folding|
3428 feature}
3429 Sets the fold level: Folds with a higher level will be closed.
3430 Setting this option to zero will close all folds. Higher numbers will
3431 close fewer folds.
3432 This option is set by commands like |zm|, |zM| and |zR|.
3433 See |fold-foldlevel|.
3434
3435 *'foldlevelstart'* *'fdls'*
3436'foldlevelstart' 'fdls' number (default: -1)
3437 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438 {not available when compiled without the |+folding|
3439 feature}
3440 Sets 'foldlevel' when starting to edit another buffer in a window.
3441 Useful to always start editing with all folds closed (value zero),
3442 some folds closed (one) or no folds closed (99).
3443 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003444 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445 ignores this option and closes all folds.
3446 It is also done before BufReadPre autocommands, to allow an autocmd to
3447 overrule the 'foldlevel' value for specific files.
3448 When the value is negative, it is not used.
3449
3450 *'foldmarker'* *'fmr'* *E536*
3451'foldmarker' 'fmr' string (default: "{{{,}}}")
3452 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 {not available when compiled without the |+folding|
3454 feature}
3455 The start and end marker used when 'foldmethod' is "marker". There
3456 must be one comma, which separates the start and end marker. The
3457 marker is a literal string (a regular expression would be too slow).
3458 See |fold-marker|.
3459
3460 *'foldmethod'* *'fdm'*
3461'foldmethod' 'fdm' string (default: "manual")
3462 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 {not available when compiled without the |+folding|
3464 feature}
3465 The kind of folding used for the current window. Possible values:
3466 |fold-manual| manual Folds are created manually.
3467 |fold-indent| indent Lines with equal indent form a fold.
3468 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3469 |fold-marker| marker Markers are used to specify folds.
3470 |fold-syntax| syntax Syntax highlighting items specify folds.
3471 |fold-diff| diff Fold text that is not changed.
3472
3473 *'foldminlines'* *'fml'*
3474'foldminlines' 'fml' number (default: 1)
3475 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 {not available when compiled without the |+folding|
3477 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003478 Sets the number of screen lines above which a fold can be displayed
3479 closed. Also for manually closed folds. With the default value of
3480 one a fold can only be closed if it takes up two or more screen lines.
3481 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003482 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 "zc" to close a fold, which is displayed open because it's smaller
3484 than 'foldminlines', a following "zc" may close a containing fold.
3485
3486 *'foldnestmax'* *'fdn'*
3487'foldnestmax' 'fdn' number (default: 20)
3488 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 {not available when compiled without the |+folding|
3490 feature}
3491 Sets the maximum nesting of folds for the "indent" and "syntax"
3492 methods. This avoids that too many folds will be created. Using more
3493 than 20 doesn't work, because the internal limit is 20.
3494
3495 *'foldopen'* *'fdo'*
3496'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3497 search,tag,undo")
3498 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 {not available when compiled without the |+folding|
3500 feature}
3501 Specifies for which type of commands folds will be opened, if the
3502 command moves the cursor into a closed fold. It is a comma separated
3503 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003504 NOTE: When the command is part of a mapping this option is not used.
3505 Add the |zv| command to the mapping to get the same effect.
3506 (rationale: the mapping may want to control opening folds itself)
3507
Bram Moolenaar071d4272004-06-13 20:20:40 +00003508 item commands ~
3509 all any
3510 block "(", "{", "[[", "[{", etc.
3511 hor horizontal movements: "l", "w", "fx", etc.
3512 insert any command in Insert mode
3513 jump far jumps: "G", "gg", etc.
3514 mark jumping to a mark: "'m", CTRL-O, etc.
3515 percent "%"
3516 quickfix ":cn", ":crew", ":make", etc.
3517 search search for a pattern: "/", "n", "*", "gd", etc.
3518 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003519 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 tag jumping to a tag: ":ta", CTRL-T, etc.
3521 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522 When a movement command is used for an operator (e.g., "dl" or "y%")
3523 this option is not used. This means the operator will include the
3524 whole closed fold.
3525 Note that vertical movements are not here, because it would make it
3526 very difficult to move onto a closed fold.
3527 In insert mode the folds containing the cursor will always be open
3528 when text is inserted.
3529 To close folds you can re-apply 'foldlevel' with the |zx| command or
3530 set the 'foldclose' option to "all".
3531
3532 *'foldtext'* *'fdt'*
3533'foldtext' 'fdt' string (default: "foldtext()")
3534 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 {not available when compiled without the |+folding|
3536 feature}
3537 An expression which is used to specify the text displayed for a closed
3538 fold. See |fold-foldtext|.
3539
Bram Moolenaar30b65812012-07-12 22:01:11 +02003540 The expression will be evaluated in the |sandbox| if set from a
3541 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003542 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003543
3544 It is not allowed to change text or jump to another window while
3545 evaluating 'foldtext' |textlock|.
3546
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003547 *'formatexpr'* *'fex'*
3548'formatexpr' 'fex' string (default "")
3549 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003550 {not available when compiled without the |+eval|
3551 feature}
3552 Expression which is evaluated to format a range of lines for the |gq|
3553 operator or automatic formatting (see 'formatoptions'). When this
3554 option is empty 'formatprg' is used.
3555
3556 The |v:lnum| variable holds the first line to be formatted.
3557 The |v:count| variable holds the number of lines to be formatted.
3558 The |v:char| variable holds the character that is going to be
3559 inserted if the expression is being evaluated due to
3560 automatic formatting. This can be empty. Don't insert
3561 it yet!
3562
3563 Example: >
3564 :set formatexpr=mylang#Format()
3565< This will invoke the mylang#Format() function in the
3566 autoload/mylang.vim file in 'runtimepath'. |autoload|
3567
3568 The expression is also evaluated when 'textwidth' is set and adding
3569 text beyond that limit. This happens under the same conditions as
3570 when internal formatting is used. Make sure the cursor is kept in the
3571 same spot relative to the text then! The |mode()| function will
3572 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003573
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003574 When the expression evaluates to non-zero Vim will fall back to using
3575 the internal format mechanism.
3576
3577 The expression will be evaluated in the |sandbox| when set from a
3578 modeline, see |sandbox-option|. That stops the option from working,
3579 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003580 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003581 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003582
Bram Moolenaar86b68352004-12-27 21:59:20 +00003583 *'formatlistpat'* *'flp'*
3584'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3585 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003586 A pattern that is used to recognize a list header. This is used for
3587 the "n" flag in 'formatoptions'.
3588 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003589 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003590 while still checking more characters. There must be a character
3591 following the pattern, when it matches the whole line it is handled
3592 like there is no match.
3593 The default recognizes a number, followed by an optional punctuation
3594 character and white space.
3595
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003596 *'formatoptions'* *'fo'*
3597'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3598 local to buffer
3599 This is a sequence of letters which describes how automatic
3600 formatting is to be done. See |fo-table|. When the 'paste' option is
3601 on, no formatting is done (like 'formatoptions' is empty). Commas can
3602 be inserted for readability.
3603 To avoid problems with flags that are added in the future, use the
3604 "+=" and "-=" feature of ":set" |add-option-flags|.
3605 NOTE: This option is set to the Vi default value when 'compatible' is
3606 set and to the Vim default value when 'compatible' is reset.
3607
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 *'formatprg'* *'fp'*
3609'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003610 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003612 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003614 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003615 If the 'formatexpr' option is not empty it will be used instead.
3616 Otherwise, if 'formatprg' option is an empty string, the internal
3617 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003618 Environment variables are expanded |:set_env|. See |option-backslash|
3619 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003620 This option cannot be set from a |modeline| or in the |sandbox|, for
3621 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622
Bram Moolenaard94464e2015-11-02 15:28:18 +01003623 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003624'fsync' 'fs' boolean (default on)
3625 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003626 When on, the library function fsync() will be called after writing a
3627 file. This will flush a file to disk, ensuring that it is safely
3628 written even on filesystems which do metadata-only journaling. This
3629 will force the harddrive to spin up on Linux systems running in laptop
3630 mode, so it may be undesirable in some situations. Be warned that
3631 turning this off increases the chances of data loss after a crash. On
3632 systems without an fsync() implementation, this variable is always
3633 off.
3634 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003635 'fsync' also applies to |writefile()| (unless a flag is used to
3636 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003637 This option cannot be set from a |modeline| or in the |sandbox|, for
3638 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003639
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3641'gdefault' 'gd' boolean (default off)
3642 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003643 When on, the ":substitute" flag 'g' is default on. This means that
3644 all matches in a line are substituted instead of one. When a 'g' flag
3645 is given to a ":substitute" command, this will toggle the substitution
3646 of all or one match. See |complex-change|.
3647
3648 command 'gdefault' on 'gdefault' off ~
3649 :s/// subst. all subst. one
3650 :s///g subst. one subst. all
3651 :s///gg subst. all subst. one
3652
3653 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003654 DEPRECATED: Setting this option may break plugins that are not aware
3655 of this option. Also, many users get confused that adding the /g flag
3656 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003657 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003658
3659 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003660'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 Format to recognize for the ":grep" command output.
3663 This is a scanf-like string that uses the same format as the
3664 'errorformat' option: see |errorformat|.
3665
3666 *'grepprg'* *'gp'*
3667'grepprg' 'gp' string (default "grep -n ",
3668 Unix: "grep -n $* /dev/null",
3669 Win32: "findstr /n" or "grep -n",
3670 VMS: "SEARCH/NUMBERS ")
3671 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003672 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 and '#' characters, which are expanded like when used in a command-
3674 line. The placeholder "$*" is allowed to specify where the arguments
3675 will be included. Environment variables are expanded |:set_env|. See
3676 |option-backslash| about including spaces and backslashes.
3677 When your "grep" accepts the "-H" argument, use this to make ":grep"
3678 also work well with a single file: >
3679 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003680< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003681 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3682 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003683 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003684 apply equally to 'grepprg'.
3685 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3686 otherwise it's "grep -n".
3687 This option cannot be set from a |modeline| or in the |sandbox|, for
3688 security reasons.
3689
3690 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3691'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3692 ve:ver35-Cursor,
3693 o:hor50-Cursor,
3694 i-ci:ver25-Cursor/lCursor,
3695 r-cr:hor20-Cursor/lCursor,
3696 sm:block-Cursor
3697 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003698 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 "n-v-c:block,o:hor50,i-ci:hor15,
3700 r-cr:hor30,sm:block")
3701 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003703 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003705 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003706 height of the cursor can be changed. This can be done by specifying a
3707 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003708 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3709 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003711 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 mode-list and an argument-list:
3713 mode-list:argument-list,mode-list:argument-list,..
3714 The mode-list is a dash separated list of these modes:
3715 n Normal mode
3716 v Visual mode
3717 ve Visual mode with 'selection' "exclusive" (same as 'v',
3718 if not specified)
3719 o Operator-pending mode
3720 i Insert mode
3721 r Replace mode
3722 c Command-line Normal (append) mode
3723 ci Command-line Insert mode
3724 cr Command-line Replace mode
3725 sm showmatch in Insert mode
3726 a all modes
3727 The argument-list is a dash separated list of these arguments:
3728 hor{N} horizontal bar, {N} percent of the character height
3729 ver{N} vertical bar, {N} percent of the character width
3730 block block cursor, fills the whole character
3731 [only one of the above three should be present]
3732 blinkwait{N} *cursor-blinking*
3733 blinkon{N}
3734 blinkoff{N}
3735 blink times for cursor: blinkwait is the delay before
3736 the cursor starts blinking, blinkon is the time that
3737 the cursor is shown and blinkoff is the time that the
3738 cursor is not shown. The times are in msec. When one
3739 of the numbers is zero, there is no blinking. The
3740 default is: "blinkwait700-blinkon400-blinkoff250".
3741 These numbers are used for a missing entry. This
3742 means that blinking is enabled by default. To switch
3743 blinking off you can use "blinkon0". The cursor only
3744 blinks when Vim is waiting for input, not while
3745 executing a command.
3746 To make the cursor blink in an xterm, see
3747 |xterm-blink|.
3748 {group-name}
3749 a highlight group name, that sets the color and font
3750 for the cursor
3751 {group-name}/{group-name}
3752 Two highlight group names, the first is used when
3753 no language mappings are used, the other when they
3754 are. |language-mapping|
3755
3756 Examples of parts:
3757 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3758 block cursor with colors from the "nCursor"
3759 highlight group
3760 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3761 In Insert and Command-line Insert mode, use a
3762 30% vertical bar cursor with colors from the
3763 "iCursor" highlight group. Blink a bit
3764 faster.
3765
3766 The 'a' mode is different. It will set the given argument-list for
3767 all modes. It does not reset anything to defaults. This can be used
3768 to do a common setting for all modes. For example, to switch off
3769 blinking: "a:blinkon0"
3770
3771 Examples of cursor highlighting: >
3772 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3773 :highlight Cursor gui=NONE guifg=bg guibg=fg
3774<
3775 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003776 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777'guifont' 'gfn' string (default "")
3778 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 {only available when compiled with GUI enabled}
3780 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003781 In its simplest form the value is just one font name.
3782 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783
3784 *'guifontset'* *'gfs'*
3785 *E250* *E252* *E234* *E597* *E598*
3786'guifontset' 'gfs' string (default "")
3787 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 {only available when compiled with GUI enabled and
3789 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003790 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791 When not empty, specifies two (or more) fonts to be used. The first
3792 one for normal English, the second one for your special language. See
3793 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003794
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3796'guifontwide' 'gfw' string (default "")
3797 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 {only available when compiled with GUI enabled}
3799 When not empty, specifies a comma-separated list of fonts to be used
3800 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003801 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003802
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 *'guiheadroom'* *'ghr'*
3804'guiheadroom' 'ghr' number (default 50)
3805 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003806 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 The number of pixels subtracted from the screen height when fitting
3808 the GUI window on the screen. Set this before the GUI is started,
3809 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003810 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 lines will be left for window decorations and other items on the
3812 screen. Set it to a negative value to allow windows taller than the
3813 screen.
3814
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003815 *'guiligatures'* *'gli'* *E1243*
3816'guiligatures' 'gli' string (default "")
3817 global
3818 {only for GTK GUI}
3819 List of ASCII characters that, when combined together, can create more
3820 complex shapes. Each character must be a printable ASCII character
3821 with a value in the 32-127 range.
3822 Example: >
3823 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3824< Changing this option updates screen output immediately. Set it to an
3825 empty string to disable ligatures.
3826
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003828'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3829 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003830 "aegimrLtT" (GTK, Motif and Athena),
3831 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003834 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 sequence of letters which describes what components and options of the
3836 GUI should be used.
3837 To avoid problems with flags that are added in the future, use the
3838 "+=" and "-=" feature of ":set" |add-option-flags|.
3839
Bram Moolenaar13568252018-03-16 20:46:58 +01003840 Valid characters are as follows:
3841 *'go-!'*
3842 '!' External commands are executed in a terminal window. Without
3843 this flag the MS-Windows GUI will open a console window to
3844 execute the command. The Unix GUI will simulate a dumb
3845 terminal to list the command output.
3846 The terminal window will be positioned at the bottom, and grow
3847 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003848 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 'a' Autoselect: If present, then whenever VISUAL mode is started,
3850 or the Visual area extended, Vim tries to become the owner of
3851 the windowing system's global selection. This means that the
3852 Visually highlighted text is available for pasting into other
3853 applications as well as into Vim itself. When the Visual mode
3854 ends, possibly due to an operation on the text, or when an
3855 application wants to paste the selection, the highlighted text
3856 is automatically yanked into the "* selection register.
3857 Thus the selection is still available for pasting into other
3858 applications after the VISUAL mode has ended.
3859 If not present, then Vim won't become the owner of the
3860 windowing system's global selection unless explicitly told to
3861 by a yank or delete operation for the "* register.
3862 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003863 *'go-P'*
3864 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003865 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003866 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003867 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868 applies to the modeless selection.
3869
3870 'guioptions' autoselect Visual autoselect modeless ~
3871 "" - -
3872 "a" yes yes
3873 "A" - yes
3874 "aA" yes yes
3875
Bram Moolenaar02467872007-05-06 13:22:01 +00003876 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 'c' Use console dialogs instead of popup dialogs for simple
3878 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003879 *'go-d'*
3880 'd' Use dark theme variant if available. Currently only works for
3881 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003882 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003883 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003884 'guitablabel' can be used to change the text in the labels.
3885 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003886 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003887 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003888 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 'f' Foreground: Don't use fork() to detach the GUI from the shell
3890 where it was started. Use this for programs that wait for the
3891 editor to finish (e.g., an e-mail program). Alternatively you
3892 can use "gvim -f" or ":gui -f" to start the GUI in the
3893 foreground. |gui-fork|
3894 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003895 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003896 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3898 corner of the window. It's black&white on non-GTK, because of
3899 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003900 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003902 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003903 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003905 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003907 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003908 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 'g' Grey menu items: Make menu items that are not active grey. If
3910 'g' is not included inactive menu items are not shown at all.
3911 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003912 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 't' Include tearoff menu items. Currently only works for Win32,
3914 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003915 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003916 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003917 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003918 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003920 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 'R' Right-hand scrollbar is present when there is a vertically
3922 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003923 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003925 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 'L' Left-hand scrollbar is present when there is a vertically
3927 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003928 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3930 the longest visible line, or on the cursor line if the 'h'
3931 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003932 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003933 'h' Limit horizontal scrollbar size to the length of the cursor
3934 line. Reduces computations. |gui-horiz-scroll|
3935
3936 And yes, you may even have scrollbars on the left AND the right if
3937 you really want to :-). See |gui-scrollbars| for more information.
3938
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003939 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 'v' Use a vertical button layout for dialogs. When not included,
3941 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003942 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003943 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 'p' Use Pointer callbacks for X11 GUI. This is required for some
3945 window managers. If the cursor is not blinking or hollow at
3946 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003947 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003949 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003950 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003951 *'go-k'*
3952 'k' Keep the GUI window size when adding/removing a scrollbar, or
3953 toolbar, tabline, etc. Instead, the behavior is similar to
3954 when the window is maximized and will adjust 'lines' and
3955 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003956 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003957 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003958
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 *'guipty'* *'noguipty'*
3960'guipty' boolean (default on)
3961 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 {only available when compiled with GUI enabled}
3963 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3964 I/O to/from shell commands. See |gui-pty|.
3965
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003966 *'guitablabel'* *'gtl'*
3967'guitablabel' 'gtl' string (default empty)
3968 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003969 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003970 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003971 pages line. When empty and when the result is empty Vim will use a
3972 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003973
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003974 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003975 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003976 The expression will be evaluated in the |sandbox| when set from a
3977 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003978 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003979
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003980 Only used when the GUI tab pages line is displayed. 'e' must be
3981 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3982 used.
3983
Bram Moolenaar57657d82006-04-21 22:12:41 +00003984 *'guitabtooltip'* *'gtt'*
3985'guitabtooltip' 'gtt' string (default empty)
3986 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003987 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003988 When nonempty describes the text to use in a tooltip for the GUI tab
3989 pages line. When empty Vim will use a default tooltip.
3990 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003991 You can include a line break. Simplest method is to use |:let|: >
3992 :let &guitabtooltip = "line one\nline two"
3993<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003994
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003996'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 (others) "$VIMRUNTIME/doc/help.txt")
3998 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 Name of the main help file. All distributed help files should be
4000 placed together in one directory. Additionally, all "doc" directories
4001 in 'runtimepath' will be used.
4002 Environment variables are expanded |:set_env|. For example:
4003 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004004 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 spaces and backslashes.
4006 This option cannot be set from a |modeline| or in the |sandbox|, for
4007 security reasons.
4008
4009 *'helpheight'* *'hh'*
4010'helpheight' 'hh' number (default 20)
4011 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 Minimal initial height of the help window when it is opened with the
4013 ":help" command. The initial height of the help window is half of the
4014 current window, or (when the 'ea' option is on) the same as other
4015 windows. When the height is less than 'helpheight', the height is
4016 set to 'helpheight'. Set to zero to disable.
4017
4018 *'helplang'* *'hlg'*
4019'helplang' 'hlg' string (default: messages language or empty)
4020 global
4021 {only available when compiled with the |+multi_lang|
4022 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023 Comma separated list of languages. Vim will use the first language
4024 for which the desired help can be found. The English help will always
4025 be used as a last resort. You can add "en" to prefer English over
4026 another language, but that will only find tags that exist in that
4027 language and not in the English help.
4028 Example: >
4029 :set helplang=de,it
4030< This will first search German, then Italian and finally English help
4031 files.
4032 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4033 try to find the tag in the current language before using this option.
4034 See |help-translated|.
4035
4036 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4037'hidden' 'hid' boolean (default off)
4038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 When off a buffer is unloaded when it is |abandon|ed. When on a
4040 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4041 displayed in another window, it does not become hidden, of course.
4042 The commands that move through the buffer list sometimes make a buffer
4043 hidden although the 'hidden' option is off: When the buffer is
4044 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004045 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004046 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 This option is set for one command with ":hide {command}" |:hide|.
4048 WARNING: It's easy to forget that you have changes in hidden buffers.
4049 Think twice when using ":q!" or ":qa!".
4050
4051 *'highlight'* *'hl'*
4052'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004053 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4054 d:Directory,e:ErrorMsg,i:IncSearch,
4055 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004056 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004057 N:CursorLineNr,r:Question,s:StatusLine,
4058 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004059 v:Visual,V:VisualNOS,w:WarningMsg,
4060 W:WildMenu,f:Folded,F:FoldColumn,
4061 A:DiffAdd,C:DiffChange,D:DiffDelete,
4062 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004063 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004064 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004065 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4066 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004067 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004068 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070 This option can be used to set highlighting mode for various
4071 occasions. It is a comma separated list of character pairs. The
4072 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004073 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004074 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004075 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4076 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 characters from 'showbreak'
4078 |hl-Directory| d directories in CTRL-D listing and other special
4079 things in listings
4080 |hl-ErrorMsg| e error messages
4081 h (obsolete, ignored)
4082 |hl-IncSearch| i 'incsearch' highlighting
4083 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4084 |hl-MoreMsg| m |more-prompt|
4085 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004086 |hl-LineNr| n line number for ":number" and ":#" commands, and
4087 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004088 |hl-LineNrAbove| a line number above the cursor for when the
4089 'relativenumber' option is set.
4090 |hl-LineNrBelow| b line number below the cursor for when the
4091 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004092 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4093 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094 |hl-Question| r |hit-enter| prompt and yes/no questions
4095 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004096 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4098 |hl-VertSplit| c column used to separate vertically split windows
4099 |hl-Visual| v Visual mode
4100 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4101 Selection" Only X11 Gui's |gui-x11| and
4102 |xterm-clipboard|.
4103 |hl-WarningMsg| w warning messages
4104 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4105 |hl-Folded| f line used for closed folds
4106 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004107 |hl-DiffAdd| A added line in diff mode
4108 |hl-DiffChange| C changed line in diff mode
4109 |hl-DiffDelete| D deleted line in diff mode
4110 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004112 |hl-Conceal| - the placeholders used for concealed characters
4113 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004114 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004115 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004116 |hl-SpellRare| R rare word |spell|
4117 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004118 |hl-Pmenu| + popup menu normal line
4119 |hl-PmenuSel| = popup menu selected line
4120 |hl-PmenuSbar| x popup menu scrollbar
4121 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122
4123 The display modes are:
4124 r reverse (termcap entry "mr" and "me")
4125 i italic (termcap entry "ZH" and "ZR")
4126 b bold (termcap entry "md" and "me")
4127 s standout (termcap entry "so" and "se")
4128 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004129 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004130 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 n no highlighting
4132 - no highlighting
4133 : use a highlight group
4134 The default is used for occasions that are not included.
4135 If you want to change what the display modes do, see |dos-colors|
4136 for an example.
4137 When using the ':' display mode, this must be followed by the name of
4138 a highlight group. A highlight group can be used to define any type
4139 of highlighting, including using color. See |:highlight| on how to
4140 define one. The default uses a different group for each occasion.
4141 See |highlight-default| for the default highlight groups.
4142
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004144'history' 'hi' number (Vim default: 50, Vi default: 0,
4145 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004148 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004150 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 NOTE: This option is set to the Vi default value when 'compatible' is
4152 set and to the Vim default value when 'compatible' is reset.
4153
4154 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4155'hkmap' 'hk' boolean (default off)
4156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 {only available when compiled with the |+rightleft|
4158 feature}
4159 When on, the keyboard is mapped for the Hebrew character set.
4160 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4161 toggle this option. See |rileft.txt|.
4162 NOTE: This option is reset when 'compatible' is set.
4163
4164 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4165'hkmapp' 'hkp' boolean (default off)
4166 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 {only available when compiled with the |+rightleft|
4168 feature}
4169 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4170 This is useful if you have a non-Hebrew keyboard.
4171 See |rileft.txt|.
4172 NOTE: This option is reset when 'compatible' is set.
4173
Bram Moolenaar036986f2017-03-16 17:41:02 +01004174 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4175'hlsearch' 'hls' boolean (default off)
4176 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004177 {not available when compiled without the
4178 |+extra_search| feature}
4179 When there is a previous search pattern, highlight all its matches.
4180 The type of highlighting used can be set with the 'l' occasion in the
4181 'highlight' option. This uses the "Search" highlight group by
4182 default. Note that only the matching text is highlighted, any offsets
4183 are not applied.
4184 See also: 'incsearch' and |:match|.
4185 When you get bored looking at the highlighted matches, you can turn it
4186 off with |:nohlsearch|. This does not change the option value, as
4187 soon as you use a search command, the highlighting comes back.
4188 'redrawtime' specifies the maximum time spent on finding matches.
4189 When the search pattern can match an end-of-line, Vim will try to
4190 highlight all of the matched text. However, this depends on where the
4191 search starts. This will be the first line in the window or the first
4192 line below a closed fold. A match in a previous line which is not
4193 drawn may not continue in a newly drawn line.
4194 You can specify whether the highlight status is restored on startup
4195 with the 'h' flag in 'viminfo' |viminfo-h|.
4196 NOTE: This option is reset when 'compatible' is set.
4197
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 *'icon'* *'noicon'*
4199'icon' boolean (default off, on when title can be restored)
4200 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201 When on, the icon text of the window will be set to the value of
4202 'iconstring' (if it is not empty), or to the name of the file
4203 currently being edited. Only the last part of the name is used.
4204 Overridden by the 'iconstring' option.
4205 Only works if the terminal supports setting window icons (currently
4206 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4207 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4208 builtin termcap).
4209 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004210 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004212 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213
4214 *'iconstring'*
4215'iconstring' string (default "")
4216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 When this option is not empty, it will be used for the icon text of
4218 the window. This happens only when the 'icon' option is on.
4219 Only works if the terminal supports setting window icon text
4220 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004221 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 When Vim was compiled with HAVE_X11 defined, the original icon will be
4223 restored if possible |X11|.
4224 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004225 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004227 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228 {not available when compiled without the |+statusline| feature}
4229
4230 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4231'ignorecase' 'ic' boolean (default off)
4232 global
4233 Ignore case in search patterns. Also used when searching in the tags
4234 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004235 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 Can be overruled by using "\c" or "\C" in the pattern, see
4237 |/ignorecase|.
4238
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004239 *'imactivatefunc'* *'imaf'*
4240'imactivatefunc' 'imaf' string (default "")
4241 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004242 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004243 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004244 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004245 The expression will be evaluated in the |sandbox| when set from a
4246 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004247
4248 Example: >
4249 function ImActivateFunc(active)
4250 if a:active
4251 ... do something
4252 else
4253 ... do something
4254 endif
4255 " return value is not used
4256 endfunction
4257 set imactivatefunc=ImActivateFunc
4258<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 *'imactivatekey'* *'imak'*
4260'imactivatekey' 'imak' string (default "")
4261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004263 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 Specifies the key that your Input Method in X-Windows uses for
4265 activation. When this is specified correctly, vim can fully control
4266 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4267 You can't use this option to change the activation key, the option
4268 tells Vim what the key is.
4269 Format:
4270 [MODIFIER_FLAG-]KEY_STRING
4271
4272 These characters can be used for MODIFIER_FLAG (case is ignored):
4273 S Shift key
4274 L Lock key
4275 C Control key
4276 1 Mod1 key
4277 2 Mod2 key
4278 3 Mod3 key
4279 4 Mod4 key
4280 5 Mod5 key
4281 Combinations are allowed, for example "S-C-space" or "SC-space" are
4282 both shift+ctrl+space.
4283 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4284
4285 Example: >
4286 :set imactivatekey=S-space
4287< "S-space" means shift+space. This is the activation key for kinput2 +
4288 canna (Japanese), and ami (Korean).
4289
4290 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4291'imcmdline' 'imc' boolean (default off)
4292 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 When set the Input Method is always on when starting to edit a command
4294 line, unless entering a search pattern (see 'imsearch' for that).
4295 Setting this option is useful when your input method allows entering
4296 English characters directly, e.g., when it's used to type accented
4297 characters with dead keys.
4298
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004299 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4301 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 When set the Input Method is never used. This is useful to disable
4303 the IM when it doesn't work properly.
4304 Currently this option is on by default for SGI/IRIX machines. This
4305 may change in later releases.
4306
4307 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004308'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310 Specifies whether :lmap or an Input Method (IM) is to be used in
4311 Insert mode. Valid values:
4312 0 :lmap is off and IM is off
4313 1 :lmap is ON and IM is off
4314 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 To always reset the option to zero when leaving Insert mode with <Esc>
4316 this can be used: >
4317 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4318< This makes :lmap and IM turn off automatically when leaving Insert
4319 mode.
4320 Note that this option changes when using CTRL-^ in Insert mode
4321 |i_CTRL-^|.
4322 The value is set to 1 when setting 'keymap' to a valid keymap name.
4323 It is also used for the argument of commands like "r" and "f".
4324 The value 0 may not work correctly with Athena and Motif with some XIM
4325 methods. Use 'imdisable' to disable XIM then.
4326
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004327 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004328 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004329 |+multi_byte_ime| or |global-ime|.
4330
Bram Moolenaar071d4272004-06-13 20:20:40 +00004331 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004332'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334 Specifies whether :lmap or an Input Method (IM) is to be used when
4335 entering a search pattern. Valid values:
4336 -1 the value of 'iminsert' is used, makes it look like
4337 'iminsert' is also used when typing a search pattern
4338 0 :lmap is off and IM is off
4339 1 :lmap is ON and IM is off
4340 2 :lmap is off and IM is ON
4341 Note that this option changes when using CTRL-^ in Command-line mode
4342 |c_CTRL-^|.
4343 The value is set to 1 when it is not -1 and setting the 'keymap'
4344 option to a valid keymap name.
4345 The value 0 may not work correctly with Athena and Motif with some XIM
4346 methods. Use 'imdisable' to disable XIM then.
4347
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004348 *'imstatusfunc'* *'imsf'*
4349'imstatusfunc' 'imsf' string (default "")
4350 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004351 This option specifies a function that is called to obtain the status
4352 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004353 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004354
4355 Example: >
4356 function ImStatusFunc()
4357 let is_active = ...do something
4358 return is_active ? 1 : 0
4359 endfunction
4360 set imstatusfunc=ImStatusFunc
4361<
4362 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004363 The expression will be evaluated in the |sandbox| when set from a
4364 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004365
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004366 *'imstyle'* *'imst'*
4367'imstyle' 'imst' number (default 1)
4368 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004369 {only available when compiled with |+xim| and
4370 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004371 This option specifies the input style of Input Method:
4372 0 use on-the-spot style
4373 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004374 See: |xim-input-style|
4375
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004376 For a long time on-the-spot style had been used in the GTK version of
4377 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004378 |single-repeat|, etc. Therefore over-the-spot style becomes the
4379 default now. This should work fine for most people, however if you
4380 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004381 The expression will be evaluated in the |sandbox| when set from a
4382 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004383
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 *'include'* *'inc'*
4385'include' 'inc' string (default "^\s*#\s*include")
4386 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387 {not available when compiled without the
4388 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004389 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004390 pattern, just like for the "/" command (See |pattern|). The default
4391 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004392 "]I", "[d", etc.
4393 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004394 comes after the matched pattern. But if "\zs" appears in the pattern
4395 then the text matched from "\zs" to the end, or until "\ze" if it
4396 appears, is used as the file name. Use this to include characters
4397 that are not in 'isfname', such as a space. You can then use
4398 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004399 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400
4401 *'includeexpr'* *'inex'*
4402'includeexpr' 'inex' string (default "")
4403 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004405 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004407 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 :set includeexpr=substitute(v:fname,'\\.','/','g')
4409< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004410
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004412 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413 Also used for |<cfile>|.
4414
Bram Moolenaar30b65812012-07-12 22:01:11 +02004415 The expression will be evaluated in the |sandbox| when set from a
4416 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004417 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004418
4419 It is not allowed to change text or jump to another window while
4420 evaluating 'includeexpr' |textlock|.
4421
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004423'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4424 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004427 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004428 While typing a search command, show where the pattern, as it was typed
4429 so far, matches. The matched string is highlighted. If the pattern
4430 is invalid or not found, nothing is shown. The screen will be updated
4431 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004432 Also applies to the pattern in commands: >
4433 :global
4434 :lvimgrep
4435 :lvimgrepadd
4436 :smagic
4437 :snomagic
4438 :sort
4439 :substitute
4440 :vglobal
4441 :vimgrep
4442 :vimgrepadd
4443< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004444 original position when no match is found and when pressing <Esc>. You
4445 still need to finish the search command with <Enter> to move the
4446 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004447 You can use the CTRL-G and CTRL-T keys to move to the next and
4448 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004449 When compiled with the |+reltime| feature Vim only searches for about
4450 half a second. With a complicated pattern and/or a lot of text the
4451 match may not be found. This is to avoid that Vim hangs while you
4452 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004453 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004454 When 'hlsearch' is on, all matched strings are highlighted too while
4455 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004456 If you don't want to turn 'hlsearch' on, but want to highlight all
4457 matches while searching, you can turn on and off 'hlsearch' with
4458 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004459 augroup vimrc-incsearch-highlight
4460 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004461 autocmd CmdlineEnter /,\? :set hlsearch
4462 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004463 augroup END
4464<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004465 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004466 to the command line. If 'ignorecase' and 'smartcase' are set and the
4467 command line has no uppercase characters, the added character is
4468 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004469 CTRL-R CTRL-W can be used to add the word at the end of the current
4470 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471 NOTE: This option is reset when 'compatible' is set.
4472
4473 *'indentexpr'* *'inde'*
4474'indentexpr' 'inde' string (default "")
4475 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 {not available when compiled without the |+cindent|
4477 or |+eval| features}
4478 Expression which is evaluated to obtain the proper indent for a line.
4479 It is used when a new line is created, for the |=| operator and
4480 in Insert mode as specified with the 'indentkeys' option.
4481 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004482 'smartindent' indenting. When 'lisp' is set, this option is
4483 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 When 'paste' is set this option is not used for indenting.
4485 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004486 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 when the expression is evaluated (but it may be moved around).
4488 The expression must return the number of spaces worth of indent. It
4489 can return "-1" to keep the current indent (this means 'autoindent' is
4490 used for the indent).
4491 Functions useful for computing the indent are |indent()|, |cindent()|
4492 and |lispindent()|.
4493 The evaluation of the expression must not have side effects! It must
4494 not change the text, jump to another window, etc. Afterwards the
4495 cursor position is always restored, thus the cursor may be moved.
4496 Normally this option would be set to call a function: >
4497 :set indentexpr=GetMyIndent()
4498< Error messages will be suppressed, unless the 'debug' option contains
4499 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004500 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004501 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004502
Bram Moolenaar30b65812012-07-12 22:01:11 +02004503 The expression will be evaluated in the |sandbox| when set from a
4504 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004505 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004506
4507 It is not allowed to change text or jump to another window while
4508 evaluating 'indentexpr' |textlock|.
4509
4510
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004512'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 {not available when compiled without the |+cindent|
4515 feature}
4516 A list of keys that, when typed in Insert mode, cause reindenting of
4517 the current line. Only happens if 'indentexpr' isn't empty.
4518 The format is identical to 'cinkeys', see |indentkeys-format|.
4519 See |C-indenting| and |indent-expression|.
4520
4521 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4522'infercase' 'inf' boolean (default off)
4523 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004525 'ignorecase' is also on, the case of the match is adjusted depending
4526 on the typed text. If the typed text contains a lowercase letter
4527 where the match has an upper case letter, the completed part is made
4528 lowercase. If the typed text has no lowercase letters and the match
4529 has a lowercase letter where the typed text has an uppercase letter,
4530 and there is a letter before it, the completed part is made uppercase.
4531 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532
4533 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4534'insertmode' 'im' boolean (default off)
4535 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536 Makes Vim work in a way that Insert mode is the default mode. Useful
4537 if you want to use Vim as a modeless editor. Used for |evim|.
4538 These Insert mode commands will be useful:
4539 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004540 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 this is a mapping, it is executed as if 'insertmode' was off.
4542 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004544 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4545 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546
4547 These items change when 'insertmode' is set:
4548 - when starting to edit of a file, Vim goes to Insert mode.
4549 - <Esc> in Insert mode is a no-op and beeps.
4550 - <Esc> in Normal mode makes Vim go to Insert mode.
4551 - CTRL-L in Insert mode is a command, it is not inserted.
4552 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4553 However, when <Esc> is used inside a mapping, it behaves like
4554 'insertmode' was not set. This was done to be able to use the same
4555 mappings with 'insertmode' set or not set.
4556 When executing commands with |:normal| 'insertmode' is not used.
4557
4558 NOTE: This option is reset when 'compatible' is set.
4559
4560 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004561'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4563 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4564 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4565 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4566 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4567 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568 The characters specified by this option are included in file names and
4569 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004570 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004571 Multi-byte characters 256 and above are always included, only the
4572 characters up to 255 are specified with this option.
4573 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004574 Think twice before adding white space to this option. Although a
4575 space may appear inside a file name, the effect will be that Vim
4576 doesn't know where a file name starts or ends when doing completion.
4577 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578
4579 Note that on systems using a backslash as path separator, Vim tries to
4580 do its best to make it work as you would expect. That is a bit
4581 tricky, since Vi originally used the backslash to escape special
4582 characters. Vim will not remove a backslash in front of a normal file
4583 name character on these systems, but it will on Unix and alikes. The
4584 '&' and '^' are not included by default, because these are special for
4585 cmd.exe.
4586
4587 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004588 Each part can be a single character number or a range. A range is two
4589 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590 decimal number between 0 and 255 or the ASCII character itself (does
4591 not work for digits). Example:
4592 "_,-,128-140,#-43" (include '_' and '-' and the range
4593 128 to 140 and '#' to 43)
4594 If a part starts with '^', the following character number or range
4595 will be excluded from the option. The option is interpreted from left
4596 to right. Put the excluded character after the range where it is
4597 included. To include '^' itself use it as the last character of the
4598 option or the end of a range. Example:
4599 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4600 If the character is '@', all characters where isalpha() returns TRUE
4601 are included. Normally these are the characters a to z and A to Z,
4602 plus accented characters. To include '@' itself use "@-@". Examples:
4603 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004604 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 "a-z,A-Z,@-@" All letters plus the '@' character.
4606 A comma can be included by using it where a character number is
4607 expected. Example:
4608 "48-57,,,_" Digits, comma and underscore.
4609 A comma can be excluded by prepending a '^'. Example:
4610 " -~,^,,9" All characters from space to '~', excluding
4611 comma, plus <Tab>.
4612 See |option-backslash| about including spaces and backslashes.
4613
4614 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004615'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 "@,48-57,_,128-167,224-235"
4617 otherwise: "@,48-57,_,192-255")
4618 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 The characters given by this option are included in identifiers.
4620 Identifiers are used in recognizing environment variables and after a
4621 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004622 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004623 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004625 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4627
4628 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004629'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 "@,48-57,_,128-167,224-235"
4631 otherwise: "@,48-57,_,192-255"
4632 Vi default: "@,48-57,_")
4633 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004635 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004636 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004637 characters above 255 check the "word" character class (any character
4638 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004639 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640 For a help file it is set to all non-blank printable characters except
4641 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4642 command).
4643 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004644 This option also influences syntax highlighting, unless the syntax
4645 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646 NOTE: This option is set to the Vi default value when 'compatible' is
4647 set and to the Vim default value when 'compatible' is reset.
4648
4649 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004650'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 "@,~-255"; otherwise: "@,161-255")
4652 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 The characters given by this option are displayed directly on the
4654 screen. It is also used for "\p" in a |pattern|. The characters from
4655 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4656 even when they are not included in 'isprint' or excluded. See
4657 'isfname' for a description of the format of this option.
4658
4659 Non-printable characters are displayed with two characters:
4660 0 - 31 "^@" - "^_"
4661 32 - 126 always single characters
4662 127 "^?"
4663 128 - 159 "~@" - "~_"
4664 160 - 254 "| " - "|~"
4665 255 "~?"
4666 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4667 displayed as <xx>, with the hexadecimal value of the byte.
4668 When 'display' contains "uhex" all unprintable characters are
4669 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004670 The SpecialKey highlighting will be used for unprintable characters.
4671 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672
4673 Multi-byte characters 256 and above are always included, only the
4674 characters up to 255 are specified with this option. When a character
4675 is printable but it is not available in the current font, a
4676 replacement character will be shown.
4677 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4678 There is no option to specify these characters.
4679
4680 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4681'joinspaces' 'js' boolean (default on)
4682 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004683 Insert two spaces after a '.', '?' and '!' with a join command.
4684 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4685 Otherwise only one space is inserted.
4686 NOTE: This option is set when 'compatible' is set.
4687
4688 *'key'*
4689'key' string (default "")
4690 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004691 {only available when compiled with the |+cryptv|
4692 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004693 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004694 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 Careful: Do not set the key value by hand, someone might see the typed
4696 key. Use the |:X| command. But you can make 'key' empty: >
4697 :set key=
4698< It is not possible to get the value of this option with ":set key" or
4699 "echo &key". This is to avoid showing it to someone who shouldn't
4700 know. It also means you cannot see it yourself once you have set it,
4701 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004702 You can use "&key" in an expression to detect whether encryption is
4703 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704
4705 *'keymap'* *'kmp'* *E544*
4706'keymap' 'kmp' string (default "")
4707 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004708 {only available when compiled with the |+keymap|
4709 feature}
4710 Name of a keyboard mapping. See |mbyte-keymap|.
4711 Setting this option to a valid keymap name has the side effect of
4712 setting 'iminsert' to one, so that the keymap becomes effective.
4713 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004714 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715
4716 *'keymodel'* *'km'*
4717'keymodel' 'km' string (default "")
4718 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719 List of comma separated words, which enable special things that keys
4720 can do. These values can be used:
4721 startsel Using a shifted special key starts selection (either
4722 Select mode or Visual mode, depending on "key" being
4723 present in 'selectmode').
4724 stopsel Using a not-shifted special key stops selection.
4725 Special keys in this context are the cursor keys, <End>, <Home>,
4726 <PageUp> and <PageDown>.
4727 The 'keymodel' option is set by the |:behave| command.
4728
4729 *'keywordprg'* *'kp'*
4730'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004731 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004733 Program to use for the |K| command. Environment variables are
4734 expanded |:set_env|. ":help" may be used to access the Vim internal
4735 help. (Note that previously setting the global option to the empty
4736 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004737 When the first character is ":", the command is invoked as a Vim
4738 Ex command prefixed with [count].
4739 When "man", "man -s" or an Ex command is used, Vim will automatically
4740 translate a count for the "K" command and pass it as the first
4741 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742 See |option-backslash| about including spaces and backslashes.
4743 Example: >
4744 :set keywordprg=man\ -s
4745< This option cannot be set from a |modeline| or in the |sandbox|, for
4746 security reasons.
4747
4748 *'langmap'* *'lmap'* *E357* *E358*
4749'langmap' 'lmap' string (default "")
4750 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751 {only available when compiled with the |+langmap|
4752 feature}
4753 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004754 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004755 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 care of translating these special characters to the original meaning
4757 of the key. This means you don't have to change the keyboard mode to
4758 be able to execute Normal mode commands.
4759 This is the opposite of the 'keymap' option, where characters are
4760 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004761 Also consider setting 'langremap' to off, to prevent 'langmap' from
4762 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004763 This option cannot be set from a |modeline| or in the |sandbox|, for
4764 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004766 Example (for Greek, in UTF-8): *greek* >
4767 :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 +00004768< Example (exchanges meaning of z and y for commands): >
4769 :set langmap=zy,yz,ZY,YZ
4770<
4771 The 'langmap' option is a list of parts, separated with commas. Each
4772 part can be in one of two forms:
4773 1. A list of pairs. Each pair is a "from" character immediately
4774 followed by the "to" character. Examples: "aA", "aAbBcC".
4775 2. A list of "from" characters, a semi-colon and a list of "to"
4776 characters. Example: "abc;ABC"
4777 Example: "aA,fgh;FGH,cCdDeE"
4778 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004779 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004780
4781 This will allow you to activate vim actions without having to switch
4782 back and forth between the languages. Your language characters will
4783 be understood as normal vim English characters (according to the
4784 langmap mappings) in the following cases:
4785 o Normal/Visual mode (commands, buffer/register names, user mappings)
4786 o Insert/Replace Mode: Register names after CTRL-R
4787 o Insert/Replace Mode: Mappings
4788 Characters entered in Command-line mode will NOT be affected by
4789 this option. Note that this option can be changed at any time
4790 allowing to switch between mappings for different languages/encodings.
4791 Use a mapping to avoid having to type it each time!
4792
4793 *'langmenu'* *'lm'*
4794'langmenu' 'lm' string (default "")
4795 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796 {only available when compiled with the |+menu| and
4797 |+multi_lang| features}
4798 Language to use for menu translation. Tells which file is loaded
4799 from the "lang" directory in 'runtimepath': >
4800 "lang/menu_" . &langmenu . ".vim"
4801< (without the spaces). For example, to always use the Dutch menus, no
4802 matter what $LANG is set to: >
4803 :set langmenu=nl_NL.ISO_8859-1
4804< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004805 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 If your $LANG is set to a non-English language but you do want to use
4807 the English menus: >
4808 :set langmenu=none
4809< This option must be set before loading menus, switching on filetype
4810 detection or syntax highlighting. Once the menus are defined setting
4811 this option has no effect. But you could do this: >
4812 :source $VIMRUNTIME/delmenu.vim
4813 :set langmenu=de_DE.ISO_8859-1
4814 :source $VIMRUNTIME/menu.vim
4815< Warning: This deletes all menus that you defined yourself!
4816
Bram Moolenaard94464e2015-11-02 15:28:18 +01004817 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004818'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004819 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004820 {only available when compiled with the |+langmap|
4821 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004822 This is just like 'langremap' but with the value inverted. It only
4823 exists for backwards compatibility. When setting 'langremap' then
4824 'langnoremap' is set to the inverted value, and the other way around.
4825
4826 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004827'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004828 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004829 {only available when compiled with the |+langmap|
4830 feature}
4831 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004832 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004833 'langmap' disables some of your mappings, try resetting this option.
4834 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004835 that works for you to avoid mappings to break.
4836
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837 *'laststatus'* *'ls'*
4838'laststatus' 'ls' number (default 1)
4839 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 The value of this option influences when the last window will have a
4841 status line:
4842 0: never
4843 1: only if there are at least two windows
4844 2: always
4845 The screen looks nicer with a status line if you have several
4846 windows, but it takes another screen line. |status-line|
4847
4848 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4849'lazyredraw' 'lz' boolean (default off)
4850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 When this option is set, the screen will not be redrawn while
4852 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004853 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004854 update use |:redraw|.
4855
4856 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4857'linebreak' 'lbr' boolean (default off)
4858 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004859 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004861 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862 than at the last character that fits on the screen. Unlike
4863 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004864 it only affects the way the file is displayed, not its contents.
4865 If 'breakindent' is set, line is visually indented. Then, the value
4866 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004867 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868 Note that <Tab> characters after an <EOL> are mostly not displayed
4869 with the right amount of white space.
4870
4871 *'lines'* *E593*
4872'lines' number (default 24 or terminal height)
4873 global
4874 Number of lines of the Vim window.
4875 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004876 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 When Vim is running in the GUI or in a resizable window, setting this
4878 option will cause the window size to be changed. When you only want
4879 to use the size for the GUI, put the command in your |gvimrc| file.
4880 Vim limits the number of lines to what fits on the screen. You can
4881 use this command to get the tallest window possible: >
4882 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004883< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004884 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885 When you set this option and Vim is unable to change the physical
4886 number of lines of the display, the display may be messed up.
4887
4888 *'linespace'* *'lsp'*
4889'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 {only in the GUI}
4892 Number of pixel lines inserted between characters. Useful if the font
4893 uses the full character cell height, making lines touch each other.
4894 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004895 With some fonts there can be too much room between lines (to have
4896 space for ascents and descents). Then it makes sense to set
4897 'linespace' to a negative value. This may cause display problems
4898 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899
4900 *'lisp'* *'nolisp'*
4901'lisp' boolean (default off)
4902 local to buffer
4903 {not available when compiled without the |+lispindent|
4904 feature}
4905 Lisp mode: When <Enter> is typed in insert mode set the indent for
4906 the next line to Lisp standards (well, sort of). Also happens with
4907 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4908 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4909 better. Also see 'lispwords'.
4910 The '-' character is included in keyword characters. Redefines the
4911 "=" operator to use this same indentation algorithm rather than
4912 calling an external program if 'equalprg' is empty.
4913 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004914
4915 *'lispwords'* *'lw'*
4916'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004917 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918 {not available when compiled without the |+lispindent|
4919 feature}
4920 Comma separated list of words that influence the Lisp indenting.
4921 |'lisp'|
4922
4923 *'list'* *'nolist'*
4924'list' boolean (default off)
4925 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00004926 List mode: By default show tabs as CTRL-I is displayed, display $
4927 after end of line. Useful to see the difference between tabs and
4928 spaces and for trailing blanks. Further changed by the 'listchars'
4929 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004930
4931 The cursor is displayed at the start of the space a Tab character
4932 occupies, not at the end as usual in Normal mode. To get this cursor
4933 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004934 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004935<
4936 Note that list mode will also affect formatting (set with 'textwidth'
4937 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938 changing the way tabs are displayed.
4939
4940 *'listchars'* *'lcs'*
4941'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004942 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004943 Strings to use in 'list' mode and for the |:list| command. It is a
4944 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004945 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 eol:c Character to show at the end of each line. When
4947 omitted, there is no extra character at the end of the
4948 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004949 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004950 tab:xy[z] Two or three characters to be used to show a tab.
4951 The third character is optional.
4952
4953 tab:xy The 'x' is always used, then 'y' as many times as will
4954 fit. Thus "tab:>-" displays:
4955 >
4956 >-
4957 >--
4958 etc.
4959
4960 tab:xyz The 'z' is always used, then 'x' is prepended, and
4961 then 'y' is used as many times as will fit. Thus
4962 "tab:<->" displays:
4963 >
4964 <>
4965 <->
4966 <-->
4967 etc.
4968
4969 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004970 *lcs-space*
4971 space:c Character to show for a space. When omitted, spaces
4972 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02004973 *lcs-multispace*
4974 multispace:c...
4975 One or more characters to use cyclically to show for
4976 multiple consecutive spaces. Overrides the "space"
4977 setting, except for single spaces. When omitted, the
4978 "space" setting is used. For example,
4979 `:set listchars=multispace:---+` shows ten consecutive
4980 spaces as:
4981 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01004982 *lcs-lead*
4983 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02004984 leading spaces are blank. Overrides the "space" and
4985 "multispace" settings for leading spaces. You can
4986 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01004987 :set listchars+=tab:>-,lead:.
4988< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004989 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02004990 trailing spaces are blank. Overrides the "space" and
4991 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02004992 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 extends:c Character to show in the last column, when 'wrap' is
4994 off and the line continues beyond the right of the
4995 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004996 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004997 precedes:c Character to show in the first visible column of the
4998 physical line, when there is text preceding the
4999 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005000 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005001 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005002 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005003 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005004 nbsp:c Character to show for a non-breakable space character
5005 (0xA0 (160 decimal) and U+202F). Left blank when
5006 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005008 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005010 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005012 Each character can be specified as hex: >
5013 set listchars=eol:\\x24
5014 set listchars=eol:\\u21b5
5015 set listchars=eol:\\U000021b5
5016< Note that a double backslash is used. The number of hex characters
5017 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5018
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 Examples: >
5020 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005021 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022 :set lcs=extends:>,precedes:<
5023< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005024 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5025 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005026 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027
5028 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5029'loadplugins' 'lpl' boolean (default on)
5030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031 When on the plugin scripts are loaded when starting up |load-plugins|.
5032 This option can be reset in your |vimrc| file to disable the loading
5033 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005034 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5035 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036
Bram Moolenaard94464e2015-11-02 15:28:18 +01005037 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005038'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005039 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005040 {only available when compiled with the |+lua/dyn|
5041 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005042 Specifies the name of the Lua shared library. The default is
5043 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005044 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005045 This option cannot be set from a |modeline| or in the |sandbox|, for
5046 security reasons.
5047
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005048 *'macatsui'* *'nomacatsui'*
5049'macatsui' boolean (default on)
5050 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005051 {not supported}
5052 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005053
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054 *'magic'* *'nomagic'*
5055'magic' boolean (default on)
5056 global
5057 Changes the special characters that can be used in search patterns.
5058 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005059 WARNING: Switching this option off most likely breaks plugins! That
5060 is because many patterns assume it's on and will fail when it's off.
5061 Only switch it off when working with old Vi scripts. In any other
5062 situation write patterns that work when 'magic' is on. Include "\M"
5063 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005064 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5065 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005066
5067 *'makeef'* *'mef'*
5068'makeef' 'mef' string (default: "")
5069 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070 {not available when compiled without the |+quickfix|
5071 feature}
5072 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5073 and the |:grep| command.
5074 When it is empty, an internally generated temp file will be used.
5075 When "##" is included, it is replaced by a number to make the name
5076 unique. This makes sure that the ":make" command doesn't overwrite an
5077 existing file.
5078 NOT used for the ":cf" command. See 'errorfile' for that.
5079 Environment variables are expanded |:set_env|.
5080 See |option-backslash| about including spaces and backslashes.
5081 This option cannot be set from a |modeline| or in the |sandbox|, for
5082 security reasons.
5083
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005084 *'makeencoding'* *'menc'*
5085'makeencoding' 'menc' string (default "")
5086 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005087 Encoding used for reading the output of external commands. When empty,
5088 encoding is not converted.
5089 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5090 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5091 and `:laddfile`.
5092
5093 This would be mostly useful when you use MS-Windows and set 'encoding'
5094 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5095 'makeencoding' to "char" has the same effect as setting to the system
5096 locale encoding. Example: >
5097 :set encoding=utf-8
5098 :set makeencoding=char " system locale is used
5099<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100 *'makeprg'* *'mp'*
5101'makeprg' 'mp' string (default "make", VMS: "MMS")
5102 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005103 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005104 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5105 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005106 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005107 Environment variables are expanded |:set_env|. See |option-backslash|
5108 about including spaces and backslashes.
5109 Note that a '|' must be escaped twice: once for ":set" and once for
5110 the interpretation of a command. When you use a filter called
5111 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112 :set makeprg=gmake\ \\\|\ myfilter
5113< The placeholder "$*" can be given (even multiple times) to specify
5114 where the arguments will be included, for example: >
5115 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5116< This option cannot be set from a |modeline| or in the |sandbox|, for
5117 security reasons.
5118
5119 *'matchpairs'* *'mps'*
5120'matchpairs' 'mps' string (default "(:),{:},[:]")
5121 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005122 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005123 other.
5124 Only character pairs are allowed that are different, thus you cannot
5125 jump between two double quotes.
5126 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005127 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005128 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129 :set mps+=<:>
5130
5131< A more exotic example, to jump between the '=' and ';' in an
5132 assignment, useful for languages like C and Java: >
5133 :au FileType c,cpp,java set mps+==:;
5134
5135< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005136 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005137
5138 *'matchtime'* *'mat'*
5139'matchtime' 'mat' number (default 5)
5140 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141 Tenths of a second to show the matching paren, when 'showmatch' is
5142 set. Note that this is not in milliseconds, like other options that
5143 set a time. This is to be compatible with Nvi.
5144
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005145 *'maxcombine'* *'mco'*
5146'maxcombine' 'mco' number (default 2)
5147 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005148 The maximum number of combining characters supported for displaying.
5149 Only used when 'encoding' is "utf-8".
5150 The default is OK for most languages. Hebrew may require 4.
5151 Maximum value is 6.
5152 Even when this option is set to 2 you can still edit text with more
5153 combining characters, you just can't see them. Use |g8| or |ga|.
5154 See |mbyte-combining|.
5155
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 *'maxfuncdepth'* *'mfd'*
5157'maxfuncdepth' 'mfd' number (default 100)
5158 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005159 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005160 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161 Maximum depth of function calls for user functions. This normally
5162 catches endless recursion. When using a recursive function with
5163 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5164 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005165 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005166 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 See also |:function|.
5168
5169 *'maxmapdepth'* *'mmd'* *E223*
5170'maxmapdepth' 'mmd' number (default 1000)
5171 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 Maximum number of times a mapping is done without resulting in a
5173 character to be used. This normally catches endless mappings, like
5174 ":map x y" with ":map y x". It still does not catch ":map g wg",
5175 because the 'w' is used before the next mapping is done. See also
5176 |key-mapping|.
5177
5178 *'maxmem'* *'mm'*
5179'maxmem' 'mm' number (default between 256 to 5120 (system
5180 dependent) or half the amount of memory
5181 available)
5182 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5184 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005185 other memory to be freed.
5186 The maximum usable value is about 2000000. Use this to work without a
5187 limit.
5188 The value is ignored when 'swapfile' is off.
5189 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005191 *'maxmempattern'* *'mmp'*
5192'maxmempattern' 'mmp' number (default 1000)
5193 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005194 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005195 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005196 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005197 When Vim runs into the limit it gives an error message and mostly
5198 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005199 Running into the limit often means that the pattern is very
5200 inefficient or too complex. This may already happen with the pattern
5201 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005202 Might also happen on redraw, when syntax rules try to match a complex
5203 text structure.
5204 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5205 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005206
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207 *'maxmemtot'* *'mmt'*
5208'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5209 dependent) or half the amount of memory
5210 available)
5211 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005212 Maximum amount of memory in Kbyte to use for all buffers together.
5213 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005214 without a limit.
5215 On 64 bit machines higher values might work. But hey, do you really
5216 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005217 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005218 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005219 Buffers with 'swapfile' off still count to the total amount of memory
5220 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005221 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222
5223 *'menuitems'* *'mis'*
5224'menuitems' 'mis' number (default 25)
5225 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 {not available when compiled without the |+menu|
5227 feature}
5228 Maximum number of items to use in a menu. Used for menus that are
5229 generated from a list of items, e.g., the Buffers menu. Changing this
5230 option has no direct effect, the menu must be refreshed first.
5231
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005232 *'mkspellmem'* *'msm'*
5233'mkspellmem' 'msm' string (default "460000,2000,500")
5234 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005235 {not available when compiled without the |+syntax|
5236 feature}
5237 Parameters for |:mkspell|. This tunes when to start compressing the
5238 word tree. Compression can be slow when there are many words, but
5239 it's needed to avoid running out of memory. The amount of memory used
5240 per word depends very much on how similar the words are, that's why
5241 this tuning is complicated.
5242
5243 There are three numbers, separated by commas:
5244 {start},{inc},{added}
5245
5246 For most languages the uncompressed word tree fits in memory. {start}
5247 gives the amount of memory in Kbyte that can be used before any
5248 compression is done. It should be a bit smaller than the amount of
5249 memory that is available to Vim.
5250
5251 When going over the {start} limit the {inc} number specifies the
5252 amount of memory in Kbyte that can be allocated before another
5253 compression is done. A low number means compression is done after
5254 less words are added, which is slow. A high number means more memory
5255 will be allocated.
5256
5257 After doing compression, {added} times 1024 words can be added before
5258 the {inc} limit is ignored and compression is done when any extra
5259 amount of memory is needed. A low number means there is a smaller
5260 chance of hitting the {inc} limit, less memory is used but it's
5261 slower.
5262
5263 The languages for which these numbers are important are Italian and
5264 Hungarian. The default works for when you have about 512 Mbyte. If
5265 you have 1 Gbyte you could use: >
5266 :set mkspellmem=900000,3000,800
5267< If you have less than 512 Mbyte |:mkspell| may fail for some
5268 languages, no matter what you set 'mkspellmem' to.
5269
Bram Moolenaar07607392019-05-26 19:20:43 +02005270 This option cannot be set from a |modeline| or in the |sandbox|.
5271
Bram Moolenaar071d4272004-06-13 20:20:40 +00005272 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005273'modeline' 'ml' boolean (Vim default: on (off for root),
5274 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005276 If 'modeline' is on 'modelines' gives the number of lines that is
5277 checked for set commands. If 'modeline' is off or 'modelines' is zero
5278 no lines are checked. See |modeline|.
5279
5280 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5281'modelineexpr' 'mle' boolean (default: off)
5282 global
5283 When on allow some options that are an expression to be set in the
5284 modeline. Check the option for whether it is affected by
5285 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005286 This option cannot be set from a |modeline| or in the |sandbox|, for
5287 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005288
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289 *'modelines'* *'mls'*
5290'modelines' 'mls' number (default 5)
5291 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292 If 'modeline' is on 'modelines' gives the number of lines that is
5293 checked for set commands. If 'modeline' is off or 'modelines' is zero
5294 no lines are checked. See |modeline|.
5295 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5296 set and to the Vim default value when 'compatible' is reset.
5297
5298 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005299 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300'modifiable' 'ma' boolean (default on)
5301 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005302 When off the buffer contents cannot be changed. The 'fileformat' and
5303 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005304 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305
5306 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5307'modified' 'mod' boolean (default off)
5308 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309 When on, the buffer is considered to be modified. This option is set
5310 when:
5311 1. A change was made to the text since it was last written. Using the
5312 |undo| command to go back to the original text will reset the
5313 option. But undoing changes that were made before writing the
5314 buffer will set the option again, since the text is different from
5315 when it was written.
5316 2. 'fileformat' or 'fileencoding' is different from its original
5317 value. The original value is set when the buffer is read or
5318 written. A ":set nomodified" command also resets the original
5319 values to the current values and the 'modified' option will be
5320 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005321 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005322 This option is not set when a change is made to the buffer as the
5323 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5324 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5325 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005326 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5327 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005328 Note that the text may actually be the same, e.g. 'modified' is set
5329 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005330
5331 *'more'* *'nomore'*
5332'more' boolean (Vim default: on, Vi default: off)
5333 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334 When on, listings pause when the whole screen is filled. You will get
5335 the |more-prompt|. When this option is off there are no pauses, the
5336 listing continues until finished.
5337 NOTE: This option is set to the Vi default value when 'compatible' is
5338 set and to the Vim default value when 'compatible' is reset.
5339
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005340 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005341'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005342 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005344 Enable the use of the mouse. Works for most terminals (xterm, Win32
5345 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5346 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5347 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005348 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005349 v Visual mode
5350 i Insert mode
5351 c Command-line mode
5352 h all previous modes when editing a help file
5353 a all previous modes
5354 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005355 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005356 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005357< If your terminal can't overrule the mouse events going to the
5358 application, use: >
5359 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005360< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005361 back to Vim using the mouse events.
5362 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5363 "xterm".
5364
5365 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005366 modeless selection. This doesn't move the text cursor.
5367
5368 See |mouse-using|. Also see |'clipboard'|.
5369
5370 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005371 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 the mouse buttons can still be used by keeping the shift key pressed.
5373 Also see the 'clipboard' option.
5374
5375 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5376'mousefocus' 'mousef' boolean (default off)
5377 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378 {only works in the GUI}
5379 The window that the mouse pointer is on is automatically activated.
5380 When changing the window layout or window focus in another way, the
5381 mouse pointer is moved to the window with keyboard focus. Off is the
5382 default because it makes using the pull down menus a little goofy, as
5383 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005384 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005385 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386
5387 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5388'mousehide' 'mh' boolean (default on)
5389 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390 {only works in the GUI}
5391 When on, the mouse pointer is hidden when characters are typed.
5392 The mouse pointer is restored when the mouse is moved.
5393
5394 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005395'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397 Sets the model to use for the mouse. The name mostly specifies what
5398 the right mouse button is used for:
5399 extend Right mouse button extends a selection. This works
5400 like in an xterm.
5401 popup Right mouse button pops up a menu. The shifted left
5402 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005403 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005404 popup_setpos Like "popup", but the cursor will be moved to the
5405 position where the mouse was clicked, and thus the
5406 selected operation will act upon the clicked object.
5407 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005408 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409 course, that right clicking outside a selection will
5410 end Visual mode.
5411 Overview of what button does what for each model:
5412 mouse extend popup(_setpos) ~
5413 left click place cursor place cursor
5414 left drag start selection start selection
5415 shift-left search word extend selection
5416 right click extend selection popup menu (place cursor)
5417 right drag extend selection -
5418 middle click paste paste
5419
5420 In the "popup" model the right mouse button produces a pop-up menu.
5421 You need to define this first, see |popup-menu|.
5422
5423 Note that you can further refine the meaning of buttons with mappings.
5424 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5425 selection (because that's handled in the GUI code directly).
5426
5427 The 'mousemodel' option is set by the |:behave| command.
5428
5429 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005430'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5431 vs:leftright,vd:lrsizing,m:no,
5432 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 {only available when compiled with the |+mouseshape|
5435 feature}
5436 This option tells Vim what the mouse pointer should look like in
5437 different modes. The option is a comma separated list of parts, much
5438 like used for 'guicursor'. Each part consist of a mode/location-list
5439 and an argument-list:
5440 mode-list:shape,mode-list:shape,..
5441 The mode-list is a dash separated list of these modes/locations:
5442 In a normal window: ~
5443 n Normal mode
5444 v Visual mode
5445 ve Visual mode with 'selection' "exclusive" (same as 'v',
5446 if not specified)
5447 o Operator-pending mode
5448 i Insert mode
5449 r Replace mode
5450
5451 Others: ~
5452 c appending to the command-line
5453 ci inserting in the command-line
5454 cr replacing in the command-line
5455 m at the 'Hit ENTER' or 'More' prompts
5456 ml idem, but cursor in the last line
5457 e any mode, pointer below last window
5458 s any mode, pointer on a status line
5459 sd any mode, while dragging a status line
5460 vs any mode, pointer on a vertical separator line
5461 vd any mode, while dragging a vertical separator line
5462 a everywhere
5463
5464 The shape is one of the following:
5465 avail name looks like ~
5466 w x arrow Normal mouse pointer
5467 w x blank no pointer at all (use with care!)
5468 w x beam I-beam
5469 w x updown up-down sizing arrows
5470 w x leftright left-right sizing arrows
5471 w x busy The system's usual busy pointer
5472 w x no The system's usual 'no input' pointer
5473 x udsizing indicates up-down resizing
5474 x lrsizing indicates left-right resizing
5475 x crosshair like a big thin +
5476 x hand1 black hand
5477 x hand2 white hand
5478 x pencil what you write with
5479 x question big ?
5480 x rightup-arrow arrow pointing right-up
5481 w x up-arrow arrow pointing up
5482 x <number> any X11 pointer number (see X11/cursorfont.h)
5483
5484 The "avail" column contains a 'w' if the shape is available for Win32,
5485 x for X11.
5486 Any modes not specified or shapes not available use the normal mouse
5487 pointer.
5488
5489 Example: >
5490 :set mouseshape=s:udsizing,m:no
5491< will make the mouse turn to a sizing arrow over the status lines and
5492 indicate no input when the hit-enter prompt is displayed (since
5493 clicking the mouse has no effect in this state.)
5494
5495 *'mousetime'* *'mouset'*
5496'mousetime' 'mouset' number (default 500)
5497 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005498 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 time in msec between two mouse clicks for the second click to be
5500 recognized as a multi click.
5501
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005502 *'mzschemedll'*
5503'mzschemedll' string (default depends on the build)
5504 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005505 {only available when compiled with the |+mzscheme/dyn|
5506 feature}
5507 Specifies the name of the MzScheme shared library. The default is
5508 DYNAMIC_MZSCH_DLL which was specified at compile time.
5509 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005510 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005511 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005512 This option cannot be set from a |modeline| or in the |sandbox|, for
5513 security reasons.
5514
5515 *'mzschemegcdll'*
5516'mzschemegcdll' string (default depends on the build)
5517 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005518 {only available when compiled with the |+mzscheme/dyn|
5519 feature}
5520 Specifies the name of the MzScheme GC shared library. The default is
5521 DYNAMIC_MZGC_DLL which was specified at compile time.
5522 The value can be equal to 'mzschemedll' if it includes the GC code.
5523 Environment variables are expanded |:set_env|.
5524 This option cannot be set from a |modeline| or in the |sandbox|, for
5525 security reasons.
5526
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005527 *'mzquantum'* *'mzq'*
5528'mzquantum' 'mzq' number (default 100)
5529 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005530 {not available when compiled without the |+mzscheme|
5531 feature}
5532 The number of milliseconds between polls for MzScheme threads.
5533 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005534 NOTE: This option is set to the Vim default value when 'compatible'
5535 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005536
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005538'nrformats' 'nf' string (default "bin,octal,hex",
5539 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005541 This defines what bases Vim will consider for numbers when using the
5542 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5543 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005544 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005545 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005546 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005547 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005549 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005550 considered to be hexadecimal. Example: Using CTRL-X on
5551 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005552 bin If included, numbers starting with "0b" or "0B" will be
5553 considered to be binary. Example: Using CTRL-X on
5554 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005555 unsigned If included, numbers are recognized as unsigned. Thus a
5556 leading dash or negative sign won't be considered as part of
5557 the number. Examples:
5558 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5559 (without "unsigned" it would become "9-2021").
5560 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5561 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005562 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5563 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005564 Numbers which simply begin with a digit in the range 1-9 are always
5565 considered decimal. This also happens for numbers that are not
5566 recognized as octal or hex.
5567
5568 *'number'* *'nu'* *'nonumber'* *'nonu'*
5569'number' 'nu' boolean (default off)
5570 local to window
5571 Print the line number in front of each line. When the 'n' option is
5572 excluded from 'cpoptions' a wrapped line will not use the column of
5573 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005574 The 'numberwidth' option can be used to set the room used for the line
5575 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576 When a long, wrapped line doesn't start with the first character, '-'
5577 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005578 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5579 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005580 *number_relativenumber*
5581 The 'relativenumber' option changes the displayed number to be
5582 relative to the cursor. Together with 'number' there are these
5583 four combinations (cursor in line 3):
5584
Bram Moolenaar3848e002016-03-19 18:42:29 +01005585 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005586 'nornu' 'nornu' 'rnu' 'rnu'
5587
5588 |apple | 1 apple | 2 apple | 2 apple
5589 |pear | 2 pear | 1 pear | 1 pear
5590 |nobody | 3 nobody | 0 nobody |3 nobody
5591 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005592
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005593 *'numberwidth'* *'nuw'*
5594'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5595 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005596 {only available when compiled with the |+linebreak|
5597 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005598 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005599 when the 'number' or 'relativenumber' option is set or printing lines
5600 with a line number. Since one space is always between the number and
5601 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005602 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005603 fit the highest line number in the buffer respectively the number of
5604 rows in the window, depending on whether 'number' or 'relativenumber'
5605 is set. Thus with the Vim default of 4 there is room for a line number
5606 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005607 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005608 NOTE: This option is set to the Vi default value when 'compatible' is
5609 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005610
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005611 *'omnifunc'* *'ofu'*
5612'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005613 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005614 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005615 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005616 This option specifies a function to be used for Insert mode omni
5617 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005618 See |complete-functions| for an explanation of how the function is
5619 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005620 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005621 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005622 This option cannot be set from a |modeline| or in the |sandbox|, for
5623 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005624
5625
Bram Moolenaar02467872007-05-06 13:22:01 +00005626 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005627'opendevice' 'odev' boolean (default off)
5628 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005629 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005630 Enable reading and writing from devices. This may get Vim stuck on a
5631 device that can be opened but doesn't actually do the I/O. Therefore
5632 it is off by default.
5633 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5634 result in editing a device.
5635
5636
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005637 *'operatorfunc'* *'opfunc'*
5638'operatorfunc' 'opfunc' string (default: empty)
5639 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005640 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005641 See |:map-operator| for more info and an example. The value can be
5642 the name of a function, a |lambda| or a |Funcref|. See
5643 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005644
5645 This option cannot be set from a |modeline| or in the |sandbox|, for
5646 security reasons.
5647
5648
Bram Moolenaar251e1912011-06-19 05:09:16 +02005649 *'osfiletype'* *'oft'*
5650'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005651 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005652 This option was supported on RISC OS, which has been removed.
5653
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005655 *'packpath'* *'pp'*
5656'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005657 Directories used to find packages. See |packages|.
5658
5659
Bram Moolenaar071d4272004-06-13 20:20:40 +00005660 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005661'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662 global
5663 Specifies the nroff macros that separate paragraphs. These are pairs
5664 of two letters (see |object-motions|).
5665
5666 *'paste'* *'nopaste'*
5667'paste' boolean (default off)
5668 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005669 Put Vim in Paste mode. This is useful if you want to cut or copy
5670 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671 unexpected effects.
5672 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005673 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674 knows about pasting and will mostly do the right thing without 'paste'
5675 being set. The same is true for a terminal where Vim handles the
5676 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005677 This option is reset when starting the GUI. Thus if you set it in
5678 your .vimrc it will work in a terminal, but not in the GUI. Setting
5679 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5680 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 When the 'paste' option is switched on (also when it was already on):
5682 - mapping in Insert mode and Command-line mode is disabled
5683 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005685 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005686 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687 - 'revins' is reset
5688 - 'ruler' is reset
5689 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005690 - 'smarttab' is reset
5691 - 'softtabstop' is set to 0
5692 - 'textwidth' is set to 0
5693 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005694 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005697 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005698 - 'indentexpr'
5699 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005700 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 NOTE: When you start editing another file while the 'paste' option is
5702 on, settings from the modelines or autocommands may change the
5703 settings again, causing trouble when pasting text. You might want to
5704 set the 'paste' option again.
5705 When the 'paste' option is reset the mentioned options are restored to
5706 the value before the moment 'paste' was switched from off to on.
5707 Resetting 'paste' before ever setting it does not have any effect.
5708 Since mapping doesn't work while 'paste' is active, you need to use
5709 the 'pastetoggle' option to toggle the 'paste' option with some key.
5710
5711 *'pastetoggle'* *'pt'*
5712'pastetoggle' 'pt' string (default "")
5713 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005714 When non-empty, specifies the key sequence that toggles the 'paste'
5715 option. This is like specifying a mapping: >
5716 :map {keys} :set invpaste<CR>
5717< Where {keys} is the value of 'pastetoggle'.
5718 The difference is that it will work even when 'paste' is set.
5719 'pastetoggle' works in Insert mode and Normal mode, but not in
5720 Command-line mode.
5721 Mappings are checked first, thus overrule 'pastetoggle'. However,
5722 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5723 this: >
5724 :map <F10> :set paste<CR>
5725 :map <F11> :set nopaste<CR>
5726 :imap <F10> <C-O>:set paste<CR>
5727 :imap <F11> <nop>
5728 :set pastetoggle=<F11>
5729< This will make <F10> start paste mode and <F11> stop paste mode.
5730 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5731 mode everything is inserted literally, except the 'pastetoggle' key
5732 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005733 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734
5735 *'pex'* *'patchexpr'*
5736'patchexpr' 'pex' string (default "")
5737 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005738 {not available when compiled without the |+diff|
5739 feature}
5740 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005741 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742
Bram Moolenaardbc28022014-07-26 13:40:44 +02005743 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744'patchmode' 'pm' string (default "")
5745 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746 When non-empty the oldest version of a file is kept. This can be used
5747 to keep the original version of a file if you are changing files in a
5748 source distribution. Only the first time that a file is written a
5749 copy of the original file will be kept. The name of the copy is the
5750 name of the original file with the string in the 'patchmode' option
5751 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005752 ".orig" or ".org". 'backupdir' must not be empty for this to work
5753 (Detail: The backup file is renamed to the patchmode file after the
5754 new file has been successfully written, that's why it must be possible
5755 to write a backup file). If there was no file to be backed up, an
5756 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005757 When the 'backupskip' pattern matches, a patchmode file is not made.
5758 Using 'patchmode' for compressed files appends the extension at the
5759 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5760 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005761 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005763 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005765 other systems: ".,,")
5766 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005768 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5769 provided that the file being searched for has a relative path (not
5770 starting with "/", "./" or "../"). The directories in the 'path'
5771 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772 - Use commas to separate directory names: >
5773 :set path=.,/usr/local/include,/usr/include
5774< - Spaces can also be used to separate directory names (for backwards
5775 compatibility with version 3.0). To have a space in a directory
5776 name, precede it with an extra backslash, and escape the space: >
5777 :set path=.,/dir/with\\\ space
5778< - To include a comma in a directory name precede it with an extra
5779 backslash: >
5780 :set path=.,/dir/with\\,comma
5781< - To search relative to the directory of the current file, use: >
5782 :set path=.
5783< - To search in the current directory use an empty string between two
5784 commas: >
5785 :set path=,,
5786< - A directory name may end in a ':' or '/'.
5787 - Environment variables are expanded |:set_env|.
5788 - When using |netrw.vim| URLs can be used. For example, adding
5789 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005790 - Search upwards and downwards in a directory tree using "*", "**" and
5791 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005792 {not available when compiled without the |+path_extra| feature}
5793 - Careful with '\' characters, type two to get one in the option: >
5794 :set path=.,c:\\include
5795< Or just use '/' instead: >
5796 :set path=.,c:/include
5797< Don't forget "." or files won't even be found in the same directory as
5798 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005799 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005800 it is something like 256 or 1024 characters.
5801 You can check if all the include files are found, using the value of
5802 'path', see |:checkpath|.
5803 The use of |:set+=| and |:set-=| is preferred when adding or removing
5804 directories from the list. This avoids problems when a future version
5805 uses another default. To remove the current directory use: >
5806 :set path-=
5807< To add the current directory use: >
5808 :set path+=
5809< To use an environment variable, you probably need to replace the
5810 separator. Here is an example to append $INCL, in which directory
5811 names are separated with a semi-colon: >
5812 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5813< Replace the ';' with a ':' or whatever separator is used. Note that
5814 this doesn't work when $INCL contains a comma or white space.
5815
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005816 *'perldll'*
5817'perldll' string (default depends on the build)
5818 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005819 {only available when compiled with the |+perl/dyn|
5820 feature}
5821 Specifies the name of the Perl shared library. The default is
5822 DYNAMIC_PERL_DLL, which was specified at compile time.
5823 Environment variables are expanded |:set_env|.
5824 This option cannot be set from a |modeline| or in the |sandbox|, for
5825 security reasons.
5826
Bram Moolenaar071d4272004-06-13 20:20:40 +00005827 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5828'preserveindent' 'pi' boolean (default off)
5829 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005830 When changing the indent of the current line, preserve as much of the
5831 indent structure as possible. Normally the indent is replaced by a
5832 series of tabs followed by spaces as required (unless |'expandtab'| is
5833 enabled, in which case only spaces are used). Enabling this option
5834 means the indent will preserve as many existing characters as possible
5835 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005836 'expandtab' does not apply to the preserved white space, a Tab remains
5837 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005838 NOTE: When using ">>" multiple times the resulting indent is a mix of
5839 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005840 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841 Also see 'copyindent'.
5842 Use |:retab| to clean up white space.
5843
5844 *'previewheight'* *'pvh'*
5845'previewheight' 'pvh' number (default 12)
5846 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005847 {not available when compiled without the |+quickfix|
5848 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005850 commands. Used for |CTRL-W_}| when no count is given. Not used when
5851 'previewpopup' is set.
5852
5853 *'previewpopup'* *'pvp'*
5854'previewpopup' 'pvp' string (default empty)
5855 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005856 {not available when compiled without the |+textprop|
5857 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005858 When not empty a popup window is used for commands that would open a
5859 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005860 Not used for the insert completion info, add "popup" to
5861 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005862
5863 *'previewwindow'* *'nopreviewwindow'*
5864 *'pvw'* *'nopvw'* *E590*
5865'previewwindow' 'pvw' boolean (default off)
5866 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005867 {not available when compiled without the |+quickfix|
5868 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005869 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005870 set. It's normally not set directly, but by using one of the commands
5871 |:ptag|, |:pedit|, etc.
5872
5873 *'printdevice'* *'pdev'*
5874'printdevice' 'pdev' string (default empty)
5875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005876 {only available when compiled with the |+printer|
5877 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005878 The name of the printer to be used for |:hardcopy|.
5879 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005880 This option cannot be set from a |modeline| or in the |sandbox|, for
5881 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882
Bram Moolenaar8299df92004-07-10 09:47:34 +00005883 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005884'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 {only available when compiled with the |+printer|
5887 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005888 Sets the character encoding used when printing.
5889 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890
5891 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005892'printexpr' 'pexpr' string (default: see below)
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 Expression used to print the PostScript produced with |:hardcopy|.
5897 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005898 This option cannot be set from a |modeline| or in the |sandbox|, for
5899 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900
Bram Moolenaar8299df92004-07-10 09:47:34 +00005901 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902'printfont' 'pfn' string (default "courier")
5903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 {only available when compiled with the |+printer|
5905 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005906 The name of the font that will be used for |:hardcopy|.
5907 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908
5909 *'printheader'* *'pheader'*
5910'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
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 format of the header produced in |:hardcopy| output.
5915 See |pheader-option|.
5916
5917 *'printmbcharset'* *'pmbcs'*
5918'printmbcharset' 'pmbcs' string (default "")
5919 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005920 {only available when compiled with the |+printer|
5921 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005922 The CJK character set to be used for CJK output from |:hardcopy|.
5923 See |pmbcs-option|.
5924
5925 *'printmbfont'* *'pmbfn'*
5926'printmbfont' 'pmbfn' 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 List of font names to be used for CJK output from |:hardcopy|.
5931 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005932
5933 *'printoptions'* *'popt'*
5934'printoptions' 'popt' string (default "")
5935 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005936 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005937 List of items that control the format of the output of |:hardcopy|.
5938 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005939
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005940 *'prompt'* *'noprompt'*
5941'prompt' boolean (default on)
5942 global
5943 When on a ":" prompt is used in Ex mode.
5944
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005945 *'pumheight'* *'ph'*
5946'pumheight' 'ph' number (default 0)
5947 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005948 Determines the maximum number of items to show in the popup menu for
5949 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005950 |ins-completion-menu|.
5951
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005952 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005953'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005954 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005955 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005956 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005957
Bram Moolenaard94464e2015-11-02 15:28:18 +01005958 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005959'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005960 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005961 {only available when compiled with the |+python/dyn|
5962 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005963 Specifies the name of the Python 2.x shared library. The default is
5964 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005965 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005966 This option cannot be set from a |modeline| or in the |sandbox|, for
5967 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005968
Bram Moolenaar94073162018-01-31 21:49:05 +01005969 *'pythonhome'*
5970'pythonhome' string (default "")
5971 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005972 {only available when compiled with the |+python/dyn|
5973 feature}
5974 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5975 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5976 which was specified at compile time, will be used for the Python 2.x
5977 home directory.
5978 Environment variables are expanded |:set_env|.
5979 This option cannot be set from a |modeline| or in the |sandbox|, for
5980 security reasons.
5981
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005982 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005983'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005984 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005985 {only available when compiled with the |+python3/dyn|
5986 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005987 Specifies the name of the Python 3 shared library. The default is
5988 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005989 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005990 This option cannot be set from a |modeline| or in the |sandbox|, for
5991 security reasons.
5992
Bram Moolenaar94073162018-01-31 21:49:05 +01005993 *'pythonthreehome'*
5994'pythonthreehome' string (default "")
5995 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005996 {only available when compiled with the |+python3/dyn|
5997 feature}
5998 Specifies the name of the Python 3 home directory. When
5999 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6000 PYTHON3_HOME, which was specified at compile time, will be used for
6001 the Python 3 home directory.
6002 Environment variables are expanded |:set_env|.
6003 This option cannot be set from a |modeline| or in the |sandbox|, for
6004 security reasons.
6005
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006006 *'pyxversion'* *'pyx'*
6007'pyxversion' 'pyx' number (default depends on the build)
6008 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006009 {only available when compiled with the |+python| or
6010 the |+python3| feature}
6011 Specifies the python version used for pyx* functions and commands
6012 |python_x|. The default value is as follows:
6013
6014 Compiled with Default ~
6015 |+python| and |+python3| 0
6016 only |+python| 2
6017 only |+python3| 3
6018
6019 Available values are 0, 2 and 3.
6020 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6021 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6022 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6023 to 2 if Python 2 is available.
6024 See also: |has-pythonx|
6025
6026 If Vim is compiled with only |+python| or |+python3| setting
6027 'pyxversion' has no effect. The pyx* functions and commands are
6028 always the same as the compiled version.
6029
6030 This option cannot be set from a |modeline| or in the |sandbox|, for
6031 security reasons.
6032
Bram Moolenaar858ba062020-05-31 23:11:59 +02006033 *'quickfixtextfunc'* *'qftf'*
6034'quickfixtextfunc' 'qftf' string (default "")
6035 global
6036 {only available when compiled with the |+quickfix|
6037 feature}
6038 This option specifies a function to be used to get the text to display
6039 in the quickfix and location list windows. This can be used to
6040 customize the information displayed in the quickfix or location window
6041 for each entry in the corresponding quickfix or location list. See
6042 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006043 function and an example. The value can be the name of a function, a
6044 |lambda| or a |Funcref|. See |option-value-function| for more
6045 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006046
6047 This option cannot be set from a |modeline| or in the |sandbox|, for
6048 security reasons.
6049
Bram Moolenaar677ee682005-01-27 14:41:15 +00006050 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006051'quoteescape' 'qe' string (default "\")
6052 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006053 The characters that are used to escape quotes in a string. Used for
6054 objects like a', a" and a` |a'|.
6055 When one of the characters in this option is found inside a string,
6056 the following character will be skipped. The default value makes the
6057 text "foo\"bar\\" considered to be one string.
6058
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6060'readonly' 'ro' boolean (default off)
6061 local to buffer
6062 If on, writes fail unless you use a '!'. Protects you from
6063 accidentally overwriting a file. Default on when Vim is started
6064 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006065 When using ":w!" the 'readonly' option is reset for the current
6066 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006067 When using the ":view" command the 'readonly' option is set for the
6068 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006069 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006071 *'redrawtime'* *'rdt'*
6072'redrawtime' 'rdt' number (default 2000)
6073 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006074 {only available when compiled with the |+reltime|
6075 feature}
6076 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006077 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006078 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006079 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006080 matches will be highlighted.
6081 For syntax highlighting the time applies per window. When over the
6082 limit syntax highlighting is disabled until |CTRL-L| is used.
6083 This is used to avoid that Vim hangs when using a very complicated
6084 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006085
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006086 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006087'regexpengine' 're' number (default 0)
6088 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006089 This selects the default regexp engine. |two-engines|
6090 The possible values are:
6091 0 automatic selection
6092 1 old engine
6093 2 NFA engine
6094 Note that when using the NFA engine and the pattern contains something
6095 that is not supported the pattern will not match. This is only useful
6096 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006097 Using automatic selection enables Vim to switch the engine, if the
6098 default engine becomes too costly. E.g., when the NFA engine uses too
6099 many states. This should prevent Vim from hanging on a combination of
6100 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006101
Bram Moolenaar64486672010-05-16 15:46:46 +02006102 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6103'relativenumber' 'rnu' boolean (default off)
6104 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006105 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006106 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006107 precede some vertical motion commands (e.g. j k + -) with, without
6108 having to calculate it yourself. Especially useful in combination with
6109 other commands (e.g. y d c < > gq gw =).
6110 When the 'n' option is excluded from 'cpoptions' a wrapped
6111 line will not use the column of line numbers (this is the default when
6112 'compatible' isn't set).
6113 The 'numberwidth' option can be used to set the room used for the line
6114 number.
6115 When a long, wrapped line doesn't start with the first character, '-'
6116 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006117 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6118 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006119
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006120 The number in front of the cursor line also depends on the value of
6121 'number', see |number_relativenumber| for all combinations of the two
6122 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006123
Bram Moolenaar071d4272004-06-13 20:20:40 +00006124 *'remap'* *'noremap'*
6125'remap' boolean (default on)
6126 global
6127 Allows for mappings to work recursively. If you do not want this for
6128 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006129 NOTE: To avoid portability problems with Vim scripts, always keep
6130 this option at the default "on". Only switch it off when working with
6131 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006133 *'renderoptions'* *'rop'*
6134'renderoptions' 'rop' string (default: empty)
6135 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006136 {only available when compiled with GUI and DIRECTX on
6137 MS-Windows}
6138 Select a text renderer and set its options. The options depend on the
6139 renderer.
6140
6141 Syntax: >
6142 set rop=type:{renderer}(,{name}:{value})*
6143<
6144 Currently, only one optional renderer is available.
6145
6146 render behavior ~
6147 directx Vim will draw text using DirectX (DirectWrite). It makes
6148 drawn glyphs more beautiful than default GDI.
6149 It requires 'encoding' is "utf-8", and only works on
6150 MS-Windows Vista or newer version.
6151
6152 Options:
6153 name meaning type value ~
6154 gamma gamma float 1.0 - 2.2 (maybe)
6155 contrast enhancedContrast float (unknown)
6156 level clearTypeLevel float (unknown)
6157 geom pixelGeometry int 0 - 2 (see below)
6158 renmode renderingMode int 0 - 6 (see below)
6159 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006160 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006161
Bram Moolenaar92467d32017-12-05 13:22:16 +01006162 See this URL for detail (except for scrlines):
6163 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006164
6165 For geom: structure of a device pixel.
6166 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6167 1 - DWRITE_PIXEL_GEOMETRY_RGB
6168 2 - DWRITE_PIXEL_GEOMETRY_BGR
6169
6170 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006171 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006172
6173 For renmode: method of rendering glyphs.
6174 0 - DWRITE_RENDERING_MODE_DEFAULT
6175 1 - DWRITE_RENDERING_MODE_ALIASED
6176 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6177 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6178 4 - DWRITE_RENDERING_MODE_NATURAL
6179 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6180 6 - DWRITE_RENDERING_MODE_OUTLINE
6181
6182 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006183 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006184
6185 For taamode: antialiasing mode used for drawing text.
6186 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6187 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6188 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6189 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6190
6191 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006192 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6193
Bram Moolenaara338adc2018-01-31 20:51:47 +01006194 For scrlines:
6195 This was used for optimizing scrolling behavior, however this
6196 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006197
6198 Example: >
6199 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006200 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006201 set rop=type:directx
6202<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006203 If select a raster font (Courier, Terminal or FixedSys which
6204 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006205 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006206
6207 NOTE: It is known that some fonts and options combination
6208 causes trouble on drawing glyphs.
6209
Bram Moolenaar92467d32017-12-05 13:22:16 +01006210 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006211 special made fonts (True-Type fonts which includes only
6212 bitmap glyphs).
6213 - 'taamode:3' will not work with some vector fonts.
6214
6215 NOTE: With this option, you can display colored emoji
6216 (emoticon) in Windows 8.1 or later. To display colored emoji,
6217 there are some conditions which you should notice.
6218
6219 - If your font includes non-colored emoji already, it will
6220 be used.
6221 - If your font doesn't have emoji, the system chooses an
6222 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6223 will be used.
6224 - When this alternative font didn't have fixed width glyph,
6225 emoji might be rendered beyond the bounding box of drawing
6226 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006227
6228 Other render types are currently not supported.
6229
Bram Moolenaar071d4272004-06-13 20:20:40 +00006230 *'report'*
6231'report' number (default 2)
6232 global
6233 Threshold for reporting number of lines changed. When the number of
6234 changed lines is more than 'report' a message will be given for most
6235 ":" commands. If you want it always, set 'report' to 0.
6236 For the ":substitute" command the number of substitutions is used
6237 instead of the number of lines.
6238
6239 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6240'restorescreen' 'rs' boolean (default on)
6241 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006242 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243 When set, the screen contents is restored when exiting Vim. This also
6244 happens when executing external commands.
6245
6246 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6247 options in your .vimrc. To disable restoring:
6248 set t_ti= t_te=
6249 To enable restoring (for an xterm):
6250 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6251 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6252
6253 *'revins'* *'ri'* *'norevins'* *'nori'*
6254'revins' 'ri' boolean (default off)
6255 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 {only available when compiled with the |+rightleft|
6257 feature}
6258 Inserting characters in Insert mode will work backwards. See "typing
6259 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6260 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006261 NOTE: This option is reset when 'compatible' is set.
6262 This option is reset when 'paste' is set and restored when 'paste' is
6263 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006264
6265 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6266'rightleft' 'rl' boolean (default off)
6267 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268 {only available when compiled with the |+rightleft|
6269 feature}
6270 When on, display orientation becomes right-to-left, i.e., characters
6271 that are stored in the file appear from the right to the left.
6272 Using this option, it is possible to edit files for languages that
6273 are written from the right to the left such as Hebrew and Arabic.
6274 This option is per window, so it is possible to edit mixed files
6275 simultaneously, or to view the same file in both ways (this is
6276 useful whenever you have a mixed text file with both right-to-left
6277 and left-to-right strings so that both sets are displayed properly
6278 in different windows). Also see |rileft.txt|.
6279
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006280 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281'rightleftcmd' 'rlc' string (default "search")
6282 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006283 {only available when compiled with the |+rightleft|
6284 feature}
6285 Each word in this option enables the command line editing to work in
6286 right-to-left mode for a group of commands:
6287
6288 search "/" and "?" commands
6289
6290 This is useful for languages such as Hebrew, Arabic and Farsi.
6291 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6292
Bram Moolenaard94464e2015-11-02 15:28:18 +01006293 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006294'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006295 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006296 {only available when compiled with the |+ruby/dyn|
6297 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006298 Specifies the name of the Ruby shared library. The default is
6299 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006300 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006301 This option cannot be set from a |modeline| or in the |sandbox|, for
6302 security reasons.
6303
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006305'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307 {not available when compiled without the
6308 |+cmdline_info| feature}
6309 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006310 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311 text in the file is shown on the far right:
6312 Top first line is visible
6313 Bot last line is visible
6314 All first and last line are visible
6315 45% relative position in the file
6316 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006317 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006319 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320 this option takes precedence over 'ruler' and 'rulerformat'
6321 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006322 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006323 the text column (byte number) and the screen column are shown,
6324 separated with a dash.
6325 For an empty line "0-1" is shown.
6326 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006327 This option is reset when 'paste' is set and restored when 'paste' is
6328 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 If you don't want to see the ruler all the time but want to know where
6330 you are, use "g CTRL-G" |g_CTRL-G|.
6331 NOTE: This option is reset when 'compatible' is set.
6332
6333 *'rulerformat'* *'ruf'*
6334'rulerformat' 'ruf' string (default empty)
6335 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 {not available when compiled without the |+statusline|
6337 feature}
6338 When this option is not empty, it determines the content of the ruler
6339 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006340 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006341 This option cannot be set in a modeline when 'modelineexpr' is off.
6342
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343 The default ruler width is 17 characters. To make the ruler 15
6344 characters wide, put "%15(" at the start and "%)" at the end.
6345 Example: >
6346 :set rulerformat=%15(%c%V\ %p%%%)
6347<
6348 *'runtimepath'* *'rtp'* *vimfiles*
6349'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006350 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351 $VIM/vimfiles,
6352 $VIMRUNTIME,
6353 $VIM/vimfiles/after,
6354 $HOME/.vim/after"
6355 Amiga: "home:vimfiles,
6356 $VIM/vimfiles,
6357 $VIMRUNTIME,
6358 $VIM/vimfiles/after,
6359 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006360 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 $VIM/vimfiles,
6362 $VIMRUNTIME,
6363 $VIM/vimfiles/after,
6364 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006365 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366 $VIMRUNTIME,
6367 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006368 Haiku: "$BE_USER_SETTINGS/vim,
6369 $VIM/vimfiles,
6370 $VIMRUNTIME,
6371 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006372 $BE_USER_SETTINGS/vim/after"
6373 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 $VIM/vimfiles,
6375 $VIMRUNTIME,
6376 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006377 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 This is a list of directories which will be searched for runtime
6380 files:
6381 filetype.vim filetypes by file name |new-filetype|
6382 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006383 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006384 colors/ color scheme files |:colorscheme|
6385 compiler/ compiler files |:compiler|
6386 doc/ documentation |write-local-help|
6387 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006388 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006389 indent/ indent scripts |indent-expression|
6390 keymap/ key mapping files |mbyte-keymap|
6391 lang/ menu translations |:menutrans|
6392 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006393 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006394 plugin/ plugin scripts |write-plugin|
6395 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006396 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397 syntax/ syntax files |mysyntaxfile|
6398 tutor/ files for vimtutor |tutor|
6399
6400 And any other file searched for with the |:runtime| command.
6401
6402 The defaults for most systems are setup to search five locations:
6403 1. In your home directory, for your personal preferences.
6404 2. In a system-wide Vim directory, for preferences from the system
6405 administrator.
6406 3. In $VIMRUNTIME, for files distributed with Vim.
6407 *after-directory*
6408 4. In the "after" directory in the system-wide Vim directory. This is
6409 for the system administrator to overrule or add to the distributed
6410 defaults (rarely needed)
6411 5. In the "after" directory in your home directory. This is for
6412 personal preferences to overrule or add to the distributed defaults
6413 or system-wide settings (rarely needed).
6414
Bram Moolenaard0796902016-09-16 20:02:31 +02006415 More entries are added when using |packages|. If it gets very long
6416 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6417 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006418
Bram Moolenaar071d4272004-06-13 20:20:40 +00006419 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6420 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006421 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 wildcards.
6423 See |:runtime|.
6424 Example: >
6425 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6426< This will use the directory "~/vimruntime" first (containing your
6427 personal Vim runtime files), then "/mygroup/vim" (shared between a
6428 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6429 files).
6430 You probably should always include $VIMRUNTIME somewhere, to use the
6431 distributed runtime files. You can put a directory before $VIMRUNTIME
6432 to find files which replace a distributed runtime files. You can put
6433 a directory after $VIMRUNTIME to find files which add to distributed
6434 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006435 When Vim is started with |--clean| the home directory entries are not
6436 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 This option cannot be set from a |modeline| or in the |sandbox|, for
6438 security reasons.
6439
6440 *'scroll'* *'scr'*
6441'scroll' 'scr' number (default: half the window height)
6442 local to window
6443 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6444 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006445 changes. This may happen when enabling the |status-line| or
6446 'tabline' option after setting the 'scroll' option.
6447 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006448 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006449 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450
6451 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6452'scrollbind' 'scb' boolean (default off)
6453 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454 See also |scroll-binding|. When this option is set, the current
6455 window scrolls as other scrollbind windows (windows that also have
6456 this option set) scroll. This option is useful for viewing the
6457 differences between two versions of a file, see 'diff'.
6458 See |'scrollopt'| for options that determine how this option should be
6459 interpreted.
6460 This option is mostly reset when splitting a window to edit another
6461 file. This means that ":split | edit file" results in two windows
6462 with scroll-binding, but ":split file" does not.
6463
Bram Moolenaarae20f342019-11-05 21:09:23 +01006464 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6465'scrollfocus' 'scf' boolean (default off)
6466 global
6467 {only for MS-Windows GUI}
6468 When using the scroll wheel and this option is set, the window under
6469 the mouse pointer is scrolled. With this option off the current
6470 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006471 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006472
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 *'scrolljump'* *'sj'*
6474'scrolljump' 'sj' number (default 1)
6475 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 Minimal number of lines to scroll when the cursor gets off the
6477 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6478 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006479 When set to a negative number from -1 to -100 this is used as the
6480 percentage of the window height. Thus -50 scrolls half the window
6481 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006482 NOTE: This option is set to 1 when 'compatible' is set.
6483
6484 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006485'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006486 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 Minimal number of screen lines to keep above and below the cursor.
6488 This will make some context visible around where you are working. If
6489 you set it to a very large value (999) the cursor line will always be
6490 in the middle of the window (except at the start or end of the file or
6491 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006492 After using the local value, go back the global value with one of
6493 these two: >
6494 setlocal scrolloff<
6495 setlocal scrolloff=-1
6496< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006497 NOTE: This option is set to 0 when 'compatible' is set.
6498
6499 *'scrollopt'* *'sbo'*
6500'scrollopt' 'sbo' string (default "ver,jump")
6501 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006503 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6504 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505 The following words are available:
6506 ver Bind vertical scrolling for 'scrollbind' windows
6507 hor Bind horizontal scrolling for 'scrollbind' windows
6508 jump Applies to the offset between two windows for vertical
6509 scrolling. This offset is the difference in the first
6510 displayed line of the bound windows. When moving
6511 around in a window, another 'scrollbind' window may
6512 reach a position before the start or after the end of
6513 the buffer. The offset is not changed though, when
6514 moving back the 'scrollbind' window will try to scroll
6515 to the desired position when possible.
6516 When now making that window the current one, two
6517 things can be done with the relative offset:
6518 1. When "jump" is not included, the relative offset is
6519 adjusted for the scroll position in the new current
6520 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006521 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 2. When "jump" is included, the other windows are
6523 scrolled to keep the same relative offset. When
6524 going back to the other window, it still uses the
6525 same relative offset.
6526 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006527 When 'diff' mode is active there always is vertical scroll binding,
6528 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529
6530 *'sections'* *'sect'*
6531'sections' 'sect' string (default "SHNHH HUnhsh")
6532 global
6533 Specifies the nroff macros that separate sections. These are pairs of
6534 two letters (See |object-motions|). The default makes a section start
6535 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6536
6537 *'secure'* *'nosecure'* *E523*
6538'secure' boolean (default off)
6539 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 When on, ":autocmd", shell and write commands are not allowed in
6541 ".vimrc" and ".exrc" in the current directory and map commands are
6542 displayed. Switch it off only if you know that you will not run into
6543 problems, or when the 'exrc' option is off. On Unix this option is
6544 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006545 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 'secure' at the end of your ~/.vimrc then.
6547 This option cannot be set from a |modeline| or in the |sandbox|, for
6548 security reasons.
6549
6550 *'selection'* *'sel'*
6551'selection' 'sel' string (default "inclusive")
6552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 This option defines the behavior of the selection. It is only used
6554 in Visual and Select mode.
6555 Possible values:
6556 value past line inclusive ~
6557 old no yes
6558 inclusive yes yes
6559 exclusive yes no
6560 "past line" means that the cursor is allowed to be positioned one
6561 character past the line.
6562 "inclusive" means that the last character of the selection is included
6563 in an operation. For example, when "x" is used to delete the
6564 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006565 When "old" is used and 'virtualedit' allows the cursor to move past
6566 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006567 Note that when "exclusive" is used and selecting from the end
6568 backwards, you cannot include the last character of a line, when
6569 starting in Normal mode and 'virtualedit' empty.
6570
6571 The 'selection' option is set by the |:behave| command.
6572
6573 *'selectmode'* *'slm'*
6574'selectmode' 'slm' string (default "")
6575 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576 This is a comma separated list of words, which specifies when to start
6577 Select mode instead of Visual mode, when a selection is started.
6578 Possible values:
6579 mouse when using the mouse
6580 key when using shifted special keys
6581 cmd when using "v", "V" or CTRL-V
6582 See |Select-mode|.
6583 The 'selectmode' option is set by the |:behave| command.
6584
6585 *'sessionoptions'* *'ssop'*
6586'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006587 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006589 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590 feature}
6591 Changes the effect of the |:mksession| command. It is a comma
6592 separated list of words. Each word enables saving and restoring
6593 something:
6594 word save and restore ~
6595 blank empty windows
6596 buffers hidden and unloaded buffers, not just those in windows
6597 curdir the current directory
6598 folds manually created folds, opened/closed folds and local
6599 fold options
6600 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006601 and contain at least one lowercase letter. Only
6602 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 help the help window
6604 localoptions options and mappings local to a window or buffer (not
6605 global values for local options)
6606 options all options and mappings (also global values for local
6607 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006608 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006609 resize size of the Vim window: 'lines' and 'columns'
6610 sesdir the directory in which the session file is located
6611 will become the current directory (useful with
6612 projects accessed over a network from different
6613 systems)
6614 slash backslashes in file names replaced with forward
6615 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006616 tabpages all tab pages; without this only the current tab page
6617 is restored, so that you can make a session for each
6618 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006619 terminal include terminal windows where the command can be
6620 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006621 unix with Unix end-of-line format (single <NL>), even when
6622 on Windows or DOS
6623 winpos position of the whole Vim window
6624 winsize window sizes
6625
6626 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006627 When neither "curdir" nor "sesdir" is included, file names are stored
6628 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 "slash" and "unix" are useful on Windows when sharing session files
6630 with Unix. The Unix version of Vim cannot source dos format scripts,
6631 but the Windows version of Vim can source unix format scripts.
6632
6633 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006634'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 global
6636 Name of the shell to use for ! and :! commands. When changing the
6637 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6638 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006639 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006640 See |option-backslash| about including spaces and backslashes.
6641 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006642
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006643 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006644 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006645 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6646< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006647 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006649 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006650 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006651 Example with escaped space (Vim will do this when initializing the
6652 option from $SHELL): >
6653 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006654< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006655 backslashes are consumed by `:set`.
6656
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 Under MS-Windows, when the executable ends in ".com" it must be
6658 included. Thus setting the shell to "command.com" or "4dos.com"
6659 works, but "command" and "4dos" do not work for all commands (e.g.,
6660 filtering).
6661 For unknown reasons, when using "4dos.com" the current directory is
6662 changed to "C:\". To avoid this set 'shell' like this: >
6663 :set shell=command.com\ /c\ 4dos
6664< This option cannot be set from a |modeline| or in the |sandbox|, for
6665 security reasons.
6666
6667 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006668'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006669 Win32, when 'shell' contains "powershell":
6670 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006671 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006674 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6675 For MS-Windows, the default is set according to the value of 'shell',
6676 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006677 On Unix it can have more than one flag. Each white space separated
6678 part is passed as an argument to the shell command.
6679 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006680 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681 This option cannot be set from a |modeline| or in the |sandbox|, for
6682 security reasons.
6683
6684 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006685'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6686 "2>&1| tee", or
6687 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 {not available when compiled without the |+quickfix|
6690 feature}
6691 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006692 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693 including spaces and backslashes.
6694 The name of the temporary file can be represented by "%s" if necessary
6695 (the file name is appended automatically if no %s appears in the value
6696 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006697 For the Amiga the default is ">". For MS-Windows using powershell the
6698 default is "2>&1 | Out-File -Encoding default", otherwise the default
6699 is ">%s 2>&1". The output is directly saved in a file and not echoed
6700 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006701 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 in a file and echoed to the screen. If the 'shell' option is "csh" or
6703 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006704 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006705 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6706 means that stderr is also included. Before using the 'shell' option a
6707 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006708 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6709 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006710 The initialization of this option is done after reading the ".vimrc"
6711 and the other initializations, so that when the 'shell' option is set
6712 there, the 'shellpipe' option changes automatically, unless it was
6713 explicitly set before.
6714 When 'shellpipe' is set to an empty string, no redirection of the
6715 ":make" output will be done. This is useful if you use a 'makeprg'
6716 that writes to 'makeef' by itself. If you want no piping, but do
6717 want to include the 'makeef', set 'shellpipe' to a single space.
6718 Don't forget to precede the space with a backslash: ":set sp=\ ".
6719 In the future pipes may be used for filtering and this option will
6720 become obsolete (at least for Unix).
6721 This option cannot be set from a |modeline| or in the |sandbox|, for
6722 security reasons.
6723
6724 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006725'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006727 Quoting character(s), put around the command passed to the shell, for
6728 the "!" and ":!" commands. The redirection is kept outside of the
6729 quoting. See 'shellxquote' to include the redirection. It's
6730 probably not useful to set both options.
6731 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006732 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006733 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 This option cannot be set from a |modeline| or in the |sandbox|, for
6735 security reasons.
6736
6737 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006738'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6739 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741 String to be used to put the output of a filter command in a temporary
6742 file. See also |:!|. See |option-backslash| about including spaces
6743 and backslashes.
6744 The name of the temporary file can be represented by "%s" if necessary
6745 (the file name is appended automatically if no %s appears in the value
6746 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006747 The default is ">". For Unix, if the 'shell' option is "csh" or
6748 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006749 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006750 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6751 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006752 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6753 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006754 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6755 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006756 The initialization of this option is done after reading the ".vimrc"
6757 and the other initializations, so that when the 'shell' option is set
6758 there, the 'shellredir' option changes automatically unless it was
6759 explicitly set before.
6760 In the future pipes may be used for filtering and this option will
6761 become obsolete (at least for Unix).
6762 This option cannot be set from a |modeline| or in the |sandbox|, for
6763 security reasons.
6764
6765 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6766'shellslash' 'ssl' boolean (default off)
6767 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006768 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006770 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006771 powershell.exe. Backward slashes can still be typed, but they are
6772 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 Note that setting or resetting this option has no effect for some
6774 existing file names, thus this option needs to be set before opening
6775 any file for best results. This might change in the future.
6776 'shellslash' only works when a backslash can be used as a path
6777 separator. To test if this is so use: >
6778 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006779< Also see 'completeslash'.
6780
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006781 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6782'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6783 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006784 When on, use temp files for shell commands. When off use a pipe.
6785 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006786 Currently a pipe is only supported on Unix and MS-Windows 2K and
6787 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006788 :if has("filterpipe")
6789< The advantage of using a pipe is that nobody can read the temp file
6790 and the 'shell' command does not need to support redirection.
6791 The advantage of using a temp file is that the file type and encoding
6792 can be detected.
6793 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6794 |FilterWritePost| autocommands event are not triggered when
6795 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006796 The `system()` function does not respect this option and always uses
6797 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006798 NOTE: This option is set to the Vim default value when 'compatible'
6799 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006800
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 *'shelltype'* *'st'*
6802'shelltype' 'st' number (default 0)
6803 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006804 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 On the Amiga this option influences the way how the commands work
6806 which use a shell.
6807 0 and 1: always use the shell
6808 2 and 3: use the shell only to filter lines
6809 4 and 5: use shell only for ':sh' command
6810 When not using the shell, the command is executed directly.
6811
6812 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6813 1 and 3: use "shell cmd" to start external commands
6814
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006815 *'shellxescape'* *'sxe'*
6816'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006817 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006818 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006819 When 'shellxquote' is set to "(" then the characters listed in this
6820 option will be escaped with a '^' character. This makes it possible
6821 to execute most external commands with cmd.exe.
6822
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 *'shellxquote'* *'sxq'*
6824'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006825 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006826 for Win32, when 'shell' is
6827 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006828 for Win32, when 'shell' contains "sh"
6829 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 for Unix, when using system(): "\"")
6831 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832 Quoting character(s), put around the command passed to the shell, for
6833 the "!" and ":!" commands. Includes the redirection. See
6834 'shellquote' to exclude the redirection. It's probably not useful
6835 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006836 When the value is '(' then ')' is appended. When the value is '"('
6837 then ')"' is appended.
6838 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006839 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006840 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6841 pwsh.exe which automatically strips off the first and last quote on a
6842 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6843 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006844 'shell', to reduce the need to set this option by the user. See
6845 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 This option cannot be set from a |modeline| or in the |sandbox|, for
6847 security reasons.
6848
6849 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6850'shiftround' 'sr' boolean (default off)
6851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852 Round indent to multiple of 'shiftwidth'. Applies to > and <
6853 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6854 a multiple of 'shiftwidth' (this is Vi compatible).
6855 NOTE: This option is reset when 'compatible' is set.
6856
6857 *'shiftwidth'* *'sw'*
6858'shiftwidth' 'sw' number (default 8)
6859 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006860 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006861 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006862 When zero the 'ts' value will be used. Use the |shiftwidth()|
6863 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864
6865 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006866'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6867 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869 This option helps to avoid all the |hit-enter| prompts caused by file
6870 messages, for example with CTRL-G, and to avoid some other messages.
6871 It is a list of flags:
6872 flag meaning when present ~
6873 f use "(3 of 5)" instead of "(file 3 of 5)"
6874 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006875 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 m use "[+]" instead of "[Modified]"
6877 n use "[New]" instead of "[New File]"
6878 r use "[RO]" instead of "[readonly]"
6879 w use "[w]" instead of "written" for file write message
6880 and "[a]" instead of "appended" for ':w >> file' command
6881 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6882 "[unix format]" and "[mac]" instead of "[mac format]".
6883 a all of the above abbreviations
6884
6885 o overwrite message for writing a file with subsequent message
6886 for reading a file (useful for ":wn" or when 'autowrite' on)
6887 O message for reading a file overwrites any previous message.
6888 Also for quickfix message (e.g., ":cn").
6889 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006890 hit TOP, continuing at BOTTOM" messages; when using the search
6891 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 t truncate file message at the start if it is too long to fit
6893 on the command-line, "<" will appear in the left most column.
6894 Ignored in Ex mode.
6895 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006896 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006897 Ignored in Ex mode.
6898 W don't give "written" or "[w]" when writing a file
6899 A don't give the "ATTENTION" message when an existing swap file
6900 is found.
6901 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006902 c don't give |ins-completion-menu| messages. For example,
6903 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6904 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006905 q use "recording" instead of "recording @a"
6906 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006907 was used for the command; note that this also affects messages
6908 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006909 S do not show search count message when searching, e.g.
6910 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911
6912 This gives you the opportunity to avoid that a change between buffers
6913 requires you to hit <Enter>, but still gives as useful a message as
6914 possible for the space available. To get the whole message that you
6915 would have got with 'shm' empty, use ":file!"
6916 Useful values:
6917 shm= No abbreviation of message.
6918 shm=a Abbreviation, but no loss of information.
6919 shm=at Abbreviation, and truncate message when necessary.
6920
6921 NOTE: This option is set to the Vi default value when 'compatible' is
6922 set and to the Vim default value when 'compatible' is reset.
6923
6924 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6925'shortname' 'sn' boolean (default off)
6926 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927 Filenames are assumed to be 8 characters plus one extension of 3
6928 characters. Multiple dots in file names are not allowed. When this
6929 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006930 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006932 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933
6934 *'showbreak'* *'sbr'* *E595*
6935'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006936 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006937 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 feature}
6939 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006940 values are "> " or "+++ ": >
6941 :set showbreak=>\
6942< Note the backslash to escape the trailing space. It's easier like
6943 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006944 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006945< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946 comma (in a future version the comma might be used to separate the
6947 part that is shown at the end and at the start of a line).
6948 The characters are highlighted according to the '@' flag in
6949 'highlight'.
6950 Note that tabs after the showbreak will be displayed differently.
6951 If you want the 'showbreak' to appear in between line numbers, add the
6952 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006953 A window-local value overrules a global value. If the global value is
6954 set and you want no value in the current window use NONE: >
6955 :setlocal showbreak=NONE
6956<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006958'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6959 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006961 {not available when compiled without the
6962 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006963 Show (partial) command in the last line of the screen. Set this
6964 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965 In Visual mode the size of the selected area is shown:
6966 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006967 If the number of bytes is different it is also displayed: "2-6"
6968 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006970 - When selecting a block, the size in screen characters:
6971 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972 NOTE: This option is set to the Vi default value when 'compatible' is
6973 set and to the Vim default value when 'compatible' is reset.
6974
6975 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6976'showfulltag' 'sft' boolean (default off)
6977 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978 When completing a word in insert mode (see |ins-completion|) from the
6979 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006980 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 matched a C function, you can see a template for what arguments are
6982 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006983 Note that this doesn't work well together with having "longest" in
6984 'completeopt', because the completion from the search pattern may not
6985 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986
6987 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6988'showmatch' 'sm' boolean (default off)
6989 global
6990 When a bracket is inserted, briefly jump to the matching one. The
6991 jump is only done if the match can be seen on the screen. The time to
6992 show the match can be set with 'matchtime'.
6993 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006994 seen or not).
6995 This option is reset when 'paste' is set and restored when 'paste' is
6996 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006997 When the 'm' flag is not included in 'cpoptions', typing a character
6998 will immediately move the cursor back to where it belongs.
6999 See the "sm" field in 'guicursor' for setting the cursor shape and
7000 blinking when showing the match.
7001 The 'matchpairs' option can be used to specify the characters to show
7002 matches for. 'rightleft' and 'revins' are used to look for opposite
7003 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007004 Also see the matchparen plugin for highlighting the match when moving
7005 around |pi_paren.txt|.
7006 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007007
7008 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7009'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7010 global
7011 If in Insert, Replace or Visual mode put a message on the last line.
7012 Use the 'M' flag in 'highlight' to set the type of highlighting for
7013 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007014 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015 doesn't mean XIM is really active, especially when 'imactivatekey' is
7016 not set.
7017 NOTE: This option is set to the Vi default value when 'compatible' is
7018 set and to the Vim default value when 'compatible' is reset.
7019
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007020 *'showtabline'* *'stal'*
7021'showtabline' 'stal' number (default 1)
7022 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007023 The value of this option specifies when the line with tab page labels
7024 will be displayed:
7025 0: never
7026 1: only if there are at least two tab pages
7027 2: always
7028 This is both for the GUI and non-GUI implementation of the tab pages
7029 line.
7030 See |tab-page| for more information about tab pages.
7031
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032 *'sidescroll'* *'ss'*
7033'sidescroll' 'ss' number (default 0)
7034 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035 The minimal number of columns to scroll horizontally. Used only when
7036 the 'wrap' option is off and the cursor is moved off of the screen.
7037 When it is zero the cursor will be put in the middle of the screen.
7038 When using a slow terminal set it to a large number or 0. When using
7039 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7040 commands.
7041
7042 *'sidescrolloff'* *'siso'*
7043'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007044 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007046 right of the cursor if 'nowrap' is set. Setting this option to a
7047 value greater than 0 while having |'sidescroll'| also at a non-zero
7048 value makes some context visible in the line you are scrolling in
7049 horizontally (except at beginning of the line). Setting this option
7050 to a large value (like 999) has the effect of keeping the cursor
7051 horizontally centered in the window, as long as one does not come too
7052 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007053 After using the local value, go back the global value with one of
7054 these two: >
7055 setlocal sidescrolloff<
7056 setlocal sidescrolloff=-1
7057< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058
7059 Example: Try this together with 'sidescroll' and 'listchars' as
7060 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007061 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007062
7063 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7064 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007065<
7066 *'signcolumn'* *'scl'*
7067'signcolumn' 'scl' string (default "auto")
7068 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007069 {not available when compiled without the |+signs|
7070 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007071 Whether or not to draw the signcolumn. Valid values are:
7072 "auto" only when there is a sign to display
7073 "no" never
7074 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007075 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007076 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007077
7078
7079 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7080'smartcase' 'scs' boolean (default off)
7081 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082 Override the 'ignorecase' option if the search pattern contains upper
7083 case characters. Only used when the search pattern is typed and
7084 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007085 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007086 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7087 recalling the search pattern from history and hitting <Enter>.
7088 NOTE: This option is reset when 'compatible' is set.
7089
7090 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7091'smartindent' 'si' boolean (default off)
7092 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 {not available when compiled without the
7094 |+smartindent| feature}
7095 Do smart autoindenting when starting a new line. Works for C-like
7096 programs, but can also be used for other languages. 'cindent' does
7097 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007098 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007099 setting 'si' has no effect. 'indentexpr' is a more advanced
7100 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007101 Normally 'autoindent' should also be on when using 'smartindent'.
7102 An indent is automatically inserted:
7103 - After a line ending in '{'.
7104 - After a line starting with a keyword from 'cinwords'.
7105 - Before a line starting with '}' (only with the "O" command).
7106 When typing '}' as the first character in a new line, that line is
7107 given the same indent as the matching '{'.
7108 When typing '#' as the first character in a new line, the indent for
7109 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007110 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7112 When using the ">>" command, lines starting with '#' are not shifted
7113 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007114 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007115 This option is reset when 'paste' is set and restored when 'paste' is
7116 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007117
7118 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7119'smarttab' 'sta' boolean (default off)
7120 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007122 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7123 <BS> will delete a 'shiftwidth' worth of space at the start of the
7124 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007125 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007126 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7127 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007128 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007130 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007131 This option is reset when 'paste' is set and restored when 'paste' is
7132 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 NOTE: This option is reset when 'compatible' is set.
7134
7135 *'softtabstop'* *'sts'*
7136'softtabstop' 'sts' number (default 0)
7137 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 Number of spaces that a <Tab> counts for while performing editing
7139 operations, like inserting a <Tab> or using <BS>. It "feels" like
7140 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7141 used. This is useful to keep the 'ts' setting at its standard value
7142 of 8, while being able to edit like it is set to 'sts'. However,
7143 commands like "x" still work on the actual characters.
7144 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007145 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007146 'softtabstop' is set to 0 when the 'paste' option is set and restored
7147 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7149 spaces is minimized by using <Tab>s.
7150 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7151 set.
7152 NOTE: This option is set to 0 when 'compatible' is set.
7153
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007154 If Vim is compiled with the |+vartabs| feature then the value of
7155 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7156 anything other than an empty string.
7157
Bram Moolenaar217ad922005-03-20 22:37:15 +00007158 *'spell'* *'nospell'*
7159'spell' boolean (default off)
7160 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007161 {not available when compiled without the |+syntax|
7162 feature}
7163 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007164 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007165
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007166 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007167'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007168 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007169 {not available when compiled without the |+syntax|
7170 feature}
7171 Pattern to locate the end of a sentence. The following word will be
7172 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007173 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007174 When this check is not wanted make this option empty.
7175 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007176 Be careful with special characters, see |option-backslash| about
7177 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007178 To set this option automatically depending on the language, see
7179 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007180
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007181 *'spellfile'* *'spf'*
7182'spellfile' 'spf' string (default empty)
7183 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007184 {not available when compiled without the |+syntax|
7185 feature}
7186 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007187 commands. It must end in ".{encoding}.add". You need to include the
7188 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007189 *E765*
7190 It may also be a comma separated list of names. A count before the
7191 |zg| and |zw| commands can be used to access each. This allows using
7192 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007193 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007194 you: Using the first directory in 'runtimepath' that is writable. If
7195 there is no "spell" directory yet it will be created. For the file
7196 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007197 ignoring the region.
7198 The resulting ".spl" file will be used for spell checking, it does not
7199 have to appear in 'spelllang'.
7200 Normally one file is used for all regions, but you can add the region
7201 name if you want to. However, it will then only be used when
7202 'spellfile' is set to it, for entries in 'spelllang' only files
7203 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007204 This option cannot be set from a |modeline| or in the |sandbox|, for
7205 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007206
Bram Moolenaar217ad922005-03-20 22:37:15 +00007207 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007208'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007209 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007210 {not available when compiled without the |+syntax|
7211 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007212 A comma separated list of word list names. When the 'spell' option is
7213 on spellchecking will be done for these languages. Example: >
7214 set spelllang=en_us,nl,medical
7215< This means US English, Dutch and medical words are recognized. Words
7216 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007217 The word list name must consist of alphanumeric characters, a dash or
7218 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007219 recommended to separate the two letter language name from a
7220 specification. Thus "en-rare" is used for rare English words.
7221 A region name must come last and have the form "_xx", where "xx" is
7222 the two-letter, lower case region name. You can use more than one
7223 region by listing them: "en_us,en_ca" supports both US and Canadian
7224 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007225 Britain. (Note: currently en_au and en_nz dictionaries are older than
7226 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007227 If the name "cjk" is included East Asian characters are excluded from
7228 spell checking. This is useful when editing text that also has Asian
7229 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007230 Note that the "medical" dictionary does not exist, it is just an
7231 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007232 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007233 As a special case the name of a .spl file can be given as-is. The
7234 first "_xx" in the name is removed and used as the region name
7235 (_xx is an underscore, two letters and followed by a non-letter).
7236 This is mainly for testing purposes. You must make sure the correct
7237 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007238 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007239 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7240 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007241 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007242
Bram Moolenaar98692072006-02-04 00:57:42 +00007243 If the |spellfile.vim| plugin is active and you use a language name
7244 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7245 will ask you if you want to download the file.
7246
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007247 After this option has been set successfully, Vim will source the files
7248 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007249 up to the first character that is not an ASCII letter or number and
7250 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007251
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007252 *'spelloptions'* *'spo'*
7253'spelloptions' 'spo' string (default "")
7254 local to buffer
7255 {not available when compiled without the |+syntax|
7256 feature}
7257 A comma separated list of options for spell checking:
7258 camel When a word is CamelCased, assume "Cased" is a
7259 separate word: every upper-case character in a word
7260 that comes after a lower case character indicates the
7261 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007262
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007263 *'spellsuggest'* *'sps'*
7264'spellsuggest' 'sps' string (default "best")
7265 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007266 {not available when compiled without the |+syntax|
7267 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007268 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007269 the |spellsuggest()| function. This is a comma-separated list of
7270 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007271
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007272 best Internal method that works best for English. Finds
7273 changes like "fast" and uses a bit of sound-a-like
7274 scoring to improve the ordering.
7275
7276 double Internal method that uses two methods and mixes the
7277 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007278 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007279 word. That only works when the language specifies
7280 sound folding. Can be slow and doesn't always give
7281 better results.
7282
7283 fast Internal method that only checks for simple changes:
7284 character inserts/deletes/swaps. Works well for
7285 simple typing mistakes.
7286
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007287 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007288 Not used for |spellsuggest()|. The number of
7289 suggestions is never more than the value of 'lines'
7290 minus two.
7291
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007292 file:{filename} Read file {filename}, which must have two columns,
7293 separated by a slash. The first column contains the
7294 bad word, the second column the suggested good word.
7295 Example:
7296 theribal/terrible ~
7297 Use this for common mistakes that do not appear at the
7298 top of the suggestion list with the internal methods.
7299 Lines without a slash are ignored, use this for
7300 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007301 The word in the second column must be correct,
7302 otherwise it will not be used. Add the word to an
7303 ".add" file if it is currently flagged as a spelling
7304 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007305 The file is used for all languages.
7306
7307 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7308 trouble with spaces. |v:val| holds the badly spelled
7309 word. The expression must evaluate to a List of
7310 Lists, each with a suggestion and a score.
7311 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007312 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007313 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007314 internal methods use. A lower score is better.
7315 This may invoke |spellsuggest()| if you temporarily
7316 set 'spellsuggest' to exclude the "expr:" part.
7317 Errors are silently ignored, unless you set the
7318 'verbose' option to a non-zero value.
7319
7320 Only one of "best", "double" or "fast" may be used. The others may
7321 appear several times in any order. Example: >
7322 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7323<
7324 This option cannot be set from a |modeline| or in the |sandbox|, for
7325 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007326
7327
Bram Moolenaar071d4272004-06-13 20:20:40 +00007328 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7329'splitbelow' 'sb' boolean (default off)
7330 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007331 When on, splitting a window will put the new window below the current
7332 one. |:split|
7333
7334 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7335'splitright' 'spr' boolean (default off)
7336 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007337 When on, splitting a window will put the new window right of the
7338 current one. |:vsplit|
7339
7340 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7341'startofline' 'sol' boolean (default on)
7342 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007343 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007344 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007345 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007346 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007347 with a linewise operator, with "%" with a count and to buffer changing
7348 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7349 only has a line number, e.g., ":25" or ":+".
7350 In case of buffer changing commands the cursor is placed at the column
7351 where it was the last time the buffer was edited.
7352 NOTE: This option is set when 'compatible' is set.
7353
Bram Moolenaar00654022011-02-25 14:42:19 +01007354 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007356 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007357 {not available when compiled without the |+statusline|
7358 feature}
7359 When nonempty, this option determines the content of the status line.
7360 Also see |status-line|.
7361
7362 The option consists of printf style '%' items interspersed with
7363 normal text. Each status line item is of the form:
7364 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007365 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007366 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007367
Bram Moolenaar238a5642006-02-21 22:12:05 +00007368 When the option starts with "%!" then it is used as an expression,
7369 evaluated and the result is used as the option value. Example: >
7370 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007371< The *g:statusline_winid* variable will be set to the |window-ID| of the
7372 window that the status line belongs to.
7373 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007374 Note that the "%!" expression is evaluated in the context of the
7375 current window and buffer, while %{} items are evaluated in the
7376 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007377
7378 When there is error while evaluating the option then it will be made
7379 empty to avoid further errors. Otherwise screen updating would loop.
7380
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381 Note that the only effect of 'ruler' when this option is set (and
7382 'laststatus' is 2) is controlling the output of |CTRL-G|.
7383
7384 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007385 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007386 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007387 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388 minwid Minimum width of the item, padding as set by '-' & '0'.
7389 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007390 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007391 on the left for text items. Numeric items will be
7392 shifted down to maxwid-2 digits followed by '>'number
7393 where number is the amount of missing digits, much like
7394 an exponential notation.
7395 item A one letter code as described below.
7396
7397 Following is a description of the possible statusline items. The
7398 second character in "item" is the type:
7399 N for number
7400 S for string
7401 F for flags as described below
7402 - not applicable
7403
7404 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007405 f S Path to the file in the buffer, as typed or relative to current
7406 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007407 F S Full path to the file in the buffer.
7408 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007409 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007411 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007412 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007413 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007415 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007417 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007419 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007420 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7421 being used: "<keymap>"
7422 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007423 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424 B N As above, in hexadecimal.
7425 o N Byte number in file of byte under cursor, first byte is 1.
7426 Mnemonic: Offset from start of file (with one added)
7427 {not available when compiled without |+byte_offset| feature}
7428 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007429 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007430 l N Line number.
7431 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007432 c N Column number (byte index).
7433 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007434 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435 p N Percentage through file in lines as in |CTRL-G|.
7436 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007437 percentage described for 'ruler'. Always 3 in length, unless
7438 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007439 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007441 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007442 Note that there is no '%' before the closing '}'. The
7443 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007444 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007445 {% - This is almost same as { except the result of the expression is
7446 re-evaluated as a statusline format string. Thus if the
7447 return value of expr contains % items they will get expanded.
7448 The expression can contain the } character, the end of
7449 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007450 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007451 func! Stl_filename() abort
7452 return "%t"
7453 endfunc
7454< `stl=%{Stl_filename()}` results in `"%t"`
7455 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007456 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457 ( - Start of item group. Can be used for setting the width and
7458 alignment of a section. Must be followed by %) somewhere.
7459 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007460 T N For 'tabline': start of tab page N label. Use %T after the last
7461 label. This information is used for mouse clicks.
7462 X N For 'tabline': start of close tab N label. Use %X after the
7463 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7464 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465 < - Where to truncate line if too long. Default is at the start.
7466 No width fields allowed.
7467 = - Separation point between left and right aligned items.
7468 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007469 # - Set highlight group. The name must follow and then a # again.
7470 Thus use %#HLname# for highlight group HLname. The same
7471 highlighting is used, also for the statusline of non-current
7472 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007473 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007474 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007475 The difference between User{N} and StatusLine will be applied
7476 to StatusLineNC for the statusline of non-current windows.
7477 The number N must be between 1 and 9. See |hl-User1..9|
7478
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007479 When displaying a flag, Vim removes the leading comma, if any, when
7480 that flag comes right after plaintext. This will make a nice display
7481 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482
Bram Moolenaar582fd852005-03-28 20:58:01 +00007483 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484 not set) and a minwid is not set for the group, the whole group will
7485 become empty. This will make a group like the following disappear
7486 completely from the statusline when none of the flags are set. >
7487 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007488< Beware that an expression is evaluated each and every time the status
7489 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007490 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007491 While evaluating %{} the current buffer and current window will be set
7492 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007493 currently being drawn. The expression will evaluate in this context.
7494 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7495 real current buffer and "g:actual_curwin" to the |window-ID| of the
7496 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007497
Bram Moolenaar30b65812012-07-12 22:01:11 +02007498 The 'statusline' option will be evaluated in the |sandbox| if set from
7499 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007500 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007501
7502 It is not allowed to change text or jump to another window while
7503 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007504
7505 If the statusline is not updated when you want it (e.g., after setting
7506 a variable that's used in an expression), you can force an update by
7507 setting an option without changing its value. Example: >
7508 :let &ro = &ro
7509
7510< A result of all digits is regarded a number for display purposes.
7511 Otherwise the result is taken as flag text and applied to the rules
7512 described above.
7513
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007514 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007516 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517
7518 Examples:
7519 Emulate standard status line with 'ruler' set >
7520 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7521< Similar, but add ASCII value of char under the cursor (like "ga") >
7522 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7523< Display byte count and byte value, modified flag in red. >
7524 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7525 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7526< Display a ,GZ flag if a compressed file is loaded >
7527 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7528< In the |:autocmd|'s: >
7529 :let b:gzflag = 1
7530< And: >
7531 :unlet b:gzflag
7532< And define this function: >
7533 :function VarExists(var, val)
7534 : if exists(a:var) | return a:val | else | return '' | endif
7535 :endfunction
7536<
7537 *'suffixes'* *'su'*
7538'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7539 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007540 Files with these suffixes get a lower priority when multiple files
7541 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007542 suffixes. Spaces after the comma are ignored. A dot is also seen as
7543 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 separator, precede it with a backslash (see |option-backslash| about
7545 including spaces and backslashes).
7546 See 'wildignore' for completely ignoring files.
7547 The use of |:set+=| and |:set-=| is preferred when adding or removing
7548 suffixes from the list. This avoids problems when a future version
7549 uses another default.
7550
7551 *'suffixesadd'* *'sua'*
7552'suffixesadd' 'sua' string (default "")
7553 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 {not available when compiled without the
7555 |+file_in_path| feature}
7556 Comma separated list of suffixes, which are used when searching for a
7557 file for the "gf", "[I", etc. commands. Example: >
7558 :set suffixesadd=.java
7559<
7560 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7561'swapfile' 'swf' boolean (default on)
7562 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007563 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564 swapfile is not wanted for a specific buffer. For example, with
7565 confidential information that even root must not be able to access.
7566 Careful: All text will be in memory:
7567 - Don't use this for big files.
7568 - Recovery will be impossible!
7569 A swapfile will only be present when |'updatecount'| is non-zero and
7570 'swapfile' is set.
7571 When 'swapfile' is reset, the swap file for the current buffer is
7572 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7573 non-zero, a swap file is immediately created.
7574 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007575 If you want to open a new buffer without creating a swap file for it,
7576 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007577 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578
7579 This option is used together with 'bufhidden' and 'buftype' to
7580 specify special kinds of buffers. See |special-buffers|.
7581
7582 *'swapsync'* *'sws'*
7583'swapsync' 'sws' string (default "fsync")
7584 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007585 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007586 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587 When this option is empty parts of the swap file may be in memory and
7588 not written to disk. When the system crashes you may lose more work.
7589 On Unix the system does a sync now and then without Vim asking for it,
7590 so the disadvantage of setting this option off is small. On some
7591 systems the swap file will not be written at all. For a unix system
7592 setting it to "sync" will use the sync() call instead of the default
7593 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007594 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595
7596 *'switchbuf'* *'swb'*
7597'switchbuf' 'swb' string (default "")
7598 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007600 Mostly for |quickfix| commands some values are also used for other
7601 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602 Possible values (comma separated list):
7603 useopen If included, jump to the first open window that
7604 contains the specified buffer (if there is one).
7605 Otherwise: Do not examine other windows.
7606 This setting is checked with |quickfix| commands, when
7607 jumping to errors (":cc", ":cn", "cp", etc.). It is
7608 also used in all buffer related split commands, for
7609 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007610 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007611 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007613 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007614 Otherwise: do not split, use current window (when used
7615 in the quickfix window: the previously used window or
7616 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007617 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007618 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007619 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007620 uselast If included, jump to the previously used window when
7621 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007622
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007623 *'synmaxcol'* *'smc'*
7624'synmaxcol' 'smc' number (default 3000)
7625 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007626 {not available when compiled without the |+syntax|
7627 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007628 Maximum column in which to search for syntax items. In long lines the
7629 text after this column is not highlighted and following lines may not
7630 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007631 This helps to avoid very slow redrawing for an XML file that is one
7632 long line.
7633 Set to zero to remove the limit.
7634
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635 *'syntax'* *'syn'*
7636'syntax' 'syn' string (default empty)
7637 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007638 {not available when compiled without the |+syntax|
7639 feature}
7640 When this option is set, the syntax with this name is loaded, unless
7641 syntax highlighting has been switched off with ":syntax off".
7642 Otherwise this option does not always reflect the current syntax (the
7643 b:current_syntax variable does).
7644 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007645 not automatically recognized. Example, in an IDL file:
7646 /* vim: set syntax=idl : */ ~
7647 When a dot appears in the value then this separates two filetype
7648 names. Example:
7649 /* vim: set syntax=c.doxygen : */ ~
7650 This will use the "c" syntax first, then the "doxygen" syntax.
7651 Note that the second one must be prepared to be loaded as an addition,
7652 otherwise it will be skipped. More than one dot may appear.
7653 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007654 :set syntax=OFF
7655< To switch syntax highlighting on according to the current value of the
7656 'filetype' option: >
7657 :set syntax=ON
7658< What actually happens when setting the 'syntax' option is that the
7659 Syntax autocommand event is triggered with the value as argument.
7660 This option is not copied to another buffer, independent of the 's' or
7661 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007662 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007663
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007664 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007665'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007666 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007667 When nonempty, this option determines the content of the tab pages
7668 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007669 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007670
7671 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007672 option and only when there is no GUI tab line. When 'e' is in
7673 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007674 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007675
7676 The value is evaluated like with 'statusline'. You can use
7677 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007678 the text to be displayed. Use "%1T" for the first label, "%2T" for
7679 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007680
Bram Moolenaare12bab32019-01-08 22:02:56 +01007681 When changing something that is used in 'tabline' that does not
7682 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007683 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007684
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007685 Keep in mind that only one of the tab pages is the current one, others
7686 are invisible and you can't jump to their windows.
7687
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007688
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007689 *'tabpagemax'* *'tpm'*
7690'tabpagemax' 'tpm' number (default 10)
7691 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007692 Maximum number of tab pages to be opened by the |-p| command line
7693 argument or the ":tab all" command. |tabpage|
7694
7695
7696 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007697'tabstop' 'ts' number (default 8)
7698 local to buffer
7699 Number of spaces that a <Tab> in the file counts for. Also see
7700 |:retab| command, and 'softtabstop' option.
7701
7702 Note: Setting 'tabstop' to any other value than 8 can make your file
7703 appear wrong in many places (e.g., when printing it).
7704
7705 There are four main ways to use tabs in Vim:
7706 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7707 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007708 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709 behave like a tab appears every 4 (or 3) characters.
7710 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7711 'expandtab'. This way you will always insert spaces. The
7712 formatting will never be messed up when 'tabstop' is changed.
7713 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007714 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715 works when using Vim to edit the file.
7716 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7717 'noexpandtab'. This should then work (for initial indents only)
7718 for any tabstop setting that people use. It might be nice to have
7719 tabs after the first non-blank inserted as spaces if you do this
7720 though. Otherwise aligned comments will be wrong when 'tabstop' is
7721 changed.
7722
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007723 If Vim is compiled with the |+vartabs| feature then the value of
7724 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7725 than an empty string.
7726
Bram Moolenaar071d4272004-06-13 20:20:40 +00007727 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7728'tagbsearch' 'tbs' boolean (default on)
7729 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007730 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007731 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007732 searching makes searching for a tag a LOT faster, but a linear search
7733 will find more tags if the tags file wasn't properly sorted.
7734 Vim normally assumes that your tags files are sorted, or indicate that
7735 they are not sorted. Only when this is not the case does the
7736 'tagbsearch' option need to be switched off.
7737
7738 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007739 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740 certain files, or retry all files with a linear search. When
7741 'tagbsearch' is off, only a linear search is done.
7742
7743 Linear searching is done anyway, for one file, when Vim finds a line
7744 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007745 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007746< [The whitespace before and after the '0' must be a single <Tab>]
7747
7748 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007749 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007750 instead of a normal tag name, a retry is done with a linear search.
7751 Tags in unsorted tags files, and matches with different case will only
7752 be found in the retry.
7753
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007754 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007755 linear search can be avoided when case is ignored. Use a value of '2'
7756 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7757 sorted with the -f switch to "sort" in most unices, as in the command:
7758 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7759 (at least 5.5) the --sort=foldcase switch can be used for this as
7760 well. Note that case must be folded to uppercase for this to work.
7761
7762 By default, tag searches are case-sensitive. Case is ignored when
7763 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7764 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007765 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7766 'tagcase' is "smart", and the pattern contains only lowercase
7767 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768
7769 When 'tagbsearch' is off, tags searching is slower when a full match
7770 exists, but faster when no full match exists. Tags in unsorted tags
7771 files may only be found with 'tagbsearch' off.
7772 When the tags file is not sorted, or sorted in a wrong way (not on
7773 ASCII byte value), 'tagbsearch' should be off, or the line given above
7774 must be included in the tags file.
7775 This option doesn't affect commands that find all matching tags (e.g.,
7776 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007777
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007778 *'tagcase'* *'tc'*
7779'tagcase' 'tc' string (default "followic")
7780 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007781 This option specifies how case is handled when searching the tags
7782 file:
7783 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007784 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007785 ignore Ignore case
7786 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007787 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007788 NOTE: This option is set to the Vi default value when 'compatible' is
7789 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007790
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007791 *'tagfunc'* *'tfu'*
7792'tagfunc' 'tfu' string (default: empty)
7793 local to buffer
7794 {not available when compiled without the |+eval|
7795 feature}
7796 This option specifies a function to be used to perform tag searches.
7797 The function gets the tag pattern and should return a List of matching
7798 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007799 function and an example. The value can be the name of a function, a
7800 |lambda| or a |Funcref|. See |option-value-function| for more
7801 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007802
Bram Moolenaar071d4272004-06-13 20:20:40 +00007803 *'taglength'* *'tl'*
7804'taglength' 'tl' number (default 0)
7805 global
7806 If non-zero, tags are significant up to this number of characters.
7807
7808 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7809'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7810 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007811 If on and using a tags file in another directory, file names in that
7812 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007813 NOTE: This option is set to the Vi default value when 'compatible' is
7814 set and to the Vim default value when 'compatible' is reset.
7815
7816 *'tags'* *'tag'* *E433*
7817'tags' 'tag' string (default "./tags,tags", when compiled with
7818 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7819 global or local to buffer |global-local|
7820 Filenames for the tag command, separated by spaces or commas. To
7821 include a space or comma in a file name, precede it with a backslash
7822 (see |option-backslash| about including spaces and backslashes).
7823 When a file name starts with "./", the '.' is replaced with the path
7824 of the current file. But only when the 'd' flag is not included in
7825 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7826 |tags-option|.
7827 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007828 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7829 find all files named "tags" below "/lib". The filename itself cannot
7830 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7831 files called "tags?". {not available when compiled without the
7832 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007833 The |tagfiles()| function can be used to get a list of the file names
7834 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7836 files are also supported. They are automatically recognized. The
7837 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7838 differences are ignored (MS-Windows). |emacs-tags|
7839 The use of |:set+=| and |:set-=| is preferred when adding or removing
7840 file names from the list. This avoids problems when a future version
7841 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007842
7843 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7844'tagstack' 'tgst' boolean (default on)
7845 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007846 When on, the |tagstack| is used normally. When off, a ":tag" or
7847 ":tselect" command with an argument will not push the tag onto the
7848 tagstack. A following ":tag" without an argument, a ":pop" command or
7849 any other command that uses the tagstack will use the unmodified
7850 tagstack, but does change the pointer to the active entry.
7851 Resetting this option is useful when using a ":tag" command in a
7852 mapping which should not change the tagstack.
7853
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007854 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007855'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007856 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007857 {only available when compiled with the |+tcl/dyn|
7858 feature}
7859 Specifies the name of the Tcl shared library. The default is
7860 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007861 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007862 This option cannot be set from a |modeline| or in the |sandbox|, for
7863 security reasons.
7864
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 *'term'* *E529* *E530* *E531*
7866'term' string (default is $TERM, if that fails:
7867 in the GUI: "builtin_gui"
7868 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007869 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007870 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007871 on Unix: "ansi"
7872 on VMS: "ansi"
7873 on Win 32: "win32")
7874 global
7875 Name of the terminal. Used for choosing the terminal control
7876 characters. Environment variables are expanded |:set_env|.
7877 For example: >
7878 :set term=$TERM
7879< See |termcap|.
7880
7881 *'termbidi'* *'tbidi'*
7882 *'notermbidi'* *'notbidi'*
7883'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7884 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007885 {only available when compiled with the |+arabic|
7886 feature}
7887 The terminal is in charge of Bi-directionality of text (as specified
7888 by Unicode). The terminal is also expected to do the required shaping
7889 that some languages (such as Arabic) require.
7890 Setting this option implies that 'rightleft' will not be set when
7891 'arabic' is set and the value of 'arabicshape' will be ignored.
7892 Note that setting 'termbidi' has the immediate effect that
7893 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7894 This option is reset when the GUI is started.
7895 For further details see |arabic.txt|.
7896
7897 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007898'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007900 Encoding used for the terminal. This specifies what character
7901 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007902 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007903 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007904 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007905 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007906 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7907 Any attempts to set a different value will be rejected, and an error
7908 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007909 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007910 because the Win32 system always passes Unicode characters.
7911 When empty, the same encoding is used as for the 'encoding' option.
7912 This is the normal value.
7913 Not all combinations for 'termencoding' and 'encoding' are valid. See
7914 |encoding-table|.
7915 The value for this option must be supported by internal conversions or
7916 iconv(). When this is not possible no conversion will be done and you
7917 will probably experience problems with non-ASCII characters.
7918 Example: You are working with the locale set to euc-jp (Japanese) and
7919 want to edit a UTF-8 file: >
7920 :let &termencoding = &encoding
7921 :set encoding=utf-8
7922< You need to do this when your system has no locale support for UTF-8.
7923
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007924 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007925'termguicolors' 'tgc' boolean (default off)
7926 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007927 {not available when compiled without the
7928 |+termguicolors| feature}
7929 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007930 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007931
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007932 Requires a ISO-8613-3 compatible terminal. If setting this option
7933 does not work (produces a colorless UI) reading |xterm-true-color|
7934 might help.
7935
7936 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7937 is required. Use this check to find out: >
7938 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007939< This requires Vim to be built with the |+vtp| feature.
7940
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007941 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007942 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007943
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007944 *'termwinkey'* *'twk'*
7945'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007946 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007947 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007948 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007949 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007950 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007951< The string must be one key stroke but can be multiple bytes.
7952 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007953 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007954 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007955
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007956 *'termwinscroll'* *'twsl'*
7957'termwinscroll' 'twsl' number (default 10000)
7958 local to buffer
7959 {not available when compiled without the
7960 |+terminal| feature}
7961 Number of scrollback lines to keep. When going over this limit the
7962 first 10% of the scrollback lines are deleted. This is just to reduce
7963 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00007964 Also used as a limit for text sent to the terminal in one write,
7965 multiplied by the number of columns times 3 (average number of bytes
7966 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007967
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007968 *'termwinsize'* *'tws'*
7969'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007970 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007971 Size used when opening the |terminal| window. Format:
7972 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007973 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007974 - When set with a "x" (e.g., "24x80") the terminal size is not
7975 adjusted to the window size. If the window is smaller only the
7976 top-left part is displayed.
7977 - When set with a "*" (e.g., "10*50") the terminal size follows the
7978 window size, but will not be smaller than the specified rows and/or
7979 columns.
7980 - When rows is zero then use the height of the window.
7981 - When columns is zero then use the width of the window.
7982 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007983 - Can be overruled in the |term_start()| options with "term_rows" and
7984 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02007985
7986 Examples:
7987 "30x0" uses 30 rows and the current window width.
7988 "20*0" uses at least 20 rows and the current window width.
7989 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007990 Note that the command running in the terminal window may still change
7991 the size of the terminal. In that case the Vim window will be
7992 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007993
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007994 *'termwintype'* *'twt'*
7995'termwintype' 'twt' string (default "")
7996 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007997 {only available when compiled with the |terminal|
7998 feature on MS-Windows}
7999 Specify the virtual console (pty) used when opening the terminal
8000 window.
8001
8002 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008003 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008004 "winpty" use winpty, fail if not supported
8005 "conpty" use |ConPTY|, fail if not supported
8006
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008007 |ConPTY| support depends on the platform. Windows 10 October 2018
8008 Update is the first version that supports ConPTY, however it is still
8009 considered unstable. ConPTY might become stable in the next release
8010 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008011 supported then you cannot open a terminal window.
8012
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 *'terse'* *'noterse'*
8014'terse' boolean (default off)
8015 global
8016 When set: Add 's' flag to 'shortmess' option (this makes the message
8017 for a search that hits the start or end of the file not being
8018 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8019 shortens a lot of messages}
8020
8021 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8022'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024 This option is obsolete. Use 'fileformats'.
8025 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8026 set to the default value for the current system. When 'textauto' is
8027 reset, 'fileformats' is made empty.
8028 NOTE: This option is set to the Vi default value when 'compatible' is
8029 set and to the Vim default value when 'compatible' is reset.
8030
8031 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008032'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008033 others: default off)
8034 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 This option is obsolete. Use 'fileformat'.
8036 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8037 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8038 "unix".
8039
8040 *'textwidth'* *'tw'*
8041'textwidth' 'tw' number (default 0)
8042 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043 Maximum width of text that is being inserted. A longer line will be
8044 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008045 this.
8046 'textwidth' is set to 0 when the 'paste' option is set and restored
8047 when 'paste' is reset.
8048 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008049 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008050 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008051 NOTE: This option is set to 0 when 'compatible' is set.
8052
8053 *'thesaurus'* *'tsr'*
8054'thesaurus' 'tsr' string (default "")
8055 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008056 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008057 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8058 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008059
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008060 This option is not used if 'thesaurusfunc' is set, either for the
8061 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008062
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008063 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008065 name. See |option-backslash| about using backslashes. The use of
8066 |:set+=| and |:set-=| is preferred when adding or removing directories
8067 from the list. This avoids problems when a future version uses
8068 another default. Backticks cannot be used in this option for security
8069 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008070
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008071 *'thesaurusfunc'* *tsrfu'*
8072'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008073 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008074 {not available when compiled without the |+eval|
8075 feature}
8076 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008077 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
8078
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008079 This option cannot be set from a |modeline| or in the |sandbox|, for
8080 security reasons.
8081
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8083'tildeop' 'top' boolean (default off)
8084 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085 When on: The tilde command "~" behaves like an operator.
8086 NOTE: This option is reset when 'compatible' is set.
8087
8088 *'timeout'* *'to'* *'notimeout'* *'noto'*
8089'timeout' 'to' boolean (default on)
8090 global
8091 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008092'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008093 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008094 These two options together determine the behavior when part of a
8095 mapped key sequence or keyboard code has been received:
8096
8097 'timeout' 'ttimeout' action ~
8098 off off do not time out
8099 on on or off time out on :mappings and key codes
8100 off on time out on key codes
8101
8102 If both options are off, Vim will wait until either the complete
8103 mapping or key sequence has been received, or it is clear that there
8104 is no mapping or key sequence for the received characters. For
8105 example: if you have mapped "vl" and Vim has received 'v', the next
8106 character is needed to see if the 'v' is followed by an 'l'.
8107 When one of the options is on, Vim will wait for about 1 second for
8108 the next character to arrive. After that the already received
8109 characters are interpreted as single characters. The waiting time can
8110 be changed with the 'timeoutlen' option.
8111 On slow terminals or very busy systems timing out may cause
8112 malfunctioning cursor keys. If both options are off, Vim waits
8113 forever after an entered <Esc> if there are key codes that start
8114 with <Esc>. You will have to type <Esc> twice. If you do not have
8115 problems with key codes, but would like to have :mapped key
8116 sequences not timing out in 1 second, set the 'ttimeout' option and
8117 reset the 'timeout' option.
8118
8119 NOTE: 'ttimeout' is reset when 'compatible' is set.
8120
8121 *'timeoutlen'* *'tm'*
8122'timeoutlen' 'tm' number (default 1000)
8123 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008124
Bram Moolenaar071d4272004-06-13 20:20:40 +00008125 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008126'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008127 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 The time in milliseconds that is waited for a key code or mapped key
8129 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8130 when part of a command has been typed.
8131 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8132 different timeout value for key codes is desired set 'ttimeoutlen' to
8133 a non-negative number.
8134
8135 ttimeoutlen mapping delay key code delay ~
8136 < 0 'timeoutlen' 'timeoutlen'
8137 >= 0 'timeoutlen' 'ttimeoutlen'
8138
8139 The timeout only happens when the 'timeout' and 'ttimeout' options
8140 tell so. A useful setting would be >
8141 :set timeout timeoutlen=3000 ttimeoutlen=100
8142< (time out on mapping after three seconds, time out on key codes after
8143 a tenth of a second).
8144
8145 *'title'* *'notitle'*
8146'title' boolean (default off, on when title can be restored)
8147 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008148 When on, the title of the window will be set to the value of
8149 'titlestring' (if it is not empty), or to:
8150 filename [+=-] (path) - VIM
8151 Where:
8152 filename the name of the file being edited
8153 - indicates the file cannot be modified, 'ma' off
8154 + indicates the file was modified
8155 = indicates the file is read-only
8156 =+ indicates the file is read-only and modified
8157 (path) is the path of the file being edited
8158 - VIM the server name |v:servername| or "VIM"
8159 Only works if the terminal supports setting window titles
8160 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008161 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008162 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8163 *X11*
8164 When Vim was compiled with HAVE_X11 defined, the original title will
8165 be restored if possible. The output of ":version" will include "+X11"
8166 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8167 works for the icon name |'icon'|.
8168 But: When Vim was started with the |-X| argument, restoring the title
8169 will not work (except in the GUI).
8170 If the title cannot be restored, it is set to the value of 'titleold'.
8171 You might want to restore the title outside of Vim then.
8172 When using an xterm from a remote machine you can use this command:
8173 rsh machine_name xterm -display $DISPLAY &
8174 then the WINDOWID environment variable should be inherited and the
8175 title of the window should change back to what it should be after
8176 exiting Vim.
8177
8178 *'titlelen'*
8179'titlelen' number (default 85)
8180 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008181 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008182 title. When the title is longer, only the end of the path name is
8183 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008184 Using a percentage makes this adapt to the width of the window. But
8185 it won't work perfectly, because the actual number of characters
8186 available also depends on the font used and other things in the title
8187 bar. When 'titlelen' is zero the full path is used. Otherwise,
8188 values from 1 to 30000 percent can be used.
8189 'titlelen' is also used for the 'titlestring' option.
8190
8191 *'titleold'*
8192'titleold' string (default "Thanks for flying Vim")
8193 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008194 This option will be used for the window title when exiting Vim if the
8195 original title cannot be restored. Only happens if 'title' is on or
8196 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008197 This option cannot be set from a |modeline| or in the |sandbox|, for
8198 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008199 *'titlestring'*
8200'titlestring' string (default "")
8201 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008202 When this option is not empty, it will be used for the title of the
8203 window. This happens only when the 'title' option is on.
8204 Only works if the terminal supports setting window titles (currently
8205 Amiga console, Win32 console, all GUI versions and terminals with a
8206 non-empty 't_ts' option).
8207 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008208 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008209
Bram Moolenaar071d4272004-06-13 20:20:40 +00008210 When this option contains printf-style '%' items, they will be
8211 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008212 This option cannot be set in a modeline when 'modelineexpr' is off.
8213
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214 Example: >
8215 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8216 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8217< The value of 'titlelen' is used to align items in the middle or right
8218 of the available space.
8219 Some people prefer to have the file name first: >
8220 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8221< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008222 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008223 separating space only when needed.
8224 NOTE: Use of special characters in 'titlestring' may cause the display
8225 to be garbled (e.g., when it contains a CR or NL character).
8226 {not available when compiled without the |+statusline| feature}
8227
8228 *'toolbar'* *'tb'*
8229'toolbar' 'tb' string (default "icons,tooltips")
8230 global
8231 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8232 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008233 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008234 possible values are:
8235 icons Toolbar buttons are shown with icons.
8236 text Toolbar buttons shown with text.
8237 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008238 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008239 tooltips Tooltips are active for toolbar buttons.
8240 Tooltips refer to the popup help text which appears after the mouse
8241 cursor is placed over a toolbar button for a brief moment.
8242
8243 If you want the toolbar to be shown with icons as well as text, do the
8244 following: >
8245 :set tb=icons,text
8246< Motif and Athena cannot display icons and text at the same time. They
8247 will show icons if both are requested.
8248
8249 If none of the strings specified in 'toolbar' are valid or if
8250 'toolbar' is empty, this option is ignored. If you want to disable
8251 the toolbar, you need to set the 'guioptions' option. For example: >
8252 :set guioptions-=T
8253< Also see |gui-toolbar|.
8254
8255 *'toolbariconsize'* *'tbis'*
8256'toolbariconsize' 'tbis' string (default "small")
8257 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008258 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008259 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008260 tiny Use tiny icons.
8261 small Use small icons (default).
8262 medium Use medium-sized icons.
8263 large Use large icons.
8264 huge Use even larger icons.
8265 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008266 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008267 the current theme. Common dimensions are giant=48x48, huge=32x32,
8268 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008269
8270 If 'toolbariconsize' is empty, the global default size as determined
8271 by user preferences or the current theme is used.
8272
8273 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8274'ttybuiltin' 'tbi' boolean (default on)
8275 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008276 When on, the builtin termcaps are searched before the external ones.
8277 When off the builtin termcaps are searched after the external ones.
8278 When this option is changed, you should set the 'term' option next for
8279 the change to take effect, for example: >
8280 :set notbi term=$TERM
8281< See also |termcap|.
8282 Rationale: The default for this option is "on", because the builtin
8283 termcap entries are generally better (many systems contain faulty
8284 xterm entries...).
8285
8286 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8287'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8288 sun-cmd, screen, rxvt, dtterm or
8289 iris-ansi; also on when running Vim in
8290 a DOS console)
8291 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008292 Indicates a fast terminal connection. More characters will be sent to
8293 the screen for redrawing, instead of using insert/delete line
8294 commands. Improves smoothness of redrawing when there are multiple
8295 windows and the terminal does not support a scrolling region.
8296 Also enables the extra writing of characters at the end of each screen
8297 line for lines that wrap. This helps when using copy/paste with the
8298 mouse in an xterm and other terminals.
8299
8300 *'ttymouse'* *'ttym'*
8301'ttymouse' 'ttym' string (default depends on 'term')
8302 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008303 {only in Unix and VMS, doesn't work in the GUI; not
8304 available when compiled without |+mouse|}
8305 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008306 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307 *xterm-mouse*
8308 xterm xterm-like mouse handling. The mouse generates
8309 "<Esc>[Mscr", where "scr" is three bytes:
8310 "s" = button state
8311 "c" = column plus 33
8312 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008313 This only works up to 223 columns! See "dec",
8314 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008315 xterm2 Works like "xterm", but with the xterm reporting the
8316 mouse position while the mouse is dragged. This works
8317 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008318 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 work. See below for how Vim detects this
8320 automatically.
8321 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008322 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008323 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008324 for the row and column. No other mouse events are
8325 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008326 *dec-mouse*
8327 dec DEC terminal mouse handling. The mouse generates a
8328 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008329 This is also available for an Xterm, if it was
8330 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008331 *jsbterm-mouse*
8332 jsbterm JSB term mouse handling.
8333 *pterm-mouse*
8334 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008335 *urxvt-mouse*
8336 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008337 The mouse works only if the terminal supports this
8338 encoding style, but it does not have 223 columns limit
8339 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008340 *sgr-mouse*
8341 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008342 mouse reporting. The mouse works even in columns
8343 beyond 223. This option is backward compatible with
8344 "xterm2" because it can also decode "xterm2" style
8345 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008346
8347 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008348 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8349 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008350 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8351 recognized, if enabled at compile time. DEC terminal mouse codes
8352 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008353 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8354 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008355 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008356 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8357 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8358 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008359 Additionally, if vim is compiled with the |+termresponse| feature and
8360 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008361 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008363 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8364 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8365 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008366 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8367 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368 :set t_RV=
8369<
8370 *'ttyscroll'* *'tsl'*
8371'ttyscroll' 'tsl' number (default 999)
8372 global
8373 Maximum number of lines to scroll the screen. If there are more lines
8374 to scroll the window is redrawn. For terminals where scrolling is
8375 very slow and redrawing is not slow this can be set to a small number,
8376 e.g., 3, to speed up displaying.
8377
8378 *'ttytype'* *'tty'*
8379'ttytype' 'tty' string (default from $TERM)
8380 global
8381 Alias for 'term', see above.
8382
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008383 *'undodir'* *'udir'*
8384'undodir' 'udir' string (default ".")
8385 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008386 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008387 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008388 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008389 "." means using the directory of the file. The undo file name for
8390 "file.txt" is ".file.txt.un~".
8391 For other directories the file name is the full path of the edited
8392 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008393 When writing: The first directory that exists is used. "." always
8394 works, no directories after "." will be used for writing.
8395 When reading all entries are tried to find an undo file. The first
8396 undo file that exists is used. When it cannot be read an error is
8397 given, no further entry is used.
8398 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008399 This option cannot be set from a |modeline| or in the |sandbox|, for
8400 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008401
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008402 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008403'undofile' 'udf' boolean (default off)
8404 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008405 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008406 When on, Vim automatically saves undo history to an undo file when
8407 writing a buffer to a file, and restores undo history from the same
8408 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008409 The directory where the undo file is stored is specified by 'undodir'.
8410 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008411 The undo file is not read when 'undoreload' causes the buffer from
8412 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008413 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008414 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008415
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008417'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008418 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008419 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008420 is kept in memory, higher numbers will cause more memory to be used.
8421 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8423 itself: >
8424 set ul=0
8425< But you can also get Vi compatibility by including the 'u' flag in
8426 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008427 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008428 Set to -1 for no undo at all. You might want to do this only for the
8429 current buffer: >
8430 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008431< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008432
8433 The local value is set to -123456 when the global value is to be used.
8434
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008435 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008436
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008437 *'undoreload'* *'ur'*
8438'undoreload' 'ur' number (default 10000)
8439 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008440 Save the whole buffer for undo when reloading it. This applies to the
8441 ":e!" command and reloading for when the buffer changed outside of
8442 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008443 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008444 of lines is smaller than the value of this option.
8445 Set this option to zero to disable undo for a reload.
8446
8447 When saving undo for a reload, any undo file is not read.
8448
8449 Note that this causes the whole buffer to be stored in memory. Set
8450 this option to a lower value if you run out of memory.
8451
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452 *'updatecount'* *'uc'*
8453'updatecount' 'uc' number (default: 200)
8454 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008455 After typing this many characters the swap file will be written to
8456 disk. When zero, no swap file will be created at all (see chapter on
8457 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8458 Vim with the "-n" option, see |startup|. When editing in readonly
8459 mode this option will be initialized to 10000.
8460 The swapfile can be disabled per buffer with |'swapfile'|.
8461 When 'updatecount' is set from zero to non-zero, swap files are
8462 created for all buffers that have 'swapfile' set. When 'updatecount'
8463 is set to zero, existing swap files are not deleted.
8464 Also see |'swapsync'|.
8465 This option has no meaning in buffers where |'buftype'| is "nofile"
8466 or "nowrite".
8467
8468 *'updatetime'* *'ut'*
8469'updatetime' 'ut' number (default 4000)
8470 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471 If this many milliseconds nothing is typed the swap file will be
8472 written to disk (see |crash-recovery|). Also used for the
8473 |CursorHold| autocommand event.
8474
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008475 *'varsofttabstop'* *'vsts'*
8476'varsofttabstop' 'vsts' string (default "")
8477 local to buffer
8478 {only available when compiled with the |+vartabs|
8479 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008480 A list of the number of spaces that a <Tab> counts for while editing,
8481 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8482 width <Tab>s are being inserted, while in fact a mixture of spaces
8483 and <Tab>s is used. Tab widths are separated with commas, with the
8484 final value applying to all subsequent tabs.
8485
8486 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008487 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008488 to use the following: >
8489 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008490< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8491 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008492
8493 Note that the value of |'softtabstop'| will be ignored while
8494 'varsofttabstop' is set.
8495
8496 *'vartabstop'* *'vts'*
8497'vartabstop' 'vts' string (default "")
8498 local to buffer
8499 {only available when compiled with the |+vartabs|
8500 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008501 A list of the number of spaces that a <Tab> in the file counts for,
8502 separated by commas. Each value corresponds to one tab, with the
8503 final value applying to all subsequent tabs. For example: >
8504 :set vartabstop=4,20,10,8
8505< This will make the first tab 4 spaces wide, the second 20 spaces,
8506 the third 10 spaces, and all following tabs 8 spaces.
8507
8508 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8509 is set.
8510
Bram Moolenaar071d4272004-06-13 20:20:40 +00008511 *'verbose'* *'vbs'*
8512'verbose' 'vbs' number (default 0)
8513 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008514 When bigger than zero, Vim will give messages about what it is doing.
8515 Currently, these messages are given:
8516 >= 1 When the viminfo file is read or written.
8517 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008518 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008519 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008520 >= 8 Files for which a group of autocommands is executed.
8521 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008522 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008523 >= 12 Every executed function.
8524 >= 13 When an exception is thrown, caught, finished, or discarded.
8525 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008526 >= 15 Every executed Ex command from a script (truncated at 200
8527 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008528 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529
8530 This option can also be set with the "-V" argument. See |-V|.
8531 This option is also set by the |:verbose| command.
8532
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008533 When the 'verbosefile' option is set then the verbose messages are not
8534 displayed.
8535
8536 *'verbosefile'* *'vfile'*
8537'verbosefile' 'vfile' string (default empty)
8538 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008539 When not empty all messages are written in a file with this name.
8540 When the file exists messages are appended.
8541 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008542 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008543 Setting 'verbosefile' to a new value is like making it empty first.
8544 The difference with |:redir| is that verbose messages are not
8545 displayed when 'verbosefile' is set.
8546
Bram Moolenaar071d4272004-06-13 20:20:40 +00008547 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008548'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008549 "$VIM/vimfiles/view",
8550 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008551 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008552 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008553 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008554 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008555 feature}
8556 Name of the directory where to store files for |:mkview|.
8557 This option cannot be set from a |modeline| or in the |sandbox|, for
8558 security reasons.
8559
8560 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008561'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008562 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008563 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008564 feature}
8565 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008566 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008567 word save and restore ~
8568 cursor cursor position in file and in window
8569 folds manually created folds, opened/closed folds and local
8570 fold options
8571 options options and mappings local to a window or buffer (not
8572 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008573 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008574 slash backslashes in file names replaced with forward
8575 slashes
8576 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008577 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008578 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008580 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008581 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008582 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008583
8584 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008585'viminfo' 'vi' string (Vi default: "", Vim default for
8586 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008587 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8588 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008590 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008591 feature}
8592 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008593 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8594 "NONE".
8595 The string should be a comma separated list of parameters, each
8596 consisting of a single character identifying the particular parameter,
8597 followed by a number or string which specifies the value of that
8598 parameter. If a particular character is left out, then the default
8599 value is used for that parameter. The following is a list of the
8600 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008602 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008603 ! When included, save and restore global variables that start
8604 with an uppercase letter, and don't contain a lowercase
8605 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008606 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008607 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008608 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008609 " Maximum number of lines saved for each register. Old name of
8610 the '<' item, with the disadvantage that you need to put a
8611 backslash before the ", otherwise it will be recognized as the
8612 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008613 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008614 % When included, save and restore the buffer list. If Vim is
8615 started with a file name argument, the buffer list is not
8616 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008617 buffer list is restored from the viminfo file. Quickfix
8618 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8619 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008620 When followed by a number, the number specifies the maximum
8621 number of buffers that are stored. Without a number all
8622 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008623 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008624 ' Maximum number of previously edited files for which the marks
8625 are remembered. This parameter must always be included when
8626 'viminfo' is non-empty.
8627 Including this item also means that the |jumplist| and the
8628 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008629 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008630 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008631 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008632 patterns are also saved. When not included, the value of
8633 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008634 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008635 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008636 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008637 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008638 < Maximum number of lines saved for each register. If zero then
8639 registers are not saved. When not included, all lines are
8640 saved. '"' is the old name for this item.
8641 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008642 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008643 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008644 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008645 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008646 c When included, convert the text in the viminfo file from the
8647 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008648 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008649 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008650 f Whether file marks need to be stored. If zero, file marks ('0
8651 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008652 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008654 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008655 h Disable the effect of 'hlsearch' when loading the viminfo
8656 file. When not included, it depends on whether ":nohlsearch"
8657 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008658 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008659 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008660 the 'n'. Must be at the end of the option! If the
8661 'viminfofile' option is set, that file name overrides the one
8662 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008663 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008664 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008665 r Removable media. The argument is a string (up to the next
8666 ','). This parameter can be given several times. Each
8667 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008668 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008669 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8670 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8671 ignored. Maximum length of each 'r' argument is 50
8672 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008673 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008674 s Maximum size of an item in Kbyte. If zero then registers are
8675 not saved. Currently only applies to registers. The default
8676 "s10" will exclude registers with more than 10 Kbyte of text.
8677 Also see the '<' item above: line count limit.
8678
8679 Example: >
8680 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8681<
8682 '50 Marks will be remembered for the last 50 files you
8683 edited.
8684 <1000 Contents of registers (up to 1000 lines each) will be
8685 remembered.
8686 s100 Registers with more than 100 Kbyte text are skipped.
8687 :0 Command-line history will not be saved.
8688 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8689 no / Since '/' is not specified, the default will be used,
8690 that is, save all of the search history, and also the
8691 previous search and substitute patterns.
8692 no % The buffer list will not be saved nor read back.
8693 no h 'hlsearch' highlighting will be restored.
8694
8695 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8696 load the contents of the file, this is not done automatically.
8697
8698 This option cannot be set from a |modeline| or in the |sandbox|, for
8699 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008700 NOTE: This option is set to the Vim default value when 'compatible'
8701 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008702
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008703 *'viminfofile'* *'vif'*
8704'viminfofile' 'vif' string (default: "")
8705 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008706 {not available when compiled without the |+viminfo|
8707 feature}
8708 When non-empty, overrides the file name used for viminfo.
8709 When equal to "NONE" no viminfo file will be read or written.
8710 This option can be set with the |-i| command line flag. The |--clean|
8711 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008712 This option cannot be set from a |modeline| or in the |sandbox|, for
8713 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008714
Bram Moolenaar071d4272004-06-13 20:20:40 +00008715 *'virtualedit'* *'ve'*
8716'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008717 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008718 A comma separated list of these words:
8719 block Allow virtual editing in Visual block mode.
8720 insert Allow virtual editing in Insert mode.
8721 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008722 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008723 none When used as the local value, do not allow virtual
8724 editing even when the global value is set. When used
8725 as the global value, "none" is the same as "".
8726 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008727
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008729 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008730 of the line. Useful for selecting a rectangle in Visual mode and
8731 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008732 "onemore" is not the same, it will only allow moving the cursor just
8733 after the last character of the line. This makes some commands more
8734 consistent. Previously the cursor was always past the end of the line
8735 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008736 break some plugins or Vim scripts. For example because |l| can move
8737 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008738 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008739 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008740 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008741 It doesn't make sense to combine "all" with "onemore", but you will
8742 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008743 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008744 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745
8746 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8747'visualbell' 'vb' boolean (default off)
8748 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008749 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008750 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008751 use: >
8752 :set vb t_vb=
8753< If you want a short flash, you can use this on many terminals: >
8754 :set vb t_vb=[?5h$<100>[?5l
8755< Here $<100> specifies the time, you can use a smaller or bigger value
8756 to get a shorter or longer flash.
8757
8758 Note: Vim will limit the bell to once per half a second. This avoids
8759 having to wait for the flashing to finish when there are lots of
8760 bells, e.g. on key repeat. This also happens without 'visualbell'
8761 set.
8762
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8764 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8765 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008766
8767 Note: When the GUI starts, 't_vb' is reset to its default value. You
8768 might want to set it again in your |gvimrc|.
8769
Bram Moolenaar071d4272004-06-13 20:20:40 +00008770 Does not work on the Amiga, you always get a screen flash.
8771 Also see 'errorbells'.
8772
8773 *'warn'* *'nowarn'*
8774'warn' boolean (default on)
8775 global
8776 Give a warning message when a shell command is used while the buffer
8777 has been changed.
8778
8779 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8780'weirdinvert' 'wiv' boolean (default off)
8781 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008782 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008783 It is provided for backwards compatibility with version 4.x.
8784 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8785 vice versa. Has no effect when the GUI is running.
8786
8787 *'whichwrap'* *'ww'*
8788'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8789 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008790 Allow specified keys that move the cursor left/right to move to the
8791 previous/next line when the cursor is on the first/last character in
8792 the line. Concatenate characters to allow this for these keys:
8793 char key mode ~
8794 b <BS> Normal and Visual
8795 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008796 h "h" Normal and Visual (not recommended)
8797 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798 < <Left> Normal and Visual
8799 > <Right> Normal and Visual
8800 ~ "~" Normal
8801 [ <Left> Insert and Replace
8802 ] <Right> Insert and Replace
8803 For example: >
8804 :set ww=<,>,[,]
8805< allows wrap only when cursor keys are used.
8806 When the movement keys are used in combination with a delete or change
8807 operator, the <EOL> also counts for a character. This makes "3h"
8808 different from "3dh" when the cursor crosses the end of a line. This
8809 is also true for "x" and "X", because they do the same as "dl" and
8810 "dh". If you use this, you may also want to use the mapping
8811 ":map <BS> X" to make backspace delete the character in front of the
8812 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008813 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008814 line (not an empty line) then it will not move to the next line. This
8815 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008816 NOTE: This option is set to the Vi default value when 'compatible' is
8817 set and to the Vim default value when 'compatible' is reset.
8818
8819 *'wildchar'* *'wc'*
8820'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8821 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008822 Character you have to type to start wildcard expansion in the
8823 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008824 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008825 The character is not recognized when used inside a macro. See
8826 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008827 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008828 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008829 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008830< NOTE: This option is set to the Vi default value when 'compatible' is
8831 set and to the Vim default value when 'compatible' is reset.
8832
8833 *'wildcharm'* *'wcm'*
8834'wildcharm' 'wcm' number (default: none (0))
8835 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008836 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008837 recognized when used inside a macro. You can find "spare" command-line
8838 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008839 you'll never actually type 'wildcharm', just use it in mappings that
8840 automatically invoke completion mode, e.g.: >
8841 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008842 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008843< Then after typing :ss you can use CTRL-P & CTRL-N.
8844
8845 *'wildignore'* *'wig'*
8846'wildignore' 'wig' string (default "")
8847 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008848 {not available when compiled without the |+wildignore|
8849 feature}
8850 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008851 patterns is ignored when expanding |wildcards|, completing file or
8852 directory names, and influences the result of |expand()|, |glob()| and
8853 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8855 Also see 'suffixes'.
8856 Example: >
8857 :set wildignore=*.o,*.obj
8858< The use of |:set+=| and |:set-=| is preferred when adding or removing
8859 a pattern from the list. This avoids problems when a future version
8860 uses another default.
8861
Bram Moolenaar94950a92010-12-02 16:01:29 +01008862
Bram Moolenaar81af9252010-12-10 20:35:50 +01008863 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008864'wildignorecase' 'wic' boolean (default off)
8865 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008866 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008867 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008868 Does not apply when the shell is used to expand wildcards, which
8869 happens when there are special characters.
8870
8871
Bram Moolenaar071d4272004-06-13 20:20:40 +00008872 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008873'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008875 {not available if compiled without the |+wildmenu|
8876 feature}
8877 When 'wildmenu' is on, command-line completion operates in an enhanced
8878 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8879 the possible matches are shown just above the command line, with the
8880 first match highlighted (overwriting the status line, if there is
8881 one). Keys that show the previous/next match, such as <Tab> or
8882 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8883 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8884 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008885 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886 If there are more matches than can fit in the line, a ">" is shown on
8887 the right and/or a "<" is shown on the left. The status line scrolls
8888 as needed.
8889 The "wildmenu" mode is abandoned when a key is hit that is not used
8890 for selecting a completion.
8891 While the "wildmenu" is active the following keys have special
8892 meanings:
8893
8894 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8895 <Down> - in filename/menu name completion: move into a
8896 subdirectory or submenu.
8897 <CR> - in menu completion, when the cursor is just after a
8898 dot: move into a submenu.
8899 <Up> - in filename/menu name completion: move up into
8900 parent directory or parent menu.
8901
8902 This makes the menus accessible from the console |console-menus|.
8903
8904 If you prefer the <Left> and <Right> keys to move the cursor instead
8905 of selecting a different match, use this: >
8906 :cnoremap <Left> <Space><BS><Left>
8907 :cnoremap <Right> <Space><BS><Right>
8908<
8909 The "WildMenu" highlighting is used for displaying the current match
8910 |hl-WildMenu|.
8911
8912 *'wildmode'* *'wim'*
8913'wildmode' 'wim' string (Vim default: "full")
8914 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008915 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008916 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008917 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008918 first part specifies the behavior for the first use of 'wildchar',
8919 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008920
8921 Each part consists of a colon separated list consisting of the
8922 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008923 "" Complete only the first match.
8924 "full" Complete the next full match. After the last match,
8925 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008926 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008927 "longest" Complete till longest common string. If this doesn't
8928 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008929 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008930 "lastused" When completing buffer names and more than one buffer
8931 matches, sort buffers by time last used (other than
8932 the current buffer).
8933 When there is only a single match, it is fully completed in all cases.
8934
8935 Examples of useful colon-separated values:
8936 "longest:full" Like "longest", but also start 'wildmenu' if it is
8937 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008938 "list:full" When more than one match, list all matches and
8939 complete first match.
8940 "list:longest" When more than one match, list all matches and
8941 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008942 "list:lastused" When more than one buffer matches, list all matches
8943 and sort buffers by time last used (other than the
8944 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008945
8946 Examples: >
8947 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008948< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008949 :set wildmode=longest,full
8950< Complete longest common string, then each full match >
8951 :set wildmode=list:full
8952< List all matches and complete each full match >
8953 :set wildmode=list,full
8954< List all matches without completing, then each full match >
8955 :set wildmode=longest,list
8956< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008957 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008958
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008959 *'wildoptions'* *'wop'*
8960'wildoptions' 'wop' string (default "")
8961 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008962 {not available when compiled without the |+wildignore|
8963 feature}
8964 A list of words that change how command line completion is done.
8965 Currently only one word is allowed:
8966 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008967 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008968 is displayed per line. Often used tag kinds are:
8969 d #define
8970 f function
8971 Also see |cmdline-completion|.
8972
Bram Moolenaar071d4272004-06-13 20:20:40 +00008973 *'winaltkeys'* *'wak'*
8974'winaltkeys' 'wak' string (default "menu")
8975 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008976 {only used in Win32, Motif, GTK and Photon GUI}
8977 Some GUI versions allow the access to menu entries by using the ALT
8978 key in combination with a character that appears underlined in the
8979 menu. This conflicts with the use of the ALT key for mappings and
8980 entering special characters. This option tells what to do:
8981 no Don't use ALT keys for menus. ALT key combinations can be
8982 mapped, but there is no automatic handling. This can then be
8983 done with the |:simalt| command.
8984 yes ALT key handling is done by the windowing system. ALT key
8985 combinations cannot be mapped.
8986 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008987 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008988 keys can be mapped.
8989 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8990 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008991 This option is not used for <F10>; on Win32 and with GTK <F10> will
8992 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008993
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008994 *'wincolor'* *'wcr'*
8995'wincolor' 'wcr' string (default empty)
8996 local to window
8997 Highlight group name to use for this window instead of the Normal
8998 color |hl-Normal|.
8999
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009000 *'window'* *'wi'*
9001'window' 'wi' number (default screen height - 1)
9002 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009003 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9004 window and the value is smaller than 'lines' minus one. The screen
9005 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009006 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9007 in a much smarter way, taking care of wrapping lines.
9008 When resizing the Vim window, the value is smaller than 1 or more than
9009 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009010 Note: Do not confuse this with the height of the Vim window, use
9011 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009012
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013 *'winheight'* *'wh'* *E591*
9014'winheight' 'wh' number (default 1)
9015 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009017 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009018 focus goes to a window that is smaller, its size is increased, at the
9019 cost of the height of other windows.
9020 Set 'winheight' to a small number for normal editing.
9021 Set it to 999 to make the current window fill most of the screen.
9022 Other windows will be only 'winminheight' high. This has the drawback
9023 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9024 to create only two windows, set the option after startup is done,
9025 using the |VimEnter| event: >
9026 au VimEnter * set winheight=999
9027< Minimum value is 1.
9028 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009029 height of the current window.
9030 'winheight' applies to the current window. Use 'winminheight' to set
9031 the minimal height for other windows.
9032
9033 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9034'winfixheight' 'wfh' boolean (default off)
9035 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009036 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009037 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9038 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009039 The height may be changed anyway when running out of room.
9040
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009041 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9042'winfixwidth' 'wfw' boolean (default off)
9043 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009044 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009045 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009046 The width may be changed anyway when running out of room.
9047
Bram Moolenaar071d4272004-06-13 20:20:40 +00009048 *'winminheight'* *'wmh'*
9049'winminheight' 'wmh' number (default 1)
9050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009051 The minimal height of a window, when it's not the current window.
9052 This is a hard minimum, windows will never become smaller.
9053 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9054 status bar) if necessary. They will return to at least one line when
9055 they become active (since the cursor has to have somewhere to go.)
9056 Use 'winheight' to set the minimal height of the current window.
9057 This option is only checked when making a window smaller. Don't use a
9058 large number, it will cause errors when opening more than a few
9059 windows. A value of 0 to 3 is reasonable.
9060
9061 *'winminwidth'* *'wmw'*
9062'winminwidth' 'wmw' number (default 1)
9063 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009064 The minimal width of a window, when it's not the current window.
9065 This is a hard minimum, windows will never become smaller.
9066 When set to zero, windows may be "squashed" to zero columns (i.e. just
9067 a vertical separator) if necessary. They will return to at least one
9068 line when they become active (since the cursor has to have somewhere
9069 to go.)
9070 Use 'winwidth' to set the minimal width of the current window.
9071 This option is only checked when making a window smaller. Don't use a
9072 large number, it will cause errors when opening more than a few
9073 windows. A value of 0 to 12 is reasonable.
9074
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009075 *'winptydll'*
9076'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9077 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009078 {only available when compiled with the |terminal|
9079 feature on MS-Windows}
9080 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009081 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009082 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009083 a fallback.
9084 Environment variables are expanded |:set_env|.
9085 This option cannot be set from a |modeline| or in the |sandbox|, for
9086 security reasons.
9087
Bram Moolenaar071d4272004-06-13 20:20:40 +00009088 *'winwidth'* *'wiw'* *E592*
9089'winwidth' 'wiw' number (default 20)
9090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009091 Minimal number of columns for the current window. This is not a hard
9092 minimum, Vim will use fewer columns if there is not enough room. If
9093 the current window is smaller, its size is increased, at the cost of
9094 the width of other windows. Set it to 999 to make the current window
9095 always fill the screen. Set it to a small number for normal editing.
9096 The width is not adjusted after one of the commands to change the
9097 width of the current window.
9098 'winwidth' applies to the current window. Use 'winminwidth' to set
9099 the minimal width for other windows.
9100
9101 *'wrap'* *'nowrap'*
9102'wrap' boolean (default on)
9103 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009104 This option changes how text is displayed. It doesn't change the text
9105 in the buffer, see 'textwidth' for that.
9106 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009107 displaying continues on the next line. When off lines will not wrap
9108 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009109 moved to a part that is not shown, the screen will scroll
9110 horizontally.
9111 The line will be broken in the middle of a word if necessary. See
9112 'linebreak' to get the break at a word boundary.
9113 To make scrolling horizontally a bit more useful, try this: >
9114 :set sidescroll=5
9115 :set listchars+=precedes:<,extends:>
9116< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009117 This option can't be set from a |modeline| when the 'diff' option is
9118 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009119
9120 *'wrapmargin'* *'wm'*
9121'wrapmargin' 'wm' number (default 0)
9122 local to buffer
9123 Number of characters from the right window border where wrapping
9124 starts. When typing text beyond this limit, an <EOL> will be inserted
9125 and inserting continues on the next line.
9126 Options that add a margin, such as 'number' and 'foldcolumn', cause
9127 the text width to be further reduced. This is Vi compatible.
9128 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009129 This option is set to 0 when 'paste' is set and restored when 'paste'
9130 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009131 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009132
9133 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9134'wrapscan' 'ws' boolean (default on) *E384* *E385*
9135 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009136 Searches wrap around the end of the file. Also applies to |]s| and
9137 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009138
9139 *'write'* *'nowrite'*
9140'write' boolean (default on)
9141 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009142 Allows writing files. When not set, writing a file is not allowed.
9143 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009144 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009145 argument. Filtering text is still possible, even though this requires
9146 writing a temporary file.
9147
9148 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9149'writeany' 'wa' boolean (default off)
9150 global
9151 Allows writing to any file with no need for "!" override.
9152
9153 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9154'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9155 otherwise)
9156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009157 Make a backup before overwriting a file. The backup is removed after
9158 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009159 also on.
9160 WARNING: Switching this option off means that when Vim fails to write
9161 your buffer correctly and then, for whatever reason, Vim exits, you
9162 lose both the original file and what you were writing. Only reset
9163 this option if your file system is almost full and it makes the write
9164 fail (and make sure not to exit Vim until the write was successful).
9165 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009166 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009167 Depending on 'backupcopy' the backup is a new file or the original
9168 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009169 NOTE: This option is set to the default value when 'compatible' is
9170 set.
9171
9172 *'writedelay'* *'wd'*
9173'writedelay' 'wd' number (default 0)
9174 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009175 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009176 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009177 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009178
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009179 vim:tw=78:ts=8:noet:ft=help:norl: