blob: 6653807866062fce69996f8101235717890883a3 [file] [log] [blame]
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001*options.txt* For Vim version 9.0. Last change: 2023 Jun 02
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...
Bram Moolenaarf1dcd142022-12-31 15:30:45 +000037 The options have the form t_AB, see
38 |terminal-options|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000039
Bram Moolenaar47003982021-12-05 21:54:04 +000040:se[t]! termcap Idem, but don't use multiple columns.
41
Bram Moolenaar071d4272004-06-13 20:20:40 +000042 *E518* *E519*
43:se[t] {option}? Show value of {option}.
44
45:se[t] {option} Toggle option: set, switch it on.
46 Number option: show value.
47 String option: show value.
48
49:se[t] no{option} Toggle option: Reset, switch it off.
50
Bram Moolenaar00a927d2010-05-14 23:24:24 +020051 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000052:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000054
55 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
56:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020057 current value of 'compatible'.
58:se[t] {option}&vi Reset option to its Vi default value.
59:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000060
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010061:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020062 these options are not changed:
63 all terminal options, starting with t_
64 'columns'
65 'cryptmethod'
66 'encoding'
67 'key'
68 'lines'
69 'term'
70 'ttymouse'
71 'ttytype'
72 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000073
74 *:set-args* *E487* *E521*
75:se[t] {option}={value} or
76:se[t] {option}:{value}
77 Set string or number option to {value}.
78 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010079 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000080 The old value can be inserted by typing 'wildchar' (by
81 default this is a <Tab> or CTRL-E if 'compatible' is
82 set). See |cmdline-completion|.
83 White space between {option} and '=' is allowed and
84 will be ignored. White space between '=' and {value}
85 is not allowed.
86 See |option-backslash| for using white space and
87 backslashes in {value}.
88
89:se[t] {option}+={value} *:set+=*
90 Add the {value} to a number option, or append the
91 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010092 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000093 value was empty.
94 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000095 are removed. When adding a flag that was already
96 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000097 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000098
99:se[t] {option}^={value} *:set^=*
100 Multiply the {value} to a number option, or prepend
101 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100102 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103 value was empty.
104 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105
106:se[t] {option}-={value} *:set-=*
107 Subtract the {value} from a number option, or remove
108 the {value} from a string option, if it is there.
109 If the {value} is not found in a string option, there
110 is no error or warning. When the option is a comma
111 separated list, a comma is deleted, unless the option
112 becomes empty.
113 When the option is a list of flags, {value} must be
114 exactly as they appear in the option. Remove flags
115 one by one to avoid problems.
116 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000117
118The {option} arguments to ":set" may be repeated. For example: >
119 :set ai nosi sw=3 ts=3
120If you make an error in one of the arguments, an error message will be given
121and the following arguments will be ignored.
122
123 *:set-verbose*
124When 'verbose' is non-zero, displaying an option value will also tell where it
125was last set. Example: >
126 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200127< shiftwidth=4 ~
128 Last set from modeline line 1 ~
129 cindent ~
130 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000131This is only done when specific option values are requested, not for ":verbose
132set all" or ":verbose set" without an argument.
133When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134When the option was set while executing a function, user command or
135autocommand, the script in which it was defined is reported.
136Note that an option may also have been set as a side effect of setting
137'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000138A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200139 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000140 Option was set in a |modeline|.
141 Last set from --cmd argument ~
142 Option was set with command line argument |--cmd| or +.
143 Last set from -c argument ~
144 Option was set with command line argument |-c|, +, |-S| or
145 |-q|.
146 Last set from environment variable ~
147 Option was set from an environment variable, $VIMINIT,
148 $GVIMINIT or $EXINIT.
149 Last set from error handler ~
150 Option was cleared when evaluating it resulted in an error.
151
Bram Moolenaardb84e452010-08-15 13:50:43 +0200152{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000153
154 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000155For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156override the value from the termcap. You can then use it in a mapping. If
157the "xx" part contains special characters, use the <t_xx> form: >
158 :set <t_#4>=^[Ot
159This can also be used to translate a special code for a normal key. For
160example, if Alt-b produces <Esc>b, use this: >
161 :set <M-b>=^[b
162(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
163The advantage over a mapping is that it works in all situations.
164
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100165You can define any key codes, e.g.: >
166 :set t_xy=^[foo;
167There is no warning for using a name that isn't recognized. You can map these
168codes as you like: >
169 :map <t_xy> something
170< *E846*
171When a key code is not set, it's like it does not exist. Trying to get its
172value will result in an error: >
173 :set t_kb=
174 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000175< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100176
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000177The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
178security reasons.
179
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000181at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182"set all" probably does not fit on the screen, causing Vim to give the
183|more-prompt|.
184
185 *option-backslash*
186To include white space in a string option value it has to be preceded with a
187backslash. To include a backslash you have to use two. Effectively this
188means that the number of backslashes in an option value is halved (rounded
189down).
190A few examples: >
191 :set tags=tags\ /usr/tags results in "tags /usr/tags"
192 :set tags=tags\\,file results in "tags\,file"
193 :set tags=tags\\\ file results in "tags\ file"
194
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000195The "|" character separates a ":set" command from a following command. To
196include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000197'titlestring' option to "hi|there": >
198 :set titlestring=hi\|there
199This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
200 :set titlestring=hi|set iconstring=there
201
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200202Similarly, in legacy script the double quote character starts a comment. To
203include the '"' in the option value, use '\"' instead. This example sets the
204'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000205 :set titlestring=hi\ \"there\"
206
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200207In |Vim9| script it's simpler, comments start with a '#' character, and only
208when preceded by white space. A backslash is needed less often: >
209 vim9script
210 set titlestring=hi\ "there"
211 set titlestring=hi#there#
212 set titlestring=hi\ \#there#
213
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100214For Win32 backslashes in file names are mostly not removed. More precise: For
215options that expect a file name (those where environment variables are
216expanded) a backslash before a normal file name character is not removed. But
217a backslash before a special character (space, backslash, comma, etc.) is used
218like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000219There is one special situation, when the value starts with "\\": >
220 :set dir=\\machine\path results in "\\machine\path"
221 :set dir=\\\\machine\\path results in "\\machine\path"
222 :set dir=\\path\\file results in "\\path\file" (wrong!)
223For the first one the start is kept, but for the second one the backslashes
224are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226result which is probably not what you want. Avoid it.
227
228 *add-option-flags* *remove-option-flags*
229 *E539* *E550* *E551* *E552*
230Some options are a list of flags. When you want to add a flag to such an
231option, without changing the existing ones, you can do it like this: >
232 :set guioptions+=a
233Remove a flag from an option like this: >
234 :set guioptions-=a
235This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000236Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000237the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
238doesn't appear.
239
240 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000241Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242environment variable exists the '$' and the following environment variable
243name is replaced with its value. If it does not exist the '$' and the name
244are not modified. Any non-id character (not a letter, digit or '_') may
245follow the environment variable name. That character and what follows is
246appended to the value of the environment variable. Examples: >
247 :set term=$TERM.new
248 :set path=/usr/$INCLUDE,$HOME/include,.
249When adding or removing a string from an option with ":set opt-=val" or ":set
250opt+=val" the expansion is done before the adding or removing.
251
252
253Handling of local options *local-options*
254
255Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100256has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257allows you to set 'list' in one window but not in another. And set
258'shiftwidth' to 3 in one buffer and 4 in another.
259
260The following explains what happens to these local options in specific
261situations. You don't really need to know all of this, since Vim mostly uses
262the option values you would expect. Unfortunately, doing what the user
263expects is a bit complicated...
264
265When splitting a window, the local options are copied to the new window. Thus
266right after the split the contents of the two windows look the same.
267
268When editing a new buffer, its local option values must be initialized. Since
269the local options of the current buffer might be specifically for that buffer,
270these are not used. Instead, for each buffer-local option there also is a
271global value, which is used for new buffers. With ":set" both the local and
272global value is changed. With "setlocal" only the local value is changed,
273thus this value is not used when editing a new buffer.
274
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200275When editing a buffer that has been edited before, the options from the window
276that was last closed are used again. If this buffer has been edited in this
277window, the values from back then are used. Otherwise the values from the
278last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279
280It's possible to set a local window option specifically for a type of buffer.
281When you edit another buffer in the same window, you don't want to keep
282using these local window options. Therefore Vim keeps a global value of the
283local window options, which is used when editing another buffer. Each window
284has its own copy of these values. Thus these are local to the window, but
285global to all buffers in the window. With this you can do: >
286 :e one
287 :set list
288 :e two
289Now the 'list' option will also be set in "two", since with the ":set list"
290command you have also set the global value. >
291 :set nolist
292 :e one
293 :setlocal list
294 :e two
295Now the 'list' option is not set, because ":set nolist" resets the global
296value, ":setlocal list" only changes the local value and ":e two" gets the
297global value. Note that if you do this next: >
298 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200299You will get back the 'list' value as it was the last time you edited "one".
300The options local to a window are remembered for each buffer. This also
301happens when the buffer is not loaded, but they are lost when the buffer is
302wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303
304 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100305:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306 current buffer or window. Not all options have a
307 local value. If the option does not have a local
308 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200309 With the "all" argument: display local values for all
310 local options.
311 Without argument: Display local values for all local
312 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000313 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000314 local value. For a global/local boolean option, when
315 the global value is being used, "--" is displayed
316 before the option name.
317 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000318 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000320:setl[ocal] {option}< Set the local value of {option} to its global value by
321 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000322
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100323:se[t] {option}< For |global-local| options: Remove the local value of
324 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000325
326 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100327:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328 option without changing the local value.
329 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200330 With the "all" argument: display global values for all
331 local options.
332 Without argument: display global values for all local
333 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000334
335For buffer-local and window-local options:
336 Command global value local value ~
337 :set option=value set set
338 :setlocal option=value - set
339:setglobal option=value set -
340 :set option? - display
341 :setlocal option? - display
342:setglobal option? display -
343
344
345Global options with a local value *global-local*
346
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000347Options are global when you mostly use one value for all buffers and windows.
348For some global options it's useful to sometimes have a different local value.
349You can set the local value with ":setlocal". That buffer or window will then
350use the local value, while other buffers and windows continue using the global
351value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000352
353For example, you have two windows, both on C source code. They use the global
354'makeprg' option. If you do this in one of the two windows: >
355 :set makeprg=gmake
356then the other window will switch to the same value. There is no need to set
357the 'makeprg' option in the other C source window too.
358However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000359another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000360files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000361 :setlocal makeprg=perlmake
362You can switch back to using the global value by making the local value empty: >
363 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100364This only works for a string option. For a number or boolean option you need
365to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100367Note that for non-boolean and non-number options using "<" copies the global
368value to the local value, it doesn't switch back to using the global value
369(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000370 :set path<
371This will make the local value of 'path' empty, so that the global value is
372used. Thus it does the same as: >
373 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000374Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000375":setlocal" on a global option might work differently then.
376
377
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000378 *option-value-function*
379Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000380'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000381a function name or a function reference or a lambda function. When using a
382lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000383>
384 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000385 set opfunc=function('MyOpFunc')
386 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000387 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000388
389Set to a script-local function: >
390 set opfunc=s:MyLocalFunc
391 set opfunc=<SID>MyLocalFunc
392In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
393the script: >
394 set opfunc=MyLocalFunc
395
396Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000397 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000398 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000399
400Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000401 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000402
403Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000404 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000405 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000406
407In Vim9 script, in a compiled function, you can use a lambda, but a
408closured does not work, because the function will be called without the
409context of where it was defined.
410
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000411
Bram Moolenaar071d4272004-06-13 20:20:40 +0000412Setting the filetype
413
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200414:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000415 Set the 'filetype' option to {filetype}, but only if
416 not done yet in a sequence of (nested) autocommands.
417 This is short for: >
418 :if !did_filetype()
419 : setlocal filetype={filetype}
420 :endif
421< This command is used in a filetype.vim file to avoid
422 setting the 'filetype' option twice, causing different
423 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200424
425 When the optional FALLBACK argument is present, a
426 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100427 'filetype'. This is to be used for filetype
428 detections that are just a guess. |did_filetype()|
429 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200430
Bram Moolenaard58e9292011-02-09 17:07:58 +0100431 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000432:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
433:opt[ions] Open a window for viewing and setting all options.
434 Options are grouped by function.
435 Offers short help for each option. Hit <CR> on the
436 short help to open a help window with more help for
437 the option.
438 Modify the value of the option and hit <CR> on the
439 "set" line to set the new value. For window and
440 buffer specific options, the last accessed window is
441 used to set the option value in, unless this is a help
442 window, in which case the window below help window is
443 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100444 {not available when compiled without the |+eval|
445 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446
447 *$HOME*
448Using "~" is like using "$HOME", but it is only recognized at the start of an
449option and after a space or comma.
450
451On Unix systems "~user" can be used too. It is replaced by the home directory
452of user "user". Example: >
453 :set path=~mool/include,/usr/include,.
454
455On Unix systems the form "${HOME}" can be used too. The name between {} can
456contain non-id characters then. Note that if you want to use this for the
457"gf" command, you need to add the '{' and '}' characters to 'isfname'.
458
459NOTE: expanding environment variables and "~/" is only done with the ":set"
460command, not when assigning a value to an option with ":let".
461
Bram Moolenaarc572da52017-08-27 16:52:01 +0200462 *$HOME-windows*
463On MS-Windows, if $HOME is not defined as an environment variable, then
464at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200465If $HOMEDRIVE is not set then $USERPROFILE is used.
466
467This expanded value is not exported to the environment, this matters when
468running an external command: >
469 :echo system('set | findstr ^HOME=')
470and >
471 :echo luaeval('os.getenv("HOME")')
472should echo nothing (an empty string) despite exists('$HOME') being true.
473When setting $HOME to a non-empty string it will be exported to the
474subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200475
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476
477Note the maximum length of an expanded option is limited. How much depends on
478the system, mostly it is something like 256 or 1024 characters.
479
480 *:fix* *:fixdel*
481:fix[del] Set the value of 't_kD':
482 't_kb' is 't_kD' becomes ~
483 CTRL-? CTRL-H
484 not CTRL-? CTRL-?
485
Bram Moolenaar82be4842021-01-11 19:40:15 +0100486 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000487
488 If your delete key terminal code is wrong, but the
489 code for backspace is alright, you can put this in
490 your .vimrc: >
491 :fixdel
492< This works no matter what the actual code for
493 backspace is.
494
495 If the backspace key terminal code is wrong you can
496 use this: >
497 :if &term == "termname"
498 : set t_kb=^V<BS>
499 : fixdel
500 :endif
501< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000502 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000503 with your terminal name.
504
505 If your <Delete> key sends a strange key sequence (not
506 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
507 :if &term == "termname"
508 : set t_kD=^V<Delete>
509 :endif
510< Where "^V" is CTRL-V and "<Delete>" is the delete key
511 (don't type eight characters!). Replace "termname"
512 with your terminal name.
513
514 *Linux-backspace*
515 Note about Linux: By default the backspace key
516 produces CTRL-?, which is wrong. You can fix it by
517 putting this line in your rc.local: >
518 echo "keycode 14 = BackSpace" | loadkeys
519<
520 *NetBSD-backspace*
521 Note about NetBSD: If your backspace doesn't produce
522 the right code, try this: >
523 xmodmap -e "keycode 22 = BackSpace"
524< If this works, add this in your .Xmodmap file: >
525 keysym 22 = BackSpace
526< You need to restart for this to take effect.
527
528==============================================================================
5292. Automatically setting options *auto-setting*
530
531Besides changing options with the ":set" command, there are three alternatives
532to set options automatically for one or more files:
533
5341. When starting Vim initializations are read from various places. See
535 |initialization|. Most of them are performed for all editing sessions,
536 and some of them depend on the directory where Vim is started.
537 You can create an initialization file with |:mkvimrc|, |:mkview| and
538 |:mksession|.
5392. If you start editing a new file, the automatic commands are executed.
540 This can be used to set options for files matching a particular pattern and
541 many other things. See |autocommand|.
5423. If you start editing a new file, and the 'modeline' option is on, a
543 number of lines at the beginning and end of the file are checked for
544 modelines. This is explained here.
545
546 *modeline* *vim:* *vi:* *ex:* *E520*
547There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100548 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100550[text{white}] empty or any text followed by at least one blank
551 character (<Space> or <Tab>); "ex:" always requires at
552 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200553{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200554[white] optional white space
555{options} a list of option settings, separated with white space
556 or ':', where each part between ':' is the argument
557 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000558
Bram Moolenaar14b69452013-06-29 23:05:20 +0200559Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000560 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200561 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562
563The second form (this is compatible with some versions of Vi):
564
Bram Moolenaarade0d392020-01-21 22:33:58 +0100565 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566
Bram Moolenaarade0d392020-01-21 22:33:58 +0100567[text{white}] empty or any text followed by at least one blank
568 character (<Space> or <Tab>); "ex:" always requires at
569 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200570{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
571[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200572se[t] the string "set " or "se " (note the space); When
573 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200574{options} a list of options, separated with white space, which
575 is the argument for a ":set" command
576: a colon
577[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578
Bram Moolenaar14b69452013-06-29 23:05:20 +0200579Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000580 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200581 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200583The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
584chance that a normal word like "lex:" is caught. There is one exception:
585"vi:" and "vim:" can also be at the start of the line (for compatibility with
586version 3.0). Using "ex:" at the start of the line will be ignored (this
587could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000588
Hu Jialun9dcd3492021-08-28 20:42:50 +0200589If the modeline is disabled within a modeline, subsequent modelines will be
590ignored. This is to allow turning off modeline on a per-file basis. This is
591useful when a line looks like a modeline but isn't. For example, it would be
592good to start a YAML file containing strings like "vim:" with
593 # vim: nomodeline ~
594so as to avoid modeline misdetection. Following options on the same line
595after modeline deactivation, if any, are still evaluated (but you would
596normally not have any).
597
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598 *modeline-local*
599The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000600buffer and window that contain the file. Although it's possible to set global
601options from a modeline, this is unusual. If you have two windows open and
602the files in it set the same global option to a different value, the result
603depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000605When editing a file that was already loaded, only the window-local options
606from the modeline are used. Thus if you manually changed a buffer-local
607option after opening the file, it won't be changed if you edit the same buffer
608in another window. But window-local options will be set.
609
Bram Moolenaar071d4272004-06-13 20:20:40 +0000610 *modeline-version*
611If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200612number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613 vim{vers}: version {vers} or later
614 vim<{vers}: version before {vers}
615 vim={vers}: version {vers}
616 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100617{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
618For example, to use a modeline only for Vim 7.0:
619 /* vim700: set foldmethod=marker */ ~
620To use a modeline for Vim after version 7.2:
621 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622There can be no blanks between "vim" and the ":".
623
624
625The number of lines that are checked can be set with the 'modelines' option.
626If 'modeline' is off or 'modelines' is 0 no lines are checked.
627
628Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000629like:
630 /* vi:ts=4: */ ~
631will give an error message for the trailing "*/". This line is OK:
632 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633
634If an error is detected the rest of the line is skipped.
635
636If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000637backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100638 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
639This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
640before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200641 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000643might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200644can be set. For some options a flag is set, so that when the value is used
645the |sandbox| is effective. Some options can only be set from the modeline
646when 'modelineexpr' is set (the default is off).
647
648Still, there is always a small risk that a modeline causes trouble. E.g.,
649when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
650So disable modelines before editing untrusted text. The mail ftplugin does
651this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
653Hint: If you would like to do something else than setting an option, you could
654define an autocommand that checks the file for a specific string. For
655example: >
656 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
657And define a function SetVar() that does something with the line containing
658"VAR".
659
660==============================================================================
6613. Options summary *option-summary*
662
663In the list below all the options are mentioned with their full name and with
664an abbreviation if there is one. Both forms may be used.
665
666In this document when a boolean option is "set" that means that ":set option"
667is entered. When an option is "reset", ":set nooption" is used.
668
669For some options there are two default values: The "Vim default", which is
670used when 'compatible' is not set, and the "Vi default", which is used when
671'compatible' is set.
672
673Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000674are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675different value in each window. For example the 'list' option can be set in
676one window and reset in another for the same text, giving both types of view
677at the same time. There are a few options that are specific to a certain
678file. These can have a different value for each file or buffer. For example
679the 'textwidth' option can be 78 for a normal text file and 0 for a C
680program.
681
682 global one option for all buffers and windows
683 local to window each window has its own copy of this option
684 local to buffer each buffer has its own copy of this option
685
686When creating a new window the option values from the currently active window
687are used as a default value for the window-specific options. For the
688buffer-specific options this depends on the 's' and 'S' flags in the
689'cpoptions' option. If 's' is included (which is the default) the values for
690buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000691first entered. If 'S' is present the options are copied each time the buffer
692is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693present, the options are copied from the currently active buffer when the
694buffer is created.
695
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000696Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000698Not all options are supported in all versions. This depends on the supported
699features and sometimes on the system. A remark about this is in curly braces
700below. When an option is not supported it may still be set without getting an
701error, this is called a hidden option. You can't get the value of a hidden
702option though, it is not stored.
703
704To test if option "foo" can be used with ":set" use something like this: >
705 if exists('&foo')
706This also returns true for a hidden option. To test if option "foo" is really
707supported use something like this: >
708 if exists('+foo')
709<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000710 *E355*
711A jump table for the options with a short description can be found at |Q_op|.
712
713 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100714'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716 {only available when compiled with the |+rightleft|
717 feature}
718 The ASCII code for the first letter of the Hebrew alphabet. The
719 routine that maps the keyboard in Hebrew mode, both in Insert mode
720 (when hkmap is set) and on the command-line (when hitting CTRL-_)
721 outputs the Hebrew characters in the range [aleph..aleph+26].
722 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
723 See |rileft.txt|.
724
725 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
726'allowrevins' 'ari' boolean (default off)
727 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728 {only available when compiled with the |+rightleft|
729 feature}
730 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
731 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
732 into reverse Insert mode, and don't know how to get out. See
733 'revins'.
734 NOTE: This option is reset when 'compatible' is set.
735
736 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
737'altkeymap' 'akm' boolean (default off)
738 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739 {only available when compiled with the |+farsi|
740 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100741 This option was for using Farsi, which has been removed. See
742 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743
744 *'ambiwidth'* *'ambw'*
745'ambiwidth' 'ambw' string (default: "single")
746 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000747 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
748 Tells Vim what to do with characters with East Asian Width Class
749 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
750 letters, Cyrillic letters).
751
752 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000753 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000754 expected by most users.
755 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200756 *E834* *E835*
757 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100758 contains a character that would be double width. These errors may
759 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200760
761 The values are overruled for characters specified with
762 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763
764 There are a number of CJK fonts for which the width of glyphs for
765 those characters are solely based on how many octets they take in
766 legacy/traditional CJK encodings. In those encodings, Euro,
767 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000768 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000770 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771 Vim is running inside a terminal (emulators) that uses a CJK font
772 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
773 this option should be set to "double" to match the width perceived
774 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100775 to be set to "double" under CJK MS-Windows when the system locale is
776 set to one of CJK locales. See Unicode Standard Annex #11
777 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100779 Vim may set this option automatically at startup time when Vim is
780 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200781 escape sequence to request cursor position report. The response can
782 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100783
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
785'antialias' 'anti' boolean (default: off)
786 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200788 on macOS}
789 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
791 which can be easier to read at certain sizes on certain displays.
792 Setting this option can sometimes cause problems if 'guifont' is set
793 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100794 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795
796 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
797'autochdir' 'acd' boolean (default off)
798 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200799 {only available when compiled with it, use
800 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000801 When on, Vim will change the current working directory whenever you
802 open a file, switch buffers, delete a buffer or open/close a window.
803 It will change to the directory containing the file which was opened
Bram Moolenaare8008642022-08-19 17:15:35 +0100804 or selected. When a buffer has no name it also has no directory, thus
805 the current directory won't change when navigating to it.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000806 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200808 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
809'autoshelldir' 'asd' boolean (default off)
810 global
811 When on, Vim will change the current working directory whenever you
812 change the directory of the shell running in a terminal window. You
813 need proper setting-up, so whenever the shell's pwd changes an OSC 7
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100814 escape sequence will be emitted. For example, on Linux, you can
815 source /etc/profile.d/vte.sh in your shell profile if you use bash or
816 zsh. For bash this should work (put it in a bash init file): >
817 if [[ -n "$VIM_TERMINAL" ]]; then
818 PROMPT_COMMAND='_vim_sync_PWD'
819 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100820 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100821 }
822 fi
823<
824 Or, in a zsh init file: >
825 if [[ -n "$VIM_TERMINAL" ]]; then
826 autoload -Uz add-zsh-hook
827 add-zsh-hook -Uz chpwd _vim_sync_PWD
828 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100829 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100830 }
831 fi
832<
833 In a fish init file: >
834 if test -n "$VIM_TERMINAL"
835 function _vim_sync_PWD --on-variable=PWD
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100836 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100837 end
838 end
839<
840 You can find an alternative method at |terminal-autoshelldir|.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000841 When the parsing of the OSC sequence fails you get *E1179* .
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200842
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
844'arabic' 'arab' boolean (default off)
845 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 {only available when compiled with the |+arabic|
847 feature}
848 This option can be set to start editing Arabic text.
849 Setting this option will:
850 - Set the 'rightleft' option, unless 'termbidi' is set.
851 - Set the 'arabicshape' option, unless 'termbidi' is set.
852 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
853 between typing English and Arabic key mapping.
854 - Set the 'delcombine' option
855 Note that 'encoding' must be "utf-8" for working with Arabic text.
856
857 Resetting this option will:
858 - Reset the 'rightleft' option.
859 - Disable the use of 'keymap' (without changing its value).
860 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200861 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100862 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 Also see |arabic.txt|.
864
865 *'arabicshape'* *'arshape'*
866 *'noarabicshape'* *'noarshape'*
867'arabicshape' 'arshape' boolean (default on)
868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 {only available when compiled with the |+arabic|
870 feature}
871 When on and 'termbidi' is off, the required visual character
872 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200873 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874 one which encompasses:
875 a) the changing/morphing of characters based on their location
876 within a word (initial, medial, final and stand-alone).
877 b) the enabling of the ability to compose characters
878 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100879 When disabled the display shows each character's true stand-alone
880 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000881 Arabic is a complex language which requires other settings, for
882 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100883 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000884
885 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
886'autoindent' 'ai' boolean (default off)
887 local to buffer
888 Copy indent from current line when starting a new line (typing <CR>
889 in Insert mode or when using the "o" or "O" command). If you do not
890 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000891 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
892 to another line has the same effect, unless the 'I' flag is included
893 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000894 When autoindent is on, formatting (with the "gq" command or when you
895 reach 'textwidth' in Insert mode) uses the indentation of the first
896 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000897 When 'smartindent' or 'cindent' is on the indent is changed in
898 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200899 The 'autoindent' option is reset when the 'paste' option is set and
900 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901
902 *'autoread'* *'ar'* *'noautoread'* *'noar'*
903'autoread' 'ar' boolean (default off)
904 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000905 When a file has been detected to have been changed outside of Vim and
906 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200907 When the file has been deleted this is not done, so you have the text
908 from before it was deleted. When it appears again then it is read.
909 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910 If this option has a local value, use this command to switch back to
911 using the global value: >
912 :set autoread<
913<
914 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
915'autowrite' 'aw' boolean (default off)
916 global
917 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000918 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000919 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
920 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000921 to another file.
922 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000923 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000924 Note that for some commands the 'autowrite' option is not used, see
925 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200926 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200927 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100928 USE WITH CARE: If you make temporary changes to a buffer that you
929 don't want to be saved this option may cause it to be saved anyway.
930 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931
932 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
933'autowriteall' 'awa' boolean (default off)
934 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
936 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
937 Setting this option also implies that Vim behaves like 'autowrite' has
938 been set.
939
940 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200941'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000943 When set to "dark", Vim will try to use colors that look good on a
944 dark background. When set to "light", Vim will try to use colors that
945 look good on a light background. Any other value is illegal.
946 Vim tries to set the default value according to the terminal used.
947 This will not always be correct.
948 Setting this option does not change the background color, it tells Vim
949 what the background color looks like. For changing the background
950 color, see |:hi-normal|.
951
952 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000953 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000954 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100955 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000956 setting 'background' will cause the color scheme to be reloaded. If
957 the color scheme adjusts to the value of 'background' this will work.
958 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100959 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000960
961 When setting 'background' to the default value with: >
962 :set background&
963< Vim will guess the value. In the GUI this should work correctly,
964 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200965 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200966 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000967
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200968 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200969 color from the terminal. If the returned RGB value is dark/light and
970 'background' is not dark/light, 'background' will be set and the
971 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200972 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100973 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200974
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975 When starting the GUI, the default value for 'background' will be
976 "light". When the value is not set in the .gvimrc, and Vim detects
977 that the background is actually quite dark, 'background' is set to
978 "dark". But this happens only AFTER the .gvimrc file has been read
979 (because the window needs to be opened to find the actual background
980 color). To get around this, force the GUI window to be opened by
981 putting a ":gui" command in the .gvimrc file, before where the value
982 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200983
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100984 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200985 For other systems "dark" is used when 'term' is "linux",
986 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
987 background. Otherwise the default is "light".
988
Bram Moolenaarc572da52017-08-27 16:52:01 +0200989 The |:terminal| command and the |term_start()| function use the
990 'background' value to decide whether the terminal window will start
991 with a white or black background.
992
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993 Normally this option would be set in the .vimrc file. Possibly
994 depending on the terminal name. Example: >
995 :if &term == "pcterm"
996 : set background=dark
997 :endif
998< When this option is set, the default settings for the highlight groups
999 will change. To use other settings, place ":highlight" commands AFTER
1000 the setting of the 'background' option.
1001 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1002 to select the colors for syntax highlighting. After changing this
1003 option, you must load syntax.vim again to see the result. This can be
1004 done with ":syntax on".
1005
1006 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001007'backspace' 'bs' string (default "", set to "indent,eol,start"
1008 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1011 mode. This is a list of items, separated by commas. Each item allows
1012 a way to backspace over something:
1013 value effect ~
1014 indent allow backspacing over autoindent
1015 eol allow backspacing over line breaks (join lines)
1016 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1017 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001018 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1019 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001020
Bram Moolenaar46eea442022-03-30 10:51:39 +01001021 When the value is empty, Vi compatible backspacing is used, none of
1022 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023
1024 For backwards compatibility with version 5.4 and earlier:
1025 value effect ~
1026 0 same as ":set backspace=" (Vi compatible)
1027 1 same as ":set backspace=indent,eol"
1028 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001029 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030
1031 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1032 NOTE: This option is set to "" when 'compatible' is set.
1033
1034 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1035'backup' 'bk' boolean (default off)
1036 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037 Make a backup before overwriting a file. Leave it around after the
1038 file has been successfully written. If you do not want to keep the
1039 backup file, but you do want a backup while the file is being
1040 written, reset this option and set the 'writebackup' option (this is
1041 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001042 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001043 |backup-table| for more explanations.
1044 When the 'backupskip' pattern matches, a backup is not made anyway.
1045 When 'patchmode' is set, the backup may be renamed to become the
1046 oldest version of a file.
1047 NOTE: This option is reset when 'compatible' is set.
1048
1049 *'backupcopy'* *'bkc'*
1050'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001051 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001052 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001053 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001054
1055 The main values are:
1056 "yes" make a copy of the file and overwrite the original one
1057 "no" rename the file and write a new one
1058 "auto" one of the previous, what works best
1059
1060 Extra values that can be combined with the ones above are:
1061 "breaksymlink" always break symlinks when writing
1062 "breakhardlink" always break hardlinks when writing
1063
1064 Making a copy and overwriting the original file:
1065 - Takes extra time to copy the file.
1066 + When the file has special attributes, is a (hard/symbolic) link or
1067 has a resource fork, all this is preserved.
1068 - When the file is a link the backup will have the name of the link,
1069 not of the real file.
1070
1071 Renaming the file and writing a new one:
1072 + It's fast.
1073 - Sometimes not all attributes of the file can be copied to the new
1074 file.
1075 - When the file is a link the new file will not be a link.
1076
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001077 The "auto" value is the middle way: When Vim sees that renaming the
1078 file is possible without side effects (the attributes can be passed on
1079 and the file is not a link) that is used. When problems are expected,
1080 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001081
1082 The "breaksymlink" and "breakhardlink" values can be used in
1083 combination with any of "yes", "no" and "auto". When included, they
1084 force Vim to always break either symbolic or hard links by doing
1085 exactly what the "no" option does, renaming the original file to
1086 become the backup and writing a new file in its place. This can be
1087 useful for example in source trees where all the files are symbolic or
1088 hard links and any changes should stay in the local source tree, not
1089 be propagated back to the original source.
1090 *crontab*
1091 One situation where "no" and "auto" will cause problems: A program
1092 that opens a file, invokes Vim to edit that file, and then tests if
1093 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001094 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095 example.
1096
1097 When a copy is made, the original file is truncated and then filled
1098 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001099 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001100 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 group of the backup is set to the group of the original file. If this
1102 fails, the protection bits for the group are made the same as for
1103 others.
1104
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001105 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106 the same attributes of the original file, and the newly written file
1107 is owned by the current user. When the file was a (hard/symbolic)
1108 link, the new file will not! That's why the "auto" value doesn't
1109 rename when the file is a link. The owner and group of the newly
1110 written file will be set to the same ones as the original file, but
1111 the system may refuse to do this. In that case the "auto" value will
1112 again not rename the file.
1113
Bram Moolenaar036986f2017-03-16 17:41:02 +01001114 NOTE: This option is set to the Vi default value when 'compatible' is
1115 set and to the Vim default value when 'compatible' is reset.
1116
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 *'backupdir'* *'bdir'*
1118'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001119 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001120 for Unix: ".,~/tmp,~/")
1121 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122 List of directories for the backup file, separated with commas.
1123 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001124 where this is possible. The directory must exist, Vim will not
1125 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001126 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127 impossible!). Writing may fail because of this.
1128 - A directory "." means to put the backup file in the same directory
1129 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001130 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1131 the backup file relative to where the edited file is. The leading
1132 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001133 ("." inside a directory name has no special meaning).
1134 - Spaces after the comma are ignored, other spaces are considered part
1135 of the directory name. To have a space at the start of a directory
1136 name, precede it with a backslash.
1137 - To include a comma in a directory name precede it with a backslash.
1138 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001139 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001140 the backup file name will be built from the complete path to the
1141 file with all path separators changed to percent '%' signs. This
1142 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001143 On Win32, it is also possible to end with "\\". However, When a
1144 separating comma is following, you must use "//", since "\\" will
1145 include the comma in the file name. Therefore it is recommended to
1146 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147 - Environment variables are expanded |:set_env|.
1148 - Careful with '\' characters, type one before a space, type two to
1149 get one in the option (see |option-backslash|), for example: >
1150 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1151< - For backwards compatibility with Vim version 3.0 a '>' at the start
1152 of the option is removed.
1153 See also 'backup' and 'writebackup' options.
1154 If you want to hide your backup files on Unix, consider this value: >
1155 :set backupdir=./.backup,~/.backup,.,/tmp
1156< You must create a ".backup" directory in each directory and in your
1157 home directory for this to work properly.
1158 The use of |:set+=| and |:set-=| is preferred when adding or removing
1159 directories from the list. This avoids problems when a future version
1160 uses another default.
1161 This option cannot be set from a |modeline| or in the |sandbox|, for
1162 security reasons.
1163
1164 *'backupext'* *'bex'* *E589*
1165'backupext' 'bex' string (default "~", for VMS: "_")
1166 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 String which is appended to a file name to make the name of the
1168 backup file. The default is quite unusual, because this avoids
1169 accidentally overwriting existing files with a backup file. You might
1170 prefer using ".bak", but make sure that you don't have files with
1171 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001172 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001174 If you like to keep a lot of backups, you could use a BufWritePre
1175 autocommand to change 'backupext' just before writing the file to
1176 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001177 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001178< Use 'backupdir' to put the backup in a different directory.
1179
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001181'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1182 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1183 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185 A list of file patterns. When one of the patterns matches with the
1186 name of the file which is written, no backup file is created. Both
1187 the specified file name and the full path name of the file are used.
1188 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1189 Watch out for special characters, see |option-backslash|.
1190 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001191 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001192
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001193 WARNING: Not having a backup file means that when Vim fails to write
1194 your buffer correctly and then, for whatever reason, Vim exits, you
1195 lose both the original file and what you were writing. Only disable
1196 backups if you don't care about losing the file.
1197
Bram Moolenaar02467872007-05-06 13:22:01 +00001198 Note that environment variables are not expanded. If you want to use
1199 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001200 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001201
1202< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001203 backup would be made by renaming the original file crontab won't see
1204 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205
1206 *'balloondelay'* *'bdlay'*
1207'balloondelay' 'bdlay' number (default: 600)
1208 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209 {only available when compiled with the |+balloon_eval|
1210 feature}
1211 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1212
1213 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1214'ballooneval' 'beval' boolean (default off)
1215 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001217 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001218 Switch on the |balloon-eval| functionality for the GUI.
1219
1220 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1221 *'nobevalterm'*
1222'balloonevalterm' 'bevalterm' boolean (default off)
1223 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001224 {only available when compiled with the
1225 |+balloon_eval_term| feature}
1226 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001228 *'balloonexpr'* *'bexpr'*
1229'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001230 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001231 {only available when compiled with the |+balloon_eval|
1232 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001233 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001234 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1235 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001236
1237 v:beval_bufnr number of the buffer in which balloon is going to show
1238 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001239 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001240 v:beval_lnum line number
1241 v:beval_col column number (byte index)
1242 v:beval_text word under or after the mouse pointer
1243
Bram Moolenaar54775062019-07-31 21:07:14 +02001244 Instead of showing a balloon, which is limited to plain text, consider
1245 using a popup window, see |popup_beval_example|. A popup window can
1246 use highlighting and show a border.
1247
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001248 The evaluation of the expression must not have side effects!
1249 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001250 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001251 return 'Cursor is at line ' .. v:beval_lnum ..
1252 \ ', column ' .. v:beval_col ..
1253 \ ' of file ' .. bufname(v:beval_bufnr) ..
1254 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001255 endfunction
1256 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001257 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001258<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001259 Also see |balloon_show()|, it can be used if the content of the balloon
1260 is to be fetched asynchronously. In that case evaluating
1261 'balloonexpr' should result in an empty string. If you get a balloon
1262 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001263
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001264 NOTE: The balloon is displayed only if the cursor is on a text
1265 character. If the result of evaluating 'balloonexpr' is not empty,
1266 Vim does not try to send a message to an external debugger (Netbeans
1267 or Sun Workshop).
1268
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001269 If the expression starts with s: or |<SID>|, then it is replaced with
1270 the script ID (|local-function|). Example: >
1271 set bexpr=s:MyBalloonExpr()
1272 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001273< Otherwise, the expression is evaluated in the context of the script
1274 where the option was set, thus script-local items are available.
1275
Bram Moolenaar30b65812012-07-12 22:01:11 +02001276 The expression will be evaluated in the |sandbox| when set from a
1277 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001278 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001279
1280 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001281 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001282
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001283 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001284 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001285< When they are supported "\n" characters will start a new line. If the
1286 expression evaluates to a |List| this is equal to using each List item
1287 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001288 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001289
Bram Moolenaar165bc692015-07-21 17:53:25 +02001290 *'belloff'* *'bo'*
1291'belloff' 'bo' string (default "")
1292 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001293 Specifies for which events the bell will not be rung. It is a comma
1294 separated list of items. For each item that is present, the bell
1295 will be silenced. This is most useful to specify specific events in
1296 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001297 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001298
1299 item meaning when present ~
1300 all All events.
1301 backspace When hitting <BS> or <Del> and deleting results in an
1302 error.
1303 cursor Fail to move around using the cursor keys or
1304 <PageUp>/<PageDown> in |Insert-mode|.
1305 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1306 |i_CTRL-X_CTRL-T|.
1307 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1308 |i_CTRL-E|.
1309 ctrlg Unknown Char after <C-G> in Insert mode.
1310 error Other Error occurred (e.g. try to join last line)
1311 (mostly used in |Normal-mode| or |Cmdline-mode|).
1312 esc hitting <Esc> in |Normal-mode|.
1313 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001314 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001315 insertmode Pressing <Esc> in 'insertmode'.
1316 lang Calling the beep module for Lua/Mzscheme/TCL.
1317 mess No output available for |g<|.
1318 showmatch Error occurred for 'showmatch' function.
1319 operator Empty region error |cpo-E|.
1320 register Unknown register after <C-R> in |Insert-mode|.
1321 shell Bell from shell output |:!|.
1322 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001323 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001324 wildmode More matches in |cmdline-completion| available
1325 (depends on the 'wildmode' setting).
1326
Bram Moolenaar036986f2017-03-16 17:41:02 +01001327 This is most useful to fine tune when in Insert mode the bell should
1328 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001329 indicate that an error occurred. It can be silenced by adding the
1330 "error" keyword.
1331
Bram Moolenaar071d4272004-06-13 20:20:40 +00001332 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1333'binary' 'bin' boolean (default off)
1334 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001335 This option should be set before editing a binary file. You can also
1336 use the |-b| Vim argument. When this option is switched on a few
1337 options will be changed (also when it already was on):
1338 'textwidth' will be set to 0
1339 'wrapmargin' will be set to 0
1340 'modeline' will be off
1341 'expandtab' will be off
1342 Also, 'fileformat' and 'fileformats' options will not be used, the
1343 file is read and written like 'fileformat' was "unix" (a single <NL>
1344 separates lines).
1345 The 'fileencoding' and 'fileencodings' options will not be used, the
1346 file is read without conversion.
1347 NOTE: When you start editing a(nother) file while the 'bin' option is
1348 on, settings from autocommands may change the settings again (e.g.,
1349 'textwidth'), causing trouble when editing. You might want to set
1350 'bin' again when the file has been loaded.
1351 The previous values of these options are remembered and restored when
1352 'bin' is switched from on to off. Each buffer has its own set of
1353 saved option values.
1354 To edit a file with 'binary' set you can use the |++bin| argument.
1355 This avoids you have to do ":set bin", which would have effect for all
1356 files you edit.
1357 When writing a file the <EOL> for the last line is only written if
1358 there was one in the original file (normally Vim appends an <EOL> to
1359 the last line if there is none; this would make the file longer). See
1360 the 'endofline' option.
1361
1362 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1363'bioskey' 'biosk' boolean (default on)
1364 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001365 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001366 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367
1368 *'bomb'* *'nobomb'*
1369'bomb' boolean (default off)
1370 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001371 When writing a file and the following conditions are met, a BOM (Byte
1372 Order Mark) is prepended to the file:
1373 - this option is on
1374 - the 'binary' option is off
1375 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1376 endian variants.
1377 Some applications use the BOM to recognize the encoding of the file.
1378 Often used for UCS-2 files on MS-Windows. For other applications it
1379 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001380 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1382 check for the presence of the BOM is done and 'bomb' set accordingly.
1383 Unless 'binary' is set, it is removed from the first line, so that you
1384 don't see it when editing. When you don't change the options, the BOM
1385 will be restored when writing the file.
1386
1387 *'breakat'* *'brk'*
1388'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1389 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001390 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391 feature}
1392 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001393 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1394 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001396 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001397'breakindent' 'bri' boolean (default off)
1398 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001399 {not available when compiled without the |+linebreak|
1400 feature}
1401 Every wrapped line will continue visually indented (same amount of
1402 space as the beginning of that line), thus preserving horizontal blocks
1403 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001404 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001405
1406 *'breakindentopt'* *'briopt'*
1407'breakindentopt' 'briopt' string (default empty)
1408 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001409 {not available when compiled without the |+linebreak|
1410 feature}
1411 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001412 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001413 min:{n} Minimum text width that will be kept after
1414 applying 'breakindent', even if the resulting
1415 text should normally be narrower. This prevents
1416 text indented almost to the right window border
1417 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001418 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001419 shift:{n} After applying 'breakindent', the wrapped line's
1420 beginning will be shifted by the given number of
1421 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001422 indentation (negative) or emphasizing the line
1423 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001424 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001425 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001426 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001427 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001428 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001429 numbered or bulleted list (using the
1430 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001431 list:-1 Uses the length of a match with 'formatlistpat'
1432 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001433 (default: 0)
1434 column:{n} Indent at column {n}. Will overrule the other
1435 sub-options. Note: an additional indent may be
1436 added for the 'showbreak' setting.
1437 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001438
Bram Moolenaar071d4272004-06-13 20:20:40 +00001439 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001440'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001442 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001444 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001445 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446 buffer Use the directory of the related buffer.
1447 current Use the current directory.
1448 {path} Use the specified directory
1449
1450 *'bufhidden'* *'bh'*
1451'bufhidden' 'bh' string (default: "")
1452 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453 This option specifies what happens when a buffer is no longer
1454 displayed in a window:
1455 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001456 hide hide the buffer (don't unload it), even if 'hidden' is
1457 not set
1458 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001459 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001460 delete delete the buffer from the buffer list, even if
1461 'hidden' is set; the |:hide| command will also delete
1462 the buffer, making it behave like |:bdelete|
1463 wipe wipe the buffer from the buffer list, even if
1464 'hidden' is set; the |:hide| command will also wipe
1465 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001467 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001468 are lost without a warning. Also, these values may break autocommands
1469 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470 This option is used together with 'buftype' and 'swapfile' to specify
1471 special kinds of buffers. See |special-buffers|.
1472
1473 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1474'buflisted' 'bl' boolean (default: on)
1475 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001476 When this option is set, the buffer shows up in the buffer list. If
1477 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1478 This option is reset by Vim for buffers that are only used to remember
1479 a file name or marks. Vim sets it when starting to edit a buffer.
1480 But not when moving to a buffer with ":buffer".
1481
1482 *'buftype'* *'bt'* *E382*
1483'buftype' 'bt' string (default: "")
1484 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485 The value of this option specifies the type of a buffer:
1486 <empty> normal buffer
1487 nofile buffer which is not related to a file and will not be
1488 written
1489 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001490 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001491 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001493 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494 help help buffer (you are not supposed to set this
1495 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001496 terminal buffer for a |terminal| (you are not supposed to set
1497 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001498 prompt buffer where only the last line can be edited, meant
1499 to be used by a plugin, see |prompt-buffer|
1500 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001501 popup buffer used in a popup window, see |popup|.
1502 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503
1504 This option is used together with 'bufhidden' and 'swapfile' to
1505 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001506 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507
1508 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001509 One such effect is that Vim will not check the timestamp of the file,
1510 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511
Bram Moolenaar280f1262006-01-30 00:14:18 +00001512 A "quickfix" buffer is only used for the error list and the location
1513 list. This value is set by the |:cwindow| and |:lwindow| commands and
1514 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001515
1516 "nofile" and "nowrite" buffers are similar:
1517 both: The buffer is not to be written to disk, ":w" doesn't
1518 work (":w filename" does work though).
1519 both: The buffer is never considered to be |'modified'|.
1520 There is no warning when the changes will be lost, for
1521 example when you quit Vim.
1522 both: A swap file is only created when using too much memory
1523 (when 'swapfile' has been reset there is never a swap
1524 file).
1525 nofile only: The buffer name is fixed, it is not handled like a
1526 file name. It is not modified in response to a |:cd|
1527 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001528 both: When using ":e bufname" and already editing "bufname"
1529 the buffer is made empty and autocommands are
1530 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001531 *E676*
1532 "acwrite" implies that the buffer name is not related to a file, like
1533 "nofile", but it will be written. Thus, in contrast to "nofile" and
1534 "nowrite", ":w" does work and a modified buffer can't be abandoned
1535 without saving. For writing there must be matching |BufWriteCmd|,
1536 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537
1538 *'casemap'* *'cmp'*
1539'casemap' 'cmp' string (default: "internal,keepascii")
1540 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001541 Specifies details about changing the case of letters. It may contain
1542 these words, separated by a comma:
1543 internal Use internal case mapping functions, the current
1544 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001545 matters when 'encoding' is a Unicode encoding,
1546 "latin1" or "iso-8859-15". When "internal" is
1547 omitted, the towupper() and towlower() system library
1548 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1550 case mapping, the current locale is not effective.
1551 This probably only matters for Turkish.
1552
Bram Moolenaar938ae282023-02-20 20:44:55 +00001553 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001554'cdhome' 'cdh' boolean (default: off)
1555 global
1556 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1557 current working directory to the |$HOME| directory like in Unix.
1558 When off, those commands just print the current directory name.
1559 On Unix this option has no effect.
1560 NOTE: This option is reset when 'compatible' is set.
1561
Bram Moolenaar071d4272004-06-13 20:20:40 +00001562 *'cdpath'* *'cd'* *E344* *E346*
1563'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1564 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001566 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1567 searched for has a relative path, not an absolute part starting with
1568 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569 The 'cdpath' option's value has the same form and semantics as
1570 |'path'|. Also see |file-searching|.
1571 The default value is taken from $CDPATH, with a "," prepended to look
1572 in the current directory first.
1573 If the default value taken from $CDPATH is not what you want, include
1574 a modified version of the following command in your vimrc file to
1575 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001576 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577< This option cannot be set from a |modeline| or in the |sandbox|, for
1578 security reasons.
1579 (parts of 'cdpath' can be passed to the shell to expand file names).
1580
1581 *'cedit'*
1582'cedit' string (Vi default: "", Vim default: CTRL-F)
1583 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001584 The key used in Command-line Mode to open the command-line window.
1585 The default is CTRL-F when 'compatible' is off.
1586 Only non-printable keys are allowed.
1587 The key can be specified as a single character, but it is difficult to
1588 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001589 :exe "set cedit=\<C-Y>"
1590 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591< |Nvi| also has this option, but it only uses the first character.
1592 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001593 NOTE: This option is set to the Vim default value when 'compatible'
1594 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595
1596 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1597'charconvert' 'ccv' string (default "")
1598 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001599 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600 An expression that is used for character encoding conversion. It is
1601 evaluated when a file that is to be read or has been written has a
1602 different encoding from what is desired.
1603 'charconvert' is not used when the internal iconv() function is
1604 supported and is able to do the conversion. Using iconv() is
1605 preferred, because it is much faster.
1606 'charconvert' is not used when reading stdin |--|, because there is no
1607 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001608 The expression must return zero, false or an empty string for success,
1609 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610 The possible encoding names encountered are in 'encoding'.
1611 Additionally, names given in 'fileencodings' and 'fileencoding' are
1612 used.
1613 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1614 is done internally by Vim, 'charconvert' is not used for this.
1615 'charconvert' is also used to convert the viminfo file, if the 'c'
1616 flag is present in 'viminfo'. Also used for Unicode conversion.
1617 Example: >
1618 set charconvert=CharConvert()
1619 fun CharConvert()
1620 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001621 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1622 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001623 return v:shell_error
1624 endfun
1625< The related Vim variables are:
1626 v:charconvert_from name of the current encoding
1627 v:charconvert_to name of the desired encoding
1628 v:fname_in name of the input file
1629 v:fname_out name of the output file
1630 Note that v:fname_in and v:fname_out will never be the same.
1631 Note that v:charconvert_from and v:charconvert_to may be different
1632 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001633
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001634 The advantage of using a function call without arguments is that it is
1635 faster, see |expr-option-function|.
1636
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 Encryption is not done by Vim when using 'charconvert'. If you want
1638 to encrypt the file after conversion, 'charconvert' should take care
1639 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001640
1641 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1642 replaced with the script ID (|local-function|). Example: >
1643 set charconvert=s:MyConvert()
1644 set charconvert=<SID>SomeConvert()
1645< Otherwise the expression is evaluated in the context of the script
1646 where the option was set, thus script-local items are available.
1647
Bram Moolenaar071d4272004-06-13 20:20:40 +00001648 This option cannot be set from a |modeline| or in the |sandbox|, for
1649 security reasons.
1650
1651 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1652'cindent' 'cin' boolean (default off)
1653 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001654 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655 that trigger reindenting in insert mode and 'cinoptions' to set your
1656 preferred indent style.
1657 If 'indentexpr' is not empty, it overrules 'cindent'.
1658 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1659 the "=" operator indents using this algorithm rather than calling an
1660 external program.
1661 See |C-indenting|.
1662 When you don't like the way 'cindent' works, try the 'smartindent'
1663 option or 'indentexpr'.
1664 This option is not used when 'paste' is set.
1665 NOTE: This option is reset when 'compatible' is set.
1666
1667 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001668'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670 A list of keys that, when typed in Insert mode, cause reindenting of
1671 the current line. Only used if 'cindent' is on and 'indentexpr' is
1672 empty.
1673 For the format of this option see |cinkeys-format|.
1674 See |C-indenting|.
1675
1676 *'cinoptions'* *'cino'*
1677'cinoptions' 'cino' string (default "")
1678 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1680 program. See |cinoptions-values| for the values of this option, and
1681 |C-indenting| for info on C indenting in general.
1682
1683
1684 *'cinwords'* *'cinw'*
1685'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1686 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687 These keywords start an extra indent in the next line when
1688 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1689 an appropriate place (inside {}).
1690 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1691 matter, include the keyword both the uppercase and lowercase:
1692 "if,If,IF".
1693
Tom Praschan3506cf32022-04-07 12:39:08 +01001694 *'cinscopedecls'* *'cinsd'*
1695'cinscopedecls' 'cinsd' string (default "public,protected,private")
1696 local to buffer
Tom Praschan3506cf32022-04-07 12:39:08 +01001697 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1698 Useful e.g. for working with the Qt framework that defines additional
1699 scope declarations "signals", "public slots" and "private slots": >
1700 set cinscopedecls+=signals,public\ slots,private\ slots
1701
1702< *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001703'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1704 for X-windows, "" otherwise)
1705 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706 {only in GUI versions or when the |+xterm_clipboard|
1707 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001708 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001709 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001710 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001711 prepend, e.g.: >
1712 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001713< When using the GUI see |'go-A'|.
1714 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001716 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 unnamed When included, Vim will use the clipboard register '*'
1718 for all yank, delete, change and put operations which
1719 would normally go to the unnamed register. When a
1720 register is explicitly specified, it will always be
1721 used regardless of whether "unnamed" is in 'clipboard'
1722 or not. The clipboard register can always be
1723 explicitly accessed using the "* notation. Also see
1724 |gui-clipboard|.
1725
Bram Moolenaar30b65812012-07-12 22:01:11 +02001726 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001727 unnamedplus A variant of the "unnamed" flag which uses the
1728 clipboard register '+' (|quoteplus|) instead of
1729 register '*' for all yank, delete, change and put
1730 operations which would normally go to the unnamed
1731 register. When "unnamed" is also included to the
1732 option, yank operations (but not delete, change or
1733 put) will additionally copy the text into register
1734 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001735 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001736 Availability can be checked with: >
1737 if has('unnamedplus')
1738<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001739 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740 autoselect Works like the 'a' flag in 'guioptions': If present,
1741 then whenever Visual mode is started, or the Visual
1742 area extended, Vim tries to become the owner of the
1743 windowing system's global selection or put the
1744 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001745 register "*. See |'go-a'| and |quotestar| for details.
1746 When the GUI is active, the 'a' flag in 'guioptions'
1747 is used, when the GUI is not active, this "autoselect"
1748 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749 Also applies to the modeless selection.
1750
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001751 *clipboard-autoselectplus*
1752 autoselectplus Like "autoselect" but using the + register instead of
1753 the * register. Compare to the 'P' flag in
1754 'guioptions'.
1755
1756 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757 autoselectml Like "autoselect", but for the modeless selection
1758 only. Compare to the 'A' flag in 'guioptions'.
1759
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001760 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001761 html When the clipboard contains HTML, use this when
1762 pasting. When putting text on the clipboard, mark it
1763 as HTML. This works to copy rendered HTML from
1764 Firefox, paste it as raw HTML in Vim, select the HTML
1765 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001766 You probably want to add this only temporarily,
1767 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001768 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001769
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001770 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771 exclude:{pattern}
1772 Defines a pattern that is matched against the name of
1773 the terminal 'term'. If there is a match, no
1774 connection will be made to the X server. This is
1775 useful in this situation:
1776 - Running Vim in a console.
1777 - $DISPLAY is set to start applications on another
1778 display.
1779 - You do not want to connect to the X server in the
1780 console, but do want this in a terminal emulator.
1781 To never connect to the X server use: >
1782 exclude:.*
1783< This has the same effect as using the |-X| argument.
1784 Note that when there is no connection to the X server
1785 the window title won't be restored and the clipboard
1786 cannot be accessed.
1787 The value of 'magic' is ignored, {pattern} is
1788 interpreted as if 'magic' was on.
1789 The rest of the option value will be used for
1790 {pattern}, this must be the last entry.
1791
1792 *'cmdheight'* *'ch'*
1793'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001794 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001795 Number of screen lines to use for the command-line. A larger value
1796 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001797 The value of this option is stored with the tab page, so that each tab
1798 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799
1800 *'cmdwinheight'* *'cwh'*
1801'cmdwinheight' 'cwh' number (default 7)
1802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803 Number of screen lines to use for the command-line window. |cmdwin|
1804
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001805 *'colorcolumn'* *'cc'*
1806'colorcolumn' 'cc' string (default "")
1807 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001808 {not available when compiled without the |+syntax|
1809 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001810 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001811 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1812 text. Will make screen redrawing slower.
1813 The screen column can be an absolute number, or a number preceded with
1814 '+' or '-', which is added to or subtracted from 'textwidth'. >
1815
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001816 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001817 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1818 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1819<
1820 When 'textwidth' is zero then the items with '-' and '+' are not used.
1821 A maximum of 256 columns are highlighted.
1822
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 *'columns'* *'co'* *E594*
1824'columns' 'co' number (default 80 or terminal width)
1825 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001827 initialization and does not have to be set by hand. Also see
1828 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 When Vim is running in the GUI or in a resizable window, setting this
1830 option will cause the window size to be changed. When you only want
1831 to use the size for the GUI, put the command in your |gvimrc| file.
1832 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001833 number of columns of the display, the display may be messed up. For
1834 the GUI it is always possible and Vim limits the number of columns to
1835 what fits on the screen. You can use this command to get the widest
1836 window possible: >
1837 :set columns=9999
1838< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839
1840 *'comments'* *'com'* *E524* *E525*
1841'comments' 'com' string (default
1842 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1843 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001844 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001845 |format-comments|. See |option-backslash| about using backslashes to
1846 insert a space.
1847
1848 *'commentstring'* *'cms'* *E537*
1849'commentstring' 'cms' string (default "/*%s*/")
1850 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001851 {not available when compiled without the |+folding|
1852 feature}
1853 A template for a comment. The "%s" in the value is replaced with the
1854 comment text. Currently only used to add markers for folding, see
1855 |fold-marker|.
1856
1857 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001858'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001859 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861 This option has the effect of making Vim either more Vi-compatible, or
1862 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001863
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001865 other options are also changed as a side effect.
1866 NOTE: Setting or resetting this option can have a lot of unexpected
1867 effects: Mappings are interpreted in another way, undo behaves
1868 differently, etc. If you set this option in your vimrc file, you
1869 should probably put it at the very start.
1870
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871 By default this option is on and the Vi defaults are used for the
1872 options. This default was chosen for those people who want to use Vim
1873 just like Vi, and don't even (want to) know about the 'compatible'
1874 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001875 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001876 this option is switched off, and all options that have not been
1877 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001878 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001879 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001880 happen for the system-wide vimrc or gvimrc file, nor for a file given
1881 with the |-u| argument). Also see |compatible-default| and
1882 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883 You can also set this option with the "-C" argument, and reset it with
1884 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001885 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886
Bram Moolenaar214641f2017-03-05 17:04:09 +01001887 When this option is set, numerous other options are set to make Vim as
1888 Vi-compatible as possible. When this option is unset, various options
1889 are set to make Vim more useful. The table below lists all the
1890 options affected.
1891 The {?} column indicates when the options are affected:
1892 + Means that the option is set to the value given in {set value} when
1893 'compatible' is set.
1894 & Means that the option is set to the value given in {set value} when
1895 'compatible' is set AND is set to its Vim default value when
1896 'compatible' is unset.
1897 - Means the option is NOT changed when setting 'compatible' but IS
1898 set to its Vim default when 'compatible' is unset.
1899 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001900
Bram Moolenaar036986f2017-03-16 17:41:02 +01001901 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001902
1903 'allowrevins' + off no CTRL-_ command
1904 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001905 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001906 'arabicshape' + on correct character shapes
1907 'backspace' + "" normal backspace
1908 'backup' + off no backup file
1909 'backupcopy' & Unix: "yes" backup file is a copy
1910 else: "auto" copy or rename backup file
1911 'balloonexpr' + "" text to show in evaluation balloon
1912 'breakindent' + off don't indent when wrapping lines
1913 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001914 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001915 'cindent' + off no C code indentation
1916 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1917 'copyindent' + off don't copy indent structure
1918 'cpoptions' & (all flags) Vi-compatible flags
1919 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001920 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001921 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001922 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001923 'cscopeverbose' + off see |cscopeverbose|
1924 'delcombine' + off unicode: delete whole char combination
1925 'digraph' + off no digraphs
1926 'esckeys' & off no <Esc>-keys in Insert mode
1927 'expandtab' + off tabs not expanded to spaces
1928 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001929 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001930 'formatexpr' + "" use 'formatprg' for auto-formatting
1931 'formatoptions' & "vt" Vi compatible formatting
1932 'gdefault' + off no default 'g' flag for ":s"
1933 'history' & 0 no commandline history
1934 'hkmap' + off no Hebrew keyboard mapping
1935 'hkmapp' + off no phonetic Hebrew keyboard mapping
1936 'hlsearch' + off no highlighting of search matches
1937 'incsearch' + off no incremental searching
1938 'indentexpr' + "" no indenting by expression
1939 'insertmode' + off do not start in Insert mode
1940 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001941 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001942 'joinspaces' + on insert 2 spaces after period
1943 'modeline' & off no modelines
1944 'more' & off no pauses in listings
1945 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1946 'numberwidth' & 8 min number of columns for line number
1947 'preserveindent'+ off don't preserve current indent structure
1948 when changing it
1949 'revins' + off no reverse insert
1950 'ruler' + off no ruler
1951 'scrolljump' + 1 no jump scroll
1952 'scrolloff' + 0 no scroll offset
1953 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1954 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001955 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001956 'showcmd' & off command characters not shown
1957 'showmode' & off current mode not shown
1958 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1959 'smartcase' + off no automatic ignore case switch
1960 'smartindent' + off no smart indentation
1961 'smarttab' + off no smart tab size
1962 'softtabstop' + 0 tabs are always 'tabstop' positions
1963 'startofline' + on goto startofline with some commands
1964 'tagcase' & "followic" 'ignorecase' when searching tags file
1965 'tagrelative' & off tag file names are not relative
1966 'termguicolors' + off don't use highlight-(guifg|guibg)
1967 'textauto' & off no automatic textmode detection
1968 'textwidth' + 0 no automatic line wrap
1969 'tildeop' + off tilde is not an operator
1970 'ttimeout' + off no terminal timeout
1971 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001972 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001973 'virtualedit' + "" cursor can only be placed on characters
1974 'whichwrap' & "" left-right movements don't wrap
1975 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001977 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001978
1979 *'complete'* *'cpt'* *E535*
1980'complete' 'cpt' string (default: ".,w,b,u,t,i")
1981 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982 This option specifies how keyword completion |ins-completion| works
1983 when CTRL-P or CTRL-N are used. It is also used for whole-line
1984 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001985 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001986 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001987 w scan buffers from other windows
1988 b scan other loaded buffers that are in the buffer list
1989 u scan the unloaded buffers that are in the buffer list
1990 U scan the buffers that are not in the buffer list
1991 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001992 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993 k{dict} scan the file {dict}. Several "k" flags can be given,
1994 patterns are valid too. For example: >
1995 :set cpt=k/usr/dict/*,k~/spanish
1996< s scan the files given with the 'thesaurus' option
1997 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1998 are valid too.
1999 i scan current and included files
2000 d scan current and included files for defined name or macro
2001 |i_CTRL-X_CTRL-D|
2002 ] tag completion
2003 t same as "]"
2004
2005 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2006 not executed, this may lead to unexpected completions from some files
2007 (gzipped files for example). Unloaded buffers are not scanned for
2008 whole-line completion.
2009
2010 The default is ".,w,b,u,t,i", which means to scan:
2011 1. the current buffer
2012 2. buffers in other windows
2013 3. other loaded buffers
2014 4. unloaded buffers
2015 5. tags
2016 6. included files
2017
2018 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002019 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2020 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002022 *'completefunc'* *'cfu'*
2023'completefunc' 'cfu' string (default: empty)
2024 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002025 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002026 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002027 This option specifies a function to be used for Insert mode completion
2028 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002029 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002030 invoked and what it should return. The value can be the name of a
2031 function, a |lambda| or a |Funcref|. See |option-value-function| for
2032 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002033 This option cannot be set from a |modeline| or in the |sandbox|, for
2034 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002035
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002036 *'completeslash'* *'csl'*
2037'completeslash' 'csl' string (default: "")
2038 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002039 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002040 When this option is set it overrules 'shellslash' for completion:
2041 - When this option is set to "slash", a forward slash is used for path
2042 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002043 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002044 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002045 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002046 - When this option is empty, same character is used as for
2047 'shellslash'.
2048 For Insert mode completion the buffer-local value is used. For
2049 command line completion the global value is used.
2050
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002051 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002052'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002053 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002054 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002055 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002056
2057 menu Use a popup menu to show the possible completions. The
2058 menu is only shown when there is more than one match and
2059 sufficient colors are available. |ins-completion-menu|
2060
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002061 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002062 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002063 match, e.g., what file it comes from.
2064
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002065 longest Only insert the longest common text of the matches. If
2066 the menu is displayed you can use CTRL-L to add more
2067 characters. Whether case is ignored depends on the kind
2068 of completion. For buffer text the 'ignorecase' option is
2069 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002070
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002071 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002072 completion in the preview window. Only works in
2073 combination with "menu" or "menuone".
2074
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002075 popup Show extra information about the currently selected
2076 completion in a popup window. Only works in combination
2077 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002078 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002079 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002080
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002081 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002082 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002083 |CompleteChanged| autocommand to fetch the info and call
2084 |popup_show()| once the popup has been filled.
2085 See the example at |complete-popuphidden|.
2086 {only works when compiled with the |+textprop| feature}
2087
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002088 noinsert Do not insert any text for a match until the user selects
2089 a match from the menu. Only works in combination with
2090 "menu" or "menuone". No effect if "longest" is present.
2091
2092 noselect Do not select a match in the menu, force the user to
2093 select one from the menu. Only works in combination with
2094 "menu" or "menuone".
2095
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002096
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002097 *'completepopup'* *'cpp'*
2098'completepopup' 'cpp' string (default empty)
2099 global
2100 {not available when compiled without the |+textprop|
2101 or |+quickfix| feature}
2102 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002103 properties of the info popup when it is created. If an info popup
2104 window already exists it is closed, so that the option value is
2105 applied when it is created again.
2106 You can also use |popup_findinfo()| and then set properties for an
2107 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002108
2109
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002110 *'concealcursor'* *'cocu'*
2111'concealcursor' 'cocu' string (default: "")
2112 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002113 {not available when compiled without the |+conceal|
2114 feature}
2115 Sets the modes in which text in the cursor line can also be concealed.
2116 When the current mode is listed then concealing happens just like in
2117 other lines.
2118 n Normal mode
2119 v Visual mode
2120 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002121 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002122
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002123 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002124 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002125 are moving around text is concealed, but when starting to insert text
2126 or selecting a Visual area the concealed text is displayed, so that
2127 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002128 Keep in mind that the cursor position is not always where it's
2129 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002130
2131
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002132 *'conceallevel'* *'cole'*
2133'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002134 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002135 {not available when compiled without the |+conceal|
2136 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002137 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2138 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002139
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002140 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002141 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002142 1 Each block of concealed text is replaced with one
2143 character. If the syntax item does not have a custom
2144 replacement character defined (see |:syn-cchar|) the
2145 character defined in 'listchars' is used (default is a
2146 space).
2147 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002148 2 Concealed text is completely hidden unless it has a
2149 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002150 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002151 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002152
Bram Moolenaara7781e02010-07-19 20:13:22 +02002153 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002154 edit and copy the text. This can be changed with the 'concealcursor'
2155 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002156
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2158'confirm' 'cf' boolean (default off)
2159 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160 When 'confirm' is on, certain operations that would normally
2161 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2162 instead raise a |dialog| asking if you wish to save the current
2163 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2164 If 'confirm' is off you can still activate confirmation for one
2165 command only (this is most useful in mappings) with the |:confirm|
2166 command.
2167 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2168
2169 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2170'conskey' 'consk' boolean (default off)
2171 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002172 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002173
2174 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2175'copyindent' 'ci' boolean (default off)
2176 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 Copy the structure of the existing lines indent when autoindenting a
2178 new line. Normally the new indent is reconstructed by a series of
2179 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2180 in which case only spaces are used). Enabling this option makes the
2181 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002182 existing line. 'expandtab' has no effect on these characters, a Tab
2183 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002185 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186 Also see 'preserveindent'.
2187
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002188 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189'cpoptions' 'cpo' string (Vim default: "aABceFs",
2190 Vi default: all flags)
2191 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002193 this indicates Vi-compatible behavior. This is used for things where
2194 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002195 'cpoptions' stands for "compatible-options".
2196 Commas can be added for readability.
2197 To avoid problems with flags that are added in the future, use the
2198 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002199
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200 NOTE: This option is set to the Vi default value when 'compatible' is
2201 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002202
2203 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2204 is saved, 'cpoptions' is set to the Vim default, and the saved value
2205 is restored at the end of the script. Changes to the value of
2206 'cpoptions' will be applied to the saved value, but keep in mind that
2207 removing a flag that is not present when 'cpoptions' is changed has no
2208 effect. In the |.vimrc| file the value is not restored, thus using
2209 `vim9script` in the |.vimrc| file results in using the Vim default.
2210
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002211 NOTE: This option is set to the POSIX default value at startup when
2212 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002213 variable exists |posix|. This means Vim tries to behave like the
2214 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215
2216 contains behavior ~
2217 *cpo-a*
2218 a When included, a ":read" command with a file name
2219 argument will set the alternate file name for the
2220 current window.
2221 *cpo-A*
2222 A When included, a ":write" command with a file name
2223 argument will set the alternate file name for the
2224 current window.
2225 *cpo-b*
2226 b "\|" in a ":map" command is recognized as the end of
2227 the map command. The '\' is included in the mapping,
2228 the text after the '|' is interpreted as the next
2229 command. Use a CTRL-V instead of a backslash to
2230 include the '|' in the mapping. Applies to all
2231 mapping, abbreviation, menu and autocmd commands.
2232 See also |map_bar|.
2233 *cpo-B*
2234 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002235 abbreviations, user commands and the "to" part of the
2236 menu commands. Remove this flag to be able to use a
2237 backslash like a CTRL-V. For example, the command
2238 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 'B' included: "\^[" (^[ is a real <Esc>)
2240 'B' excluded: "<Esc>" (5 characters)
2241 ('<' excluded in both cases)
2242 *cpo-c*
2243 c Searching continues at the end of any match at the
2244 cursor position, but not further than the start of the
2245 next line. When not present searching continues
2246 one character from the cursor position. With 'c'
2247 "abababababab" only gets three matches when repeating
2248 "/abab", without 'c' there are five matches.
2249 *cpo-C*
2250 C Do not concatenate sourced lines that start with a
2251 backslash. See |line-continuation|.
2252 *cpo-d*
2253 d Using "./" in the 'tags' option doesn't mean to use
2254 the tags file relative to the current file, but the
2255 tags file in the current directory.
2256 *cpo-D*
2257 D Can't use CTRL-K to enter a digraph after Normal mode
2258 commands with a character argument, like |r|, |f| and
2259 |t|.
2260 *cpo-e*
2261 e When executing a register with ":@r", always add a
2262 <CR> to the last line, also when the register is not
2263 linewise. If this flag is not present, the register
2264 is not linewise and the last line does not end in a
2265 <CR>, then the last line is put on the command-line
2266 and can be edited before hitting <CR>.
2267 *cpo-E*
2268 E It is an error when using "y", "d", "c", "g~", "gu" or
2269 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002270 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002271 This makes "y0" fail in the first column.
2272 *cpo-f*
2273 f When included, a ":read" command with a file name
2274 argument will set the file name for the current buffer,
2275 if the current buffer doesn't have a file name yet.
2276 *cpo-F*
2277 F When included, a ":write" command with a file name
2278 argument will set the file name for the current
2279 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002280 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002281 *cpo-g*
2282 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002283 *cpo-H*
2284 H When using "I" on a line with only blanks, insert
2285 before the last blank. Without this flag insert after
2286 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287 *cpo-i*
2288 i When included, interrupting the reading of a file will
2289 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002290 *cpo-I*
2291 I When moving the cursor up or down just after inserting
2292 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293 *cpo-j*
2294 j When joining lines, only add two spaces after a '.',
2295 not after '!' or '?'. Also see 'joinspaces'.
2296 *cpo-J*
2297 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002298 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002299 white space.
2300 *cpo-k*
2301 k Disable the recognition of raw key codes in
2302 mappings, abbreviations, and the "to" part of menu
2303 commands. For example, if <Key> sends ^[OA (where ^[
2304 is <Esc>), the command ":map X ^[OA" results in X
2305 being mapped to:
2306 'k' included: "^[OA" (3 characters)
2307 'k' excluded: "<Key>" (one key code)
2308 Also see the '<' flag below.
2309 *cpo-K*
2310 K Don't wait for a key code to complete when it is
2311 halfway a mapping. This breaks mapping <F1><F1> when
2312 only part of the second <F1> has been read. It
2313 enables cancelling the mapping by typing <F1><Esc>.
2314 *cpo-l*
2315 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002316 literally, only "\]", "\^", "\-" and "\\" are special.
2317 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2319 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002320 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002321 *cpo-L*
2322 L When the 'list' option is set, 'wrapmargin',
2323 'textwidth', 'softtabstop' and Virtual Replace mode
2324 (see |gR|) count a <Tab> as two characters, instead of
2325 the normal behavior of a <Tab>.
2326 *cpo-m*
2327 m When included, a showmatch will always wait half a
2328 second. When not included, a showmatch will wait half
2329 a second or until a character is typed. |'showmatch'|
2330 *cpo-M*
2331 M When excluded, "%" matching will take backslashes into
2332 account. Thus in "( \( )" and "\( ( \)" the outer
2333 parenthesis match. When included "%" ignores
2334 backslashes, which is Vi compatible.
2335 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002336 n When included, the column used for 'number' and
2337 'relativenumber' will also be used for text of wrapped
2338 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339 *cpo-o*
2340 o Line offset to search command is not remembered for
2341 next search.
2342 *cpo-O*
2343 O Don't complain if a file is being overwritten, even
2344 when it didn't exist when editing it. This is a
2345 protection against a file unexpectedly created by
2346 someone else. Vi didn't complain about this.
2347 *cpo-p*
2348 p Vi compatible Lisp indenting. When not present, a
2349 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002350 *cpo-P*
2351 P When included, a ":write" command that appends to a
2352 file will set the file name for the current buffer, if
2353 the current buffer doesn't have a file name yet and
2354 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002355 *cpo-q*
2356 q When joining multiple lines leave the cursor at the
2357 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358 *cpo-r*
2359 r Redo ("." command) uses "/" to repeat a search
2360 command, instead of the actually used search string.
2361 *cpo-R*
2362 R Remove marks from filtered lines. Without this flag
2363 marks are kept like |:keepmarks| was used.
2364 *cpo-s*
2365 s Set buffer options when entering the buffer for the
2366 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002367 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368 set when the buffer is created.
2369 *cpo-S*
2370 S Set buffer options always when entering a buffer
2371 (except 'readonly', 'fileformat', 'filetype' and
2372 'syntax'). This is the (most) Vi compatible setting.
2373 The options are set to the values in the current
2374 buffer. When you change an option and go to another
2375 buffer, the value is copied. Effectively makes the
2376 buffer options global to all buffers.
2377
2378 's' 'S' copy buffer options
2379 no no when buffer created
2380 yes no when buffer first entered (default)
2381 X yes each time when buffer entered (vi comp.)
2382 *cpo-t*
2383 t Search pattern for the tag command is remembered for
2384 "n" command. Otherwise Vim only puts the pattern in
2385 the history for search pattern, but doesn't change the
2386 last used search pattern.
2387 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002388 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389 *cpo-v*
2390 v Backspaced characters remain visible on the screen in
2391 Insert mode. Without this flag the characters are
2392 erased from the screen right away. With this flag the
2393 screen newly typed text overwrites backspaced
2394 characters.
2395 *cpo-w*
2396 w When using "cw" on a blank character, only change one
2397 character and not all blanks until the start of the
2398 next word.
2399 *cpo-W*
2400 W Don't overwrite a readonly file. When omitted, ":w!"
2401 overwrites a readonly file, if possible.
2402 *cpo-x*
2403 x <Esc> on the command-line executes the command-line.
2404 The default in Vim is to abandon the command-line,
2405 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002406 *cpo-X*
2407 X When using a count with "R" the replaced text is
2408 deleted only once. Also when repeating "R" with "."
2409 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002411 y A yank command can be redone with ".". Think twice if
2412 you really want to use this, it may break some
2413 plugins, since most people expect "." to only repeat a
2414 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002415 *cpo-Z*
2416 Z When using "w!" while the 'readonly' option is set,
2417 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002418 *cpo-!*
2419 ! When redoing a filter command, use the last used
2420 external command, whatever it was. Otherwise the last
2421 used -filter- command is used.
2422 *cpo-$*
2423 $ When making a change to one line, don't redisplay the
2424 line, but put a '$' at the end of the changed text.
2425 The changed text will be overwritten when you type the
2426 new text. The line is redisplayed if you type any
2427 command that moves the cursor from the insertion
2428 point.
2429 *cpo-%*
2430 % Vi-compatible matching is done for the "%" command.
2431 Does not recognize "#if", "#endif", etc.
2432 Does not recognize "/*" and "*/".
2433 Parens inside single and double quotes are also
2434 counted, causing a string that contains a paren to
2435 disturb the matching. For example, in a line like
2436 "if (strcmp("foo(", s))" the first paren does not
2437 match the last one. When this flag is not included,
2438 parens inside single and double quotes are treated
2439 specially. When matching a paren outside of quotes,
2440 everything inside quotes is ignored. When matching a
2441 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002442 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002443 This flag is also used for other features, such as
2444 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002445 *cpo--*
2446 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002447 it would go above the first line or below the last
2448 line. Without it the cursor moves to the first or
2449 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002450 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002451 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002452 *cpo-+*
2453 + When included, a ":write file" command will reset the
2454 'modified' flag of the buffer, even though the buffer
2455 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002456 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002457 * Use ":*" in the same way as ":@". When not included,
2458 ":*" is an alias for ":'<,'>", select the Visual area.
2459 *cpo-<*
2460 < Disable the recognition of special key codes in |<>|
2461 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002462 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002463 ":map X <Tab>" results in X being mapped to:
2464 '<' included: "<Tab>" (5 characters)
2465 '<' excluded: "^I" (^I is a real <Tab>)
2466 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002467 *cpo->*
2468 > When appending to a register, put a line break before
2469 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002470 *cpo-;*
2471 ; When using |,| or |;| to repeat the last |t| search
2472 and the cursor is right in front of the searched
2473 character, the cursor won't move. When not included,
2474 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002475 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002476
2477 POSIX flags. These are not included in the Vi default value, except
2478 when $VIM_POSIX was set on startup. |posix|
2479
2480 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002481 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002482 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002483 *cpo-&*
2484 & When ":preserve" was used keep the swap file when
2485 exiting normally while this buffer is still loaded.
2486 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002487 *cpo-\*
2488 \ Backslash in a [] range in a search pattern is taken
2489 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002490 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2491 '\' excluded: "/[ \-]" finds <Space> and '-'
2492 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002493 *cpo-/*
2494 / When "%" is used as the replacement string in a |:s|
2495 command, use the previous replacement string. |:s%|
2496 *cpo-{*
2497 { The |{| and |}| commands also stop at a "{" character
2498 at the start of a line.
2499 *cpo-.*
2500 . The ":chdir" and ":cd" commands fail if the current
2501 buffer is modified, unless ! is used. Vim doesn't
2502 need this, since it remembers the full path of an
2503 opened file.
2504 *cpo-bar*
2505 | The value of the $LINES and $COLUMNS environment
2506 variables overrule the terminal size values obtained
2507 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002508
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002510 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002511'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002512 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002513 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002514 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002515 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002516 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002517 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002518 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002519 blowfish Blowfish method. Medium strong encryption but it has
2520 an implementation flaw. Requires Vim 7.3 or later,
2521 files can NOT be read by Vim 7.2 and older. This adds
2522 a "seed" to the file, every time you write the file
2523 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002524 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002525 *blowfish2*
2526 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002527 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002528 and older. This adds a "seed" to the file, every time
2529 you write the file the encrypted bytes will be
2530 different. The whole undo file is encrypted, not just
2531 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002532 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002533 *E1197* *E1198* *E1199* *E1200* *E1201*
2534 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2535 Code. Medium strong till strong encryption.
2536 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002537 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002538 It adds a seed and a message authentication code (MAC)
2539 to the file. This needs at least a Vim 8.2.3022 to
2540 read the encrypted file.
2541 Encryption of swap files is not supported, therefore
2542 no swap file will be used when xchacha20 encryption is
2543 enabled.
2544 Encryption of undo files is not yet supported,
2545 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002546 CAREFUL: Files written with this method might have to
2547 be read back with the same version of Vim if the
2548 binary format changes later.
2549 Obsolete, please do no longer use.
2550 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2551 stores the key derivation parameters together with the
2552 encrypted file. Should work better in case the
2553 parameters in the libsodium library ever change.
2554 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002555 might have to be read back with the same version of
2556 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002557
Christian Brabandtaae58342023-04-23 17:50:22 +01002558 You should use "blowfish2", also to re-encrypt older files. The
2559 "xchacha20" method provides better encryption, but it does not work
2560 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002561
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002562 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002563 to the detected method of the file being read. Thus if you write it
2564 without changing 'cryptmethod' the same method will be used.
2565 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002566 explicitly write it, you don't get a warning unless there are other
2567 modifications. Also see |:X|.
2568
2569 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002570 the value "blowfish2". When setting the local value to an empty
2571 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002572
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002573 When a new encryption method is added in a later version of Vim, and
2574 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002575 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002576
2577
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 *'cscopepathcomp'* *'cspc'*
2579'cscopepathcomp' 'cspc' number (default 0)
2580 global
2581 {not available when compiled without the |+cscope|
2582 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 Determines how many components of the path to show in a list of tags.
2584 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002585 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586
2587 *'cscopeprg'* *'csprg'*
2588'cscopeprg' 'csprg' string (default "cscope")
2589 global
2590 {not available when compiled without the |+cscope|
2591 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002592 Specifies the command to execute cscope. See |cscopeprg|.
2593 This option cannot be set from a |modeline| or in the |sandbox|, for
2594 security reasons.
2595
2596 *'cscopequickfix'* *'csqf'*
2597'cscopequickfix' 'csqf' string (default "")
2598 global
2599 {not available when compiled without the |+cscope|
2600 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002601 Specifies whether to use quickfix window to show cscope results.
2602 See |cscopequickfix|.
2603
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002604 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002605'cscoperelative' 'csre' boolean (default off)
2606 global
2607 {not available when compiled without the |+cscope|
2608 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002609 In the absence of a prefix (-P) for cscope. setting this option enables
2610 to use the basename of cscope.out path as the prefix.
2611 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002612 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002613
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2615'cscopetag' 'cst' boolean (default off)
2616 global
2617 {not available when compiled without the |+cscope|
2618 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002619 Use cscope for tag commands. See |cscope-options|.
2620 NOTE: This option is reset when 'compatible' is set.
2621
2622 *'cscopetagorder'* *'csto'*
2623'cscopetagorder' 'csto' number (default 0)
2624 global
2625 {not available when compiled without the |+cscope|
2626 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002627 Determines the order in which ":cstag" performs a search. See
2628 |cscopetagorder|.
2629 NOTE: This option is set to 0 when 'compatible' is set.
2630
2631 *'cscopeverbose'* *'csverb'*
2632 *'nocscopeverbose'* *'nocsverb'*
2633'cscopeverbose' 'csverb' boolean (default off)
2634 global
2635 {not available when compiled without the |+cscope|
2636 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 Give messages when adding a cscope database. See |cscopeverbose|.
2638 NOTE: This option is reset when 'compatible' is set.
2639
Bram Moolenaar860cae12010-06-05 23:22:07 +02002640 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2641'cursorbind' 'crb' boolean (default off)
2642 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002643 When this option is set, as the cursor in the current
2644 window moves other cursorbound windows (windows that also have
2645 this option set) move their cursors to the corresponding line and
2646 column. This option is useful for viewing the
2647 differences between two versions of a file (see 'diff'); in diff mode,
2648 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002649 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002650
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002651
2652 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2653'cursorcolumn' 'cuc' boolean (default off)
2654 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002655 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002656 feature}
2657 Highlight the screen column of the cursor with CursorColumn
2658 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2659 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002660 If you only want the highlighting in the current window you can use
2661 these autocommands: >
2662 au WinLeave * set nocursorline nocursorcolumn
2663 au WinEnter * set cursorline cursorcolumn
2664<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002665
2666 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2667'cursorline' 'cul' boolean (default off)
2668 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002669 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002670 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002671 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2672 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002673 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002674 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002675
2676
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002677 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002678'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002679 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002680 {not available when compiled without the |+syntax|
2681 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002682 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002683 Valid values:
2684 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002685 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002686 "screenline" Highlight only the screen line of the cursor with
2687 CursorLine |hl-CursorLine|.
2688 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002689 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002690
2691 Special value:
2692 "both" Alias for the values "line,number".
2693
2694 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002695
2696
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 *'debug'*
2698'debug' string (default "")
2699 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002700 These values can be used:
2701 msg Error messages that would otherwise be omitted will be given
2702 anyway.
2703 throw Error messages that would otherwise be omitted will be given
2704 anyway and also throw an exception and set |v:errmsg|.
2705 beep A message will be given when otherwise only a beep would be
2706 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002707 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002708 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2709 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710
2711 *'define'* *'def'*
2712'define' 'def' string (default "^\s*#\s*define")
2713 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002714 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 pattern, just like for the "/" command. This option is used for the
2716 commands like "[i" and "[d" |include-search|. The 'isident' option is
2717 used to recognize the defined name after the match:
2718 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2719 See |option-backslash| about inserting backslashes to include a space
2720 or backslash.
2721 The default value is for C programs. For C++ this value would be
2722 useful, to include const type declarations: >
2723 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002724< You can also use "\ze" just before the name and continue the pattern
2725 to check what is following. E.g. for Javascript, if a function is
2726 defined with "func_name = function(args)": >
2727 ^\s*\ze\i\+\s*=\s*function(
2728< If the function is defined with "func_name : function() {...": >
2729 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002731 To avoid that use `:let` with a single quote string: >
2732 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002733<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002734
2735 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2736'delcombine' 'deco' boolean (default off)
2737 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738 If editing Unicode and this option is set, backspace and Normal mode
2739 "x" delete each combining character on its own. When it is off (the
2740 default) the character along with its combining characters are
2741 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002742 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743
2744 This is useful for Arabic, Hebrew and many other languages where one
2745 may have combining characters overtop of base characters, and want
2746 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002747 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748
2749 *'dictionary'* *'dict'*
2750'dictionary' 'dict' string (default "")
2751 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 List of file names, separated by commas, that are used to lookup words
2753 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2754 contain a list of words. This can be one word per line, or several
2755 words per line, separated by non-keyword characters (white space is
2756 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002757
2758 When this option is empty or an entry "spell" is present, and spell
2759 checking is enabled, words in the word lists for the currently active
2760 'spelllang' are used. See |spell|.
2761
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002762 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 after a comma are ignored, otherwise spaces are included in the file
2764 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002765 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 Where to find a list of words?
2767 - On FreeBSD, there is the file "/usr/share/dict/words".
2768 - In the Simtel archive, look in the "msdos/linguist" directory.
2769 - In "miscfiles" of the GNU collection.
2770 The use of |:set+=| and |:set-=| is preferred when adding or removing
2771 directories from the list. This avoids problems when a future version
2772 uses another default.
2773 Backticks cannot be used in this option for security reasons.
2774
2775 *'diff'* *'nodiff'*
2776'diff' boolean (default off)
2777 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 {not available when compiled without the |+diff|
2779 feature}
2780 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002781 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782
2783 *'dex'* *'diffexpr'*
2784'diffexpr' 'dex' string (default "")
2785 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786 {not available when compiled without the |+diff|
2787 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002788 Expression which is evaluated to obtain a diff file (either ed-style
2789 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790 This option cannot be set from a |modeline| or in the |sandbox|, for
2791 security reasons.
2792
2793 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002794'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796 {not available when compiled without the |+diff|
2797 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002798 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799 All are optional. Items must be separated by a comma.
2800
2801 filler Show filler lines, to keep the text
2802 synchronized with a window that has inserted
2803 lines at the same position. Mostly useful
2804 when windows are side-by-side and 'scrollbind'
2805 is set.
2806
2807 context:{n} Use a context of {n} lines between a change
2808 and a fold that contains unchanged lines.
2809 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002810 When using zero the context is actually one,
2811 since folds require a line in between, also
2812 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002813 See |fold-diff|.
2814
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002815 iblank Ignore changes where lines are all blank. Adds
2816 the "-B" flag to the "diff" command if
2817 'diffexpr' is empty. Check the documentation
2818 of the "diff" command for what this does
2819 exactly.
2820 NOTE: the diff windows will get out of sync,
2821 because no differences between blank lines are
2822 taken into account.
2823
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824 icase Ignore changes in case of text. "a" and "A"
2825 are considered the same. Adds the "-i" flag
2826 to the "diff" command if 'diffexpr' is empty.
2827
2828 iwhite Ignore changes in amount of white space. Adds
2829 the "-b" flag to the "diff" command if
2830 'diffexpr' is empty. Check the documentation
2831 of the "diff" command for what this does
2832 exactly. It should ignore adding trailing
2833 white space, but not leading white space.
2834
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002835 iwhiteall Ignore all white space changes. Adds
2836 the "-w" flag to the "diff" command if
2837 'diffexpr' is empty. Check the documentation
2838 of the "diff" command for what this does
2839 exactly.
2840
2841 iwhiteeol Ignore white space changes at end of line.
2842 Adds the "-Z" flag to the "diff" command if
2843 'diffexpr' is empty. Check the documentation
2844 of the "diff" command for what this does
2845 exactly.
2846
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002847 horizontal Start diff mode with horizontal splits (unless
2848 explicitly specified otherwise).
2849
2850 vertical Start diff mode with vertical splits (unless
2851 explicitly specified otherwise).
2852
Bram Moolenaarc8234772019-11-10 21:00:27 +01002853 closeoff When a window is closed where 'diff' is set
2854 and there is only one window remaining in the
2855 same tab page with 'diff' set, execute
2856 `:diffoff` in that window. This undoes a
2857 `:diffsplit` command.
2858
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002859 hiddenoff Do not use diff mode for a buffer when it
2860 becomes hidden.
2861
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002862 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2863 starting diff mode. Without this 2 is used.
2864
Bram Moolenaar4223d432021-02-10 13:18:17 +01002865 followwrap Follow the 'wrap' option and leave as it is.
2866
Bram Moolenaare828b762018-09-10 17:51:58 +02002867 internal Use the internal diff library. This is
2868 ignored when 'diffexpr' is set. *E960*
2869 When running out of memory when writing a
2870 buffer this item will be ignored for diffs
2871 involving that buffer. Set the 'verbose'
2872 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873
Bram Moolenaare828b762018-09-10 17:51:58 +02002874 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002875 Use the indent heuristic for the internal
2876 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002877
2878 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002879 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002880 algorithms are:
2881 myers the default algorithm
2882 minimal spend extra time to generate the
2883 smallest possible diff
2884 patience patience diff algorithm
2885 histogram histogram diff algorithm
2886
2887 Examples: >
2888 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002890 :set diffopt=internal,filler,foldcolumn:3
2891 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892<
2893 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2894'digraph' 'dg' boolean (default off)
2895 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002896 {not available when compiled without the |+digraphs|
2897 feature}
2898 Enable the entering of digraphs in Insert mode with {char1} <BS>
2899 {char2}. See |digraphs|.
2900 NOTE: This option is reset when 'compatible' is set.
2901
2902 *'directory'* *'dir'*
2903'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002904 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 for Unix: ".,~/tmp,/var/tmp,/tmp")
2906 global
2907 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002908 Recommended value: ".,~/vimswap//" - this will put the swap file next
2909 to the edited file if possible, and in your personal swap directory
2910 otherwise. Make sure "~/vimswap//" is only readable for you.
2911
2912 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913 - The swap file will be created in the first directory where this is
2914 possible.
2915 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002916 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917 - A directory "." means to put the swap file in the same directory as
2918 the edited file. On Unix, a dot is prepended to the file name, so
2919 it doesn't show in a directory listing. On MS-Windows the "hidden"
2920 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002921 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2922 the swap file relative to where the edited file is. The leading "."
2923 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002924 - For Unix and Win32, if a directory ends in two path separators "//",
2925 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002926 with all path separators replaced by percent '%' signs (including
2927 the colon following the drive letter on Win32). This will ensure
2928 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002929 On Win32, it is also possible to end with "\\". However, When a
2930 separating comma is following, you must use "//", since "\\" will
2931 include the comma in the file name. Therefore it is recommended to
2932 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 - Spaces after the comma are ignored, other spaces are considered part
2934 of the directory name. To have a space at the start of a directory
2935 name, precede it with a backslash.
2936 - To include a comma in a directory name precede it with a backslash.
2937 - A directory name may end in an ':' or '/'.
2938 - Environment variables are expanded |:set_env|.
2939 - Careful with '\' characters, type one before a space, type two to
2940 get one in the option (see |option-backslash|), for example: >
2941 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2942< - For backwards compatibility with Vim version 3.0 a '>' at the start
2943 of the option is removed.
2944 Using "." first in the list is recommended. This means that editing
2945 the same file twice will result in a warning. Using "/tmp" on Unix is
2946 discouraged: When the system crashes you lose the swap file.
2947 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002948 choice than "/tmp". But others on the computer may be able to see the
2949 files, and it can contain a lot of files, your swap files get lost in
2950 the crowd. That is why a "tmp" directory in your home directory is
2951 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952 The use of |:set+=| and |:set-=| is preferred when adding or removing
2953 directories from the list. This avoids problems when a future version
2954 uses another default.
2955 This option cannot be set from a |modeline| or in the |sandbox|, for
2956 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957
2958 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002959'display' 'dy' string (default "", set to "truncate" in
2960 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01002962 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 flags:
2964 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002965 in a window will be displayed. "@@@" is put in the
2966 last columns of the last screen line to indicate the
2967 rest of the line is not displayed.
2968 truncate Like "lastline", but "@@@" is displayed in the first
2969 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 uhex Show unprintable characters hexadecimal as <xx>
2971 instead of using ^C and ~C.
2972
Bram Moolenaard0796902016-09-16 20:02:31 +02002973 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002974 doesn't fit is replaced with "@" lines.
2975
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01002976 The "@" character can be changed by setting the "lastline" item in
2977 'fillchars'. The character is highlighted with |hl-NonText|.
2978
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979 *'eadirection'* *'ead'*
2980'eadirection' 'ead' string (default "both")
2981 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982 Tells when the 'equalalways' option applies:
2983 ver vertically, width of windows is not affected
2984 hor horizontally, height of windows is not affected
2985 both width and height of windows is affected
2986
2987 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2988'edcompatible' 'ed' boolean (default off)
2989 global
2990 Makes the 'g' and 'c' flags of the ":substitute" command to be
2991 toggled each time the flag is given. See |complex-change|. See
2992 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002993 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002994 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995
Bram Moolenaar03413f42016-04-12 21:07:15 +02002996 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002997'emoji' 'emo' boolean (default: on)
2998 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002999 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003000 This excludes "text emoji" characters, which are normally displayed as
3001 single width. Unfortunately there is no good specification for this
3002 and it has been determined on trial-and-error basis. Use the
3003 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003004
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003006'encoding' 'enc' string (default for MS-Windows: "utf-8",
3007 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 Sets the character encoding used inside Vim. It applies to text in
3010 the buffers, registers, Strings in expressions, text stored in the
3011 viminfo file, etc. It sets the kind of characters which Vim can work
3012 with. See |encoding-names| for the possible values.
3013
3014 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003015 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003017 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018
Bram Moolenaar865242e2010-07-14 21:12:05 +02003019 This option cannot be set from a |modeline|. It would most likely
3020 corrupt the text.
3021
Bram Moolenaar3df01732017-02-17 22:47:16 +01003022 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3023 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 'encoding', "utf-8" is the natural choice for the environment and
3025 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003026 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003027 versions, and to avoid changing the encoding of newly created files
3028 without your knowledge (in case 'fileencodings' is empty).
3029
3030 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003031 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 iconv() or as specified with 'charconvert'.
3033
Bram Moolenaar207f0092020-08-30 17:20:20 +02003034 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003035 can use: >
3036 if has("multi_byte_encoding")
3037<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 Normally 'encoding' will be equal to your current locale. This will
3039 be the default if Vim recognizes your environment settings. If
3040 'encoding' is not set to the current locale, 'termencoding' must be
3041 set to convert typed and displayed text. See |encoding-table|.
3042
3043 When you set this option, it fires the |EncodingChanged| autocommand
3044 event so that you can set up fonts if necessary.
3045
3046 When the option is set, the value is converted to lowercase. Thus
3047 you can set it with uppercase values too. Underscores are translated
3048 to '-' signs.
3049 When the encoding is recognized, it is changed to the standard name.
3050 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3051 "iso-8859-2" and "utf8" becomes "utf-8".
3052
3053 Note: "latin1" is also used when the encoding could not be detected.
3054 This only works when editing files in the same encoding! When the
3055 actual character set is not latin1, make sure 'fileencoding' and
3056 'fileencodings' are empty. When conversion is needed, switch to using
3057 utf-8.
3058
3059 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3060 You don't notice this while editing, but it does matter for the
3061 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3062 setting 'encoding' to one of these values instead of utf-8 only has
3063 effect for encoding used for files when 'fileencoding' is empty.
3064
Bram Moolenaar661b1822005-07-28 22:36:45 +00003065 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3066 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003068 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003069'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003071 Indicates that a CTRL-Z character was found at the end of the file
3072 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003074 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003075 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003076 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003077
3078 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3079'endofline' 'eol' boolean (default on)
3080 local to buffer
3081 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003082 is on, or 'fixeol' option is off, no <EOL> will be written for the
3083 last line in the file. This option is automatically set or reset when
3084 starting to edit a new file, depending on whether file has an <EOL>
3085 for the last line in the file. Normally you don't have to set or
3086 reset this option.
3087 When 'binary' is off and 'fixeol' is on the value is not used when
3088 writing the file. When 'binary' is on or 'fixeol' is off it is used
3089 to remember the presence of a <EOL> for the last line in the file, so
3090 that when you write the file the situation from the original file can
3091 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003092 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093
3094 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3095'equalalways' 'ea' boolean (default on)
3096 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003098 splitting or closing a window. This also happens the moment the
3099 option is switched on. When off, splitting a window will reduce the
3100 size of the current window and leave the other windows the same. When
3101 closing a window the extra lines are given to the window next to it
3102 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 When mixing vertically and horizontally split windows, a minimal size
3104 is computed and some windows may be larger if there is room. The
3105 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003106 Changing the height and width of a window can be avoided by setting
3107 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003108 If a window size is specified when creating a new window sizes are
3109 currently not equalized (it's complicated, but may be implemented in
3110 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111
3112 *'equalprg'* *'ep'*
3113'equalprg' 'ep' string (default "")
3114 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003116 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003117 or 'indentexpr'. When Vim was compiled without internal formatting,
3118 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003119 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 about including spaces and backslashes.
3121 This option cannot be set from a |modeline| or in the |sandbox|, for
3122 security reasons.
3123
3124 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3125'errorbells' 'eb' boolean (default off)
3126 global
3127 Ring the bell (beep or screen flash) for error messages. This only
3128 makes a difference for error messages, the bell will be used always
3129 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003130 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003131 screen flash or do nothing. See 'belloff' to finetune when to ring the
3132 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133
3134 *'errorfile'* *'ef'*
3135'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3136 others: "errors.err")
3137 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 {not available when compiled without the |+quickfix|
3139 feature}
3140 Name of the errorfile for the QuickFix mode (see |:cf|).
3141 When the "-q" command-line argument is used, 'errorfile' is set to the
3142 following argument. See |-q|.
3143 NOT used for the ":make" command. See 'makeef' for that.
3144 Environment variables are expanded |:set_env|.
3145 See |option-backslash| about including spaces and backslashes.
3146 This option cannot be set from a |modeline| or in the |sandbox|, for
3147 security reasons.
3148
3149 *'errorformat'* *'efm'*
3150'errorformat' 'efm' string (default is very long)
3151 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 {not available when compiled without the |+quickfix|
3153 feature}
3154 Scanf-like description of the format for the lines in the error file
3155 (see |errorformat|).
3156
3157 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3158'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3159 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 Function keys that start with an <Esc> are recognized in Insert
3161 mode. When this option is off, the cursor and function keys cannot be
3162 used in Insert mode if they start with an <Esc>. The advantage of
3163 this is that the single <Esc> is recognized immediately, instead of
3164 after one second. Instead of resetting this option, you might want to
3165 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3166 when 'esckeys' is off, you can still map anything, but the cursor keys
3167 won't work by default.
3168 NOTE: This option is set to the Vi default value when 'compatible' is
3169 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003170 NOTE: when this option is off then the |modifyOtherKeys| functionality
3171 is disabled while in Insert mode to avoid ending Insert mode with any
3172 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173
3174 *'eventignore'* *'ei'*
3175'eventignore' 'ei' string (default "")
3176 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003178 When set to "all" or when "all" is one of the items, all autocommand
3179 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003180 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 :set ei=WinEnter,WinLeave
3182<
3183 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3184'expandtab' 'et' boolean (default off)
3185 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003187 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3189 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003190 This option is reset when the 'paste' option is set and restored when
3191 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 NOTE: This option is reset when 'compatible' is set.
3193
3194 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3195'exrc' 'ex' boolean (default off)
3196 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003198 directory.
3199
3200 Setting this option is a potential security leak. E.g., consider
3201 unpacking a package or fetching files from github, a .vimrc in there
3202 might be a trojan horse. BETTER NOT SET THIS OPTION!
3203 Instead, define an autocommand in your .vimrc to set options for a
3204 matching directory.
3205
3206 If you do switch this option on you should also consider setting the
3207 'secure' option (see |initialization|).
3208 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209 This option cannot be set from a |modeline| or in the |sandbox|, for
3210 security reasons.
3211
3212 *'fileencoding'* *'fenc'* *E213*
3213'fileencoding' 'fenc' string (default: "")
3214 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003216
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003218 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 When 'fileencoding' is empty, the same value as 'encoding' will be
3220 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003221 No error will be given when the value is set, only when it is used,
3222 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003223 Conversion will also be done when 'encoding' and 'fileencoding' are
3224 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3225 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003227 'encoding' is "utf-8" or another Unicode encoding, conversion
3228 is most likely done in a way that the reverse conversion
3229 results in the same text. When 'encoding' is not "utf-8" some
3230 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003231
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 See 'encoding' for the possible values. Additionally, values may be
3233 specified that can be handled by the converter, see
3234 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003235
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 When reading a file 'fileencoding' will be set from 'fileencodings'.
3237 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003238 'fileencoding', use the |++enc| argument. One exception: when
3239 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003240 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003241
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3243 When the option is set, the value is converted to lowercase. Thus
3244 you can set it with uppercase values too. '_' characters are
3245 replaced with '-'. If a name is recognized from the list for
3246 'encoding', it is replaced by the standard name. For example
3247 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003248
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 When this option is set, after starting to edit a file, the 'modified'
3250 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003251
3252 Keep in mind that changing 'fenc' from a modeline happens
3253 AFTER the text has been read, thus it applies to when the file will be
3254 written. If you do set 'fenc' in a modeline, you might want to set
3255 'nomodified' to avoid not being able to ":q".
3256
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 This option can not be changed when 'modifiable' is off.
3258
3259 *'fe'*
3260 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003261 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262 old short name was 'fe', which is no longer used.
3263
3264 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003265'fileencodings' 'fencs' string (default: "ucs-bom",
3266 "ucs-bom,utf-8,default,latin1" when
3267 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 This is a list of character encodings considered when starting to edit
3270 an existing file. When a file is read, Vim tries to use the first
3271 mentioned character encoding. If an error is detected, the next one
3272 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003273 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 an empty string, which means the value of 'encoding' is used.
3275 WARNING: Conversion can cause loss of information! When
3276 'encoding' is "utf-8" (or one of the other Unicode variants)
3277 conversion is most likely done in a way that the reverse
3278 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003279 "utf-8" some non-ASCII characters may be lost! You can use
3280 the |++bad| argument to specify what is done with characters
3281 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 For an empty file or a file with only ASCII characters most encodings
3283 will work and the first entry of 'fileencodings' will be used (except
3284 "ucs-bom", which requires the BOM to be present). If you prefer
3285 another encoding use an BufReadPost autocommand event to test if your
3286 preferred encoding is to be used. Example: >
3287 au BufReadPost * if search('\S', 'w') == 0 |
3288 \ set fenc=iso-2022-jp | endif
3289< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3290 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003291 When the |++enc| argument is used then the value of 'fileencodings' is
3292 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003293 Note that 'fileencodings' is not used for a new file, the global value
3294 of 'fileencoding' is used instead. You can set it with: >
3295 :setglobal fenc=iso-8859-2
3296< This means that a non-existing file may get a different encoding than
3297 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 The special value "ucs-bom" can be used to check for a Unicode BOM
3299 (Byte Order Mark) at the start of the file. It must not be preceded
3300 by "utf-8" or another Unicode encoding for this to work properly.
3301 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3302 because Vim cannot detect an error, thus the encoding is always
3303 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003304 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003305 environment. On MS-Windows this is the system encoding. Otherwise
3306 this is the default value for 'encoding'. It is useful when
3307 'encoding' is set to "utf-8" and your environment uses a non-latin1
3308 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003309 When 'encoding' is "utf-8" and a file contains an illegal byte
3310 sequence it won't be recognized as UTF-8. You can use the |8g8|
3311 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 WRONG VALUES: WHAT'S WRONG:
3313 latin1,utf-8 "latin1" will always be used
3314 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3315 file
3316 cp1250,latin1 "cp1250" will always be used
3317 If 'fileencodings' is empty, 'fileencoding' is not modified.
3318 See 'fileencoding' for the possible values.
3319 Setting this option does not have an effect until the next time a file
3320 is read.
3321
3322 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003323'fileformat' 'ff' string (MS-Windows default: "dos",
3324 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 This gives the <EOL> of the current buffer, which is used for
3327 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003328 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 unix <NL>
3330 mac <CR>
3331 When "dos" is used, CTRL-Z at the end of a file is ignored.
3332 See |file-formats| and |file-read|.
3333 For the character encoding of the file see 'fileencoding'.
3334 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003335 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 This option is set automatically when starting to edit a file and
3337 'fileformats' is not empty and 'binary' is off.
3338 When this option is set, after starting to edit a file, the 'modified'
3339 option is set, because the file would be different when written.
3340 This option can not be changed when 'modifiable' is off.
3341 For backwards compatibility: When this option is set to "dos",
3342 'textmode' is set, otherwise 'textmode' is reset.
3343
3344 *'fileformats'* *'ffs'*
3345'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003346 Vim+Vi MS-Windows: "dos,unix",
3347 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348 Vi Cygwin: "unix,dos",
3349 Vi others: "")
3350 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 This gives the end-of-line (<EOL>) formats that will be tried when
3352 starting to edit a new buffer and when reading a file into an existing
3353 buffer:
3354 - When empty, the format defined with 'fileformat' will be used
3355 always. It is not set automatically.
3356 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003357 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 'fileformats' name will be used when a file is read into an existing
3359 buffer, no matter what 'fileformat' for that buffer is set to.
3360 - When more than one name is present, separated by commas, automatic
3361 <EOL> detection will be done when reading a file. When starting to
3362 edit a file, a check is done for the <EOL>:
3363 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3364 'fileformat' is set to "dos".
3365 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003366 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003368 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3369 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003370 This means that "mac" is only chosen when:
3371 "unix" is not present or no <NL> is found in the file, and
3372 "dos" is not present or no <CR><NL> is found in the file.
3373 Except: if "unix" was chosen, but there is a <CR> before
3374 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003375 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 4. If 'fileformat' is still not set, the first name from
3377 'fileformats' is used.
3378 When reading a file into an existing buffer, the same is done, but
3379 this happens like 'fileformat' has been set appropriately for that
3380 file only, the option is not changed.
3381 When 'binary' is set, the value of 'fileformats' is not used.
3382
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003383 When Vim starts up with an empty buffer the first item is used. You
3384 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003385
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3387 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3388 done:
3389 - When 'fileformats' is empty, there is no automatic detection. Dos
3390 format will be used.
3391 - When 'fileformats' is set to one or more names, automatic detection
3392 is done. This is based on the first <NL> in the file: If there is a
3393 <CR> in front of it, Dos format is used, otherwise Unix format is
3394 used.
3395 Also see |file-formats|.
3396 For backwards compatibility: When this option is set to an empty
3397 string or one format (no comma is included), 'textauto' is reset,
3398 otherwise 'textauto' is set.
3399 NOTE: This option is set to the Vi default value when 'compatible' is
3400 set and to the Vim default value when 'compatible' is reset.
3401
Bram Moolenaarbf884932013-04-05 22:26:15 +02003402 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3403'fileignorecase' 'fic' boolean (default on for systems where case in file
3404 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003405 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003406 When set case is ignored when using file names and directories.
3407 See 'wildignorecase' for only ignoring case when doing completion.
3408
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 *'filetype'* *'ft'*
3410'filetype' 'ft' string (default: "")
3411 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003412 When this option is set, the FileType autocommand event is triggered.
3413 All autocommands that match with the value of this option will be
3414 executed. Thus the value of 'filetype' is used in place of the file
3415 name.
3416 Otherwise this option does not always reflect the current file type.
3417 This option is normally set when the file type is detected. To enable
3418 this use the ":filetype on" command. |:filetype|
3419 Setting this option to a different value is most useful in a modeline,
3420 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003421 Example, for in an IDL file:
3422 /* vim: set filetype=idl : */ ~
3423 |FileType| |filetypes|
3424 When a dot appears in the value then this separates two filetype
3425 names. Example:
3426 /* vim: set filetype=c.doxygen : */ ~
3427 This will use the "c" filetype first, then the "doxygen" filetype.
3428 This works both for filetype plugins and for syntax files. More than
3429 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 This option is not copied to another buffer, independent of the 's' or
3431 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003432 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433
3434 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003435'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003436 global or local to window |global-local|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003437 {not available when compiled without the |+folding|
3438 feature}
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003439 Characters to fill the statuslines, vertical separators and special
3440 lines in the window.
3441 It is a comma-separated list of items. Each item has a name, a colon
3442 and the value of that item:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003444 item name default Used for ~
3445 stl ' ' or '^' statusline of the current window
3446 stlnc ' ' or '=' statusline of the non-current windows
3447 vert '|' vertical separators |:vsplit|
3448 fold '-' filling 'foldtext'
3449 foldopen '-' mark the beginning of a fold
3450 foldclose '+' show a closed fold
3451 foldsep '|' open fold middle character
3452 diff '-' deleted lines of the 'diff' option
3453 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003454 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003456 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003457 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458 otherwise.
3459
3460 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003461 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462< This is similar to the default, except that these characters will also
3463 be used when there is highlighting.
3464
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003465 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3466 single-byte and multibyte characters are supported. But double-width
3467 characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003468
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003470 item name highlight group ~
3471 stl StatusLine |hl-StatusLine|
3472 stlnc StatusLineNC |hl-StatusLineNC|
3473 vert VertSplit |hl-VertSplit|
3474 fold Folded |hl-Folded|
3475 diff DiffDelete |hl-DiffDelete|
3476 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003477 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003479 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3480'fixendofline' 'fixeol' boolean (default on)
3481 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003482 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003483 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003484 preserve the situation from the original file.
3485 When the 'binary' option is set the value of this option doesn't
3486 matter.
3487 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003488 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003489
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003491'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 {only available when compiled with the |+rightleft|
3494 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003495 This option was for using Farsi, which has been removed. See
3496 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497
3498 *'foldclose'* *'fcl'*
3499'foldclose' 'fcl' string (default "")
3500 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 {not available when compiled without the |+folding|
3502 feature}
3503 When set to "all", a fold is closed when the cursor isn't in it and
3504 its level is higher than 'foldlevel'. Useful if you want folds to
3505 automatically close when moving out of them.
3506
3507 *'foldcolumn'* *'fdc'*
3508'foldcolumn' 'fdc' number (default 0)
3509 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 {not available when compiled without the |+folding|
3511 feature}
3512 When non-zero, a column with the specified width is shown at the side
3513 of the window which indicates open and closed folds. The maximum
3514 value is 12.
3515 See |folding|.
3516
3517 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3518'foldenable' 'fen' boolean (default on)
3519 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 {not available when compiled without the |+folding|
3521 feature}
3522 When off, all folds are open. This option can be used to quickly
3523 switch between showing all text unfolded and viewing the text with
3524 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003525 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 'foldenable' is off.
3527 This option is set by commands that create a new fold or close a fold.
3528 See |folding|.
3529
3530 *'foldexpr'* *'fde'*
3531'foldexpr' 'fde' string (default: "0")
3532 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003534 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003536 for each line to obtain its fold level. The context is set to the
3537 script where 'foldexpr' was set, script-local items can be accessed.
3538 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003539
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 Moolenaar8f3f58f2010-01-06 20:52:26 +01003542 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003543 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003544
3545 It is not allowed to change text or jump to another window while
3546 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547
3548 *'foldignore'* *'fdi'*
3549'foldignore' 'fdi' string (default: "#")
3550 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 {not available when compiled without the |+folding|
3552 feature}
3553 Used only when 'foldmethod' is "indent". Lines starting with
3554 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003555 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556 The default "#" works well for C programs. See |fold-indent|.
3557
3558 *'foldlevel'* *'fdl'*
3559'foldlevel' 'fdl' number (default: 0)
3560 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 {not available when compiled without the |+folding|
3562 feature}
3563 Sets the fold level: Folds with a higher level will be closed.
3564 Setting this option to zero will close all folds. Higher numbers will
3565 close fewer folds.
3566 This option is set by commands like |zm|, |zM| and |zR|.
3567 See |fold-foldlevel|.
3568
3569 *'foldlevelstart'* *'fdls'*
3570'foldlevelstart' 'fdls' number (default: -1)
3571 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572 {not available when compiled without the |+folding|
3573 feature}
3574 Sets 'foldlevel' when starting to edit another buffer in a window.
3575 Useful to always start editing with all folds closed (value zero),
3576 some folds closed (one) or no folds closed (99).
3577 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003578 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579 ignores this option and closes all folds.
3580 It is also done before BufReadPre autocommands, to allow an autocmd to
3581 overrule the 'foldlevel' value for specific files.
3582 When the value is negative, it is not used.
3583
3584 *'foldmarker'* *'fmr'* *E536*
3585'foldmarker' 'fmr' string (default: "{{{,}}}")
3586 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 {not available when compiled without the |+folding|
3588 feature}
3589 The start and end marker used when 'foldmethod' is "marker". There
3590 must be one comma, which separates the start and end marker. The
3591 marker is a literal string (a regular expression would be too slow).
3592 See |fold-marker|.
3593
3594 *'foldmethod'* *'fdm'*
3595'foldmethod' 'fdm' string (default: "manual")
3596 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597 {not available when compiled without the |+folding|
3598 feature}
3599 The kind of folding used for the current window. Possible values:
3600 |fold-manual| manual Folds are created manually.
3601 |fold-indent| indent Lines with equal indent form a fold.
3602 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3603 |fold-marker| marker Markers are used to specify folds.
3604 |fold-syntax| syntax Syntax highlighting items specify folds.
3605 |fold-diff| diff Fold text that is not changed.
3606
3607 *'foldminlines'* *'fml'*
3608'foldminlines' 'fml' number (default: 1)
3609 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 {not available when compiled without the |+folding|
3611 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003612 Sets the number of screen lines above which a fold can be displayed
3613 closed. Also for manually closed folds. With the default value of
3614 one a fold can only be closed if it takes up two or more screen lines.
3615 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003616 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003617 "zc" to close a fold, which is displayed open because it's smaller
3618 than 'foldminlines', a following "zc" may close a containing fold.
3619
3620 *'foldnestmax'* *'fdn'*
3621'foldnestmax' 'fdn' number (default: 20)
3622 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003623 {not available when compiled without the |+folding|
3624 feature}
3625 Sets the maximum nesting of folds for the "indent" and "syntax"
3626 methods. This avoids that too many folds will be created. Using more
3627 than 20 doesn't work, because the internal limit is 20.
3628
3629 *'foldopen'* *'fdo'*
3630'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3631 search,tag,undo")
3632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633 {not available when compiled without the |+folding|
3634 feature}
3635 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003636 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003638 NOTE: When the command is part of a mapping this option is not used.
3639 Add the |zv| command to the mapping to get the same effect.
3640 (rationale: the mapping may want to control opening folds itself)
3641
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 item commands ~
3643 all any
3644 block "(", "{", "[[", "[{", etc.
3645 hor horizontal movements: "l", "w", "fx", etc.
3646 insert any command in Insert mode
3647 jump far jumps: "G", "gg", etc.
3648 mark jumping to a mark: "'m", CTRL-O, etc.
3649 percent "%"
3650 quickfix ":cn", ":crew", ":make", etc.
3651 search search for a pattern: "/", "n", "*", "gd", etc.
3652 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003653 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 tag jumping to a tag: ":ta", CTRL-T, etc.
3655 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656 When a movement command is used for an operator (e.g., "dl" or "y%")
3657 this option is not used. This means the operator will include the
3658 whole closed fold.
3659 Note that vertical movements are not here, because it would make it
3660 very difficult to move onto a closed fold.
3661 In insert mode the folds containing the cursor will always be open
3662 when text is inserted.
3663 To close folds you can re-apply 'foldlevel' with the |zx| command or
3664 set the 'foldclose' option to "all".
3665
3666 *'foldtext'* *'fdt'*
3667'foldtext' 'fdt' string (default: "foldtext()")
3668 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 {not available when compiled without the |+folding|
3670 feature}
3671 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003672 fold. The context is set to the script where 'foldexpr' was set,
3673 script-local items can be accessed. See |fold-foldtext| for the
3674 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675
Bram Moolenaar30b65812012-07-12 22:01:11 +02003676 The expression will be evaluated in the |sandbox| if set from a
3677 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003678 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003679
3680 It is not allowed to change text or jump to another window while
3681 evaluating 'foldtext' |textlock|.
3682
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003683 *'formatexpr'* *'fex'*
3684'formatexpr' 'fex' string (default "")
3685 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003686 {not available when compiled without the |+eval|
3687 feature}
3688 Expression which is evaluated to format a range of lines for the |gq|
3689 operator or automatic formatting (see 'formatoptions'). When this
3690 option is empty 'formatprg' is used.
3691
3692 The |v:lnum| variable holds the first line to be formatted.
3693 The |v:count| variable holds the number of lines to be formatted.
3694 The |v:char| variable holds the character that is going to be
3695 inserted if the expression is being evaluated due to
3696 automatic formatting. This can be empty. Don't insert
3697 it yet!
3698
3699 Example: >
3700 :set formatexpr=mylang#Format()
3701< This will invoke the mylang#Format() function in the
3702 autoload/mylang.vim file in 'runtimepath'. |autoload|
3703
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003704 The advantage of using a function call without arguments is that it is
3705 faster, see |expr-option-function|.
3706
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003707 The expression is also evaluated when 'textwidth' is set and adding
3708 text beyond that limit. This happens under the same conditions as
3709 when internal formatting is used. Make sure the cursor is kept in the
3710 same spot relative to the text then! The |mode()| function will
3711 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003712
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003713 When the expression evaluates to non-zero Vim will fall back to using
3714 the internal format mechanism.
3715
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003716 If the expression starts with s: or |<SID>|, then it is replaced with
3717 the script ID (|local-function|). Example: >
3718 set formatexpr=s:MyFormatExpr()
3719 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003720< Otherwise, the expression is evaluated in the context of the script
3721 where the option was set, thus script-local items are available.
3722
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003723 The expression will be evaluated in the |sandbox| when set from a
3724 modeline, see |sandbox-option|. That stops the option from working,
3725 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003726 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003727 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003728
Bram Moolenaar86b68352004-12-27 21:59:20 +00003729 *'formatlistpat'* *'flp'*
3730'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3731 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003732 A pattern that is used to recognize a list header. This is used for
3733 the "n" flag in 'formatoptions'.
3734 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003735 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003736 while still checking more characters. There must be a character
3737 following the pattern, when it matches the whole line it is handled
3738 like there is no match.
3739 The default recognizes a number, followed by an optional punctuation
3740 character and white space.
3741
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003742 *'formatoptions'* *'fo'*
3743'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3744 local to buffer
3745 This is a sequence of letters which describes how automatic
3746 formatting is to be done. See |fo-table|. When the 'paste' option is
3747 on, no formatting is done (like 'formatoptions' is empty). Commas can
3748 be inserted for readability.
3749 To avoid problems with flags that are added in the future, use the
3750 "+=" and "-=" feature of ":set" |add-option-flags|.
3751 NOTE: This option is set to the Vi default value when 'compatible' is
3752 set and to the Vim default value when 'compatible' is reset.
3753
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754 *'formatprg'* *'fp'*
3755'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003756 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003758 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003760 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003761 If the 'formatexpr' option is not empty it will be used instead.
3762 Otherwise, if 'formatprg' option is an empty string, the internal
3763 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003764 Environment variables are expanded |:set_env|. See |option-backslash|
3765 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003766 This option cannot be set from a |modeline| or in the |sandbox|, for
3767 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768
Bram Moolenaard94464e2015-11-02 15:28:18 +01003769 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003770'fsync' 'fs' boolean (default on)
3771 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003772 When on, the library function fsync() will be called after writing a
3773 file. This will flush a file to disk, ensuring that it is safely
3774 written even on filesystems which do metadata-only journaling. This
3775 will force the harddrive to spin up on Linux systems running in laptop
3776 mode, so it may be undesirable in some situations. Be warned that
3777 turning this off increases the chances of data loss after a crash. On
3778 systems without an fsync() implementation, this variable is always
3779 off.
3780 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003781 'fsync' also applies to |writefile()| (unless a flag is used to
3782 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003783 This option cannot be set from a |modeline| or in the |sandbox|, for
3784 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003785
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3787'gdefault' 'gd' boolean (default off)
3788 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 When on, the ":substitute" flag 'g' is default on. This means that
3790 all matches in a line are substituted instead of one. When a 'g' flag
3791 is given to a ":substitute" command, this will toggle the substitution
3792 of all or one match. See |complex-change|.
3793
3794 command 'gdefault' on 'gdefault' off ~
3795 :s/// subst. all subst. one
3796 :s///g subst. one subst. all
3797 :s///gg subst. all subst. one
3798
3799 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003800 DEPRECATED: Setting this option may break plugins that are not aware
3801 of this option. Also, many users get confused that adding the /g flag
3802 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003803 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804
3805 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003806'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 Format to recognize for the ":grep" command output.
3809 This is a scanf-like string that uses the same format as the
3810 'errorformat' option: see |errorformat|.
3811
3812 *'grepprg'* *'gp'*
3813'grepprg' 'gp' string (default "grep -n ",
3814 Unix: "grep -n $* /dev/null",
3815 Win32: "findstr /n" or "grep -n",
3816 VMS: "SEARCH/NUMBERS ")
3817 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003818 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819 and '#' characters, which are expanded like when used in a command-
3820 line. The placeholder "$*" is allowed to specify where the arguments
3821 will be included. Environment variables are expanded |:set_env|. See
3822 |option-backslash| about including spaces and backslashes.
3823 When your "grep" accepts the "-H" argument, use this to make ":grep"
3824 also work well with a single file: >
3825 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003826< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003827 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3828 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003829 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 apply equally to 'grepprg'.
3831 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3832 otherwise it's "grep -n".
3833 This option cannot be set from a |modeline| or in the |sandbox|, for
3834 security reasons.
3835
3836 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3837'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3838 ve:ver35-Cursor,
3839 o:hor50-Cursor,
3840 i-ci:ver25-Cursor/lCursor,
3841 r-cr:hor20-Cursor/lCursor,
3842 sm:block-Cursor
3843 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003844 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003845 "n-v-c:block,o:hor50,i-ci:hor15,
3846 r-cr:hor30,sm:block")
3847 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003848 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003849 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003851 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003852 height of the cursor can be changed. This can be done by specifying a
3853 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003854 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3855 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003856
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003857 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858 mode-list and an argument-list:
3859 mode-list:argument-list,mode-list:argument-list,..
3860 The mode-list is a dash separated list of these modes:
3861 n Normal mode
3862 v Visual mode
3863 ve Visual mode with 'selection' "exclusive" (same as 'v',
3864 if not specified)
3865 o Operator-pending mode
3866 i Insert mode
3867 r Replace mode
3868 c Command-line Normal (append) mode
3869 ci Command-line Insert mode
3870 cr Command-line Replace mode
3871 sm showmatch in Insert mode
3872 a all modes
3873 The argument-list is a dash separated list of these arguments:
3874 hor{N} horizontal bar, {N} percent of the character height
3875 ver{N} vertical bar, {N} percent of the character width
3876 block block cursor, fills the whole character
3877 [only one of the above three should be present]
3878 blinkwait{N} *cursor-blinking*
3879 blinkon{N}
3880 blinkoff{N}
3881 blink times for cursor: blinkwait is the delay before
3882 the cursor starts blinking, blinkon is the time that
3883 the cursor is shown and blinkoff is the time that the
3884 cursor is not shown. The times are in msec. When one
3885 of the numbers is zero, there is no blinking. The
3886 default is: "blinkwait700-blinkon400-blinkoff250".
3887 These numbers are used for a missing entry. This
3888 means that blinking is enabled by default. To switch
3889 blinking off you can use "blinkon0". The cursor only
3890 blinks when Vim is waiting for input, not while
3891 executing a command.
3892 To make the cursor blink in an xterm, see
3893 |xterm-blink|.
3894 {group-name}
3895 a highlight group name, that sets the color and font
3896 for the cursor
3897 {group-name}/{group-name}
3898 Two highlight group names, the first is used when
3899 no language mappings are used, the other when they
3900 are. |language-mapping|
3901
3902 Examples of parts:
3903 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3904 block cursor with colors from the "nCursor"
3905 highlight group
3906 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3907 In Insert and Command-line Insert mode, use a
3908 30% vertical bar cursor with colors from the
3909 "iCursor" highlight group. Blink a bit
3910 faster.
3911
3912 The 'a' mode is different. It will set the given argument-list for
3913 all modes. It does not reset anything to defaults. This can be used
3914 to do a common setting for all modes. For example, to switch off
3915 blinking: "a:blinkon0"
3916
3917 Examples of cursor highlighting: >
3918 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3919 :highlight Cursor gui=NONE guifg=bg guibg=fg
3920<
3921 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003922 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923'guifont' 'gfn' string (default "")
3924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 {only available when compiled with GUI enabled}
3926 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003927 In its simplest form the value is just one font name.
3928 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929
3930 *'guifontset'* *'gfs'*
3931 *E250* *E252* *E234* *E597* *E598*
3932'guifontset' 'gfs' string (default "")
3933 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 {only available when compiled with GUI enabled and
3935 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003936 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 When not empty, specifies two (or more) fonts to be used. The first
3938 one for normal English, the second one for your special language. See
3939 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003940
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3942'guifontwide' 'gfw' string (default "")
3943 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 {only available when compiled with GUI enabled}
3945 When not empty, specifies a comma-separated list of fonts to be used
3946 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003947 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003948
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 *'guiheadroom'* *'ghr'*
3950'guiheadroom' 'ghr' number (default 50)
3951 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003952 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 The number of pixels subtracted from the screen height when fitting
3954 the GUI window on the screen. Set this before the GUI is started,
3955 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003956 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 lines will be left for window decorations and other items on the
3958 screen. Set it to a negative value to allow windows taller than the
3959 screen.
3960
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003961 *'guiligatures'* *'gli'* *E1243*
3962'guiligatures' 'gli' string (default "")
3963 global
3964 {only for GTK GUI}
3965 List of ASCII characters that, when combined together, can create more
3966 complex shapes. Each character must be a printable ASCII character
3967 with a value in the 32-127 range.
3968 Example: >
3969 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3970< Changing this option updates screen output immediately. Set it to an
3971 empty string to disable ligatures.
3972
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003974'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3975 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003976 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003977 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003980 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 sequence of letters which describes what components and options of the
3982 GUI should be used.
3983 To avoid problems with flags that are added in the future, use the
3984 "+=" and "-=" feature of ":set" |add-option-flags|.
3985
Bram Moolenaar13568252018-03-16 20:46:58 +01003986 Valid characters are as follows:
3987 *'go-!'*
3988 '!' External commands are executed in a terminal window. Without
3989 this flag the MS-Windows GUI will open a console window to
3990 execute the command. The Unix GUI will simulate a dumb
3991 terminal to list the command output.
3992 The terminal window will be positioned at the bottom, and grow
3993 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003994 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 'a' Autoselect: If present, then whenever VISUAL mode is started,
3996 or the Visual area extended, Vim tries to become the owner of
3997 the windowing system's global selection. This means that the
3998 Visually highlighted text is available for pasting into other
3999 applications as well as into Vim itself. When the Visual mode
4000 ends, possibly due to an operation on the text, or when an
4001 application wants to paste the selection, the highlighted text
4002 is automatically yanked into the "* selection register.
4003 Thus the selection is still available for pasting into other
4004 applications after the VISUAL mode has ended.
4005 If not present, then Vim won't become the owner of the
4006 windowing system's global selection unless explicitly told to
4007 by a yank or delete operation for the "* register.
4008 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004009 *'go-P'*
4010 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004011 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004012 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004013 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 applies to the modeless selection.
4015
4016 'guioptions' autoselect Visual autoselect modeless ~
4017 "" - -
4018 "a" yes yes
4019 "A" - yes
4020 "aA" yes yes
4021
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004022 When using a terminal see the 'clipboard' option.
4023
Bram Moolenaar02467872007-05-06 13:22:01 +00004024 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 'c' Use console dialogs instead of popup dialogs for simple
4026 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004027 *'go-d'*
4028 'd' Use dark theme variant if available. Currently only works for
4029 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004030 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004031 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004032 'guitablabel' can be used to change the text in the labels.
4033 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004034 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004035 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004036 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 'f' Foreground: Don't use fork() to detach the GUI from the shell
4038 where it was started. Use this for programs that wait for the
4039 editor to finish (e.g., an e-mail program). Alternatively you
4040 can use "gvim -f" or ":gui -f" to start the GUI in the
4041 foreground. |gui-fork|
4042 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004043 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004044 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4046 corner of the window. It's black&white on non-GTK, because of
4047 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004048 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004049 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004050 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004051 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004052 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004053 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004055 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004056 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 'g' Grey menu items: Make menu items that are not active grey. If
4058 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004059 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060 't' Include tearoff menu items. Currently only works for Win32,
4061 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004062 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004063 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4064 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004065 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004067 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068 'R' Right-hand scrollbar is present when there is a vertically
4069 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004070 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004072 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 'L' Left-hand scrollbar is present when there is a vertically
4074 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004075 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4077 the longest visible line, or on the cursor line if the 'h'
4078 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004079 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 'h' Limit horizontal scrollbar size to the length of the cursor
4081 line. Reduces computations. |gui-horiz-scroll|
4082
4083 And yes, you may even have scrollbars on the left AND the right if
4084 you really want to :-). See |gui-scrollbars| for more information.
4085
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004086 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004087 'v' Use a vertical button layout for dialogs. When not included,
4088 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004089 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004090 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 'p' Use Pointer callbacks for X11 GUI. This is required for some
4092 window managers. If the cursor is not blinking or hollow at
4093 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004094 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004096 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004097 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004098 *'go-k'*
4099 'k' Keep the GUI window size when adding/removing a scrollbar, or
4100 toolbar, tabline, etc. Instead, the behavior is similar to
4101 when the window is maximized and will adjust 'lines' and
4102 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004103 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004104 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004105
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 *'guipty'* *'noguipty'*
4107'guipty' boolean (default on)
4108 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 {only available when compiled with GUI enabled}
4110 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4111 I/O to/from shell commands. See |gui-pty|.
4112
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004113 *'guitablabel'* *'gtl'*
4114'guitablabel' 'gtl' string (default empty)
4115 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004116 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004117 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004118 pages line. When empty and when the result is empty Vim will use a
4119 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004120
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004121 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004122 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004123 The expression will be evaluated in the |sandbox| when set from a
4124 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004125 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004126
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004127 Only used when the GUI tab pages line is displayed. 'e' must be
4128 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4129 used.
4130
Bram Moolenaar57657d82006-04-21 22:12:41 +00004131 *'guitabtooltip'* *'gtt'*
4132'guitabtooltip' 'gtt' string (default empty)
4133 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004134 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004135 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004136 pages line. When empty Vim will use a default tooltip.
4137 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004138 You can include a line break. Simplest method is to use |:let|: >
4139 :let &guitabtooltip = "line one\nline two"
4140<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004141
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004143'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004144 (others) "$VIMRUNTIME/doc/help.txt")
4145 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 Name of the main help file. All distributed help files should be
4147 placed together in one directory. Additionally, all "doc" directories
4148 in 'runtimepath' will be used.
4149 Environment variables are expanded |:set_env|. For example:
4150 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004151 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 spaces and backslashes.
4153 This option cannot be set from a |modeline| or in the |sandbox|, for
4154 security reasons.
4155
4156 *'helpheight'* *'hh'*
4157'helpheight' 'hh' number (default 20)
4158 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159 Minimal initial height of the help window when it is opened with the
4160 ":help" command. The initial height of the help window is half of the
4161 current window, or (when the 'ea' option is on) the same as other
4162 windows. When the height is less than 'helpheight', the height is
4163 set to 'helpheight'. Set to zero to disable.
4164
4165 *'helplang'* *'hlg'*
4166'helplang' 'hlg' string (default: messages language or empty)
4167 global
4168 {only available when compiled with the |+multi_lang|
4169 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004170 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 for which the desired help can be found. The English help will always
4172 be used as a last resort. You can add "en" to prefer English over
4173 another language, but that will only find tags that exist in that
4174 language and not in the English help.
4175 Example: >
4176 :set helplang=de,it
4177< This will first search German, then Italian and finally English help
4178 files.
4179 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4180 try to find the tag in the current language before using this option.
4181 See |help-translated|.
4182
4183 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4184'hidden' 'hid' boolean (default off)
4185 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 When off a buffer is unloaded when it is |abandon|ed. When on a
4187 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4188 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004189
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004191 hidden even if the 'hidden' option is off when these three are true:
4192 - the buffer is modified
4193 - 'autowrite' is off or writing is not possible
4194 - the '!' flag was used
4195 Also see |windows.txt|.
4196
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004197 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 This option is set for one command with ":hide {command}" |:hide|.
4199 WARNING: It's easy to forget that you have changes in hidden buffers.
4200 Think twice when using ":q!" or ":qa!".
4201
4202 *'highlight'* *'hl'*
4203'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004204 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4205 d:Directory,e:ErrorMsg,i:IncSearch,
4206 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004207 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004208 N:CursorLineNr,r:Question,s:StatusLine,
4209 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004210 v:Visual,V:VisualNOS,w:WarningMsg,
4211 W:WildMenu,f:Folded,F:FoldColumn,
4212 A:DiffAdd,C:DiffChange,D:DiffDelete,
4213 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004214 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004215 L:SpellLocal,+:Pmenu,=:PmenuSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004216 [:PmenuKind,]:PmenuKindSel,
4217 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004218 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4219 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004220 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004221 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004224 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004226 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004228 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4229 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004230 characters from 'showbreak'
4231 |hl-Directory| d directories in CTRL-D listing and other special
4232 things in listings
4233 |hl-ErrorMsg| e error messages
4234 h (obsolete, ignored)
4235 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004236 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4238 |hl-MoreMsg| m |more-prompt|
4239 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004240 |hl-LineNr| n line number for ":number" and ":#" commands, and
4241 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004242 |hl-LineNrAbove| a line number above the cursor for when the
4243 'relativenumber' option is set.
4244 |hl-LineNrBelow| b line number below the cursor for when the
4245 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004246 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4247 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 |hl-Question| r |hit-enter| prompt and yes/no questions
4249 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004250 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4252 |hl-VertSplit| c column used to separate vertically split windows
4253 |hl-Visual| v Visual mode
4254 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4255 Selection" Only X11 Gui's |gui-x11| and
4256 |xterm-clipboard|.
4257 |hl-WarningMsg| w warning messages
4258 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4259 |hl-Folded| f line used for closed folds
4260 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004261 |hl-DiffAdd| A added line in diff mode
4262 |hl-DiffChange| C changed line in diff mode
4263 |hl-DiffDelete| D deleted line in diff mode
4264 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004265 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004266 |hl-Conceal| - the placeholders used for concealed characters
4267 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004268 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004269 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004270 |hl-SpellRare| R rare word |spell|
4271 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004272 |hl-Pmenu| + popup menu normal line
4273 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004274 |hl-PmenuKind| [ popup menu "kind" normal line
4275 |hl-PmenuKindSel| ] popup menu "kind" selected line
4276 |hl-PmenuExtra| { popup menu "kind" normal line
4277 |hl-PmenuExtraSel| } popup menu "kind" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004278 |hl-PmenuSbar| x popup menu scrollbar
4279 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004280
4281 The display modes are:
4282 r reverse (termcap entry "mr" and "me")
4283 i italic (termcap entry "ZH" and "ZR")
4284 b bold (termcap entry "md" and "me")
4285 s standout (termcap entry "so" and "se")
4286 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004287 c undercurl (termcap entry "Us" and "Ce")
4288 2 double underline (termcap entry "Ds" and "Ce")
4289 d dotted underline (termcap entry "ds" and "Ce")
4290 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004291 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 n no highlighting
4293 - no highlighting
4294 : use a highlight group
4295 The default is used for occasions that are not included.
4296 If you want to change what the display modes do, see |dos-colors|
4297 for an example.
4298 When using the ':' display mode, this must be followed by the name of
4299 a highlight group. A highlight group can be used to define any type
4300 of highlighting, including using color. See |:highlight| on how to
4301 define one. The default uses a different group for each occasion.
4302 See |highlight-default| for the default highlight groups.
4303
Bram Moolenaar071d4272004-06-13 20:20:40 +00004304 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004305'history' 'hi' number (Vim default: 50, Vi default: 0,
4306 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004309 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004311 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 NOTE: This option is set to the Vi default value when 'compatible' is
4313 set and to the Vim default value when 'compatible' is reset.
4314
4315 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4316'hkmap' 'hk' boolean (default off)
4317 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 {only available when compiled with the |+rightleft|
4319 feature}
4320 When on, the keyboard is mapped for the Hebrew character set.
4321 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4322 toggle this option. See |rileft.txt|.
4323 NOTE: This option is reset when 'compatible' is set.
4324
4325 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4326'hkmapp' 'hkp' boolean (default off)
4327 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004328 {only available when compiled with the |+rightleft|
4329 feature}
4330 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4331 This is useful if you have a non-Hebrew keyboard.
4332 See |rileft.txt|.
4333 NOTE: This option is reset when 'compatible' is set.
4334
Bram Moolenaar036986f2017-03-16 17:41:02 +01004335 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4336'hlsearch' 'hls' boolean (default off)
4337 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004338 {not available when compiled without the
4339 |+extra_search| feature}
4340 When there is a previous search pattern, highlight all its matches.
4341 The type of highlighting used can be set with the 'l' occasion in the
4342 'highlight' option. This uses the "Search" highlight group by
4343 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004344 are not applied. If the "CurSearch" highlight group is set then the
4345 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004346 See also: 'incsearch' and |:match|.
4347 When you get bored looking at the highlighted matches, you can turn it
4348 off with |:nohlsearch|. This does not change the option value, as
4349 soon as you use a search command, the highlighting comes back.
4350 'redrawtime' specifies the maximum time spent on finding matches.
4351 When the search pattern can match an end-of-line, Vim will try to
4352 highlight all of the matched text. However, this depends on where the
4353 search starts. This will be the first line in the window or the first
4354 line below a closed fold. A match in a previous line which is not
4355 drawn may not continue in a newly drawn line.
4356 You can specify whether the highlight status is restored on startup
4357 with the 'h' flag in 'viminfo' |viminfo-h|.
4358 NOTE: This option is reset when 'compatible' is set.
4359
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 *'icon'* *'noicon'*
4361'icon' boolean (default off, on when title can be restored)
4362 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 When on, the icon text of the window will be set to the value of
4364 'iconstring' (if it is not empty), or to the name of the file
4365 currently being edited. Only the last part of the name is used.
4366 Overridden by the 'iconstring' option.
4367 Only works if the terminal supports setting window icons (currently
4368 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4369 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4370 builtin termcap).
4371 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004372 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004374 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375
4376 *'iconstring'*
4377'iconstring' string (default "")
4378 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 When this option is not empty, it will be used for the icon text of
4380 the window. This happens only when the 'icon' option is on.
4381 Only works if the terminal supports setting window icon text
4382 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004383 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 When Vim was compiled with HAVE_X11 defined, the original icon will be
4385 restored if possible |X11|.
4386 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004387 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004389 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004390 {not available when compiled without the |+statusline| feature}
4391
4392 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4393'ignorecase' 'ic' boolean (default off)
4394 global
4395 Ignore case in search patterns. Also used when searching in the tags
4396 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004397 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398 Can be overruled by using "\c" or "\C" in the pattern, see
4399 |/ignorecase|.
4400
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004401 *'imactivatefunc'* *'imaf'*
4402'imactivatefunc' 'imaf' string (default "")
4403 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004404 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004405 activate or deactivate the Input Method. The value can be the name of
4406 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4407 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004408 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004409 The expression will be evaluated in the |sandbox| when set from a
4410 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004411
4412 Example: >
4413 function ImActivateFunc(active)
4414 if a:active
4415 ... do something
4416 else
4417 ... do something
4418 endif
4419 " return value is not used
4420 endfunction
4421 set imactivatefunc=ImActivateFunc
4422<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423 *'imactivatekey'* *'imak'*
4424'imactivatekey' 'imak' string (default "")
4425 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004427 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 Specifies the key that your Input Method in X-Windows uses for
4429 activation. When this is specified correctly, vim can fully control
4430 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4431 You can't use this option to change the activation key, the option
4432 tells Vim what the key is.
4433 Format:
4434 [MODIFIER_FLAG-]KEY_STRING
4435
4436 These characters can be used for MODIFIER_FLAG (case is ignored):
4437 S Shift key
4438 L Lock key
4439 C Control key
4440 1 Mod1 key
4441 2 Mod2 key
4442 3 Mod3 key
4443 4 Mod4 key
4444 5 Mod5 key
4445 Combinations are allowed, for example "S-C-space" or "SC-space" are
4446 both shift+ctrl+space.
4447 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4448
4449 Example: >
4450 :set imactivatekey=S-space
4451< "S-space" means shift+space. This is the activation key for kinput2 +
4452 canna (Japanese), and ami (Korean).
4453
4454 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4455'imcmdline' 'imc' boolean (default off)
4456 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 When set the Input Method is always on when starting to edit a command
4458 line, unless entering a search pattern (see 'imsearch' for that).
4459 Setting this option is useful when your input method allows entering
4460 English characters directly, e.g., when it's used to type accented
4461 characters with dead keys.
4462
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004463 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4465 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 When set the Input Method is never used. This is useful to disable
4467 the IM when it doesn't work properly.
4468 Currently this option is on by default for SGI/IRIX machines. This
4469 may change in later releases.
4470
4471 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004472'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 Specifies whether :lmap or an Input Method (IM) is to be used in
4475 Insert mode. Valid values:
4476 0 :lmap is off and IM is off
4477 1 :lmap is ON and IM is off
4478 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 To always reset the option to zero when leaving Insert mode with <Esc>
4480 this can be used: >
4481 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4482< This makes :lmap and IM turn off automatically when leaving Insert
4483 mode.
4484 Note that this option changes when using CTRL-^ in Insert mode
4485 |i_CTRL-^|.
4486 The value is set to 1 when setting 'keymap' to a valid keymap name.
4487 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004488 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489 methods. Use 'imdisable' to disable XIM then.
4490
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004491 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004492 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004493 |+multi_byte_ime| or |global-ime|.
4494
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004496'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498 Specifies whether :lmap or an Input Method (IM) is to be used when
4499 entering a search pattern. Valid values:
4500 -1 the value of 'iminsert' is used, makes it look like
4501 'iminsert' is also used when typing a search pattern
4502 0 :lmap is off and IM is off
4503 1 :lmap is ON and IM is off
4504 2 :lmap is off and IM is ON
4505 Note that this option changes when using CTRL-^ in Command-line mode
4506 |c_CTRL-^|.
4507 The value is set to 1 when it is not -1 and setting the 'keymap'
4508 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004509 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 methods. Use 'imdisable' to disable XIM then.
4511
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004512 *'imstatusfunc'* *'imsf'*
4513'imstatusfunc' 'imsf' string (default "")
4514 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004515 This option specifies a function that is called to obtain the status
4516 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004517 The value can be the name of a function, a |lambda| or a |Funcref|.
4518 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004519 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004520
4521 Example: >
4522 function ImStatusFunc()
4523 let is_active = ...do something
4524 return is_active ? 1 : 0
4525 endfunction
4526 set imstatusfunc=ImStatusFunc
4527<
4528 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004529 The expression will be evaluated in the |sandbox| when set from a
4530 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004531
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004532 *'imstyle'* *'imst'*
4533'imstyle' 'imst' number (default 1)
4534 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004535 {only available when compiled with |+xim| and
4536 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004537 This option specifies the input style of Input Method:
4538 0 use on-the-spot style
4539 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004540 See: |xim-input-style|
4541
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004542 For a long time on-the-spot style had been used in the GTK version of
4543 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004544 |single-repeat|, etc. Therefore over-the-spot style becomes the
4545 default now. This should work fine for most people, however if you
4546 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004547 The expression will be evaluated in the |sandbox| when set from a
4548 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004549
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 *'include'* *'inc'*
4551'include' 'inc' string (default "^\s*#\s*include")
4552 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 {not available when compiled without the
4554 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004555 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 pattern, just like for the "/" command (See |pattern|). The default
4557 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004558 "]I", "[d", etc.
4559 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004560 comes after the matched pattern. But if "\zs" appears in the pattern
4561 then the text matched from "\zs" to the end, or until "\ze" if it
4562 appears, is used as the file name. Use this to include characters
4563 that are not in 'isfname', such as a space. You can then use
4564 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004565 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566
4567 *'includeexpr'* *'inex'*
4568'includeexpr' 'inex' string (default "")
4569 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004571 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004573 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004574 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004576 Note the double backslash: the `:set` command first halves them, then
4577 one remains it the value, where "\." matches a dot literally. For
4578 simple character replacements `tr()` avoids the need for escaping: >
4579 :setlocal includeexpr=tr(v:fname,'.','/')
4580<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004582 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 Also used for |<cfile>|.
4584
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004585 If the expression starts with s: or |<SID>|, then it is replaced with
4586 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004587 setlocal includeexpr=s:MyIncludeExpr()
4588 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004589< Otherwise, the expression is evaluated in the context of the script
4590 where the option was set, thus script-local items are available.
4591
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004592 It is more efficient if the value is just a function call without
4593 arguments, see |expr-option-function|.
4594
Bram Moolenaar30b65812012-07-12 22:01:11 +02004595 The expression will be evaluated in the |sandbox| when set from a
4596 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004597 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004598
4599 It is not allowed to change text or jump to another window while
4600 evaluating 'includeexpr' |textlock|.
4601
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004603'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004604 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004607 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004608 While typing a search command, show where the pattern, as it was typed
4609 so far, matches. The matched string is highlighted. If the pattern
4610 is invalid or not found, nothing is shown. The screen will be updated
4611 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004612 Also applies to the pattern in commands: >
4613 :global
4614 :lvimgrep
4615 :lvimgrepadd
4616 :smagic
4617 :snomagic
4618 :sort
4619 :substitute
4620 :vglobal
4621 :vimgrep
4622 :vimgrepadd
4623< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004624 original position when no match is found and when pressing <Esc>. You
4625 still need to finish the search command with <Enter> to move the
4626 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004627 You can use the CTRL-G and CTRL-T keys to move to the next and
4628 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004629 When compiled with the |+reltime| feature Vim only searches for about
4630 half a second. With a complicated pattern and/or a lot of text the
4631 match may not be found. This is to avoid that Vim hangs while you
4632 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004633 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004634 When 'hlsearch' is on, all matched strings are highlighted too while
4635 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004636 If you don't want to turn 'hlsearch' on, but want to highlight all
4637 matches while searching, you can turn on and off 'hlsearch' with
4638 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004639 augroup vimrc-incsearch-highlight
4640 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004641 autocmd CmdlineEnter /,\? :set hlsearch
4642 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004643 augroup END
4644<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004645 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004646 to the command line. If 'ignorecase' and 'smartcase' are set and the
4647 command line has no uppercase characters, the added character is
4648 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004649 CTRL-R CTRL-W can be used to add the word at the end of the current
4650 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 NOTE: This option is reset when 'compatible' is set.
4652
4653 *'indentexpr'* *'inde'*
4654'indentexpr' 'inde' string (default "")
4655 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004656 {not available when compiled without the |+eval|
4657 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658 Expression which is evaluated to obtain the proper indent for a line.
4659 It is used when a new line is created, for the |=| operator and
4660 in Insert mode as specified with the 'indentkeys' option.
4661 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004662 'smartindent' indenting. When 'lisp' is set, this option is
Bram Moolenaar49846fb2022-10-15 16:05:33 +01004663 is only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664 When 'paste' is set this option is not used for indenting.
4665 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004666 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004668
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004669 If the expression starts with s: or |<SID>|, then it is replaced with
4670 the script ID (|local-function|). Example: >
4671 set indentexpr=s:MyIndentExpr()
4672 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004673< Otherwise, the expression is evaluated in the context of the script
4674 where the option was set, thus script-local items are available.
4675
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004676 The advantage of using a function call without arguments is that it is
4677 faster, see |expr-option-function|.
4678
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679 The expression must return the number of spaces worth of indent. It
4680 can return "-1" to keep the current indent (this means 'autoindent' is
4681 used for the indent).
4682 Functions useful for computing the indent are |indent()|, |cindent()|
4683 and |lispindent()|.
4684 The evaluation of the expression must not have side effects! It must
4685 not change the text, jump to another window, etc. Afterwards the
4686 cursor position is always restored, thus the cursor may be moved.
4687 Normally this option would be set to call a function: >
4688 :set indentexpr=GetMyIndent()
4689< Error messages will be suppressed, unless the 'debug' option contains
4690 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004691 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004692 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004693
Bram Moolenaar30b65812012-07-12 22:01:11 +02004694 The expression will be evaluated in the |sandbox| when set from a
4695 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004696 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004697
4698 It is not allowed to change text or jump to another window while
4699 evaluating 'indentexpr' |textlock|.
4700
4701
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004703'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 A list of keys that, when typed in Insert mode, cause reindenting of
4706 the current line. Only happens if 'indentexpr' isn't empty.
4707 The format is identical to 'cinkeys', see |indentkeys-format|.
4708 See |C-indenting| and |indent-expression|.
4709
4710 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4711'infercase' 'inf' boolean (default off)
4712 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004713 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004714 'ignorecase' is also on, the case of the match is adjusted depending
4715 on the typed text. If the typed text contains a lowercase letter
4716 where the match has an upper case letter, the completed part is made
4717 lowercase. If the typed text has no lowercase letters and the match
4718 has a lowercase letter where the typed text has an uppercase letter,
4719 and there is a letter before it, the completed part is made uppercase.
4720 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721
4722 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4723'insertmode' 'im' boolean (default off)
4724 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 Makes Vim work in a way that Insert mode is the default mode. Useful
4726 if you want to use Vim as a modeless editor. Used for |evim|.
4727 These Insert mode commands will be useful:
4728 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004729 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 this is a mapping, it is executed as if 'insertmode' was off.
4731 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004733 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4734 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735
4736 These items change when 'insertmode' is set:
4737 - when starting to edit of a file, Vim goes to Insert mode.
4738 - <Esc> in Insert mode is a no-op and beeps.
4739 - <Esc> in Normal mode makes Vim go to Insert mode.
4740 - CTRL-L in Insert mode is a command, it is not inserted.
4741 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4742 However, when <Esc> is used inside a mapping, it behaves like
4743 'insertmode' was not set. This was done to be able to use the same
4744 mappings with 'insertmode' set or not set.
4745 When executing commands with |:normal| 'insertmode' is not used.
4746
4747 NOTE: This option is reset when 'compatible' is set.
4748
4749 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004750'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4752 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4753 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4754 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4755 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4756 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757 The characters specified by this option are included in file names and
4758 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004759 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760 Multi-byte characters 256 and above are always included, only the
4761 characters up to 255 are specified with this option.
4762 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004763 Think twice before adding white space to this option. Although a
4764 space may appear inside a file name, the effect will be that Vim
4765 doesn't know where a file name starts or ends when doing completion.
4766 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767
4768 Note that on systems using a backslash as path separator, Vim tries to
4769 do its best to make it work as you would expect. That is a bit
4770 tricky, since Vi originally used the backslash to escape special
4771 characters. Vim will not remove a backslash in front of a normal file
4772 name character on these systems, but it will on Unix and alikes. The
4773 '&' and '^' are not included by default, because these are special for
4774 cmd.exe.
4775
4776 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004777 Each part can be a single character number or a range. A range is two
4778 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004779 decimal number between 0 and 255 or the ASCII character itself (does
4780 not work for digits). Example:
4781 "_,-,128-140,#-43" (include '_' and '-' and the range
4782 128 to 140 and '#' to 43)
4783 If a part starts with '^', the following character number or range
4784 will be excluded from the option. The option is interpreted from left
4785 to right. Put the excluded character after the range where it is
4786 included. To include '^' itself use it as the last character of the
4787 option or the end of a range. Example:
4788 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4789 If the character is '@', all characters where isalpha() returns TRUE
4790 are included. Normally these are the characters a to z and A to Z,
4791 plus accented characters. To include '@' itself use "@-@". Examples:
4792 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004793 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794 "a-z,A-Z,@-@" All letters plus the '@' character.
4795 A comma can be included by using it where a character number is
4796 expected. Example:
4797 "48-57,,,_" Digits, comma and underscore.
4798 A comma can be excluded by prepending a '^'. Example:
4799 " -~,^,,9" All characters from space to '~', excluding
4800 comma, plus <Tab>.
4801 See |option-backslash| about including spaces and backslashes.
4802
4803 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004804'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 "@,48-57,_,128-167,224-235"
4806 otherwise: "@,48-57,_,192-255")
4807 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808 The characters given by this option are included in identifiers.
4809 Identifiers are used in recognizing environment variables and after a
4810 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004811 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004812 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004814 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004815 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4816
4817 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004818'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 "@,48-57,_,128-167,224-235"
4820 otherwise: "@,48-57,_,192-255"
4821 Vi default: "@,48-57,_")
4822 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004824 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004825 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004826 characters above 255 check the "word" character class (any character
4827 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004828 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 For a help file it is set to all non-blank printable characters except
4830 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4831 command).
4832 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004833 This option also influences syntax highlighting, unless the syntax
4834 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 NOTE: This option is set to the Vi default value when 'compatible' is
4836 set and to the Vim default value when 'compatible' is reset.
4837
4838 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004839'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 "@,~-255"; otherwise: "@,161-255")
4841 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004842 The characters given by this option are displayed directly on the
4843 screen. It is also used for "\p" in a |pattern|. The characters from
4844 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4845 even when they are not included in 'isprint' or excluded. See
4846 'isfname' for a description of the format of this option.
4847
4848 Non-printable characters are displayed with two characters:
4849 0 - 31 "^@" - "^_"
4850 32 - 126 always single characters
4851 127 "^?"
4852 128 - 159 "~@" - "~_"
4853 160 - 254 "| " - "|~"
4854 255 "~?"
4855 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4856 displayed as <xx>, with the hexadecimal value of the byte.
4857 When 'display' contains "uhex" all unprintable characters are
4858 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004859 The SpecialKey highlighting will be used for unprintable characters.
4860 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004861
4862 Multi-byte characters 256 and above are always included, only the
4863 characters up to 255 are specified with this option. When a character
4864 is printable but it is not available in the current font, a
4865 replacement character will be shown.
4866 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4867 There is no option to specify these characters.
4868
4869 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4870'joinspaces' 'js' boolean (default on)
4871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 Insert two spaces after a '.', '?' and '!' with a join command.
4873 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4874 Otherwise only one space is inserted.
4875 NOTE: This option is set when 'compatible' is set.
4876
4877 *'key'*
4878'key' string (default "")
4879 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004880 {only available when compiled with the |+cryptv|
4881 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004883 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884 Careful: Do not set the key value by hand, someone might see the typed
4885 key. Use the |:X| command. But you can make 'key' empty: >
4886 :set key=
4887< It is not possible to get the value of this option with ":set key" or
4888 "echo &key". This is to avoid showing it to someone who shouldn't
4889 know. It also means you cannot see it yourself once you have set it,
4890 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004891 You can use "&key" in an expression to detect whether encryption is
4892 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893
4894 *'keymap'* *'kmp'* *E544*
4895'keymap' 'kmp' string (default "")
4896 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 {only available when compiled with the |+keymap|
4898 feature}
4899 Name of a keyboard mapping. See |mbyte-keymap|.
4900 Setting this option to a valid keymap name has the side effect of
4901 setting 'iminsert' to one, so that the keymap becomes effective.
4902 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004903 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904
4905 *'keymodel'* *'km'*
4906'keymodel' 'km' string (default "")
4907 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004908 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909 can do. These values can be used:
4910 startsel Using a shifted special key starts selection (either
4911 Select mode or Visual mode, depending on "key" being
4912 present in 'selectmode').
4913 stopsel Using a not-shifted special key stops selection.
4914 Special keys in this context are the cursor keys, <End>, <Home>,
4915 <PageUp> and <PageDown>.
4916 The 'keymodel' option is set by the |:behave| command.
4917
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004918 *'keyprotocol'* *'kpc'*
4919'keyprotocol' 'kpc' string (default: see below)
4920 global
4921 Specifies what keyboard protocol to use depending on the value of
4922 'term'. The supported keyboard protocols names are:
4923 none whatever the terminal uses
4924 mok2 modifyOtherKeys level 2, as supported by xterm
4925 kitty Kitty keyboard protocol, as supported by Kitty
4926
Bram Moolenaara87749e2022-11-30 10:23:17 +00004927 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004928 a pattern that is matched against the 'term' option, a colon and the
4929 protocol name to be used. To illustrate this, the default value would
4930 be set with: >
4931 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
4932
4933< This means that when 'term' contains "kitty, "foot" or "wezterm"
4934 somewhere then the "kitty" protocol is used. When 'term' contains
Bram Moolenaar938ae282023-02-20 20:44:55 +00004935 "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004936
4937 The first match is used, thus if you want to have "kitty" use the
4938 kitty protocol, but "badkitty" not, then you should match "badkitty"
4939 first and use the "none" value: >
4940 set keyprotocol=badkitty:none,kitty:kitty
4941<
4942 The option is used after 'term' has been changed. First the termcap
4943 entries are set, possibly using the builtin list, see |builtin-terms|.
4944 Then this option is inspected and if there is a match and a protocol
4945 is specified the following happens:
4946 none Nothing, the regular t_TE and t_TI values remain
4947
4948 mok2 The t_TE value is changed to:
4949 CSI >4;m disables modifyOtherKeys
4950 The t_TI value is changed to:
4951 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00004952 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004953
4954 kitty The t_TE value is changed to:
4955 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00004956 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004957 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00004958 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004959 CSI ?u request kitty keyboard protocol state
4960 CSI >c request the termresponse
4961
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00004962 If you notice problems, such as characters being displayed that
4963 disappear after `CTRL-L`, you might want to try making this option
4964 empty. Then set the 'term' option to have it take effect: >
4965 set keyprotocol=
4966 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00004967<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004968
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969 *'keywordprg'* *'kp'*
4970'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004971 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 Program to use for the |K| command. Environment variables are
4974 expanded |:set_env|. ":help" may be used to access the Vim internal
4975 help. (Note that previously setting the global option to the empty
4976 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004977 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01004978 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004979 When "man", "man -s" or an Ex command is used, Vim will automatically
4980 translate a count for the "K" command and pass it as the first
4981 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 See |option-backslash| about including spaces and backslashes.
4983 Example: >
4984 :set keywordprg=man\ -s
4985< This option cannot be set from a |modeline| or in the |sandbox|, for
4986 security reasons.
4987
4988 *'langmap'* *'lmap'* *E357* *E358*
4989'langmap' 'lmap' string (default "")
4990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 {only available when compiled with the |+langmap|
4992 feature}
4993 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004994 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004995 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 care of translating these special characters to the original meaning
4997 of the key. This means you don't have to change the keyboard mode to
4998 be able to execute Normal mode commands.
4999 This is the opposite of the 'keymap' option, where characters are
5000 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005001 Also consider setting 'langremap' to off, to prevent 'langmap' from
5002 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005003 This option cannot be set from a |modeline| or in the |sandbox|, for
5004 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005006 Example (for Greek, in UTF-8): *greek* >
5007 :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 +00005008< Example (exchanges meaning of z and y for commands): >
5009 :set langmap=zy,yz,ZY,YZ
5010<
5011 The 'langmap' option is a list of parts, separated with commas. Each
5012 part can be in one of two forms:
5013 1. A list of pairs. Each pair is a "from" character immediately
5014 followed by the "to" character. Examples: "aA", "aAbBcC".
5015 2. A list of "from" characters, a semi-colon and a list of "to"
5016 characters. Example: "abc;ABC"
5017 Example: "aA,fgh;FGH,cCdDeE"
5018 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005019 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020
5021 This will allow you to activate vim actions without having to switch
5022 back and forth between the languages. Your language characters will
5023 be understood as normal vim English characters (according to the
5024 langmap mappings) in the following cases:
5025 o Normal/Visual mode (commands, buffer/register names, user mappings)
5026 o Insert/Replace Mode: Register names after CTRL-R
5027 o Insert/Replace Mode: Mappings
5028 Characters entered in Command-line mode will NOT be affected by
5029 this option. Note that this option can be changed at any time
5030 allowing to switch between mappings for different languages/encodings.
5031 Use a mapping to avoid having to type it each time!
5032
5033 *'langmenu'* *'lm'*
5034'langmenu' 'lm' string (default "")
5035 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 {only available when compiled with the |+menu| and
5037 |+multi_lang| features}
5038 Language to use for menu translation. Tells which file is loaded
5039 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005040 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005041< (without the spaces). For example, to always use the Dutch menus, no
5042 matter what $LANG is set to: >
5043 :set langmenu=nl_NL.ISO_8859-1
5044< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005045 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046 If your $LANG is set to a non-English language but you do want to use
5047 the English menus: >
5048 :set langmenu=none
5049< This option must be set before loading menus, switching on filetype
5050 detection or syntax highlighting. Once the menus are defined setting
5051 this option has no effect. But you could do this: >
5052 :source $VIMRUNTIME/delmenu.vim
5053 :set langmenu=de_DE.ISO_8859-1
5054 :source $VIMRUNTIME/menu.vim
5055< Warning: This deletes all menus that you defined yourself!
5056
Bram Moolenaard94464e2015-11-02 15:28:18 +01005057 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005058'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005059 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005060 {only available when compiled with the |+langmap|
5061 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005062 This is just like 'langremap' but with the value inverted. It only
5063 exists for backwards compatibility. When setting 'langremap' then
5064 'langnoremap' is set to the inverted value, and the other way around.
5065
5066 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005067'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005068 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005069 {only available when compiled with the |+langmap|
5070 feature}
5071 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005072 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005073 'langmap' disables some of your mappings, try resetting this option.
5074 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005075 that works for you to avoid mappings to break.
5076
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077 *'laststatus'* *'ls'*
5078'laststatus' 'ls' number (default 1)
5079 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005080 The value of this option influences when the last window will have a
5081 status line:
5082 0: never
5083 1: only if there are at least two windows
5084 2: always
5085 The screen looks nicer with a status line if you have several
5086 windows, but it takes another screen line. |status-line|
5087
5088 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5089'lazyredraw' 'lz' boolean (default off)
5090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091 When this option is set, the screen will not be redrawn while
5092 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005093 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005094 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005095 This may occasionally cause display errors. It is only meant to be set
5096 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01005097 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098
5099 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5100'linebreak' 'lbr' boolean (default off)
5101 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005102 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005104 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105 than at the last character that fits on the screen. Unlike
5106 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005107 it only affects the way the file is displayed, not its contents.
5108 If 'breakindent' is set, line is visually indented. Then, the value
5109 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005110 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 Note that <Tab> characters after an <EOL> are mostly not displayed
5112 with the right amount of white space.
5113
5114 *'lines'* *E593*
5115'lines' number (default 24 or terminal height)
5116 global
5117 Number of lines of the Vim window.
5118 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005119 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 When Vim is running in the GUI or in a resizable window, setting this
5121 option will cause the window size to be changed. When you only want
5122 to use the size for the GUI, put the command in your |gvimrc| file.
5123 Vim limits the number of lines to what fits on the screen. You can
5124 use this command to get the tallest window possible: >
5125 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005126< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005127 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005128 When you set this option and Vim is unable to change the physical
5129 number of lines of the display, the display may be messed up.
5130
5131 *'linespace'* *'lsp'*
5132'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5133 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134 {only in the GUI}
5135 Number of pixel lines inserted between characters. Useful if the font
5136 uses the full character cell height, making lines touch each other.
5137 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005138 With some fonts there can be too much room between lines (to have
5139 space for ascents and descents). Then it makes sense to set
5140 'linespace' to a negative value. This may cause display problems
5141 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142
5143 *'lisp'* *'nolisp'*
5144'lisp' boolean (default off)
5145 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005146 Lisp mode: When <Enter> is typed in insert mode set the indent for
5147 the next line to Lisp standards (well, sort of). Also happens with
5148 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5149 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5150 better. Also see 'lispwords'.
5151 The '-' character is included in keyword characters. Redefines the
5152 "=" operator to use this same indentation algorithm rather than
5153 calling an external program if 'equalprg' is empty.
5154 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005156 *'lispoptions'* *'lop'*
5157'lispoptions' 'lop' string (default "")
5158 local to buffer
5159 Comma-separated list of items that influence the Lisp indenting when
5160 enabled with the |'lisp'| option. Currently only one item is
5161 supported:
5162 expr:1 use 'indentexpr' for Lisp indenting when it is set
5163 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5164 Note that when using 'indentexpr' the `=` operator indents all the
5165 lines, otherwise the first line is not indented (Vi-compatible).
5166
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 *'lispwords'* *'lw'*
5168'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005169 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005170 Comma-separated list of words that influence the Lisp indenting when
5171 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172
5173 *'list'* *'nolist'*
5174'list' boolean (default off)
5175 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005176 List mode: By default show tabs as CTRL-I is displayed, display $
5177 after end of line. Useful to see the difference between tabs and
5178 spaces and for trailing blanks. Further changed by the 'listchars'
5179 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005180
5181 The cursor is displayed at the start of the space a Tab character
5182 occupies, not at the end as usual in Normal mode. To get this cursor
5183 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005184 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005185<
5186 Note that list mode will also affect formatting (set with 'textwidth'
5187 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188 changing the way tabs are displayed.
5189
5190 *'listchars'* *'lcs'*
5191'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005192 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005193 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005194 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005195 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196 eol:c Character to show at the end of each line. When
5197 omitted, there is no extra character at the end of the
5198 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005199 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005200 tab:xy[z] Two or three characters to be used to show a tab.
5201 The third character is optional.
5202
5203 tab:xy The 'x' is always used, then 'y' as many times as will
5204 fit. Thus "tab:>-" displays:
5205 >
5206 >-
5207 >--
5208 etc.
5209
5210 tab:xyz The 'z' is always used, then 'x' is prepended, and
5211 then 'y' is used as many times as will fit. Thus
5212 "tab:<->" displays:
5213 >
5214 <>
5215 <->
5216 <-->
5217 etc.
5218
5219 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005220 *lcs-space*
5221 space:c Character to show for a space. When omitted, spaces
5222 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005223 *lcs-multispace*
5224 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005225 One or more characters to use cyclically to show for
5226 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005227 setting, except for single spaces. When omitted, the
5228 "space" setting is used. For example,
5229 `:set listchars=multispace:---+` shows ten consecutive
5230 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005231 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005232 *lcs-lead*
5233 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005234 leading spaces are blank. Overrides the "space" and
5235 "multispace" settings for leading spaces. You can
5236 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005237 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005238< *lcs-leadmultispace*
5239 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005240 Like the |lcs-multispace| value, but for leading
5241 spaces only. Also overrides |lcs-lead| for leading
5242 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005243 `:set listchars=leadmultispace:---+` shows ten
5244 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005245 ---+---+--XXX ~
5246 Where "XXX" denotes the first non-blank characters in
5247 the line.
5248 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005249 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005250 trailing spaces are blank. Overrides the "space" and
5251 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005252 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253 extends:c Character to show in the last column, when 'wrap' is
5254 off and the line continues beyond the right of the
5255 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005256 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005257 precedes:c Character to show in the first visible column of the
5258 physical line, when there is text preceding the
5259 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005260 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005261 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005262 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005263 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005264 nbsp:c Character to show for a non-breakable space character
5265 (0xA0 (160 decimal) and U+202F). Left blank when
5266 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005267
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005268 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005269 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005270 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005272 Each character can be specified as hex: >
5273 set listchars=eol:\\x24
5274 set listchars=eol:\\u21b5
5275 set listchars=eol:\\U000021b5
5276< Note that a double backslash is used. The number of hex characters
5277 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5278
Bram Moolenaar071d4272004-06-13 20:20:40 +00005279 Examples: >
5280 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005281 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282 :set lcs=extends:>,precedes:<
5283< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005284 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5285 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005286 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287
5288 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5289'loadplugins' 'lpl' boolean (default on)
5290 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291 When on the plugin scripts are loaded when starting up |load-plugins|.
5292 This option can be reset in your |vimrc| file to disable the loading
5293 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005294 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5295 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005296
Bram Moolenaard94464e2015-11-02 15:28:18 +01005297 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005298'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005299 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005300 {only available when compiled with the |+lua/dyn|
5301 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005302 Specifies the name of the Lua shared library. The default is
5303 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005304 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005305 This option cannot be set from a |modeline| or in the |sandbox|, for
5306 security reasons.
5307
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005308 *'macatsui'* *'nomacatsui'*
5309'macatsui' boolean (default on)
5310 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005311 {not supported}
5312 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005313
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314 *'magic'* *'nomagic'*
5315'magic' boolean (default on)
5316 global
5317 Changes the special characters that can be used in search patterns.
5318 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005319 WARNING: Switching this option off most likely breaks plugins! That
5320 is because many patterns assume it's on and will fail when it's off.
5321 Only switch it off when working with old Vi scripts. In any other
5322 situation write patterns that work when 'magic' is on. Include "\M"
5323 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005324 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5325 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005326
5327 *'makeef'* *'mef'*
5328'makeef' 'mef' string (default: "")
5329 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005330 {not available when compiled without the |+quickfix|
5331 feature}
5332 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5333 and the |:grep| command.
5334 When it is empty, an internally generated temp file will be used.
5335 When "##" is included, it is replaced by a number to make the name
5336 unique. This makes sure that the ":make" command doesn't overwrite an
5337 existing file.
5338 NOT used for the ":cf" command. See 'errorfile' for that.
5339 Environment variables are expanded |:set_env|.
5340 See |option-backslash| about including spaces and backslashes.
5341 This option cannot be set from a |modeline| or in the |sandbox|, for
5342 security reasons.
5343
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005344 *'makeencoding'* *'menc'*
5345'makeencoding' 'menc' string (default "")
5346 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005347 Encoding used for reading the output of external commands. When empty,
5348 encoding is not converted.
5349 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5350 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5351 and `:laddfile`.
5352
5353 This would be mostly useful when you use MS-Windows and set 'encoding'
5354 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5355 'makeencoding' to "char" has the same effect as setting to the system
5356 locale encoding. Example: >
5357 :set encoding=utf-8
5358 :set makeencoding=char " system locale is used
5359<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360 *'makeprg'* *'mp'*
5361'makeprg' 'mp' string (default "make", VMS: "MMS")
5362 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005363 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005364 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5365 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005366 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005367 Environment variables are expanded |:set_env|. See |option-backslash|
5368 about including spaces and backslashes.
5369 Note that a '|' must be escaped twice: once for ":set" and once for
5370 the interpretation of a command. When you use a filter called
5371 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 :set makeprg=gmake\ \\\|\ myfilter
5373< The placeholder "$*" can be given (even multiple times) to specify
5374 where the arguments will be included, for example: >
5375 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5376< This option cannot be set from a |modeline| or in the |sandbox|, for
5377 security reasons.
5378
5379 *'matchpairs'* *'mps'*
5380'matchpairs' 'mps' string (default "(:),{:},[:]")
5381 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005383 other.
5384 Only character pairs are allowed that are different, thus you cannot
5385 jump between two double quotes.
5386 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005387 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005388 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389 :set mps+=<:>
5390
5391< A more exotic example, to jump between the '=' and ';' in an
5392 assignment, useful for languages like C and Java: >
5393 :au FileType c,cpp,java set mps+==:;
5394
5395< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005396 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397
5398 *'matchtime'* *'mat'*
5399'matchtime' 'mat' number (default 5)
5400 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401 Tenths of a second to show the matching paren, when 'showmatch' is
5402 set. Note that this is not in milliseconds, like other options that
5403 set a time. This is to be compatible with Nvi.
5404
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005405 *'maxcombine'* *'mco'*
5406'maxcombine' 'mco' number (default 2)
5407 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005408 The maximum number of combining characters supported for displaying.
5409 Only used when 'encoding' is "utf-8".
5410 The default is OK for most languages. Hebrew may require 4.
5411 Maximum value is 6.
5412 Even when this option is set to 2 you can still edit text with more
5413 combining characters, you just can't see them. Use |g8| or |ga|.
5414 See |mbyte-combining|.
5415
Bram Moolenaar071d4272004-06-13 20:20:40 +00005416 *'maxfuncdepth'* *'mfd'*
5417'maxfuncdepth' 'mfd' number (default 100)
5418 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005419 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005420 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005421 Maximum depth of function calls for user functions. This normally
5422 catches endless recursion. When using a recursive function with
5423 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5424 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005425 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005426 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427 See also |:function|.
5428
5429 *'maxmapdepth'* *'mmd'* *E223*
5430'maxmapdepth' 'mmd' number (default 1000)
5431 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432 Maximum number of times a mapping is done without resulting in a
5433 character to be used. This normally catches endless mappings, like
5434 ":map x y" with ":map y x". It still does not catch ":map g wg",
5435 because the 'w' is used before the next mapping is done. See also
5436 |key-mapping|.
5437
5438 *'maxmem'* *'mm'*
5439'maxmem' 'mm' number (default between 256 to 5120 (system
5440 dependent) or half the amount of memory
5441 available)
5442 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5444 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005445 other memory to be freed.
5446 The maximum usable value is about 2000000. Use this to work without a
5447 limit.
5448 The value is ignored when 'swapfile' is off.
5449 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005450
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005451 *'maxmempattern'* *'mmp'*
5452'maxmempattern' 'mmp' number (default 1000)
5453 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005454 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005455 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005456 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005457 When Vim runs into the limit it gives an error message and mostly
5458 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005459 Running into the limit often means that the pattern is very
5460 inefficient or too complex. This may already happen with the pattern
5461 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005462 Might also happen on redraw, when syntax rules try to match a complex
5463 text structure.
5464 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5465 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005466
Bram Moolenaar071d4272004-06-13 20:20:40 +00005467 *'maxmemtot'* *'mmt'*
5468'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5469 dependent) or half the amount of memory
5470 available)
5471 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005472 Maximum amount of memory in Kbyte to use for all buffers together.
5473 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005474 without a limit.
5475 On 64 bit machines higher values might work. But hey, do you really
5476 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005477 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005478 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005479 Buffers with 'swapfile' off still count to the total amount of memory
5480 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005481 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482
5483 *'menuitems'* *'mis'*
5484'menuitems' 'mis' number (default 25)
5485 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486 {not available when compiled without the |+menu|
5487 feature}
5488 Maximum number of items to use in a menu. Used for menus that are
5489 generated from a list of items, e.g., the Buffers menu. Changing this
5490 option has no direct effect, the menu must be refreshed first.
5491
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005492 *'mkspellmem'* *'msm'*
5493'mkspellmem' 'msm' string (default "460000,2000,500")
5494 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005495 {not available when compiled without the |+syntax|
5496 feature}
5497 Parameters for |:mkspell|. This tunes when to start compressing the
5498 word tree. Compression can be slow when there are many words, but
5499 it's needed to avoid running out of memory. The amount of memory used
5500 per word depends very much on how similar the words are, that's why
5501 this tuning is complicated.
5502
5503 There are three numbers, separated by commas:
5504 {start},{inc},{added}
5505
5506 For most languages the uncompressed word tree fits in memory. {start}
5507 gives the amount of memory in Kbyte that can be used before any
5508 compression is done. It should be a bit smaller than the amount of
5509 memory that is available to Vim.
5510
5511 When going over the {start} limit the {inc} number specifies the
5512 amount of memory in Kbyte that can be allocated before another
5513 compression is done. A low number means compression is done after
5514 less words are added, which is slow. A high number means more memory
5515 will be allocated.
5516
5517 After doing compression, {added} times 1024 words can be added before
5518 the {inc} limit is ignored and compression is done when any extra
5519 amount of memory is needed. A low number means there is a smaller
5520 chance of hitting the {inc} limit, less memory is used but it's
5521 slower.
5522
5523 The languages for which these numbers are important are Italian and
5524 Hungarian. The default works for when you have about 512 Mbyte. If
5525 you have 1 Gbyte you could use: >
5526 :set mkspellmem=900000,3000,800
5527< If you have less than 512 Mbyte |:mkspell| may fail for some
5528 languages, no matter what you set 'mkspellmem' to.
5529
Bram Moolenaar07607392019-05-26 19:20:43 +02005530 This option cannot be set from a |modeline| or in the |sandbox|.
5531
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005533'modeline' 'ml' boolean (Vim default: on (off for root),
5534 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005536 If 'modeline' is on 'modelines' gives the number of lines that is
5537 checked for set commands. If 'modeline' is off or 'modelines' is zero
5538 no lines are checked. See |modeline|.
5539
5540 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5541'modelineexpr' 'mle' boolean (default: off)
5542 global
5543 When on allow some options that are an expression to be set in the
5544 modeline. Check the option for whether it is affected by
5545 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005546 This option cannot be set from a |modeline| or in the |sandbox|, for
5547 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005548
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 *'modelines'* *'mls'*
5550'modelines' 'mls' number (default 5)
5551 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005552 If 'modeline' is on 'modelines' gives the number of lines that is
5553 checked for set commands. If 'modeline' is off or 'modelines' is zero
5554 no lines are checked. See |modeline|.
5555 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5556 set and to the Vim default value when 'compatible' is reset.
5557
5558 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005559 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560'modifiable' 'ma' boolean (default on)
5561 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005562 When off the buffer contents cannot be changed. The 'fileformat' and
5563 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005564 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565
5566 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5567'modified' 'mod' boolean (default off)
5568 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005569 When on, the buffer is considered to be modified. This option is set
5570 when:
5571 1. A change was made to the text since it was last written. Using the
5572 |undo| command to go back to the original text will reset the
5573 option. But undoing changes that were made before writing the
5574 buffer will set the option again, since the text is different from
5575 when it was written.
5576 2. 'fileformat' or 'fileencoding' is different from its original
5577 value. The original value is set when the buffer is read or
5578 written. A ":set nomodified" command also resets the original
5579 values to the current values and the 'modified' option will be
5580 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005581 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005582 This option is not set when a change is made to the buffer as the
5583 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5584 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5585 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5587 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005588 Note that the text may actually be the same, e.g. 'modified' is set
5589 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590
5591 *'more'* *'nomore'*
5592'more' boolean (Vim default: on, Vi default: off)
5593 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 When on, listings pause when the whole screen is filled. You will get
5595 the |more-prompt|. When this option is off there are no pauses, the
5596 listing continues until finished.
5597 NOTE: This option is set to the Vi default value when 'compatible' is
5598 set and to the Vim default value when 'compatible' is reset.
5599
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005600 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005601'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005602 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005604 Enable the use of the mouse. Works for most terminals (xterm, Win32
5605 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5606 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5607 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005608 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005609 v Visual mode
5610 i Insert mode
5611 c Command-line mode
5612 h all previous modes when editing a help file
5613 a all previous modes
5614 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005615 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005616 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005617< If your terminal can't overrule the mouse events going to the
5618 application, use: >
5619 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005620< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005621 back to Vim using the mouse events.
5622 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5623 "xterm".
5624
5625 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626 modeless selection. This doesn't move the text cursor.
5627
5628 See |mouse-using|. Also see |'clipboard'|.
5629
5630 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005631 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005632 the mouse buttons can still be used by keeping the shift key pressed.
5633 Also see the 'clipboard' option.
5634
5635 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5636'mousefocus' 'mousef' boolean (default off)
5637 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638 {only works in the GUI}
5639 The window that the mouse pointer is on is automatically activated.
5640 When changing the window layout or window focus in another way, the
5641 mouse pointer is moved to the window with keyboard focus. Off is the
5642 default because it makes using the pull down menus a little goofy, as
5643 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005644 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005645 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646
5647 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5648'mousehide' 'mh' boolean (default on)
5649 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005650 {only works in the GUI}
5651 When on, the mouse pointer is hidden when characters are typed.
5652 The mouse pointer is restored when the mouse is moved.
5653
5654 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005655'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005656 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005657 Sets the model to use for the mouse. The name mostly specifies what
5658 the right mouse button is used for:
5659 extend Right mouse button extends a selection. This works
5660 like in an xterm.
5661 popup Right mouse button pops up a menu. The shifted left
5662 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005663 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005664 popup_setpos Like "popup", but the cursor will be moved to the
5665 position where the mouse was clicked, and thus the
5666 selected operation will act upon the clicked object.
5667 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005668 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 course, that right clicking outside a selection will
5670 end Visual mode.
5671 Overview of what button does what for each model:
5672 mouse extend popup(_setpos) ~
5673 left click place cursor place cursor
5674 left drag start selection start selection
5675 shift-left search word extend selection
5676 right click extend selection popup menu (place cursor)
5677 right drag extend selection -
5678 middle click paste paste
5679
5680 In the "popup" model the right mouse button produces a pop-up menu.
5681 You need to define this first, see |popup-menu|.
5682
5683 Note that you can further refine the meaning of buttons with mappings.
5684 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5685 selection (because that's handled in the GUI code directly).
5686
5687 The 'mousemodel' option is set by the |:behave| command.
5688
Bram Moolenaar938ae282023-02-20 20:44:55 +00005689 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005690'mousemoveevent' 'mousemev' boolean (default off)
5691 global
5692 {only works in the GUI}
5693 When on, mouse move events are delivered to the input queue and are
5694 available for mapping. The default, off, avoids the mouse movement
5695 overhead except when needed. See |gui-mouse-mapping|.
5696 Warning: Setting this option can make pending mappings to be aborted
5697 when the mouse is moved.
5698 Currently only works in the GUI, may be made to work in a terminal
5699 later.
5700
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005702'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5703 vs:leftright,vd:lrsizing,m:no,
5704 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706 {only available when compiled with the |+mouseshape|
5707 feature}
5708 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005709 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 like used for 'guicursor'. Each part consist of a mode/location-list
5711 and an argument-list:
5712 mode-list:shape,mode-list:shape,..
5713 The mode-list is a dash separated list of these modes/locations:
5714 In a normal window: ~
5715 n Normal mode
5716 v Visual mode
5717 ve Visual mode with 'selection' "exclusive" (same as 'v',
5718 if not specified)
5719 o Operator-pending mode
5720 i Insert mode
5721 r Replace mode
5722
5723 Others: ~
5724 c appending to the command-line
5725 ci inserting in the command-line
5726 cr replacing in the command-line
5727 m at the 'Hit ENTER' or 'More' prompts
5728 ml idem, but cursor in the last line
5729 e any mode, pointer below last window
5730 s any mode, pointer on a status line
5731 sd any mode, while dragging a status line
5732 vs any mode, pointer on a vertical separator line
5733 vd any mode, while dragging a vertical separator line
5734 a everywhere
5735
5736 The shape is one of the following:
5737 avail name looks like ~
5738 w x arrow Normal mouse pointer
5739 w x blank no pointer at all (use with care!)
5740 w x beam I-beam
5741 w x updown up-down sizing arrows
5742 w x leftright left-right sizing arrows
5743 w x busy The system's usual busy pointer
5744 w x no The system's usual 'no input' pointer
5745 x udsizing indicates up-down resizing
5746 x lrsizing indicates left-right resizing
5747 x crosshair like a big thin +
5748 x hand1 black hand
5749 x hand2 white hand
5750 x pencil what you write with
5751 x question big ?
5752 x rightup-arrow arrow pointing right-up
5753 w x up-arrow arrow pointing up
5754 x <number> any X11 pointer number (see X11/cursorfont.h)
5755
5756 The "avail" column contains a 'w' if the shape is available for Win32,
5757 x for X11.
5758 Any modes not specified or shapes not available use the normal mouse
5759 pointer.
5760
5761 Example: >
5762 :set mouseshape=s:udsizing,m:no
5763< will make the mouse turn to a sizing arrow over the status lines and
5764 indicate no input when the hit-enter prompt is displayed (since
5765 clicking the mouse has no effect in this state.)
5766
5767 *'mousetime'* *'mouset'*
5768'mousetime' 'mouset' number (default 500)
5769 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005770 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 time in msec between two mouse clicks for the second click to be
5772 recognized as a multi click.
5773
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005774 *'mzschemedll'*
5775'mzschemedll' string (default depends on the build)
5776 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005777 {only available when compiled with the |+mzscheme/dyn|
5778 feature}
5779 Specifies the name of the MzScheme shared library. The default is
5780 DYNAMIC_MZSCH_DLL which was specified at compile time.
5781 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005782 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005783 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005784 This option cannot be set from a |modeline| or in the |sandbox|, for
5785 security reasons.
5786
5787 *'mzschemegcdll'*
5788'mzschemegcdll' string (default depends on the build)
5789 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005790 {only available when compiled with the |+mzscheme/dyn|
5791 feature}
5792 Specifies the name of the MzScheme GC shared library. The default is
5793 DYNAMIC_MZGC_DLL which was specified at compile time.
5794 The value can be equal to 'mzschemedll' if it includes the GC code.
5795 Environment variables are expanded |:set_env|.
5796 This option cannot be set from a |modeline| or in the |sandbox|, for
5797 security reasons.
5798
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005799 *'mzquantum'* *'mzq'*
5800'mzquantum' 'mzq' number (default 100)
5801 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005802 {not available when compiled without the |+mzscheme|
5803 feature}
5804 The number of milliseconds between polls for MzScheme threads.
5805 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005806 NOTE: This option is set to the Vim default value when 'compatible'
5807 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005808
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005810'nrformats' 'nf' string (default "bin,octal,hex",
5811 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005812 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 This defines what bases Vim will consider for numbers when using the
5814 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5815 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005816 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005818 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005819 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005820 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005821 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005822 considered to be hexadecimal. Example: Using CTRL-X on
5823 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005824 bin If included, numbers starting with "0b" or "0B" will be
5825 considered to be binary. Example: Using CTRL-X on
5826 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005827 unsigned If included, numbers are recognized as unsigned. Thus a
5828 leading dash or negative sign won't be considered as part of
5829 the number. Examples:
5830 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5831 (without "unsigned" it would become "9-2021").
5832 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5833 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005834 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5835 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836 Numbers which simply begin with a digit in the range 1-9 are always
5837 considered decimal. This also happens for numbers that are not
5838 recognized as octal or hex.
5839
5840 *'number'* *'nu'* *'nonumber'* *'nonu'*
5841'number' 'nu' boolean (default off)
5842 local to window
5843 Print the line number in front of each line. When the 'n' option is
5844 excluded from 'cpoptions' a wrapped line will not use the column of
5845 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005846 The 'numberwidth' option can be used to set the room used for the line
5847 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005848 When a long, wrapped line doesn't start with the first character, '-'
5849 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005850 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5851 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005852 *number_relativenumber*
5853 The 'relativenumber' option changes the displayed number to be
5854 relative to the cursor. Together with 'number' there are these
5855 four combinations (cursor in line 3):
5856
Bram Moolenaar3848e002016-03-19 18:42:29 +01005857 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005858 'nornu' 'nornu' 'rnu' 'rnu'
5859
5860 |apple | 1 apple | 2 apple | 2 apple
5861 |pear | 2 pear | 1 pear | 1 pear
5862 |nobody | 3 nobody | 0 nobody |3 nobody
5863 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005864
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005865 *'numberwidth'* *'nuw'*
5866'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5867 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005868 {only available when compiled with the |+linebreak|
5869 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005870 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005871 when the 'number' or 'relativenumber' option is set or printing lines
5872 with a line number. Since one space is always between the number and
5873 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005874 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005875 fit the highest line number in the buffer respectively the number of
5876 rows in the window, depending on whether 'number' or 'relativenumber'
5877 is set. Thus with the Vim default of 4 there is room for a line number
5878 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005879 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005880 NOTE: This option is set to the Vi default value when 'compatible' is
5881 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005882
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005883 *'omnifunc'* *'ofu'*
5884'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005885 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005886 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005887 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005888 This option specifies a function to be used for Insert mode omni
5889 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005890 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005891 invoked and what it should return. The value can be the name of a
5892 function, a |lambda| or a |Funcref|. See |option-value-function| for
5893 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005894 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005895 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005896 This option cannot be set from a |modeline| or in the |sandbox|, for
5897 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005898
5899
Bram Moolenaar02467872007-05-06 13:22:01 +00005900 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005901'opendevice' 'odev' boolean (default off)
5902 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005903 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005904 Enable reading and writing from devices. This may get Vim stuck on a
5905 device that can be opened but doesn't actually do the I/O. Therefore
5906 it is off by default.
5907 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5908 result in editing a device.
5909
5910
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005911 *'operatorfunc'* *'opfunc'*
5912'operatorfunc' 'opfunc' string (default: empty)
5913 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005914 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005915 See |:map-operator| for more info and an example. The value can be
5916 the name of a function, a |lambda| or a |Funcref|. See
5917 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005918
5919 This option cannot be set from a |modeline| or in the |sandbox|, for
5920 security reasons.
5921
5922
Bram Moolenaar251e1912011-06-19 05:09:16 +02005923 *'osfiletype'* *'oft'*
5924'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005926 This option was supported on RISC OS, which has been removed.
5927
Bram Moolenaar071d4272004-06-13 20:20:40 +00005928
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005929 *'packpath'* *'pp'*
5930'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005931 Directories used to find packages. See |packages|.
5932
5933
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005935'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005936 global
5937 Specifies the nroff macros that separate paragraphs. These are pairs
5938 of two letters (see |object-motions|).
5939
5940 *'paste'* *'nopaste'*
5941'paste' boolean (default off)
5942 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005943 Put Vim in Paste mode. This is useful if you want to cut or copy
5944 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005945 unexpected effects.
5946 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005947 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005948 knows about pasting and will mostly do the right thing without 'paste'
5949 being set. The same is true for a terminal where Vim handles the
5950 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005951 This option is reset when starting the GUI. Thus if you set it in
5952 your .vimrc it will work in a terminal, but not in the GUI. Setting
5953 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5954 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005955 When the 'paste' option is switched on (also when it was already on):
5956 - mapping in Insert mode and Command-line mode is disabled
5957 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005958 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005959 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005960 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005961 - 'revins' is reset
5962 - 'ruler' is reset
5963 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005964 - 'smarttab' is reset
5965 - 'softtabstop' is set to 0
5966 - 'textwidth' is set to 0
5967 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005968 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005969 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005970 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005971 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005972 - 'indentexpr'
5973 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005974 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005975 NOTE: When you start editing another file while the 'paste' option is
5976 on, settings from the modelines or autocommands may change the
5977 settings again, causing trouble when pasting text. You might want to
5978 set the 'paste' option again.
5979 When the 'paste' option is reset the mentioned options are restored to
5980 the value before the moment 'paste' was switched from off to on.
5981 Resetting 'paste' before ever setting it does not have any effect.
5982 Since mapping doesn't work while 'paste' is active, you need to use
5983 the 'pastetoggle' option to toggle the 'paste' option with some key.
5984
5985 *'pastetoggle'* *'pt'*
5986'pastetoggle' 'pt' string (default "")
5987 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005988 When non-empty, specifies the key sequence that toggles the 'paste'
5989 option. This is like specifying a mapping: >
5990 :map {keys} :set invpaste<CR>
5991< Where {keys} is the value of 'pastetoggle'.
5992 The difference is that it will work even when 'paste' is set.
5993 'pastetoggle' works in Insert mode and Normal mode, but not in
5994 Command-line mode.
5995 Mappings are checked first, thus overrule 'pastetoggle'. However,
5996 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5997 this: >
5998 :map <F10> :set paste<CR>
5999 :map <F11> :set nopaste<CR>
6000 :imap <F10> <C-O>:set paste<CR>
6001 :imap <F11> <nop>
6002 :set pastetoggle=<F11>
6003< This will make <F10> start paste mode and <F11> stop paste mode.
6004 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6005 mode everything is inserted literally, except the 'pastetoggle' key
6006 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006007 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008
6009 *'pex'* *'patchexpr'*
6010'patchexpr' 'pex' string (default "")
6011 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012 {not available when compiled without the |+diff|
6013 feature}
6014 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006015 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006016
Bram Moolenaardbc28022014-07-26 13:40:44 +02006017 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018'patchmode' 'pm' string (default "")
6019 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020 When non-empty the oldest version of a file is kept. This can be used
6021 to keep the original version of a file if you are changing files in a
6022 source distribution. Only the first time that a file is written a
6023 copy of the original file will be kept. The name of the copy is the
6024 name of the original file with the string in the 'patchmode' option
6025 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006026 ".orig" or ".org". 'backupdir' must not be empty for this to work
6027 (Detail: The backup file is renamed to the patchmode file after the
6028 new file has been successfully written, that's why it must be possible
6029 to write a backup file). If there was no file to be backed up, an
6030 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 When the 'backupskip' pattern matches, a patchmode file is not made.
6032 Using 'patchmode' for compressed files appends the extension at the
6033 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6034 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006035 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006037 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 other systems: ".,,")
6040 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006041 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006042 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6043 provided that the file being searched for has a relative path (not
6044 starting with "/", "./" or "../"). The directories in the 'path'
6045 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046 - Use commas to separate directory names: >
6047 :set path=.,/usr/local/include,/usr/include
6048< - Spaces can also be used to separate directory names (for backwards
6049 compatibility with version 3.0). To have a space in a directory
6050 name, precede it with an extra backslash, and escape the space: >
6051 :set path=.,/dir/with\\\ space
6052< - To include a comma in a directory name precede it with an extra
6053 backslash: >
6054 :set path=.,/dir/with\\,comma
6055< - To search relative to the directory of the current file, use: >
6056 :set path=.
6057< - To search in the current directory use an empty string between two
6058 commas: >
6059 :set path=,,
6060< - A directory name may end in a ':' or '/'.
6061 - Environment variables are expanded |:set_env|.
6062 - When using |netrw.vim| URLs can be used. For example, adding
6063 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006064 - Search upwards and downwards in a directory tree using "*", "**" and
6065 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 - Careful with '\' characters, type two to get one in the option: >
6067 :set path=.,c:\\include
6068< Or just use '/' instead: >
6069 :set path=.,c:/include
6070< Don't forget "." or files won't even be found in the same directory as
6071 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006072 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006073 it is something like 256 or 1024 characters.
6074 You can check if all the include files are found, using the value of
6075 'path', see |:checkpath|.
6076 The use of |:set+=| and |:set-=| is preferred when adding or removing
6077 directories from the list. This avoids problems when a future version
6078 uses another default. To remove the current directory use: >
6079 :set path-=
6080< To add the current directory use: >
6081 :set path+=
6082< To use an environment variable, you probably need to replace the
6083 separator. Here is an example to append $INCL, in which directory
6084 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006085 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006086< Replace the ';' with a ':' or whatever separator is used. Note that
6087 this doesn't work when $INCL contains a comma or white space.
6088
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006089 *'perldll'*
6090'perldll' string (default depends on the build)
6091 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006092 {only available when compiled with the |+perl/dyn|
6093 feature}
6094 Specifies the name of the Perl shared library. The default is
6095 DYNAMIC_PERL_DLL, which was specified at compile time.
6096 Environment variables are expanded |:set_env|.
6097 This option cannot be set from a |modeline| or in the |sandbox|, for
6098 security reasons.
6099
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6101'preserveindent' 'pi' boolean (default off)
6102 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 When changing the indent of the current line, preserve as much of the
6104 indent structure as possible. Normally the indent is replaced by a
6105 series of tabs followed by spaces as required (unless |'expandtab'| is
6106 enabled, in which case only spaces are used). Enabling this option
6107 means the indent will preserve as many existing characters as possible
6108 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006109 'expandtab' does not apply to the preserved white space, a Tab remains
6110 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111 NOTE: When using ">>" multiple times the resulting indent is a mix of
6112 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006113 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 Also see 'copyindent'.
6115 Use |:retab| to clean up white space.
6116
6117 *'previewheight'* *'pvh'*
6118'previewheight' 'pvh' number (default 12)
6119 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006120 {not available when compiled without the |+quickfix|
6121 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006123 commands. Used for |CTRL-W_}| when no count is given. Not used when
6124 'previewpopup' is set.
6125
6126 *'previewpopup'* *'pvp'*
6127'previewpopup' 'pvp' string (default empty)
6128 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006129 {not available when compiled without the |+textprop|
6130 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006131 When not empty a popup window is used for commands that would open a
6132 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006133 Not used for the insert completion info, add "popup" to
6134 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006135
6136 *'previewwindow'* *'nopreviewwindow'*
6137 *'pvw'* *'nopvw'* *E590*
6138'previewwindow' 'pvw' boolean (default off)
6139 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006140 {not available when compiled without the |+quickfix|
6141 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006142 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143 set. It's normally not set directly, but by using one of the commands
6144 |:ptag|, |:pedit|, etc.
6145
6146 *'printdevice'* *'pdev'*
6147'printdevice' 'pdev' string (default empty)
6148 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 {only available when compiled with the |+printer|
6150 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006151 The name of the printer to be used for |:hardcopy|.
6152 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006153 This option cannot be set from a |modeline| or in the |sandbox|, for
6154 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006155
Bram Moolenaar8299df92004-07-10 09:47:34 +00006156 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006157'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159 {only available when compiled with the |+printer|
6160 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006161 Sets the character encoding used when printing.
6162 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163
6164 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006165'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006166 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 {only available when compiled with the |+printer|
6168 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006169 Expression used to print the PostScript produced with |:hardcopy|.
6170 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006171 This option cannot be set from a |modeline| or in the |sandbox|, for
6172 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006173
Bram Moolenaar8299df92004-07-10 09:47:34 +00006174 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006175'printfont' 'pfn' string (default "courier")
6176 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006177 {only available when compiled with the |+printer|
6178 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006179 The name of the font that will be used for |:hardcopy|.
6180 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006181
6182 *'printheader'* *'pheader'*
6183'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6184 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185 {only available when compiled with the |+printer|
6186 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006187 The format of the header produced in |:hardcopy| output.
6188 See |pheader-option|.
6189
6190 *'printmbcharset'* *'pmbcs'*
6191'printmbcharset' 'pmbcs' string (default "")
6192 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006193 {only available when compiled with the |+printer|
6194 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006195 The CJK character set to be used for CJK output from |:hardcopy|.
6196 See |pmbcs-option|.
6197
6198 *'printmbfont'* *'pmbfn'*
6199'printmbfont' 'pmbfn' string (default "")
6200 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006201 {only available when compiled with the |+printer|
6202 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006203 List of font names to be used for CJK output from |:hardcopy|.
6204 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205
6206 *'printoptions'* *'popt'*
6207'printoptions' 'popt' string (default "")
6208 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006210 List of items that control the format of the output of |:hardcopy|.
6211 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006213 *'prompt'* *'noprompt'*
6214'prompt' boolean (default on)
6215 global
6216 When on a ":" prompt is used in Ex mode.
6217
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006218 *'pumheight'* *'ph'*
6219'pumheight' 'ph' number (default 0)
6220 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006221 Determines the maximum number of items to show in the popup menu for
6222 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006223 |ins-completion-menu|.
6224
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006225 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006226'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006227 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006228 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006229 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006230
Bram Moolenaard94464e2015-11-02 15:28:18 +01006231 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006232'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006233 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006234 {only available when compiled with the |+python/dyn|
6235 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006236 Specifies the name of the Python 2.x shared library. The default is
6237 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006238 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006239 This option cannot be set from a |modeline| or in the |sandbox|, for
6240 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006241
Bram Moolenaar94073162018-01-31 21:49:05 +01006242 *'pythonhome'*
6243'pythonhome' string (default "")
6244 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006245 {only available when compiled with the |+python/dyn|
6246 feature}
6247 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6248 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6249 which was specified at compile time, will be used for the Python 2.x
6250 home directory.
6251 Environment variables are expanded |:set_env|.
6252 This option cannot be set from a |modeline| or in the |sandbox|, for
6253 security reasons.
6254
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006255 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006256'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006257 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006258 {only available when compiled with the |+python3/dyn|
6259 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006260 Specifies the name of the Python 3 shared library. The default is
6261 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006262 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006263 This option cannot be set from a |modeline| or in the |sandbox|, for
6264 security reasons.
6265
Bram Moolenaar94073162018-01-31 21:49:05 +01006266 *'pythonthreehome'*
6267'pythonthreehome' string (default "")
6268 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006269 {only available when compiled with the |+python3/dyn|
6270 feature}
6271 Specifies the name of the Python 3 home directory. When
6272 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6273 PYTHON3_HOME, which was specified at compile time, will be used for
6274 the Python 3 home directory.
6275 Environment variables are expanded |:set_env|.
6276 This option cannot be set from a |modeline| or in the |sandbox|, for
6277 security reasons.
6278
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006279 *'pyxversion'* *'pyx'*
6280'pyxversion' 'pyx' number (default depends on the build)
6281 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006282 {only available when compiled with the |+python| or
6283 the |+python3| feature}
6284 Specifies the python version used for pyx* functions and commands
6285 |python_x|. The default value is as follows:
6286
6287 Compiled with Default ~
6288 |+python| and |+python3| 0
6289 only |+python| 2
6290 only |+python3| 3
6291
6292 Available values are 0, 2 and 3.
6293 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6294 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6295 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6296 to 2 if Python 2 is available.
6297 See also: |has-pythonx|
6298
6299 If Vim is compiled with only |+python| or |+python3| setting
6300 'pyxversion' has no effect. The pyx* functions and commands are
6301 always the same as the compiled version.
6302
6303 This option cannot be set from a |modeline| or in the |sandbox|, for
6304 security reasons.
6305
Bram Moolenaar858ba062020-05-31 23:11:59 +02006306 *'quickfixtextfunc'* *'qftf'*
6307'quickfixtextfunc' 'qftf' string (default "")
6308 global
6309 {only available when compiled with the |+quickfix|
6310 feature}
6311 This option specifies a function to be used to get the text to display
6312 in the quickfix and location list windows. This can be used to
6313 customize the information displayed in the quickfix or location window
6314 for each entry in the corresponding quickfix or location list. See
6315 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006316 function and an example. The value can be the name of a function, a
6317 |lambda| or a |Funcref|. See |option-value-function| for more
6318 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006319
6320 This option cannot be set from a |modeline| or in the |sandbox|, for
6321 security reasons.
6322
Bram Moolenaar677ee682005-01-27 14:41:15 +00006323 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006324'quoteescape' 'qe' string (default "\")
6325 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006326 The characters that are used to escape quotes in a string. Used for
6327 objects like a', a" and a` |a'|.
6328 When one of the characters in this option is found inside a string,
6329 the following character will be skipped. The default value makes the
6330 text "foo\"bar\\" considered to be one string.
6331
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6333'readonly' 'ro' boolean (default off)
6334 local to buffer
6335 If on, writes fail unless you use a '!'. Protects you from
6336 accidentally overwriting a file. Default on when Vim is started
6337 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006338 When using ":w!" the 'readonly' option is reset for the current
6339 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006340 When using the ":view" command the 'readonly' option is set for the
6341 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006342 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006344 *'redrawtime'* *'rdt'*
6345'redrawtime' 'rdt' number (default 2000)
6346 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006347 {only available when compiled with the |+reltime|
6348 feature}
6349 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006350 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006351 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006352 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006353 matches will be highlighted.
6354 For syntax highlighting the time applies per window. When over the
6355 limit syntax highlighting is disabled until |CTRL-L| is used.
6356 This is used to avoid that Vim hangs when using a very complicated
6357 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006358
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006359 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006360'regexpengine' 're' number (default 0)
6361 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006362 This selects the default regexp engine. |two-engines|
6363 The possible values are:
6364 0 automatic selection
6365 1 old engine
6366 2 NFA engine
6367 Note that when using the NFA engine and the pattern contains something
6368 that is not supported the pattern will not match. This is only useful
6369 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006370 Using automatic selection enables Vim to switch the engine, if the
6371 default engine becomes too costly. E.g., when the NFA engine uses too
6372 many states. This should prevent Vim from hanging on a combination of
6373 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006374
Bram Moolenaar64486672010-05-16 15:46:46 +02006375 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6376'relativenumber' 'rnu' boolean (default off)
6377 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006378 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006379 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006380 precede some vertical motion commands (e.g. j k + -) with, without
6381 having to calculate it yourself. Especially useful in combination with
6382 other commands (e.g. y d c < > gq gw =).
6383 When the 'n' option is excluded from 'cpoptions' a wrapped
6384 line will not use the column of line numbers (this is the default when
6385 'compatible' isn't set).
6386 The 'numberwidth' option can be used to set the room used for the line
6387 number.
6388 When a long, wrapped line doesn't start with the first character, '-'
6389 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006390 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6391 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006392
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006393 The number in front of the cursor line also depends on the value of
6394 'number', see |number_relativenumber| for all combinations of the two
6395 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006396
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397 *'remap'* *'noremap'*
6398'remap' boolean (default on)
6399 global
6400 Allows for mappings to work recursively. If you do not want this for
6401 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006402 NOTE: To avoid portability problems with Vim scripts, always keep
6403 this option at the default "on". Only switch it off when working with
6404 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006406 *'renderoptions'* *'rop'*
6407'renderoptions' 'rop' string (default: empty)
6408 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006409 {only available when compiled with GUI and DIRECTX on
6410 MS-Windows}
6411 Select a text renderer and set its options. The options depend on the
6412 renderer.
6413
6414 Syntax: >
6415 set rop=type:{renderer}(,{name}:{value})*
6416<
6417 Currently, only one optional renderer is available.
6418
6419 render behavior ~
6420 directx Vim will draw text using DirectX (DirectWrite). It makes
6421 drawn glyphs more beautiful than default GDI.
6422 It requires 'encoding' is "utf-8", and only works on
6423 MS-Windows Vista or newer version.
6424
6425 Options:
6426 name meaning type value ~
6427 gamma gamma float 1.0 - 2.2 (maybe)
6428 contrast enhancedContrast float (unknown)
6429 level clearTypeLevel float (unknown)
6430 geom pixelGeometry int 0 - 2 (see below)
6431 renmode renderingMode int 0 - 6 (see below)
6432 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006433 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006434
Bram Moolenaar92467d32017-12-05 13:22:16 +01006435 See this URL for detail (except for scrlines):
6436 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006437
6438 For geom: structure of a device pixel.
6439 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6440 1 - DWRITE_PIXEL_GEOMETRY_RGB
6441 2 - DWRITE_PIXEL_GEOMETRY_BGR
6442
6443 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006444 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006445
6446 For renmode: method of rendering glyphs.
6447 0 - DWRITE_RENDERING_MODE_DEFAULT
6448 1 - DWRITE_RENDERING_MODE_ALIASED
6449 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6450 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6451 4 - DWRITE_RENDERING_MODE_NATURAL
6452 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6453 6 - DWRITE_RENDERING_MODE_OUTLINE
6454
6455 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006456 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006457
6458 For taamode: antialiasing mode used for drawing text.
6459 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6460 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6461 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6462 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6463
6464 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006465 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6466
Bram Moolenaara338adc2018-01-31 20:51:47 +01006467 For scrlines:
6468 This was used for optimizing scrolling behavior, however this
6469 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006470
6471 Example: >
6472 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006473 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006474 set rop=type:directx
6475<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006476 If select a raster font (Courier, Terminal or FixedSys which
6477 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006478 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006479
6480 NOTE: It is known that some fonts and options combination
6481 causes trouble on drawing glyphs.
6482
Bram Moolenaar92467d32017-12-05 13:22:16 +01006483 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006484 special made fonts (True-Type fonts which includes only
6485 bitmap glyphs).
6486 - 'taamode:3' will not work with some vector fonts.
6487
6488 NOTE: With this option, you can display colored emoji
6489 (emoticon) in Windows 8.1 or later. To display colored emoji,
6490 there are some conditions which you should notice.
6491
6492 - If your font includes non-colored emoji already, it will
6493 be used.
6494 - If your font doesn't have emoji, the system chooses an
6495 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6496 will be used.
6497 - When this alternative font didn't have fixed width glyph,
6498 emoji might be rendered beyond the bounding box of drawing
6499 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006500
6501 Other render types are currently not supported.
6502
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 *'report'*
6504'report' number (default 2)
6505 global
6506 Threshold for reporting number of lines changed. When the number of
6507 changed lines is more than 'report' a message will be given for most
6508 ":" commands. If you want it always, set 'report' to 0.
6509 For the ":substitute" command the number of substitutions is used
6510 instead of the number of lines.
6511
6512 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6513'restorescreen' 'rs' boolean (default on)
6514 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006515 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 When set, the screen contents is restored when exiting Vim. This also
6517 happens when executing external commands.
6518
6519 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6520 options in your .vimrc. To disable restoring:
6521 set t_ti= t_te=
6522 To enable restoring (for an xterm):
6523 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6524 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6525
6526 *'revins'* *'ri'* *'norevins'* *'nori'*
6527'revins' 'ri' boolean (default off)
6528 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529 {only available when compiled with the |+rightleft|
6530 feature}
6531 Inserting characters in Insert mode will work backwards. See "typing
6532 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6533 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006534 NOTE: This option is reset when 'compatible' is set.
6535 This option is reset when 'paste' is set and restored when 'paste' is
6536 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537
6538 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6539'rightleft' 'rl' boolean (default off)
6540 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541 {only available when compiled with the |+rightleft|
6542 feature}
6543 When on, display orientation becomes right-to-left, i.e., characters
6544 that are stored in the file appear from the right to the left.
6545 Using this option, it is possible to edit files for languages that
6546 are written from the right to the left such as Hebrew and Arabic.
6547 This option is per window, so it is possible to edit mixed files
6548 simultaneously, or to view the same file in both ways (this is
6549 useful whenever you have a mixed text file with both right-to-left
6550 and left-to-right strings so that both sets are displayed properly
6551 in different windows). Also see |rileft.txt|.
6552
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006553 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554'rightleftcmd' 'rlc' string (default "search")
6555 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556 {only available when compiled with the |+rightleft|
6557 feature}
6558 Each word in this option enables the command line editing to work in
6559 right-to-left mode for a group of commands:
6560
6561 search "/" and "?" commands
6562
6563 This is useful for languages such as Hebrew, Arabic and Farsi.
6564 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6565
Bram Moolenaard94464e2015-11-02 15:28:18 +01006566 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006567'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006568 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006569 {only available when compiled with the |+ruby/dyn|
6570 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006571 Specifies the name of the Ruby shared library. The default is
6572 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006573 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006574 This option cannot be set from a |modeline| or in the |sandbox|, for
6575 security reasons.
6576
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006578'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006579 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006581 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 text in the file is shown on the far right:
6583 Top first line is visible
6584 Bot last line is visible
6585 All first and last line are visible
6586 45% relative position in the file
6587 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006588 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006589 ruler is shown there. Otherwise it is shown in the last line of the
6590 screen. If the statusline is given by 'statusline' (i.e. not empty),
6591 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006593 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 the text column (byte number) and the screen column are shown,
6595 separated with a dash.
6596 For an empty line "0-1" is shown.
6597 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006598 This option is reset when 'paste' is set and restored when 'paste' is
6599 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600 If you don't want to see the ruler all the time but want to know where
6601 you are, use "g CTRL-G" |g_CTRL-G|.
6602 NOTE: This option is reset when 'compatible' is set.
6603
6604 *'rulerformat'* *'ruf'*
6605'rulerformat' 'ruf' string (default empty)
6606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607 {not available when compiled without the |+statusline|
6608 feature}
6609 When this option is not empty, it determines the content of the ruler
6610 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006611 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006612 This option cannot be set in a modeline when 'modelineexpr' is off.
6613
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 The default ruler width is 17 characters. To make the ruler 15
6615 characters wide, put "%15(" at the start and "%)" at the end.
6616 Example: >
6617 :set rulerformat=%15(%c%V\ %p%%%)
6618<
6619 *'runtimepath'* *'rtp'* *vimfiles*
6620'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006621 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 $VIM/vimfiles,
6623 $VIMRUNTIME,
6624 $VIM/vimfiles/after,
6625 $HOME/.vim/after"
6626 Amiga: "home:vimfiles,
6627 $VIM/vimfiles,
6628 $VIMRUNTIME,
6629 $VIM/vimfiles/after,
6630 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006631 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 $VIM/vimfiles,
6633 $VIMRUNTIME,
6634 $VIM/vimfiles/after,
6635 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006636 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 $VIMRUNTIME,
6638 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006639 Haiku: "$BE_USER_SETTINGS/vim,
6640 $VIM/vimfiles,
6641 $VIMRUNTIME,
6642 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006643 $BE_USER_SETTINGS/vim/after"
6644 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006645 $VIM/vimfiles,
6646 $VIMRUNTIME,
6647 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006648 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006650 This is a list of directories which will be searched for runtime
6651 files:
6652 filetype.vim filetypes by file name |new-filetype|
6653 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006654 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 colors/ color scheme files |:colorscheme|
6656 compiler/ compiler files |:compiler|
6657 doc/ documentation |write-local-help|
6658 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006659 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660 indent/ indent scripts |indent-expression|
6661 keymap/ key mapping files |mbyte-keymap|
6662 lang/ menu translations |:menutrans|
6663 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006664 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 plugin/ plugin scripts |write-plugin|
6666 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006667 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 syntax/ syntax files |mysyntaxfile|
6669 tutor/ files for vimtutor |tutor|
6670
6671 And any other file searched for with the |:runtime| command.
6672
6673 The defaults for most systems are setup to search five locations:
6674 1. In your home directory, for your personal preferences.
6675 2. In a system-wide Vim directory, for preferences from the system
6676 administrator.
6677 3. In $VIMRUNTIME, for files distributed with Vim.
6678 *after-directory*
6679 4. In the "after" directory in the system-wide Vim directory. This is
6680 for the system administrator to overrule or add to the distributed
6681 defaults (rarely needed)
6682 5. In the "after" directory in your home directory. This is for
6683 personal preferences to overrule or add to the distributed defaults
6684 or system-wide settings (rarely needed).
6685
Bram Moolenaard0796902016-09-16 20:02:31 +02006686 More entries are added when using |packages|. If it gets very long
6687 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6688 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006689
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6691 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006692 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693 wildcards.
6694 See |:runtime|.
6695 Example: >
6696 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6697< This will use the directory "~/vimruntime" first (containing your
6698 personal Vim runtime files), then "/mygroup/vim" (shared between a
6699 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6700 files).
6701 You probably should always include $VIMRUNTIME somewhere, to use the
6702 distributed runtime files. You can put a directory before $VIMRUNTIME
6703 to find files which replace a distributed runtime files. You can put
6704 a directory after $VIMRUNTIME to find files which add to distributed
6705 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006706 When Vim is started with |--clean| the home directory entries are not
6707 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 This option cannot be set from a |modeline| or in the |sandbox|, for
6709 security reasons.
6710
6711 *'scroll'* *'scr'*
6712'scroll' 'scr' number (default: half the window height)
6713 local to window
6714 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6715 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006716 changes. This may happen when enabling the |status-line| or
6717 'tabline' option after setting the 'scroll' option.
6718 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006719 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006720 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721
6722 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6723'scrollbind' 'scb' boolean (default off)
6724 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006725 See also |scroll-binding|. When this option is set, the current
6726 window scrolls as other scrollbind windows (windows that also have
6727 this option set) scroll. This option is useful for viewing the
6728 differences between two versions of a file, see 'diff'.
6729 See |'scrollopt'| for options that determine how this option should be
6730 interpreted.
6731 This option is mostly reset when splitting a window to edit another
6732 file. This means that ":split | edit file" results in two windows
6733 with scroll-binding, but ":split file" does not.
6734
Bram Moolenaarae20f342019-11-05 21:09:23 +01006735 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6736'scrollfocus' 'scf' boolean (default off)
6737 global
6738 {only for MS-Windows GUI}
6739 When using the scroll wheel and this option is set, the window under
6740 the mouse pointer is scrolled. With this option off the current
6741 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006742 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006743
Bram Moolenaar071d4272004-06-13 20:20:40 +00006744 *'scrolljump'* *'sj'*
6745'scrolljump' 'sj' number (default 1)
6746 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 Minimal number of lines to scroll when the cursor gets off the
6748 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6749 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006750 When set to a negative number from -1 to -100 this is used as the
6751 percentage of the window height. Thus -50 scrolls half the window
6752 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 NOTE: This option is set to 1 when 'compatible' is set.
6754
6755 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006756'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006757 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 Minimal number of screen lines to keep above and below the cursor.
6759 This will make some context visible around where you are working. If
6760 you set it to a very large value (999) the cursor line will always be
6761 in the middle of the window (except at the start or end of the file or
6762 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006763 After using the local value, go back the global value with one of
6764 these two: >
6765 setlocal scrolloff<
6766 setlocal scrolloff=-1
6767< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768 NOTE: This option is set to 0 when 'compatible' is set.
6769
6770 *'scrollopt'* *'sbo'*
6771'scrollopt' 'sbo' string (default "ver,jump")
6772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006774 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6775 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776 The following words are available:
6777 ver Bind vertical scrolling for 'scrollbind' windows
6778 hor Bind horizontal scrolling for 'scrollbind' windows
6779 jump Applies to the offset between two windows for vertical
6780 scrolling. This offset is the difference in the first
6781 displayed line of the bound windows. When moving
6782 around in a window, another 'scrollbind' window may
6783 reach a position before the start or after the end of
6784 the buffer. The offset is not changed though, when
6785 moving back the 'scrollbind' window will try to scroll
6786 to the desired position when possible.
6787 When now making that window the current one, two
6788 things can be done with the relative offset:
6789 1. When "jump" is not included, the relative offset is
6790 adjusted for the scroll position in the new current
6791 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006792 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793 2. When "jump" is included, the other windows are
6794 scrolled to keep the same relative offset. When
6795 going back to the other window, it still uses the
6796 same relative offset.
6797 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006798 When 'diff' mode is active there always is vertical scroll binding,
6799 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800
6801 *'sections'* *'sect'*
6802'sections' 'sect' string (default "SHNHH HUnhsh")
6803 global
6804 Specifies the nroff macros that separate sections. These are pairs of
6805 two letters (See |object-motions|). The default makes a section start
6806 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6807
6808 *'secure'* *'nosecure'* *E523*
6809'secure' boolean (default off)
6810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 When on, ":autocmd", shell and write commands are not allowed in
6812 ".vimrc" and ".exrc" in the current directory and map commands are
6813 displayed. Switch it off only if you know that you will not run into
6814 problems, or when the 'exrc' option is off. On Unix this option is
6815 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006816 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 'secure' at the end of your ~/.vimrc then.
6818 This option cannot be set from a |modeline| or in the |sandbox|, for
6819 security reasons.
6820
6821 *'selection'* *'sel'*
6822'selection' 'sel' string (default "inclusive")
6823 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 This option defines the behavior of the selection. It is only used
6825 in Visual and Select mode.
6826 Possible values:
6827 value past line inclusive ~
6828 old no yes
6829 inclusive yes yes
6830 exclusive yes no
6831 "past line" means that the cursor is allowed to be positioned one
6832 character past the line.
6833 "inclusive" means that the last character of the selection is included
6834 in an operation. For example, when "x" is used to delete the
6835 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006836 When "old" is used and 'virtualedit' allows the cursor to move past
6837 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 Note that when "exclusive" is used and selecting from the end
6839 backwards, you cannot include the last character of a line, when
6840 starting in Normal mode and 'virtualedit' empty.
6841
6842 The 'selection' option is set by the |:behave| command.
6843
6844 *'selectmode'* *'slm'*
6845'selectmode' 'slm' string (default "")
6846 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006847 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848 Select mode instead of Visual mode, when a selection is started.
6849 Possible values:
6850 mouse when using the mouse
6851 key when using shifted special keys
6852 cmd when using "v", "V" or CTRL-V
6853 See |Select-mode|.
6854 The 'selectmode' option is set by the |:behave| command.
6855
6856 *'sessionoptions'* *'ssop'*
6857'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006858 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006860 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006861 feature}
6862 Changes the effect of the |:mksession| command. It is a comma
6863 separated list of words. Each word enables saving and restoring
6864 something:
6865 word save and restore ~
6866 blank empty windows
6867 buffers hidden and unloaded buffers, not just those in windows
6868 curdir the current directory
6869 folds manually created folds, opened/closed folds and local
6870 fold options
6871 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006872 and contain at least one lowercase letter. Only
6873 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874 help the help window
6875 localoptions options and mappings local to a window or buffer (not
6876 global values for local options)
6877 options all options and mappings (also global values for local
6878 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006879 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 resize size of the Vim window: 'lines' and 'columns'
6881 sesdir the directory in which the session file is located
6882 will become the current directory (useful with
6883 projects accessed over a network from different
6884 systems)
6885 slash backslashes in file names replaced with forward
6886 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006887 tabpages all tab pages; without this only the current tab page
6888 is restored, so that you can make a session for each
6889 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006890 terminal include terminal windows where the command can be
6891 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 unix with Unix end-of-line format (single <NL>), even when
6893 on Windows or DOS
6894 winpos position of the whole Vim window
6895 winsize window sizes
6896
6897 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006898 When neither "curdir" nor "sesdir" is included, file names are stored
6899 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006900 If you leave out "options" many things won't work well after restoring
6901 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 "slash" and "unix" are useful on Windows when sharing session files
6903 with Unix. The Unix version of Vim cannot source dos format scripts,
6904 but the Windows version of Vim can source unix format scripts.
6905
6906 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006907'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908 global
6909 Name of the shell to use for ! and :! commands. When changing the
6910 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6911 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006912 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 See |option-backslash| about including spaces and backslashes.
6914 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006915
Bram Moolenaara2baa732022-02-04 16:09:54 +00006916 In |restricted-mode| shell commands will not be possible. This mode
6917 is used if the value of $SHELL ends in "false" or "nologin".
6918
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006919 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006920 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006921 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6922< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006923 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006924 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006925 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006927 Example with escaped space (Vim will do this when initializing the
6928 option from $SHELL): >
6929 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006930< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006931 backslashes are consumed by `:set`.
6932
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933 Under MS-Windows, when the executable ends in ".com" it must be
6934 included. Thus setting the shell to "command.com" or "4dos.com"
6935 works, but "command" and "4dos" do not work for all commands (e.g.,
6936 filtering).
6937 For unknown reasons, when using "4dos.com" the current directory is
6938 changed to "C:\". To avoid this set 'shell' like this: >
6939 :set shell=command.com\ /c\ 4dos
6940< This option cannot be set from a |modeline| or in the |sandbox|, for
6941 security reasons.
6942
6943 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006944'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006945 Win32, when 'shell' contains "powershell":
6946 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006947 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006948 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006950 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6951 For MS-Windows, the default is set according to the value of 'shell',
6952 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006953 On Unix it can have more than one flag. Each white space separated
6954 part is passed as an argument to the shell command.
6955 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006956 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 This option cannot be set from a |modeline| or in the |sandbox|, for
6958 security reasons.
6959
6960 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006961'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6962 "2>&1| tee", or
6963 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965 {not available when compiled without the |+quickfix|
6966 feature}
6967 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006968 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 including spaces and backslashes.
6970 The name of the temporary file can be represented by "%s" if necessary
6971 (the file name is appended automatically if no %s appears in the value
6972 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006973 For the Amiga the default is ">". For MS-Windows using powershell the
6974 default is "2>&1 | Out-File -Encoding default", otherwise the default
6975 is ">%s 2>&1". The output is directly saved in a file and not echoed
6976 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006977 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978 in a file and echoed to the screen. If the 'shell' option is "csh" or
6979 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006980 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006981 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6982 means that stderr is also included. Before using the 'shell' option a
6983 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006984 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6985 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 The initialization of this option is done after reading the ".vimrc"
6987 and the other initializations, so that when the 'shell' option is set
6988 there, the 'shellpipe' option changes automatically, unless it was
6989 explicitly set before.
6990 When 'shellpipe' is set to an empty string, no redirection of the
6991 ":make" output will be done. This is useful if you use a 'makeprg'
6992 that writes to 'makeef' by itself. If you want no piping, but do
6993 want to include the 'makeef', set 'shellpipe' to a single space.
6994 Don't forget to precede the space with a backslash: ":set sp=\ ".
6995 In the future pipes may be used for filtering and this option will
6996 become obsolete (at least for Unix).
6997 This option cannot be set from a |modeline| or in the |sandbox|, for
6998 security reasons.
6999
7000 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007001'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007002 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003 Quoting character(s), put around the command passed to the shell, for
7004 the "!" and ":!" commands. The redirection is kept outside of the
7005 quoting. See 'shellxquote' to include the redirection. It's
7006 probably not useful to set both options.
7007 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007008 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007009 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007010 This option cannot be set from a |modeline| or in the |sandbox|, for
7011 security reasons.
7012
7013 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007014'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7015 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007017 String to be used to put the output of a filter command in a temporary
7018 file. See also |:!|. See |option-backslash| about including spaces
7019 and backslashes.
7020 The name of the temporary file can be represented by "%s" if necessary
7021 (the file name is appended automatically if no %s appears in the value
7022 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007023 The default is ">". For Unix, if the 'shell' option is "csh" or
7024 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007025 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007026 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7027 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007028 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7029 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007030 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7031 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032 The initialization of this option is done after reading the ".vimrc"
7033 and the other initializations, so that when the 'shell' option is set
7034 there, the 'shellredir' option changes automatically unless it was
7035 explicitly set before.
7036 In the future pipes may be used for filtering and this option will
7037 become obsolete (at least for Unix).
7038 This option cannot be set from a |modeline| or in the |sandbox|, for
7039 security reasons.
7040
7041 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7042'shellslash' 'ssl' boolean (default off)
7043 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007044 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007046 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007047 powershell.exe. Backward slashes can still be typed, but they are
7048 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 Note that setting or resetting this option has no effect for some
7050 existing file names, thus this option needs to be set before opening
7051 any file for best results. This might change in the future.
7052 'shellslash' only works when a backslash can be used as a path
7053 separator. To test if this is so use: >
7054 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007055< Also see 'completeslash'.
7056
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007057 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7058'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7059 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007060 When on, use temp files for shell commands. When off use a pipe.
7061 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007062 Currently a pipe is only supported on Unix and MS-Windows 2K and
7063 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007064 :if has("filterpipe")
7065< The advantage of using a pipe is that nobody can read the temp file
7066 and the 'shell' command does not need to support redirection.
7067 The advantage of using a temp file is that the file type and encoding
7068 can be detected.
7069 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7070 |FilterWritePost| autocommands event are not triggered when
7071 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007072 The `system()` function does not respect this option and always uses
7073 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007074 NOTE: This option is set to the Vim default value when 'compatible'
7075 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007076
Bram Moolenaar071d4272004-06-13 20:20:40 +00007077 *'shelltype'* *'st'*
7078'shelltype' 'st' number (default 0)
7079 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007080 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081 On the Amiga this option influences the way how the commands work
7082 which use a shell.
7083 0 and 1: always use the shell
7084 2 and 3: use the shell only to filter lines
7085 4 and 5: use shell only for ':sh' command
7086 When not using the shell, the command is executed directly.
7087
7088 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7089 1 and 3: use "shell cmd" to start external commands
7090
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007091 *'shellxescape'* *'sxe'*
7092'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007093 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007094 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007095 When 'shellxquote' is set to "(" then the characters listed in this
7096 option will be escaped with a '^' character. This makes it possible
7097 to execute most external commands with cmd.exe.
7098
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 *'shellxquote'* *'sxq'*
7100'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007101 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007102 for Win32, when 'shell' is
7103 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007104 for Win32, when 'shell' contains "sh"
7105 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106 for Unix, when using system(): "\"")
7107 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108 Quoting character(s), put around the command passed to the shell, for
7109 the "!" and ":!" commands. Includes the redirection. See
7110 'shellquote' to exclude the redirection. It's probably not useful
7111 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007112 When the value is '(' then ')' is appended. When the value is '"('
7113 then ')"' is appended.
7114 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007115 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007116 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7117 pwsh.exe which automatically strips off the first and last quote on a
7118 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7119 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007120 'shell', to reduce the need to set this option by the user. See
7121 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007122 This option cannot be set from a |modeline| or in the |sandbox|, for
7123 security reasons.
7124
7125 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7126'shiftround' 'sr' boolean (default off)
7127 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 Round indent to multiple of 'shiftwidth'. Applies to > and <
7129 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7130 a multiple of 'shiftwidth' (this is Vi compatible).
7131 NOTE: This option is reset when 'compatible' is set.
7132
7133 *'shiftwidth'* *'sw'*
7134'shiftwidth' 'sw' number (default 8)
7135 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007136 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007138 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007139 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007140
7141 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007142'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7143 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007144 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007145 This option helps to avoid all the |hit-enter| prompts caused by file
7146 messages, for example with CTRL-G, and to avoid some other messages.
7147 It is a list of flags:
7148 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007149 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7150 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7151 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7152 m use "[+]" instead of "[Modified]" *shm-m*
7153 n use "[New]" instead of "[New File]" *shm-n*
7154 r use "[RO]" instead of "[readonly]" *shm-r*
7155 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007157 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7158 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007159 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007160 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007161
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007162 o overwrite message for writing a file with subsequent *shm-o*
7163 message for reading a file (useful for ":wn" or when
7164 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007165 O message for reading a file overwrites any previous *shm-O*
7166 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007167 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7168 "search hit TOP, continuing at BOTTOM" messages; when using
7169 the search count do not show "W" after the count message (see
7170 S below)
7171 t truncate file message at the start if it is too long *shm-t*
7172 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007173 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007174 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007175 long to fit on the command line; "..." will appear in the
7176 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007177 W don't give "written" or "[w]" when writing a file *shm-W*
7178 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007179 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007180 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007181 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007182 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007183 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7184 match", "Pattern not found", "Back at original", etc.
7185 C don't give messages while scanning for ins-completion *shm-C*
7186 items, for instance "scanning tags"
7187 q use "recording" instead of "recording @a" *shm-q*
7188 F don't give the file info when editing a file, like *shm-F*
7189 `:silent` was used for the command; note that this also
7190 affects messages from autocommands
Bram Moolenaar938ae282023-02-20 20:44:55 +00007191 S do not show search count message when searching, e.g. *shm-S*
7192 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193
7194 This gives you the opportunity to avoid that a change between buffers
7195 requires you to hit <Enter>, but still gives as useful a message as
7196 possible for the space available. To get the whole message that you
7197 would have got with 'shm' empty, use ":file!"
7198 Useful values:
7199 shm= No abbreviation of message.
7200 shm=a Abbreviation, but no loss of information.
7201 shm=at Abbreviation, and truncate message when necessary.
7202
7203 NOTE: This option is set to the Vi default value when 'compatible' is
7204 set and to the Vim default value when 'compatible' is reset.
7205
7206 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7207'shortname' 'sn' boolean (default off)
7208 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007209 Filenames are assumed to be 8 characters plus one extension of 3
7210 characters. Multiple dots in file names are not allowed. When this
7211 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007212 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007213 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007214 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215
7216 *'showbreak'* *'sbr'* *E595*
7217'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007218 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007219 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220 feature}
7221 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007222 values are "> " or "+++ ": >
7223 :set showbreak=>\
7224< Note the backslash to escape the trailing space. It's easier like
7225 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007226 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007227< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228 comma (in a future version the comma might be used to separate the
7229 part that is shown at the end and at the start of a line).
7230 The characters are highlighted according to the '@' flag in
7231 'highlight'.
7232 Note that tabs after the showbreak will be displayed differently.
7233 If you want the 'showbreak' to appear in between line numbers, add the
7234 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007235 A window-local value overrules a global value. If the global value is
7236 set and you want no value in the current window use NONE: >
7237 :setlocal showbreak=NONE
7238<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007240'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7241 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007243 Show (partial) command in the last line of the screen. Set this
7244 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007245 In Visual mode the size of the selected area is shown:
7246 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007247 If the number of bytes is different it is also displayed: "2-6"
7248 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007250 - When selecting a block, the size in screen characters:
7251 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007252 This information can be displayed in an alternative location using the
7253 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007254 NOTE: This option is set to the Vi default value when 'compatible' is
7255 set and to the Vim default value when 'compatible' is reset.
7256
Luuk van Baalba936f62022-12-15 13:15:39 +00007257 *'showcmdloc'* *'sloc'*
7258'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007259 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007260 This option can be used to display the (partially) entered command in
7261 another location. Possible values are:
7262 last Last line of the screen (default).
7263 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007264 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007265 Setting this option to "statusline" or "tabline" means that these will
7266 be redrawn whenever the command changes, which can be on every key
7267 pressed.
7268 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7269 place the text. Without a custom 'statusline' or 'tabline' it will be
7270 displayed in a convenient location.
7271
Bram Moolenaar071d4272004-06-13 20:20:40 +00007272 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7273'showfulltag' 'sft' boolean (default off)
7274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 When completing a word in insert mode (see |ins-completion|) from the
7276 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007277 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 matched a C function, you can see a template for what arguments are
7279 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007280 Note that this doesn't work well together with having "longest" in
7281 'completeopt', because the completion from the search pattern may not
7282 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283
7284 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7285'showmatch' 'sm' boolean (default off)
7286 global
7287 When a bracket is inserted, briefly jump to the matching one. The
7288 jump is only done if the match can be seen on the screen. The time to
7289 show the match can be set with 'matchtime'.
7290 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007291 seen or not).
7292 This option is reset when 'paste' is set and restored when 'paste' is
7293 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007294 When the 'm' flag is not included in 'cpoptions', typing a character
7295 will immediately move the cursor back to where it belongs.
7296 See the "sm" field in 'guicursor' for setting the cursor shape and
7297 blinking when showing the match.
7298 The 'matchpairs' option can be used to specify the characters to show
7299 matches for. 'rightleft' and 'revins' are used to look for opposite
7300 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007301 Also see the matchparen plugin for highlighting the match when moving
7302 around |pi_paren.txt|.
7303 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304
7305 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7306'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7307 global
7308 If in Insert, Replace or Visual mode put a message on the last line.
7309 Use the 'M' flag in 'highlight' to set the type of highlighting for
7310 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007311 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007312 doesn't mean XIM is really active, especially when 'imactivatekey' is
7313 not set.
7314 NOTE: This option is set to the Vi default value when 'compatible' is
7315 set and to the Vim default value when 'compatible' is reset.
7316
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007317 *'showtabline'* *'stal'*
7318'showtabline' 'stal' number (default 1)
7319 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007320 The value of this option specifies when the line with tab page labels
7321 will be displayed:
7322 0: never
7323 1: only if there are at least two tab pages
7324 2: always
7325 This is both for the GUI and non-GUI implementation of the tab pages
7326 line.
7327 See |tab-page| for more information about tab pages.
7328
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329 *'sidescroll'* *'ss'*
7330'sidescroll' 'ss' number (default 0)
7331 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007332 The minimal number of columns to scroll horizontally. Used only when
7333 the 'wrap' option is off and the cursor is moved off of the screen.
7334 When it is zero the cursor will be put in the middle of the screen.
7335 When using a slow terminal set it to a large number or 0. When using
7336 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7337 commands.
7338
7339 *'sidescrolloff'* *'siso'*
7340'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007341 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007343 right of the cursor if 'nowrap' is set. Setting this option to a
7344 value greater than 0 while having |'sidescroll'| also at a non-zero
7345 value makes some context visible in the line you are scrolling in
7346 horizontally (except at beginning of the line). Setting this option
7347 to a large value (like 999) has the effect of keeping the cursor
7348 horizontally centered in the window, as long as one does not come too
7349 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007350 After using the local value, go back the global value with one of
7351 these two: >
7352 setlocal sidescrolloff<
7353 setlocal sidescrolloff=-1
7354< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355
7356 Example: Try this together with 'sidescroll' and 'listchars' as
7357 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007358 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359
7360 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7361 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007362<
7363 *'signcolumn'* *'scl'*
7364'signcolumn' 'scl' string (default "auto")
7365 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007366 {not available when compiled without the |+signs|
7367 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007368 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007369 "auto" only when there is a sign to display
7370 "no" never
7371 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007372 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007373 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007374
7375
7376 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7377'smartcase' 'scs' boolean (default off)
7378 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007379 Override the 'ignorecase' option if the search pattern contains upper
7380 case characters. Only used when the search pattern is typed and
7381 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007382 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007383 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7384 recalling the search pattern from history and hitting <Enter>.
7385 NOTE: This option is reset when 'compatible' is set.
7386
7387 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7388'smartindent' 'si' boolean (default off)
7389 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007390 Do smart autoindenting when starting a new line. Works for C-like
7391 programs, but can also be used for other languages. 'cindent' does
7392 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007393 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007394 setting 'si' has no effect. 'indentexpr' is a more advanced
7395 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 Normally 'autoindent' should also be on when using 'smartindent'.
7397 An indent is automatically inserted:
7398 - After a line ending in '{'.
7399 - After a line starting with a keyword from 'cinwords'.
7400 - Before a line starting with '}' (only with the "O" command).
7401 When typing '}' as the first character in a new line, that line is
7402 given the same indent as the matching '{'.
7403 When typing '#' as the first character in a new line, the indent for
7404 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007405 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007406 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7407 When using the ">>" command, lines starting with '#' are not shifted
7408 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007409 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007410 This option is reset when 'paste' is set and restored when 'paste' is
7411 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007412
7413 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7414'smarttab' 'sta' boolean (default off)
7415 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007417 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7418 <BS> will delete a 'shiftwidth' worth of space at the start of the
7419 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007420 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007421 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7422 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007423 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007425 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007426 This option is reset when 'paste' is set and restored when 'paste' is
7427 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428 NOTE: This option is reset when 'compatible' is set.
7429
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007430 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7431'smoothscroll' 'sms' boolean (default off)
7432 local to window
7433 Scrolling works with screen lines. When 'wrap' is set and the first
7434 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007435 above the window. "<<<" is displayed at the start of the first line,
7436 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007437 You may also want to add "lastline" to the 'display' option to show as
7438 much of the last line as possible.
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007439 NOTE: only partly implemented, currently works with CTRL-E, CTRL-Y
7440 and scrolling with the mouse.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007441
Bram Moolenaar071d4272004-06-13 20:20:40 +00007442 *'softtabstop'* *'sts'*
7443'softtabstop' 'sts' number (default 0)
7444 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007445 Number of spaces that a <Tab> counts for while performing editing
7446 operations, like inserting a <Tab> or using <BS>. It "feels" like
7447 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7448 used. This is useful to keep the 'ts' setting at its standard value
7449 of 8, while being able to edit like it is set to 'sts'. However,
7450 commands like "x" still work on the actual characters.
7451 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007452 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007453 'softtabstop' is set to 0 when the 'paste' option is set and restored
7454 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7456 spaces is minimized by using <Tab>s.
7457 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7458 set.
7459 NOTE: This option is set to 0 when 'compatible' is set.
7460
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007461 If Vim is compiled with the |+vartabs| feature then the value of
7462 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7463 anything other than an empty string.
7464
Bram Moolenaar217ad922005-03-20 22:37:15 +00007465 *'spell'* *'nospell'*
7466'spell' boolean (default off)
7467 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007468 {not available when compiled without the |+syntax|
7469 feature}
7470 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007471 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007472
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007473 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007474'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007475 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007476 {not available when compiled without the |+syntax|
7477 feature}
7478 Pattern to locate the end of a sentence. The following word will be
7479 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007480 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007481 When this check is not wanted make this option empty.
7482 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007483 Be careful with special characters, see |option-backslash| about
7484 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007485 To set this option automatically depending on the language, see
7486 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007487
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007488 *'spellfile'* *'spf'*
7489'spellfile' 'spf' string (default empty)
7490 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007491 {not available when compiled without the |+syntax|
7492 feature}
7493 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007494 commands. It must end in ".{encoding}.add". You need to include the
7495 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007496 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007497 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007498 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007499 |zg| and |zw| commands can be used to access each. This allows using
7500 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007501 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007502 you: Using the first directory in 'runtimepath' that is writable. If
7503 there is no "spell" directory yet it will be created. For the file
7504 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007505 ignoring the region.
7506 The resulting ".spl" file will be used for spell checking, it does not
7507 have to appear in 'spelllang'.
7508 Normally one file is used for all regions, but you can add the region
7509 name if you want to. However, it will then only be used when
7510 'spellfile' is set to it, for entries in 'spelllang' only files
7511 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007512 This option cannot be set from a |modeline| or in the |sandbox|, for
7513 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007514
Bram Moolenaar217ad922005-03-20 22:37:15 +00007515 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007516'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007517 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007518 {not available when compiled without the |+syntax|
7519 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007520 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007521 on spellchecking will be done for these languages. Example: >
7522 set spelllang=en_us,nl,medical
7523< This means US English, Dutch and medical words are recognized. Words
7524 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007525 The word list name must consist of alphanumeric characters, a dash or
7526 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007527 recommended to separate the two letter language name from a
7528 specification. Thus "en-rare" is used for rare English words.
7529 A region name must come last and have the form "_xx", where "xx" is
7530 the two-letter, lower case region name. You can use more than one
7531 region by listing them: "en_us,en_ca" supports both US and Canadian
7532 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007533 Britain. (Note: currently en_au and en_nz dictionaries are older than
7534 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007535 If the name "cjk" is included East Asian characters are excluded from
7536 spell checking. This is useful when editing text that also has Asian
7537 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007538 Note that the "medical" dictionary does not exist, it is just an
7539 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007540 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007541 As a special case the name of a .spl file can be given as-is. The
7542 first "_xx" in the name is removed and used as the region name
7543 (_xx is an underscore, two letters and followed by a non-letter).
7544 This is mainly for testing purposes. You must make sure the correct
7545 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007546 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007547 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7548 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007549 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007550
Bram Moolenaar98692072006-02-04 00:57:42 +00007551 If the |spellfile.vim| plugin is active and you use a language name
7552 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7553 will ask you if you want to download the file.
7554
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007555 After this option has been set successfully, Vim will source the files
7556 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007557 up to the first character that is not an ASCII letter or number and
7558 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007559
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007560 *'spelloptions'* *'spo'*
7561'spelloptions' 'spo' string (default "")
7562 local to buffer
7563 {not available when compiled without the |+syntax|
7564 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007565 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007566 camel When a word is CamelCased, assume "Cased" is a
7567 separate word: every upper-case character in a word
7568 that comes after a lower case character indicates the
7569 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007570
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007571 *'spellsuggest'* *'sps'*
7572'spellsuggest' 'sps' string (default "best")
7573 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007574 {not available when compiled without the |+syntax|
7575 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007576 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007577 the |spellsuggest()| function. This is a comma-separated list of
7578 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007579
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007580 best Internal method that works best for English. Finds
7581 changes like "fast" and uses a bit of sound-a-like
7582 scoring to improve the ordering.
7583
7584 double Internal method that uses two methods and mixes the
7585 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007586 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007587 word. That only works when the language specifies
7588 sound folding. Can be slow and doesn't always give
7589 better results.
7590
7591 fast Internal method that only checks for simple changes:
7592 character inserts/deletes/swaps. Works well for
7593 simple typing mistakes.
7594
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007595 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007596 Not used for |spellsuggest()|. The number of
7597 suggestions is never more than the value of 'lines'
7598 minus two.
7599
Bram Moolenaar585ee072022-01-29 11:22:17 +00007600 timeout:{millisec} Limit the time searching for suggestions to
7601 {millisec} milli seconds. Applies to the following
7602 methods. When omitted the limit is 5000. When
7603 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007604 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007605
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007606 file:{filename} Read file {filename}, which must have two columns,
7607 separated by a slash. The first column contains the
7608 bad word, the second column the suggested good word.
7609 Example:
7610 theribal/terrible ~
7611 Use this for common mistakes that do not appear at the
7612 top of the suggestion list with the internal methods.
7613 Lines without a slash are ignored, use this for
7614 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007615 The word in the second column must be correct,
7616 otherwise it will not be used. Add the word to an
7617 ".add" file if it is currently flagged as a spelling
7618 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007619 The file is used for all languages.
7620
7621 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007622 trouble with spaces. Best is to call a function
7623 without arguments, see |expr-option-function|.
7624 |v:val| holds the badly spelled word. The expression
7625 must evaluate to a List of Lists, each with a
7626 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007627 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007628 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007629 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007630 internal methods use. A lower score is better.
7631 This may invoke |spellsuggest()| if you temporarily
7632 set 'spellsuggest' to exclude the "expr:" part.
7633 Errors are silently ignored, unless you set the
7634 'verbose' option to a non-zero value.
7635
7636 Only one of "best", "double" or "fast" may be used. The others may
7637 appear several times in any order. Example: >
7638 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7639<
7640 This option cannot be set from a |modeline| or in the |sandbox|, for
7641 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007642
7643
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7645'splitbelow' 'sb' boolean (default off)
7646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647 When on, splitting a window will put the new window below the current
7648 one. |:split|
7649
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007650 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007651'splitkeep' 'spk' string (default "cursor")
7652 global
7653 The value of this option determines the scroll behavior when opening,
7654 closing or resizing horizontal splits.
7655
7656 Possible values are:
7657 cursor Keep the same relative cursor position.
7658 screen Keep the text on the same screen line.
7659 topline Keep the topline the same.
7660
7661 For the "screen" and "topline" values, the cursor position will be
7662 changed when necessary. In this case, the jumplist will be populated
7663 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007664 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007665
Bram Moolenaar071d4272004-06-13 20:20:40 +00007666 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7667'splitright' 'spr' boolean (default off)
7668 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007669 When on, splitting a window will put the new window right of the
7670 current one. |:vsplit|
7671
7672 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7673'startofline' 'sol' boolean (default on)
7674 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007675 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007676 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007677 (if possible). This applies to the commands:
7678 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
7679 - "d", "<<" and ">>" with a linewise operator
7680 - "%" with a count
7681 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7682 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007683 In case of buffer changing commands the cursor is placed at the column
7684 where it was the last time the buffer was edited.
7685 NOTE: This option is set when 'compatible' is set.
7686
Bram Moolenaar00654022011-02-25 14:42:19 +01007687 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007688'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007689 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 {not available when compiled without the |+statusline|
7691 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007692 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693 Also see |status-line|.
7694
7695 The option consists of printf style '%' items interspersed with
7696 normal text. Each status line item is of the form:
7697 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007698 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007699 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007700
Bram Moolenaar238a5642006-02-21 22:12:05 +00007701 When the option starts with "%!" then it is used as an expression,
7702 evaluated and the result is used as the option value. Example: >
7703 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007704< The *g:statusline_winid* variable will be set to the |window-ID| of the
7705 window that the status line belongs to.
7706 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007707 Note that the "%!" expression is evaluated in the context of the
7708 current window and buffer, while %{} items are evaluated in the
7709 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007710
7711 When there is error while evaluating the option then it will be made
7712 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007713 When the result contains unprintable characters the result is
7714 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007715
Bram Moolenaar071d4272004-06-13 20:20:40 +00007716 Note that the only effect of 'ruler' when this option is set (and
7717 'laststatus' is 2) is controlling the output of |CTRL-G|.
7718
7719 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007720 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007721 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007722 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723 minwid Minimum width of the item, padding as set by '-' & '0'.
7724 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007725 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726 on the left for text items. Numeric items will be
7727 shifted down to maxwid-2 digits followed by '>'number
7728 where number is the amount of missing digits, much like
7729 an exponential notation.
7730 item A one letter code as described below.
7731
7732 Following is a description of the possible statusline items. The
7733 second character in "item" is the type:
7734 N for number
7735 S for string
7736 F for flags as described below
7737 - not applicable
7738
7739 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007740 f S Path to the file in the buffer, as typed or relative to current
7741 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742 F S Full path to the file in the buffer.
7743 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007744 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007746 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007747 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007748 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007749 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007750 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007751 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007752 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007754 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7756 being used: "<keymap>"
7757 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007758 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007759 B N As above, in hexadecimal.
7760 o N Byte number in file of byte under cursor, first byte is 1.
7761 Mnemonic: Offset from start of file (with one added)
7762 {not available when compiled without |+byte_offset| feature}
7763 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007764 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765 l N Line number.
7766 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007767 c N Column number (byte index).
7768 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007769 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007770 p N Percentage through file in lines as in |CTRL-G|.
7771 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007772 percentage described for 'ruler'. Always 3 in length, unless
7773 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007774 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007775 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007776 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007777 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007778 Note that there is no '%' before the closing '}'. The
7779 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007780 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007781 {% - This is almost same as { except the result of the expression is
7782 re-evaluated as a statusline format string. Thus if the
7783 return value of expr contains % items they will get expanded.
7784 The expression can contain the } character, the end of
7785 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007786 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007787 func! Stl_filename() abort
7788 return "%t"
7789 endfunc
7790< `stl=%{Stl_filename()}` results in `"%t"`
7791 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007792 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007793 ( - Start of item group. Can be used for setting the width and
7794 alignment of a section. Must be followed by %) somewhere.
7795 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007796 T N For 'tabline': start of tab page N label. Use %T after the last
7797 label. This information is used for mouse clicks.
7798 X N For 'tabline': start of close tab N label. Use %X after the
7799 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7800 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007801 < - Where to truncate line if too long. Default is at the start.
7802 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007803 = - Separation point between alignment sections. Each section will
7804 be separated by an equal number of spaces. With one %= what
7805 comes after it will be right-aligned. With two %= there is a
7806 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007808 # - Set highlight group. The name must follow and then a # again.
7809 Thus use %#HLname# for highlight group HLname. The same
7810 highlighting is used, also for the statusline of non-current
7811 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007813 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007814 The difference between User{N} and StatusLine will be applied to
7815 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007816 The number N must be between 1 and 9. See |hl-User1..9|
7817
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007818 When displaying a flag, Vim removes the leading comma, if any, when
7819 that flag comes right after plaintext. This will make a nice display
7820 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821
Bram Moolenaar582fd852005-03-28 20:58:01 +00007822 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823 not set) and a minwid is not set for the group, the whole group will
7824 become empty. This will make a group like the following disappear
7825 completely from the statusline when none of the flags are set. >
7826 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007827< Beware that an expression is evaluated each and every time the status
7828 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007829 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007830 While evaluating %{} the current buffer and current window will be set
7831 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007832 currently being drawn. The expression will evaluate in this context.
7833 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7834 real current buffer and "g:actual_curwin" to the |window-ID| of the
7835 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007836
Bram Moolenaar30b65812012-07-12 22:01:11 +02007837 The 'statusline' option will be evaluated in the |sandbox| if set from
7838 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007839 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007840
7841 It is not allowed to change text or jump to another window while
7842 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007843
7844 If the statusline is not updated when you want it (e.g., after setting
7845 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007846 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007848 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007849 Otherwise the result is taken as flag text and applied to the rules
7850 described above.
7851
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007852 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007853 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007854 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855
7856 Examples:
7857 Emulate standard status line with 'ruler' set >
7858 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7859< Similar, but add ASCII value of char under the cursor (like "ga") >
7860 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7861< Display byte count and byte value, modified flag in red. >
7862 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7863 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7864< Display a ,GZ flag if a compressed file is loaded >
7865 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7866< In the |:autocmd|'s: >
7867 :let b:gzflag = 1
7868< And: >
7869 :unlet b:gzflag
7870< And define this function: >
7871 :function VarExists(var, val)
7872 : if exists(a:var) | return a:val | else | return '' | endif
7873 :endfunction
7874<
7875 *'suffixes'* *'su'*
7876'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 Files with these suffixes get a lower priority when multiple files
7879 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007880 suffixes. Spaces after the comma are ignored. A dot is also seen as
7881 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007882 separator, precede it with a backslash (see |option-backslash| about
7883 including spaces and backslashes).
7884 See 'wildignore' for completely ignoring files.
7885 The use of |:set+=| and |:set-=| is preferred when adding or removing
7886 suffixes from the list. This avoids problems when a future version
7887 uses another default.
7888
7889 *'suffixesadd'* *'sua'*
7890'suffixesadd' 'sua' string (default "")
7891 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007892 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007893 file for the "gf", "[I", etc. commands. Example: >
7894 :set suffixesadd=.java
7895<
7896 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7897'swapfile' 'swf' boolean (default on)
7898 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007899 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007900 swapfile is not wanted for a specific buffer. For example, with
7901 confidential information that even root must not be able to access.
7902 Careful: All text will be in memory:
7903 - Don't use this for big files.
7904 - Recovery will be impossible!
7905 A swapfile will only be present when |'updatecount'| is non-zero and
7906 'swapfile' is set.
7907 When 'swapfile' is reset, the swap file for the current buffer is
7908 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7909 non-zero, a swap file is immediately created.
7910 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007911 If you want to open a new buffer without creating a swap file for it,
7912 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007913 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914
7915 This option is used together with 'bufhidden' and 'buftype' to
7916 specify special kinds of buffers. See |special-buffers|.
7917
7918 *'swapsync'* *'sws'*
7919'swapsync' 'sws' string (default "fsync")
7920 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007921 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007922 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007923 When this option is empty parts of the swap file may be in memory and
7924 not written to disk. When the system crashes you may lose more work.
7925 On Unix the system does a sync now and then without Vim asking for it,
7926 so the disadvantage of setting this option off is small. On some
7927 systems the swap file will not be written at all. For a unix system
7928 setting it to "sync" will use the sync() call instead of the default
7929 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007930 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007931
7932 *'switchbuf'* *'swb'*
7933'switchbuf' 'swb' string (default "")
7934 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01007936 This option is checked, when
7937 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
7938 etc.)
7939 - jumping to a tag using the |:stag| command.
7940 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
7941 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
7942 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007943 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01007944 useopen If included, jump to the first open window in the
7945 current tab page that contains the specified buffer
7946 (if there is one). Otherwise: Do not examine other
7947 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007948 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007949 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007951 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007952 Otherwise: do not split, use current window (when used
7953 in the quickfix window: the previously used window or
7954 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007955 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007956 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007957 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007958 uselast If included, jump to the previously used window when
7959 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007960
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007961 *'synmaxcol'* *'smc'*
7962'synmaxcol' 'smc' number (default 3000)
7963 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007964 {not available when compiled without the |+syntax|
7965 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007966 Maximum column in which to search for syntax items. In long lines the
7967 text after this column is not highlighted and following lines may not
7968 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007969 This helps to avoid very slow redrawing for an XML file that is one
7970 long line.
7971 Set to zero to remove the limit.
7972
Bram Moolenaar071d4272004-06-13 20:20:40 +00007973 *'syntax'* *'syn'*
7974'syntax' 'syn' string (default empty)
7975 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007976 {not available when compiled without the |+syntax|
7977 feature}
7978 When this option is set, the syntax with this name is loaded, unless
7979 syntax highlighting has been switched off with ":syntax off".
7980 Otherwise this option does not always reflect the current syntax (the
7981 b:current_syntax variable does).
7982 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007983 not automatically recognized. Example, in an IDL file:
7984 /* vim: set syntax=idl : */ ~
7985 When a dot appears in the value then this separates two filetype
7986 names. Example:
7987 /* vim: set syntax=c.doxygen : */ ~
7988 This will use the "c" syntax first, then the "doxygen" syntax.
7989 Note that the second one must be prepared to be loaded as an addition,
7990 otherwise it will be skipped. More than one dot may appear.
7991 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007992 :set syntax=OFF
7993< To switch syntax highlighting on according to the current value of the
7994 'filetype' option: >
7995 :set syntax=ON
7996< What actually happens when setting the 'syntax' option is that the
7997 Syntax autocommand event is triggered with the value as argument.
7998 This option is not copied to another buffer, independent of the 's' or
7999 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008000 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008002 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008003'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008004 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008005 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008006 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008007 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008008
8009 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008010 option and only when there is no GUI tab line. When 'e' is in
8011 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008012 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008013
8014 The value is evaluated like with 'statusline'. You can use
8015 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008016 the text to be displayed. Use "%1T" for the first label, "%2T" for
8017 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008018
Bram Moolenaare12bab32019-01-08 22:02:56 +01008019 When changing something that is used in 'tabline' that does not
8020 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008021 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008022
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008023 Keep in mind that only one of the tab pages is the current one, others
8024 are invisible and you can't jump to their windows.
8025
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008026
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008027 *'tabpagemax'* *'tpm'*
8028'tabpagemax' 'tpm' number (default 10)
8029 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008030 Maximum number of tab pages to be opened by the |-p| command line
8031 argument or the ":tab all" command. |tabpage|
8032
8033
8034 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035'tabstop' 'ts' number (default 8)
8036 local to buffer
8037 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008038 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039
8040 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008041 appear wrong in many places, e.g., when printing it.
8042 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043
8044 There are four main ways to use tabs in Vim:
8045 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8046 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008047 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008049 This is the recommended way, the file will look the same with other
8050 tools and when listing it in a terminal.
8051 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8052 'expandtab'. This way you will always insert spaces. The
8053 formatting will never be messed up when 'tabstop' is changed (leave
8054 it at 8 just in case). The file will be a bit larger.
8055 You do need to check if no Tabs exist in the file. You can get rid
8056 of them by first setting 'expandtab' and using `%retab!`, making
8057 sure the value of 'tabstop' is set correctly.
8058 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008059 'expandtab'. This way you will always insert spaces. The
8060 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008061 You do need to check if no Tabs exist in the file, just like in the
8062 item just above.
8063 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008064 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008065 works when using Vim to edit the file, other tools assume a tabstop
8066 is worth 8 spaces.
8067 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008068 'noexpandtab'. This should then work (for initial indents only)
8069 for any tabstop setting that people use. It might be nice to have
8070 tabs after the first non-blank inserted as spaces if you do this
8071 though. Otherwise aligned comments will be wrong when 'tabstop' is
8072 changed.
8073
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008074 If Vim is compiled with the |+vartabs| feature then the value of
8075 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8076 than an empty string.
8077
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8079'tagbsearch' 'tbs' boolean (default on)
8080 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008081 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008082 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008083 searching makes searching for a tag a LOT faster, but a linear search
8084 will find more tags if the tags file wasn't properly sorted.
8085 Vim normally assumes that your tags files are sorted, or indicate that
8086 they are not sorted. Only when this is not the case does the
8087 'tagbsearch' option need to be switched off.
8088
8089 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008090 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008091 certain files, or retry all files with a linear search. When
8092 'tagbsearch' is off, only a linear search is done.
8093
8094 Linear searching is done anyway, for one file, when Vim finds a line
8095 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008096 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008097< [The whitespace before and after the '0' must be a single <Tab>]
8098
8099 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008100 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008101 instead of a normal tag name, a retry is done with a linear search.
8102 Tags in unsorted tags files, and matches with different case will only
8103 be found in the retry.
8104
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008105 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008106 linear search can be avoided when case is ignored. Use a value of '2'
8107 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8108 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008109 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8110 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8111 used for this as well. Note that case must be folded to uppercase for
8112 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008113
8114 By default, tag searches are case-sensitive. Case is ignored when
8115 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8116 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008117 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8118 'tagcase' is "smart", and the pattern contains only lowercase
8119 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120
8121 When 'tagbsearch' is off, tags searching is slower when a full match
8122 exists, but faster when no full match exists. Tags in unsorted tags
8123 files may only be found with 'tagbsearch' off.
8124 When the tags file is not sorted, or sorted in a wrong way (not on
8125 ASCII byte value), 'tagbsearch' should be off, or the line given above
8126 must be included in the tags file.
8127 This option doesn't affect commands that find all matching tags (e.g.,
8128 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008129
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008130 *'tagcase'* *'tc'*
8131'tagcase' 'tc' string (default "followic")
8132 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008133 This option specifies how case is handled when searching the tags
8134 file:
8135 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008136 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008137 ignore Ignore case
8138 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008139 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008140 NOTE: This option is set to the Vi default value when 'compatible' is
8141 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008142
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008143 *'tagfunc'* *'tfu'*
8144'tagfunc' 'tfu' string (default: empty)
8145 local to buffer
8146 {not available when compiled without the |+eval|
8147 feature}
8148 This option specifies a function to be used to perform tag searches.
8149 The function gets the tag pattern and should return a List of matching
8150 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008151 function and an example. The value can be the name of a function, a
8152 |lambda| or a |Funcref|. See |option-value-function| for more
8153 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008154
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 *'taglength'* *'tl'*
8156'taglength' 'tl' number (default 0)
8157 global
8158 If non-zero, tags are significant up to this number of characters.
8159
8160 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8161'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8162 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008163 If on and using a tags file in another directory, file names in that
8164 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008165 NOTE: This option is set to the Vi default value when 'compatible' is
8166 set and to the Vim default value when 'compatible' is reset.
8167
8168 *'tags'* *'tag'* *E433*
8169'tags' 'tag' string (default "./tags,tags", when compiled with
8170 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8171 global or local to buffer |global-local|
8172 Filenames for the tag command, separated by spaces or commas. To
8173 include a space or comma in a file name, precede it with a backslash
8174 (see |option-backslash| about including spaces and backslashes).
8175 When a file name starts with "./", the '.' is replaced with the path
8176 of the current file. But only when the 'd' flag is not included in
8177 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8178 |tags-option|.
8179 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008180 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8181 find all files named "tags" below "/lib". The filename itself cannot
8182 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008183 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008184 The |tagfiles()| function can be used to get a list of the file names
8185 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008186 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8187 files are also supported. They are automatically recognized. The
8188 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8189 differences are ignored (MS-Windows). |emacs-tags|
8190 The use of |:set+=| and |:set-=| is preferred when adding or removing
8191 file names from the list. This avoids problems when a future version
8192 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008193
8194 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8195'tagstack' 'tgst' boolean (default on)
8196 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008197 When on, the |tagstack| is used normally. When off, a ":tag" or
8198 ":tselect" command with an argument will not push the tag onto the
8199 tagstack. A following ":tag" without an argument, a ":pop" command or
8200 any other command that uses the tagstack will use the unmodified
8201 tagstack, but does change the pointer to the active entry.
8202 Resetting this option is useful when using a ":tag" command in a
8203 mapping which should not change the tagstack.
8204
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008205 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008206'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008207 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008208 {only available when compiled with the |+tcl/dyn|
8209 feature}
8210 Specifies the name of the Tcl shared library. The default is
8211 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008212 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008213 This option cannot be set from a |modeline| or in the |sandbox|, for
8214 security reasons.
8215
Bram Moolenaar071d4272004-06-13 20:20:40 +00008216 *'term'* *E529* *E530* *E531*
8217'term' string (default is $TERM, if that fails:
8218 in the GUI: "builtin_gui"
8219 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008220 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008221 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008222 on Unix: "ansi"
8223 on VMS: "ansi"
8224 on Win 32: "win32")
8225 global
8226 Name of the terminal. Used for choosing the terminal control
8227 characters. Environment variables are expanded |:set_env|.
8228 For example: >
8229 :set term=$TERM
8230< See |termcap|.
8231
8232 *'termbidi'* *'tbidi'*
8233 *'notermbidi'* *'notbidi'*
8234'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8235 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008236 {only available when compiled with the |+arabic|
8237 feature}
8238 The terminal is in charge of Bi-directionality of text (as specified
8239 by Unicode). The terminal is also expected to do the required shaping
8240 that some languages (such as Arabic) require.
8241 Setting this option implies that 'rightleft' will not be set when
8242 'arabic' is set and the value of 'arabicshape' will be ignored.
8243 Note that setting 'termbidi' has the immediate effect that
8244 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8245 This option is reset when the GUI is started.
8246 For further details see |arabic.txt|.
8247
8248 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008249'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008251 Encoding used for the terminal. This specifies what character
8252 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008253 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008254 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008255 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008256 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008257 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8258 Any attempts to set a different value will be rejected, and an error
8259 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008260 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008261 because the Win32 system always passes Unicode characters.
8262 When empty, the same encoding is used as for the 'encoding' option.
8263 This is the normal value.
8264 Not all combinations for 'termencoding' and 'encoding' are valid. See
8265 |encoding-table|.
8266 The value for this option must be supported by internal conversions or
8267 iconv(). When this is not possible no conversion will be done and you
8268 will probably experience problems with non-ASCII characters.
8269 Example: You are working with the locale set to euc-jp (Japanese) and
8270 want to edit a UTF-8 file: >
8271 :let &termencoding = &encoding
8272 :set encoding=utf-8
8273< You need to do this when your system has no locale support for UTF-8.
8274
Bram Moolenaar938ae282023-02-20 20:44:55 +00008275 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008276'termguicolors' 'tgc' boolean (default off)
8277 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008278 {not available when compiled without the
8279 |+termguicolors| feature}
8280 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008281 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008282
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008283 Requires a ISO-8613-3 compatible terminal. If setting this option
8284 does not work (produces a colorless UI) reading |xterm-true-color|
8285 might help.
8286
8287 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8288 is required. Use this check to find out: >
8289 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008290< This requires Vim to be built with the |+vtp| feature.
8291
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008292 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008293
8294 When using Vim with Windows Terminal, the background of Windows
8295 Terminal is normally filled with the Vim background color. Setting
8296 'termguicolors' and the guibg of the Normal highlight group to NONE
8297 will make the background transparent: >
8298 :hi Normal guibg=NONE
8299<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008300 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008301
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008302 *'termwinkey'* *'twk'*
8303'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008304 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008305 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008306 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008307 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008308 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008309< The string must be one key stroke but can be multiple bytes.
8310 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008311 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008312 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008313
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008314 *'termwinscroll'* *'twsl'*
8315'termwinscroll' 'twsl' number (default 10000)
8316 local to buffer
8317 {not available when compiled without the
8318 |+terminal| feature}
8319 Number of scrollback lines to keep. When going over this limit the
8320 first 10% of the scrollback lines are deleted. This is just to reduce
8321 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008322 Also used as a limit for text sent to the terminal in one write,
8323 multiplied by the number of columns times 3 (average number of bytes
8324 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008325
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008326 *'termwinsize'* *'tws'*
8327'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008328 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008329 Size used when opening the |terminal| window. Format:
8330 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008331 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008332 - When set with a "x" (e.g., "24x80") the terminal size is not
8333 adjusted to the window size. If the window is smaller only the
8334 top-left part is displayed.
8335 - When set with a "*" (e.g., "10*50") the terminal size follows the
8336 window size, but will not be smaller than the specified rows and/or
8337 columns.
8338 - When rows is zero then use the height of the window.
8339 - When columns is zero then use the width of the window.
8340 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008341 - Can be overruled in the |term_start()| options with "term_rows" and
8342 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008343
8344 Examples:
8345 "30x0" uses 30 rows and the current window width.
8346 "20*0" uses at least 20 rows and the current window width.
8347 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008348 Note that the command running in the terminal window may still change
8349 the size of the terminal. In that case the Vim window will be
8350 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008351
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008352 *'termwintype'* *'twt'*
8353'termwintype' 'twt' string (default "")
8354 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008355 {only available when compiled with the |terminal|
8356 feature on MS-Windows}
8357 Specify the virtual console (pty) used when opening the terminal
8358 window.
8359
8360 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008361 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008362 "winpty" use winpty, fail if not supported
8363 "conpty" use |ConPTY|, fail if not supported
8364
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008365 |ConPTY| support depends on the platform. Windows 10 October 2018
8366 Update is the first version that supports ConPTY, however it is still
8367 considered unstable. ConPTY might become stable in the next release
8368 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008369 supported then you cannot open a terminal window.
8370
Bram Moolenaar071d4272004-06-13 20:20:40 +00008371 *'terse'* *'noterse'*
8372'terse' boolean (default off)
8373 global
8374 When set: Add 's' flag to 'shortmess' option (this makes the message
8375 for a search that hits the start or end of the file not being
8376 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8377 shortens a lot of messages}
8378
8379 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8380'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8381 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008382 This option is obsolete. Use 'fileformats'.
8383 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8384 set to the default value for the current system. When 'textauto' is
8385 reset, 'fileformats' is made empty.
8386 NOTE: This option is set to the Vi default value when 'compatible' is
8387 set and to the Vim default value when 'compatible' is reset.
8388
8389 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008390'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008391 others: default off)
8392 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008393 This option is obsolete. Use 'fileformat'.
8394 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8395 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8396 "unix".
8397
8398 *'textwidth'* *'tw'*
8399'textwidth' 'tw' number (default 0)
8400 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008401 Maximum width of text that is being inserted. A longer line will be
8402 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008403 this.
8404 'textwidth' is set to 0 when the 'paste' option is set and restored
8405 when 'paste' is reset.
8406 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008408 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008409 NOTE: This option is set to 0 when 'compatible' is set.
8410
8411 *'thesaurus'* *'tsr'*
8412'thesaurus' 'tsr' string (default "")
8413 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008414 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008415 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8416 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008417
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008418 This option is not used if 'thesaurusfunc' is set, either for the
8419 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008420
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008421 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008423 name. See |option-backslash| about using backslashes. The use of
8424 |:set+=| and |:set-=| is preferred when adding or removing directories
8425 from the list. This avoids problems when a future version uses
8426 another default. Backticks cannot be used in this option for security
8427 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008429 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008430'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008431 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008432 {not available when compiled without the |+eval|
8433 feature}
8434 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008435 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008436 The value can be the name of a function, a |lambda| or a |Funcref|.
8437 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008438
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008439 This option cannot be set from a |modeline| or in the |sandbox|, for
8440 security reasons.
8441
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8443'tildeop' 'top' boolean (default off)
8444 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008445 When on: The tilde command "~" behaves like an operator.
8446 NOTE: This option is reset when 'compatible' is set.
8447
8448 *'timeout'* *'to'* *'notimeout'* *'noto'*
8449'timeout' 'to' boolean (default on)
8450 global
8451 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008452'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008453 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008454 These two options together determine the behavior when part of a
8455 mapped key sequence or keyboard code has been received:
8456
8457 'timeout' 'ttimeout' action ~
8458 off off do not time out
8459 on on or off time out on :mappings and key codes
8460 off on time out on key codes
8461
8462 If both options are off, Vim will wait until either the complete
8463 mapping or key sequence has been received, or it is clear that there
8464 is no mapping or key sequence for the received characters. For
8465 example: if you have mapped "vl" and Vim has received 'v', the next
8466 character is needed to see if the 'v' is followed by an 'l'.
8467 When one of the options is on, Vim will wait for about 1 second for
8468 the next character to arrive. After that the already received
8469 characters are interpreted as single characters. The waiting time can
8470 be changed with the 'timeoutlen' option.
8471 On slow terminals or very busy systems timing out may cause
8472 malfunctioning cursor keys. If both options are off, Vim waits
8473 forever after an entered <Esc> if there are key codes that start
8474 with <Esc>. You will have to type <Esc> twice. If you do not have
8475 problems with key codes, but would like to have :mapped key
8476 sequences not timing out in 1 second, set the 'ttimeout' option and
8477 reset the 'timeout' option.
8478
8479 NOTE: 'ttimeout' is reset when 'compatible' is set.
8480
8481 *'timeoutlen'* *'tm'*
8482'timeoutlen' 'tm' number (default 1000)
8483 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008484
Bram Moolenaar071d4272004-06-13 20:20:40 +00008485 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008486'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008488 The time in milliseconds that is waited for a key code or mapped key
8489 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8490 when part of a command has been typed.
8491 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8492 different timeout value for key codes is desired set 'ttimeoutlen' to
8493 a non-negative number.
8494
8495 ttimeoutlen mapping delay key code delay ~
8496 < 0 'timeoutlen' 'timeoutlen'
8497 >= 0 'timeoutlen' 'ttimeoutlen'
8498
8499 The timeout only happens when the 'timeout' and 'ttimeout' options
8500 tell so. A useful setting would be >
8501 :set timeout timeoutlen=3000 ttimeoutlen=100
8502< (time out on mapping after three seconds, time out on key codes after
8503 a tenth of a second).
8504
8505 *'title'* *'notitle'*
8506'title' boolean (default off, on when title can be restored)
8507 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008508 When on, the title of the window will be set to the value of
8509 'titlestring' (if it is not empty), or to:
8510 filename [+=-] (path) - VIM
8511 Where:
8512 filename the name of the file being edited
8513 - indicates the file cannot be modified, 'ma' off
8514 + indicates the file was modified
8515 = indicates the file is read-only
8516 =+ indicates the file is read-only and modified
8517 (path) is the path of the file being edited
8518 - VIM the server name |v:servername| or "VIM"
8519 Only works if the terminal supports setting window titles
8520 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008521 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008522 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8523 *X11*
8524 When Vim was compiled with HAVE_X11 defined, the original title will
8525 be restored if possible. The output of ":version" will include "+X11"
8526 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8527 works for the icon name |'icon'|.
8528 But: When Vim was started with the |-X| argument, restoring the title
8529 will not work (except in the GUI).
8530 If the title cannot be restored, it is set to the value of 'titleold'.
8531 You might want to restore the title outside of Vim then.
8532 When using an xterm from a remote machine you can use this command:
8533 rsh machine_name xterm -display $DISPLAY &
8534 then the WINDOWID environment variable should be inherited and the
8535 title of the window should change back to what it should be after
8536 exiting Vim.
8537
8538 *'titlelen'*
8539'titlelen' number (default 85)
8540 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008541 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008542 title. When the title is longer, only the end of the path name is
8543 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008544 Using a percentage makes this adapt to the width of the window. But
8545 it won't work perfectly, because the actual number of characters
8546 available also depends on the font used and other things in the title
8547 bar. When 'titlelen' is zero the full path is used. Otherwise,
8548 values from 1 to 30000 percent can be used.
8549 'titlelen' is also used for the 'titlestring' option.
8550
8551 *'titleold'*
8552'titleold' string (default "Thanks for flying Vim")
8553 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008554 This option will be used for the window title when exiting Vim if the
8555 original title cannot be restored. Only happens if 'title' is on or
8556 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008557 This option cannot be set from a |modeline| or in the |sandbox|, for
8558 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559 *'titlestring'*
8560'titlestring' string (default "")
8561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008562 When this option is not empty, it will be used for the title of the
8563 window. This happens only when the 'title' option is on.
8564 Only works if the terminal supports setting window titles (currently
8565 Amiga console, Win32 console, all GUI versions and terminals with a
8566 non-empty 't_ts' option).
8567 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008568 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008569
Bram Moolenaar071d4272004-06-13 20:20:40 +00008570 When this option contains printf-style '%' items, they will be
8571 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008572 This option cannot be set in a modeline when 'modelineexpr' is off.
8573
Bram Moolenaar071d4272004-06-13 20:20:40 +00008574 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008575 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008576 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8577< The value of 'titlelen' is used to align items in the middle or right
8578 of the available space.
8579 Some people prefer to have the file name first: >
8580 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8581< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008582 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008583 separating space only when needed.
8584 NOTE: Use of special characters in 'titlestring' may cause the display
8585 to be garbled (e.g., when it contains a CR or NL character).
8586 {not available when compiled without the |+statusline| feature}
8587
8588 *'toolbar'* *'tb'*
8589'toolbar' 'tb' string (default "icons,tooltips")
8590 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008591 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008592 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008593 possible values are:
8594 icons Toolbar buttons are shown with icons.
8595 text Toolbar buttons shown with text.
8596 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008597 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008598 tooltips Tooltips are active for toolbar buttons.
8599 Tooltips refer to the popup help text which appears after the mouse
8600 cursor is placed over a toolbar button for a brief moment.
8601
8602 If you want the toolbar to be shown with icons as well as text, do the
8603 following: >
8604 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008605< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008606 will show icons if both are requested.
8607
8608 If none of the strings specified in 'toolbar' are valid or if
8609 'toolbar' is empty, this option is ignored. If you want to disable
8610 the toolbar, you need to set the 'guioptions' option. For example: >
8611 :set guioptions-=T
8612< Also see |gui-toolbar|.
8613
8614 *'toolbariconsize'* *'tbis'*
8615'toolbariconsize' 'tbis' string (default "small")
8616 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008617 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008618 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008619 tiny Use tiny icons.
8620 small Use small icons (default).
8621 medium Use medium-sized icons.
8622 large Use large icons.
8623 huge Use even larger icons.
8624 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008626 the current theme. Common dimensions are giant=48x48, huge=32x32,
8627 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008628
8629 If 'toolbariconsize' is empty, the global default size as determined
8630 by user preferences or the current theme is used.
8631
8632 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8633'ttybuiltin' 'tbi' boolean (default on)
8634 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008635 When on, the builtin termcaps are searched before the external ones.
8636 When off the builtin termcaps are searched after the external ones.
8637 When this option is changed, you should set the 'term' option next for
8638 the change to take effect, for example: >
8639 :set notbi term=$TERM
8640< See also |termcap|.
8641 Rationale: The default for this option is "on", because the builtin
8642 termcap entries are generally better (many systems contain faulty
8643 xterm entries...).
8644
8645 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008646'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008648 Indicates a fast terminal connection. More characters will be sent to
8649 the screen for redrawing, instead of using insert/delete line
8650 commands. Improves smoothness of redrawing when there are multiple
8651 windows and the terminal does not support a scrolling region.
8652 Also enables the extra writing of characters at the end of each screen
8653 line for lines that wrap. This helps when using copy/paste with the
8654 mouse in an xterm and other terminals.
8655
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008656 The default used to be set only for some terminal names, but these
8657 days nearly all terminals are fast, therefore the default is now "on".
8658 If you have a slow connection you may want to set this option off,
8659 e.g. depending on the host name: >
8660 if hostname() =~ 'faraway'
8661 set nottyfast
8662 endif
8663<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 *'ttymouse'* *'ttym'*
8665'ttymouse' 'ttym' string (default depends on 'term')
8666 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008667 {only in Unix and VMS, doesn't work in the GUI; not
8668 available when compiled without |+mouse|}
8669 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008670 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008671 *xterm-mouse*
8672 xterm xterm-like mouse handling. The mouse generates
8673 "<Esc>[Mscr", where "scr" is three bytes:
8674 "s" = button state
8675 "c" = column plus 33
8676 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008677 This only works up to 223 columns! See "dec",
8678 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008679 xterm2 Works like "xterm", but with the xterm reporting the
8680 mouse position while the mouse is dragged. This works
8681 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008682 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008683 work. See below for how Vim detects this
8684 automatically.
8685 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008686 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008687 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008688 for the row and column. No other mouse events are
8689 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008690 *dec-mouse*
8691 dec DEC terminal mouse handling. The mouse generates a
8692 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008693 This is also available for an Xterm, if it was
8694 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008695 *jsbterm-mouse*
8696 jsbterm JSB term mouse handling.
8697 *pterm-mouse*
8698 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008699 *urxvt-mouse*
8700 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008701 The mouse works only if the terminal supports this
8702 encoding style, but it does not have 223 columns limit
8703 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008704 *sgr-mouse*
8705 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008706 mouse reporting. The mouse works even in columns
8707 beyond 223. This option is backward compatible with
8708 "xterm2" because it can also decode "xterm2" style
8709 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710
8711 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008712 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8713 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008714 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8715 recognized, if enabled at compile time. DEC terminal mouse codes
8716 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008717 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8718 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008720 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8721 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8722 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008723 If the terminfo/termcap entry "XM" exists and the first number is
8724 "1006" then 'ttymouse' will be set to "sgr". This works for many
8725 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008726 Additionally, if vim is compiled with the |+termresponse| feature and
8727 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008728 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008729 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008730 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8731 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8732 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008733 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8734 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008735 :set t_RV=
8736<
8737 *'ttyscroll'* *'tsl'*
8738'ttyscroll' 'tsl' number (default 999)
8739 global
8740 Maximum number of lines to scroll the screen. If there are more lines
8741 to scroll the window is redrawn. For terminals where scrolling is
8742 very slow and redrawing is not slow this can be set to a small number,
8743 e.g., 3, to speed up displaying.
8744
8745 *'ttytype'* *'tty'*
8746'ttytype' 'tty' string (default from $TERM)
8747 global
8748 Alias for 'term', see above.
8749
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008750 *'undodir'* *'udir'*
8751'undodir' 'udir' string (default ".")
8752 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008753 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008754 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008755 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008756 "." means using the directory of the file. The undo file name for
8757 "file.txt" is ".file.txt.un~".
8758 For other directories the file name is the full path of the edited
8759 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008760 When writing: The first directory that exists is used. "." always
8761 works, no directories after "." will be used for writing.
8762 When reading all entries are tried to find an undo file. The first
8763 undo file that exists is used. When it cannot be read an error is
8764 given, no further entry is used.
8765 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008766 This option cannot be set from a |modeline| or in the |sandbox|, for
8767 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008768
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008769 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008770'undofile' 'udf' boolean (default off)
8771 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008772 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008773 When on, Vim automatically saves undo history to an undo file when
8774 writing a buffer to a file, and restores undo history from the same
8775 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008776 The directory where the undo file is stored is specified by 'undodir'.
8777 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008778 The undo file is not read when 'undoreload' causes the buffer from
8779 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008780 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008781 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008782
Bram Moolenaar071d4272004-06-13 20:20:40 +00008783 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008784'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008785 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008786 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008787 is kept in memory, higher numbers will cause more memory to be used.
8788 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008789 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8790 itself: >
8791 set ul=0
8792< But you can also get Vi compatibility by including the 'u' flag in
8793 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008794 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008795 Set to -1 for no undo at all. You might want to do this only for the
8796 current buffer: >
8797 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008799
8800 The local value is set to -123456 when the global value is to be used.
8801
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008802 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008803
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008804 *'undoreload'* *'ur'*
8805'undoreload' 'ur' number (default 10000)
8806 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008807 Save the whole buffer for undo when reloading it. This applies to the
8808 ":e!" command and reloading for when the buffer changed outside of
8809 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008810 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008811 of lines is smaller than the value of this option.
8812 Set this option to zero to disable undo for a reload.
8813
8814 When saving undo for a reload, any undo file is not read.
8815
8816 Note that this causes the whole buffer to be stored in memory. Set
8817 this option to a lower value if you run out of memory.
8818
Bram Moolenaar071d4272004-06-13 20:20:40 +00008819 *'updatecount'* *'uc'*
8820'updatecount' 'uc' number (default: 200)
8821 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008822 After typing this many characters the swap file will be written to
8823 disk. When zero, no swap file will be created at all (see chapter on
8824 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8825 Vim with the "-n" option, see |startup|. When editing in readonly
8826 mode this option will be initialized to 10000.
8827 The swapfile can be disabled per buffer with |'swapfile'|.
8828 When 'updatecount' is set from zero to non-zero, swap files are
8829 created for all buffers that have 'swapfile' set. When 'updatecount'
8830 is set to zero, existing swap files are not deleted.
8831 Also see |'swapsync'|.
8832 This option has no meaning in buffers where |'buftype'| is "nofile"
8833 or "nowrite".
8834
8835 *'updatetime'* *'ut'*
8836'updatetime' 'ut' number (default 4000)
8837 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 If this many milliseconds nothing is typed the swap file will be
8839 written to disk (see |crash-recovery|). Also used for the
8840 |CursorHold| autocommand event.
8841
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008842 *'varsofttabstop'* *'vsts'*
8843'varsofttabstop' 'vsts' string (default "")
8844 local to buffer
8845 {only available when compiled with the |+vartabs|
8846 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008847 A list of the number of spaces that a <Tab> counts for while editing,
8848 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8849 width <Tab>s are being inserted, while in fact a mixture of spaces
8850 and <Tab>s is used. Tab widths are separated with commas, with the
8851 final value applying to all subsequent tabs.
8852
8853 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008854 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008855 to use the following: >
8856 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008857< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8858 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008859
8860 Note that the value of |'softtabstop'| will be ignored while
8861 'varsofttabstop' is set.
8862
8863 *'vartabstop'* *'vts'*
8864'vartabstop' 'vts' string (default "")
8865 local to buffer
8866 {only available when compiled with the |+vartabs|
8867 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008868 A list of the number of spaces that a <Tab> in the file counts for,
8869 separated by commas. Each value corresponds to one tab, with the
8870 final value applying to all subsequent tabs. For example: >
8871 :set vartabstop=4,20,10,8
8872< This will make the first tab 4 spaces wide, the second 20 spaces,
8873 the third 10 spaces, and all following tabs 8 spaces.
8874
8875 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8876 is set.
8877
Bram Moolenaar071d4272004-06-13 20:20:40 +00008878 *'verbose'* *'vbs'*
8879'verbose' 'vbs' number (default 0)
8880 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008881 When bigger than zero, Vim will give messages about what it is doing.
8882 Currently, these messages are given:
8883 >= 1 When the viminfo file is read or written.
8884 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008885 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008886 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008887 >= 8 Files for which a group of autocommands is executed.
8888 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008889 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008890 >= 12 Every executed function.
8891 >= 13 When an exception is thrown, caught, finished, or discarded.
8892 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008893 >= 15 Every executed Ex command from a script (truncated at 200
8894 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008895 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008896
8897 This option can also be set with the "-V" argument. See |-V|.
8898 This option is also set by the |:verbose| command.
8899
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008900 When the 'verbosefile' option is set then the verbose messages are not
8901 displayed.
8902
8903 *'verbosefile'* *'vfile'*
8904'verbosefile' 'vfile' string (default empty)
8905 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008906 When not empty all messages are written in a file with this name.
8907 When the file exists messages are appended.
8908 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008909 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008910 Setting 'verbosefile' to a new value is like making it empty first.
8911 The difference with |:redir| is that verbose messages are not
8912 displayed when 'verbosefile' is set.
8913
Bram Moolenaar071d4272004-06-13 20:20:40 +00008914 *'viewdir'* *'vdir'*
Bram Moolenaar801961d2023-06-23 16:15:13 +01008915'viewdir' 'vdir' string (default for Amiga "$VIM/vimfiles/view",
8916 for Win32: "$HOME/vimfiles/view",
8917 for Unix: "~/.vim/view",
8918 for macOS: "$VIM/vimfiles/view"
8919 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008920 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008921 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008922 feature}
8923 Name of the directory where to store files for |:mkview|.
8924 This option cannot be set from a |modeline| or in the |sandbox|, for
8925 security reasons.
8926
8927 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008928'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008929 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008930 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008931 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008932 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008933 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008934 word save and restore ~
8935 cursor cursor position in file and in window
8936 folds manually created folds, opened/closed folds and local
8937 fold options
8938 options options and mappings local to a window or buffer (not
8939 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008940 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008941 slash backslashes in file names replaced with forward
8942 slashes
8943 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008944 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008945 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008947 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008948 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008949 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008950
8951 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008952'viminfo' 'vi' string (Vi default: "", Vim default for
8953 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008954 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8955 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008956 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008957 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008958 feature}
8959 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008960 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8961 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008962 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008963 consisting of a single character identifying the particular parameter,
8964 followed by a number or string which specifies the value of that
8965 parameter. If a particular character is left out, then the default
8966 value is used for that parameter. The following is a list of the
8967 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008968 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008969 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008970 ! When included, save and restore global variables that start
8971 with an uppercase letter, and don't contain a lowercase
8972 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008973 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008974 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008975 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008976 " Maximum number of lines saved for each register. Old name of
8977 the '<' item, with the disadvantage that you need to put a
8978 backslash before the ", otherwise it will be recognized as the
8979 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008980 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008981 % When included, save and restore the buffer list. If Vim is
8982 started with a file name argument, the buffer list is not
8983 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008984 buffer list is restored from the viminfo file. Quickfix
8985 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8986 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008987 When followed by a number, the number specifies the maximum
8988 number of buffers that are stored. Without a number all
8989 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008990 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008991 ' Maximum number of previously edited files for which the marks
8992 are remembered. This parameter must always be included when
8993 'viminfo' is non-empty.
8994 Including this item also means that the |jumplist| and the
8995 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008996 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008997 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008998 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008999 patterns are also saved. When not included, the value of
9000 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009001 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009002 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009003 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009004 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005 < Maximum number of lines saved for each register. If zero then
9006 registers are not saved. When not included, all lines are
9007 saved. '"' is the old name for this item.
9008 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009009 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009010 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009011 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009012 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013 c When included, convert the text in the viminfo file from the
9014 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009015 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009016 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009017 f Whether file marks need to be stored. If zero, file marks ('0
9018 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009019 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009020 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009021 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009022 h Disable the effect of 'hlsearch' when loading the viminfo
9023 file. When not included, it depends on whether ":nohlsearch"
9024 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009025 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009026 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009027 the 'n'. Must be at the end of the option! If the
9028 'viminfofile' option is set, that file name overrides the one
9029 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009030 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009031 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009032 r Removable media. The argument is a string (up to the next
9033 ','). This parameter can be given several times. Each
9034 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009035 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009036 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9037 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9038 ignored. Maximum length of each 'r' argument is 50
9039 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009040 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009041 s Maximum size of an item in Kbyte. If zero then registers are
9042 not saved. Currently only applies to registers. The default
9043 "s10" will exclude registers with more than 10 Kbyte of text.
9044 Also see the '<' item above: line count limit.
9045
9046 Example: >
9047 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9048<
9049 '50 Marks will be remembered for the last 50 files you
9050 edited.
9051 <1000 Contents of registers (up to 1000 lines each) will be
9052 remembered.
9053 s100 Registers with more than 100 Kbyte text are skipped.
9054 :0 Command-line history will not be saved.
9055 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9056 no / Since '/' is not specified, the default will be used,
9057 that is, save all of the search history, and also the
9058 previous search and substitute patterns.
9059 no % The buffer list will not be saved nor read back.
9060 no h 'hlsearch' highlighting will be restored.
9061
9062 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9063 load the contents of the file, this is not done automatically.
9064
9065 This option cannot be set from a |modeline| or in the |sandbox|, for
9066 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009067 NOTE: This option is set to the Vim default value when 'compatible'
9068 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009069
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009070 *'viminfofile'* *'vif'*
9071'viminfofile' 'vif' string (default: "")
9072 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009073 {not available when compiled without the |+viminfo|
9074 feature}
9075 When non-empty, overrides the file name used for viminfo.
9076 When equal to "NONE" no viminfo file will be read or written.
9077 This option can be set with the |-i| command line flag. The |--clean|
9078 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009079 This option cannot be set from a |modeline| or in the |sandbox|, for
9080 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009081
Bram Moolenaar071d4272004-06-13 20:20:40 +00009082 *'virtualedit'* *'ve'*
9083'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009084 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009085 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009086 block Allow virtual editing in Visual block mode.
9087 insert Allow virtual editing in Insert mode.
9088 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009089 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009090 none When used as the local value, do not allow virtual
9091 editing even when the global value is set. When used
9092 as the global value, "none" is the same as "".
9093 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009094
Bram Moolenaar071d4272004-06-13 20:20:40 +00009095 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009096 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009097 of the line. Useful for selecting a rectangle in Visual mode and
9098 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009099 "onemore" is not the same, it will only allow moving the cursor just
9100 after the last character of the line. This makes some commands more
9101 consistent. Previously the cursor was always past the end of the line
9102 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009103 break some plugins or Vim scripts. For example because |l| can move
9104 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009105 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009106 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009107 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009108 It doesn't make sense to combine "all" with "onemore", but you will
9109 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009110 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009111 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009112
9113 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9114'visualbell' 'vb' boolean (default off)
9115 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009116 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009117 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009118 use: >
9119 :set vb t_vb=
9120< If you want a short flash, you can use this on many terminals: >
9121 :set vb t_vb=[?5h$<100>[?5l
9122< Here $<100> specifies the time, you can use a smaller or bigger value
9123 to get a shorter or longer flash.
9124
9125 Note: Vim will limit the bell to once per half a second. This avoids
9126 having to wait for the flashing to finish when there are lots of
9127 bells, e.g. on key repeat. This also happens without 'visualbell'
9128 set.
9129
Bram Moolenaar071d4272004-06-13 20:20:40 +00009130 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9131 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9132 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009133
9134 Note: When the GUI starts, 't_vb' is reset to its default value. You
9135 might want to set it again in your |gvimrc|.
9136
Bram Moolenaar071d4272004-06-13 20:20:40 +00009137 Does not work on the Amiga, you always get a screen flash.
9138 Also see 'errorbells'.
9139
9140 *'warn'* *'nowarn'*
9141'warn' boolean (default on)
9142 global
9143 Give a warning message when a shell command is used while the buffer
9144 has been changed.
9145
9146 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9147'weirdinvert' 'wiv' boolean (default off)
9148 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009149 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009150 It is provided for backwards compatibility with version 4.x.
9151 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9152 vice versa. Has no effect when the GUI is running.
9153
9154 *'whichwrap'* *'ww'*
9155'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009157 Allow specified keys that move the cursor left/right to move to the
9158 previous/next line when the cursor is on the first/last character in
9159 the line. Concatenate characters to allow this for these keys:
9160 char key mode ~
9161 b <BS> Normal and Visual
9162 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009163 h "h" Normal and Visual (not recommended)
9164 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009165 < <Left> Normal and Visual
9166 > <Right> Normal and Visual
9167 ~ "~" Normal
9168 [ <Left> Insert and Replace
9169 ] <Right> Insert and Replace
9170 For example: >
9171 :set ww=<,>,[,]
9172< allows wrap only when cursor keys are used.
9173 When the movement keys are used in combination with a delete or change
9174 operator, the <EOL> also counts for a character. This makes "3h"
9175 different from "3dh" when the cursor crosses the end of a line. This
9176 is also true for "x" and "X", because they do the same as "dl" and
9177 "dh". If you use this, you may also want to use the mapping
9178 ":map <BS> X" to make backspace delete the character in front of the
9179 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009180 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009181 line (not an empty line) then it will not move to the next line. This
9182 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009183 NOTE: This option is set to the Vi default value when 'compatible' is
9184 set and to the Vim default value when 'compatible' is reset.
9185
9186 *'wildchar'* *'wc'*
9187'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9188 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009189 Character you have to type to start wildcard expansion in the
9190 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009191 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009192 The character is not recognized when used inside a macro. See
9193 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009194 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009195 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009196 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009197< NOTE: This option is set to the Vi default value when 'compatible' is
9198 set and to the Vim default value when 'compatible' is reset.
9199
9200 *'wildcharm'* *'wcm'*
9201'wildcharm' 'wcm' number (default: none (0))
9202 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009203 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009204 recognized when used inside a macro. You can find "spare" command-line
9205 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009206 you'll never actually type 'wildcharm', just use it in mappings that
9207 automatically invoke completion mode, e.g.: >
9208 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009209 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009210< Then after typing :ss you can use CTRL-P & CTRL-N.
9211
9212 *'wildignore'* *'wig'*
9213'wildignore' 'wig' string (default "")
9214 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009215 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009216 patterns is ignored when expanding |wildcards|, completing file or
9217 directory names, and influences the result of |expand()|, |glob()| and
9218 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009219 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9220 Also see 'suffixes'.
9221 Example: >
9222 :set wildignore=*.o,*.obj
9223< The use of |:set+=| and |:set-=| is preferred when adding or removing
9224 a pattern from the list. This avoids problems when a future version
9225 uses another default.
9226
Bram Moolenaar94950a92010-12-02 16:01:29 +01009227
Bram Moolenaar81af9252010-12-10 20:35:50 +01009228 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009229'wildignorecase' 'wic' boolean (default off)
9230 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009231 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009232 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009233 Does not apply when the shell is used to expand wildcards, which
9234 happens when there are special characters.
9235
9236
Bram Moolenaar071d4272004-06-13 20:20:40 +00009237 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009238'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009239 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009240 When 'wildmenu' is on, command-line completion operates in an enhanced
9241 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009242 the possible matches are shown.
9243 When 'wildoptions' contains "pum", then the completion matches are
9244 shown in a popup menu. Otherwise they are displayed just above the
9245 command line, with the first match highlighted (overwriting the status
9246 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009247 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009248 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9249 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9250 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009251 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009252 If there are more matches than can fit in the line, a ">" is shown on
9253 the right and/or a "<" is shown on the left. The status line scrolls
9254 as needed.
9255 The "wildmenu" mode is abandoned when a key is hit that is not used
9256 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009257 While the "wildmenu" is active, not using the popup menu, the
9258 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009259
9260 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9261 <Down> - in filename/menu name completion: move into a
9262 subdirectory or submenu.
9263 <CR> - in menu completion, when the cursor is just after a
9264 dot: move into a submenu.
9265 <Up> - in filename/menu name completion: move up into
9266 parent directory or parent menu.
9267
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009268 When using the popup menu for command line completion, the following
9269 keys have special meanings:
9270 <Down> - select next match (like CTRL-N)
9271 <Left> - in filename/menu name completion: move up into
9272 parent directory or parent menu.
9273 <Right> - in filename/menu name completion: move into a
9274 subdirectory or submenu.
9275 <Up> - select previous match (like CTRL-P)
9276 CTRL-E - end completion, go back to what was there before
9277 selecting a match.
9278 CTRL-N - go to the next entry
9279 CTRL-P - go to the previous entry
9280 CTRL-Y - accept the currently selected match and stop
9281 completion.
9282
Bram Moolenaar071d4272004-06-13 20:20:40 +00009283 This makes the menus accessible from the console |console-menus|.
9284
9285 If you prefer the <Left> and <Right> keys to move the cursor instead
9286 of selecting a different match, use this: >
9287 :cnoremap <Left> <Space><BS><Left>
9288 :cnoremap <Right> <Space><BS><Right>
9289<
9290 The "WildMenu" highlighting is used for displaying the current match
9291 |hl-WildMenu|.
9292
9293 *'wildmode'* *'wim'*
9294'wildmode' 'wim' string (Vim default: "full")
9295 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009296 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009297 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009298 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009299 first part specifies the behavior for the first use of 'wildchar',
9300 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009301
9302 Each part consists of a colon separated list consisting of the
9303 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009304 "" Complete only the first match.
9305 "full" Complete the next full match. After the last match,
9306 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009307 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009308 "longest" Complete till longest common string. If this doesn't
9309 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009310 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009311 "lastused" When completing buffer names and more than one buffer
9312 matches, sort buffers by time last used (other than
9313 the current buffer).
9314 When there is only a single match, it is fully completed in all cases.
9315
9316 Examples of useful colon-separated values:
9317 "longest:full" Like "longest", but also start 'wildmenu' if it is
9318 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009319 "list:full" When more than one match, list all matches and
9320 complete first match.
9321 "list:longest" When more than one match, list all matches and
9322 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009323 "list:lastused" When more than one buffer matches, list all matches
9324 and sort buffers by time last used (other than the
9325 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009326
9327 Examples: >
9328 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009329< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009330 :set wildmode=longest,full
9331< Complete longest common string, then each full match >
9332 :set wildmode=list:full
9333< List all matches and complete each full match >
9334 :set wildmode=list,full
9335< List all matches without completing, then each full match >
9336 :set wildmode=longest,list
9337< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009338 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009339
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009340 *'wildoptions'* *'wop'*
9341'wildoptions' 'wop' string (default "")
9342 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009343 A list of words that change how |cmdline-completion| is done.
9344 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009345 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009346 this value is specified, wildcard expansion will not
9347 be used for completion. The matches will be sorted by
9348 the "best match" rather than alphabetically sorted.
9349 This will find more matches than the wildcard
9350 expansion. Currently fuzzy matching based completion
9351 is not supported for file and directory names and
9352 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009353 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009354 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009355 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009356 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009357 is displayed per line. Often used tag kinds are:
9358 d #define
9359 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009360
Bram Moolenaar071d4272004-06-13 20:20:40 +00009361 *'winaltkeys'* *'wak'*
9362'winaltkeys' 'wak' string (default "menu")
9363 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009364 {only used in Win32, Motif, GTK and Photon GUI}
9365 Some GUI versions allow the access to menu entries by using the ALT
9366 key in combination with a character that appears underlined in the
9367 menu. This conflicts with the use of the ALT key for mappings and
9368 entering special characters. This option tells what to do:
9369 no Don't use ALT keys for menus. ALT key combinations can be
9370 mapped, but there is no automatic handling. This can then be
9371 done with the |:simalt| command.
9372 yes ALT key handling is done by the windowing system. ALT key
9373 combinations cannot be mapped.
9374 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009375 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009376 keys can be mapped.
9377 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9378 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009379 This option is not used for <F10>; on Win32 and with GTK <F10> will
9380 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009381
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009382 *'wincolor'* *'wcr'*
9383'wincolor' 'wcr' string (default empty)
9384 local to window
9385 Highlight group name to use for this window instead of the Normal
9386 color |hl-Normal|.
9387
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009388 *'window'* *'wi'*
9389'window' 'wi' number (default screen height - 1)
9390 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009391 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9392 window and the value is smaller than 'lines' minus one. The screen
9393 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009394 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9395 in a much smarter way, taking care of wrapping lines.
9396 When resizing the Vim window, the value is smaller than 1 or more than
9397 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009398 Note: Do not confuse this with the height of the Vim window, use
9399 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009400
Bram Moolenaar071d4272004-06-13 20:20:40 +00009401 *'winheight'* *'wh'* *E591*
9402'winheight' 'wh' number (default 1)
9403 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009404 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009405 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009406 focus goes to a window that is smaller, its size is increased, at the
9407 cost of the height of other windows.
9408 Set 'winheight' to a small number for normal editing.
9409 Set it to 999 to make the current window fill most of the screen.
9410 Other windows will be only 'winminheight' high. This has the drawback
9411 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9412 to create only two windows, set the option after startup is done,
9413 using the |VimEnter| event: >
9414 au VimEnter * set winheight=999
9415< Minimum value is 1.
9416 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009417 height of the current window.
9418 'winheight' applies to the current window. Use 'winminheight' to set
9419 the minimal height for other windows.
9420
9421 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9422'winfixheight' 'wfh' boolean (default off)
9423 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009424 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009425 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9426 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009427 The height may be changed anyway when running out of room.
9428
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009429 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9430'winfixwidth' 'wfw' boolean (default off)
9431 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009432 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009433 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009434 The width may be changed anyway when running out of room.
9435
Bram Moolenaar071d4272004-06-13 20:20:40 +00009436 *'winminheight'* *'wmh'*
9437'winminheight' 'wmh' number (default 1)
9438 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009439 The minimal height of a window, when it's not the current window.
9440 This is a hard minimum, windows will never become smaller.
9441 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9442 status bar) if necessary. They will return to at least one line when
9443 they become active (since the cursor has to have somewhere to go.)
9444 Use 'winheight' to set the minimal height of the current window.
9445 This option is only checked when making a window smaller. Don't use a
9446 large number, it will cause errors when opening more than a few
9447 windows. A value of 0 to 3 is reasonable.
9448
9449 *'winminwidth'* *'wmw'*
9450'winminwidth' 'wmw' number (default 1)
9451 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009452 The minimal width of a window, when it's not the current window.
9453 This is a hard minimum, windows will never become smaller.
9454 When set to zero, windows may be "squashed" to zero columns (i.e. just
9455 a vertical separator) if necessary. They will return to at least one
9456 line when they become active (since the cursor has to have somewhere
9457 to go.)
9458 Use 'winwidth' to set the minimal width of the current window.
9459 This option is only checked when making a window smaller. Don't use a
9460 large number, it will cause errors when opening more than a few
9461 windows. A value of 0 to 12 is reasonable.
9462
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009463 *'winptydll'*
9464'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9465 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009466 {only available when compiled with the |terminal|
9467 feature on MS-Windows}
9468 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009469 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009470 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009471 a fallback.
9472 Environment variables are expanded |:set_env|.
9473 This option cannot be set from a |modeline| or in the |sandbox|, for
9474 security reasons.
9475
Bram Moolenaar071d4272004-06-13 20:20:40 +00009476 *'winwidth'* *'wiw'* *E592*
9477'winwidth' 'wiw' number (default 20)
9478 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009479 Minimal number of columns for the current window. This is not a hard
9480 minimum, Vim will use fewer columns if there is not enough room. If
9481 the current window is smaller, its size is increased, at the cost of
9482 the width of other windows. Set it to 999 to make the current window
9483 always fill the screen. Set it to a small number for normal editing.
9484 The width is not adjusted after one of the commands to change the
9485 width of the current window.
9486 'winwidth' applies to the current window. Use 'winminwidth' to set
9487 the minimal width for other windows.
9488
9489 *'wrap'* *'nowrap'*
9490'wrap' boolean (default on)
9491 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009492 This option changes how text is displayed. It doesn't change the text
9493 in the buffer, see 'textwidth' for that.
9494 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009495 displaying continues on the next line. When off lines will not wrap
9496 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009497 moved to a part that is not shown, the screen will scroll
9498 horizontally.
9499 The line will be broken in the middle of a word if necessary. See
9500 'linebreak' to get the break at a word boundary.
9501 To make scrolling horizontally a bit more useful, try this: >
9502 :set sidescroll=5
9503 :set listchars+=precedes:<,extends:>
9504< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009505 This option can't be set from a |modeline| when the 'diff' option is
9506 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009507
9508 *'wrapmargin'* *'wm'*
9509'wrapmargin' 'wm' number (default 0)
9510 local to buffer
9511 Number of characters from the right window border where wrapping
9512 starts. When typing text beyond this limit, an <EOL> will be inserted
9513 and inserting continues on the next line.
9514 Options that add a margin, such as 'number' and 'foldcolumn', cause
9515 the text width to be further reduced. This is Vi compatible.
9516 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009517 This option is set to 0 when 'paste' is set and restored when 'paste'
9518 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009519 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009520
9521 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9522'wrapscan' 'ws' boolean (default on) *E384* *E385*
9523 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009524 Searches wrap around the end of the file. Also applies to |]s| and
9525 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009526
9527 *'write'* *'nowrite'*
9528'write' boolean (default on)
9529 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009530 Allows writing files. When not set, writing a file is not allowed.
9531 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009532 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009533 argument. Filtering text is still possible, even though this requires
9534 writing a temporary file.
9535
9536 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9537'writeany' 'wa' boolean (default off)
9538 global
9539 Allows writing to any file with no need for "!" override.
9540
9541 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9542'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9543 otherwise)
9544 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009545 Make a backup before overwriting a file. The backup is removed after
9546 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009547 also on.
9548 WARNING: Switching this option off means that when Vim fails to write
9549 your buffer correctly and then, for whatever reason, Vim exits, you
9550 lose both the original file and what you were writing. Only reset
9551 this option if your file system is almost full and it makes the write
9552 fail (and make sure not to exit Vim until the write was successful).
9553 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009554 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009555 Depending on 'backupcopy' the backup is a new file or the original
9556 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009557 NOTE: This option is set to the default value when 'compatible' is
9558 set.
9559
9560 *'writedelay'* *'wd'*
9561'writedelay' 'wd' number (default 0)
9562 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009563 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009564 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009565 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009566
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009567 *'xtermcodes'* *'noxtermcodes'*
9568'xtermcodes' boolean (default on)
9569 global
9570 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009571 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009572 key codes and number of colors from the terminal. This takes care of
9573 various configuration options of the terminal that cannot be obtained
9574 from the termlib/terminfo entry, see |xterm-codes|.
9575 A side effect may be that t_Co changes and Vim will redraw the
9576 display.
9577
9578
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009579 vim:tw=78:ts=8:noet:ft=help:norl: