blob: 336d4497d5e1fbe0273c900f714d656c774cb864 [file] [log] [blame]
Bram Moolenaar71b6d332022-09-10 13:13:14 +01001*options.txt* For Vim version 9.0. Last change: 2022 Sep 09
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
37
Bram Moolenaar47003982021-12-05 21:54:04 +000038:se[t]! termcap Idem, but don't use multiple columns.
39
Bram Moolenaar071d4272004-06-13 20:20:40 +000040 *E518* *E519*
41:se[t] {option}? Show value of {option}.
42
43:se[t] {option} Toggle option: set, switch it on.
44 Number option: show value.
45 String option: show value.
46
47:se[t] no{option} Toggle option: Reset, switch it off.
48
Bram Moolenaar00a927d2010-05-14 23:24:24 +020049 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000050:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020051:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000052
53 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
54:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020055 current value of 'compatible'.
56:se[t] {option}&vi Reset option to its Vi default value.
57:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000058
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010059:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020060 these options are not changed:
61 all terminal options, starting with t_
62 'columns'
63 'cryptmethod'
64 'encoding'
65 'key'
66 'lines'
67 'term'
68 'ttymouse'
69 'ttytype'
70 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000071
72 *:set-args* *E487* *E521*
73:se[t] {option}={value} or
74:se[t] {option}:{value}
75 Set string or number option to {value}.
76 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010077 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000078 The old value can be inserted by typing 'wildchar' (by
79 default this is a <Tab> or CTRL-E if 'compatible' is
80 set). See |cmdline-completion|.
81 White space between {option} and '=' is allowed and
82 will be ignored. White space between '=' and {value}
83 is not allowed.
84 See |option-backslash| for using white space and
85 backslashes in {value}.
86
87:se[t] {option}+={value} *:set+=*
88 Add the {value} to a number option, or append the
89 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010090 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 value was empty.
92 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000093 are removed. When adding a flag that was already
94 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000095 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000096
97:se[t] {option}^={value} *:set^=*
98 Multiply the {value} to a number option, or prepend
99 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100100 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101 value was empty.
102 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103
104:se[t] {option}-={value} *:set-=*
105 Subtract the {value} from a number option, or remove
106 the {value} from a string option, if it is there.
107 If the {value} is not found in a string option, there
108 is no error or warning. When the option is a comma
109 separated list, a comma is deleted, unless the option
110 becomes empty.
111 When the option is a list of flags, {value} must be
112 exactly as they appear in the option. Remove flags
113 one by one to avoid problems.
114 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115
116The {option} arguments to ":set" may be repeated. For example: >
117 :set ai nosi sw=3 ts=3
118If you make an error in one of the arguments, an error message will be given
119and the following arguments will be ignored.
120
121 *:set-verbose*
122When 'verbose' is non-zero, displaying an option value will also tell where it
123was last set. Example: >
124 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200125< shiftwidth=4 ~
126 Last set from modeline line 1 ~
127 cindent ~
128 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000129This is only done when specific option values are requested, not for ":verbose
130set all" or ":verbose set" without an argument.
131When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000132When the option was set while executing a function, user command or
133autocommand, the script in which it was defined is reported.
134Note that an option may also have been set as a side effect of setting
135'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200137 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000138 Option was set in a |modeline|.
139 Last set from --cmd argument ~
140 Option was set with command line argument |--cmd| or +.
141 Last set from -c argument ~
142 Option was set with command line argument |-c|, +, |-S| or
143 |-q|.
144 Last set from environment variable ~
145 Option was set from an environment variable, $VIMINIT,
146 $GVIMINIT or $EXINIT.
147 Last set from error handler ~
148 Option was cleared when evaluating it resulted in an error.
149
Bram Moolenaardb84e452010-08-15 13:50:43 +0200150{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151
152 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000153For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000154override the value from the termcap. You can then use it in a mapping. If
155the "xx" part contains special characters, use the <t_xx> form: >
156 :set <t_#4>=^[Ot
157This can also be used to translate a special code for a normal key. For
158example, if Alt-b produces <Esc>b, use this: >
159 :set <M-b>=^[b
160(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
161The advantage over a mapping is that it works in all situations.
162
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100163You can define any key codes, e.g.: >
164 :set t_xy=^[foo;
165There is no warning for using a name that isn't recognized. You can map these
166codes as you like: >
167 :map <t_xy> something
168< *E846*
169When a key code is not set, it's like it does not exist. Trying to get its
170value will result in an error: >
171 :set t_kb=
172 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000173< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100174
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000175The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
176security reasons.
177
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000179at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180"set all" probably does not fit on the screen, causing Vim to give the
181|more-prompt|.
182
183 *option-backslash*
184To include white space in a string option value it has to be preceded with a
185backslash. To include a backslash you have to use two. Effectively this
186means that the number of backslashes in an option value is halved (rounded
187down).
188A few examples: >
189 :set tags=tags\ /usr/tags results in "tags /usr/tags"
190 :set tags=tags\\,file results in "tags\,file"
191 :set tags=tags\\\ file results in "tags\ file"
192
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000193The "|" character separates a ":set" command from a following command. To
194include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195'titlestring' option to "hi|there": >
196 :set titlestring=hi\|there
197This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
198 :set titlestring=hi|set iconstring=there
199
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200200Similarly, in legacy script the double quote character starts a comment. To
201include the '"' in the option value, use '\"' instead. This example sets the
202'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000203 :set titlestring=hi\ \"there\"
204
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200205In |Vim9| script it's simpler, comments start with a '#' character, and only
206when preceded by white space. A backslash is needed less often: >
207 vim9script
208 set titlestring=hi\ "there"
209 set titlestring=hi#there#
210 set titlestring=hi\ \#there#
211
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100212For Win32 backslashes in file names are mostly not removed. More precise: For
213options that expect a file name (those where environment variables are
214expanded) a backslash before a normal file name character is not removed. But
215a backslash before a special character (space, backslash, comma, etc.) is used
216like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217There is one special situation, when the value starts with "\\": >
218 :set dir=\\machine\path results in "\\machine\path"
219 :set dir=\\\\machine\\path results in "\\machine\path"
220 :set dir=\\path\\file results in "\\path\file" (wrong!)
221For the first one the start is kept, but for the second one the backslashes
222are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000223halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224result which is probably not what you want. Avoid it.
225
226 *add-option-flags* *remove-option-flags*
227 *E539* *E550* *E551* *E552*
228Some options are a list of flags. When you want to add a flag to such an
229option, without changing the existing ones, you can do it like this: >
230 :set guioptions+=a
231Remove a flag from an option like this: >
232 :set guioptions-=a
233This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000234Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
236doesn't appear.
237
238 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000239Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000240environment variable exists the '$' and the following environment variable
241name is replaced with its value. If it does not exist the '$' and the name
242are not modified. Any non-id character (not a letter, digit or '_') may
243follow the environment variable name. That character and what follows is
244appended to the value of the environment variable. Examples: >
245 :set term=$TERM.new
246 :set path=/usr/$INCLUDE,$HOME/include,.
247When adding or removing a string from an option with ":set opt-=val" or ":set
248opt+=val" the expansion is done before the adding or removing.
249
250
251Handling of local options *local-options*
252
253Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100254has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255allows you to set 'list' in one window but not in another. And set
256'shiftwidth' to 3 in one buffer and 4 in another.
257
258The following explains what happens to these local options in specific
259situations. You don't really need to know all of this, since Vim mostly uses
260the option values you would expect. Unfortunately, doing what the user
261expects is a bit complicated...
262
263When splitting a window, the local options are copied to the new window. Thus
264right after the split the contents of the two windows look the same.
265
266When editing a new buffer, its local option values must be initialized. Since
267the local options of the current buffer might be specifically for that buffer,
268these are not used. Instead, for each buffer-local option there also is a
269global value, which is used for new buffers. With ":set" both the local and
270global value is changed. With "setlocal" only the local value is changed,
271thus this value is not used when editing a new buffer.
272
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200273When editing a buffer that has been edited before, the options from the window
274that was last closed are used again. If this buffer has been edited in this
275window, the values from back then are used. Otherwise the values from the
276last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277
278It's possible to set a local window option specifically for a type of buffer.
279When you edit another buffer in the same window, you don't want to keep
280using these local window options. Therefore Vim keeps a global value of the
281local window options, which is used when editing another buffer. Each window
282has its own copy of these values. Thus these are local to the window, but
283global to all buffers in the window. With this you can do: >
284 :e one
285 :set list
286 :e two
287Now the 'list' option will also be set in "two", since with the ":set list"
288command you have also set the global value. >
289 :set nolist
290 :e one
291 :setlocal list
292 :e two
293Now the 'list' option is not set, because ":set nolist" resets the global
294value, ":setlocal list" only changes the local value and ":e two" gets the
295global value. Note that if you do this next: >
296 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200297You will get back the 'list' value as it was the last time you edited "one".
298The options local to a window are remembered for each buffer. This also
299happens when the buffer is not loaded, but they are lost when the buffer is
300wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301
302 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100303:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304 current buffer or window. Not all options have a
305 local value. If the option does not have a local
306 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200307 With the "all" argument: display local values for all
308 local options.
309 Without argument: Display local values for all local
310 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000312 local value. For a global/local boolean option, when
313 the global value is being used, "--" is displayed
314 before the option name.
315 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000318:setl[ocal] {option}< Set the local value of {option} to its global value by
319 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000320
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100321:se[t] {option}< For |global-local| options: Remove the local value of
322 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100325:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 option without changing the local value.
327 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200328 With the "all" argument: display global values for all
329 local options.
330 Without argument: display global values for all local
331 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332
333For buffer-local and window-local options:
334 Command global value local value ~
335 :set option=value set set
336 :setlocal option=value - set
337:setglobal option=value set -
338 :set option? - display
339 :setlocal option? - display
340:setglobal option? display -
341
342
343Global options with a local value *global-local*
344
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000345Options are global when you mostly use one value for all buffers and windows.
346For some global options it's useful to sometimes have a different local value.
347You can set the local value with ":setlocal". That buffer or window will then
348use the local value, while other buffers and windows continue using the global
349value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350
351For example, you have two windows, both on C source code. They use the global
352'makeprg' option. If you do this in one of the two windows: >
353 :set makeprg=gmake
354then the other window will switch to the same value. There is no need to set
355the 'makeprg' option in the other C source window too.
356However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000357another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000358files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359 :setlocal makeprg=perlmake
360You can switch back to using the global value by making the local value empty: >
361 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100362This only works for a string option. For a number or boolean option you need
363to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000364 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100365Note that for non-boolean and non-number options using "<" copies the global
366value to the local value, it doesn't switch back to using the global value
367(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000368 :set path<
369This will make the local value of 'path' empty, so that the global value is
370used. Thus it does the same as: >
371 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000372Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373":setlocal" on a global option might work differently then.
374
375
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000376 *option-value-function*
377Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000378'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000379a function name or a function reference or a lambda function. When using a
380lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000381>
382 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000383 set opfunc=function('MyOpFunc')
384 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000385 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000386
387Set to a script-local function: >
388 set opfunc=s:MyLocalFunc
389 set opfunc=<SID>MyLocalFunc
390In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
391the script: >
392 set opfunc=MyLocalFunc
393
394Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000395 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000396 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000397
398Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000399 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000400
401Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000402 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000403 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000404
405In Vim9 script, in a compiled function, you can use a lambda, but a
406closured does not work, because the function will be called without the
407context of where it was defined.
408
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000409
Bram Moolenaar071d4272004-06-13 20:20:40 +0000410Setting the filetype
411
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200412:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413 Set the 'filetype' option to {filetype}, but only if
414 not done yet in a sequence of (nested) autocommands.
415 This is short for: >
416 :if !did_filetype()
417 : setlocal filetype={filetype}
418 :endif
419< This command is used in a filetype.vim file to avoid
420 setting the 'filetype' option twice, causing different
421 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200422
423 When the optional FALLBACK argument is present, a
424 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100425 'filetype'. This is to be used for filetype
426 detections that are just a guess. |did_filetype()|
427 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200428
Bram Moolenaard58e9292011-02-09 17:07:58 +0100429 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
431:opt[ions] Open a window for viewing and setting all options.
432 Options are grouped by function.
433 Offers short help for each option. Hit <CR> on the
434 short help to open a help window with more help for
435 the option.
436 Modify the value of the option and hit <CR> on the
437 "set" line to set the new value. For window and
438 buffer specific options, the last accessed window is
439 used to set the option value in, unless this is a help
440 window, in which case the window below help window is
441 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100442 {not available when compiled without the |+eval|
443 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000444
445 *$HOME*
446Using "~" is like using "$HOME", but it is only recognized at the start of an
447option and after a space or comma.
448
449On Unix systems "~user" can be used too. It is replaced by the home directory
450of user "user". Example: >
451 :set path=~mool/include,/usr/include,.
452
453On Unix systems the form "${HOME}" can be used too. The name between {} can
454contain non-id characters then. Note that if you want to use this for the
455"gf" command, you need to add the '{' and '}' characters to 'isfname'.
456
457NOTE: expanding environment variables and "~/" is only done with the ":set"
458command, not when assigning a value to an option with ":let".
459
Bram Moolenaarc572da52017-08-27 16:52:01 +0200460 *$HOME-windows*
461On MS-Windows, if $HOME is not defined as an environment variable, then
462at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200463If $HOMEDRIVE is not set then $USERPROFILE is used.
464
465This expanded value is not exported to the environment, this matters when
466running an external command: >
467 :echo system('set | findstr ^HOME=')
468and >
469 :echo luaeval('os.getenv("HOME")')
470should echo nothing (an empty string) despite exists('$HOME') being true.
471When setting $HOME to a non-empty string it will be exported to the
472subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200473
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474
475Note the maximum length of an expanded option is limited. How much depends on
476the system, mostly it is something like 256 or 1024 characters.
477
478 *:fix* *:fixdel*
479:fix[del] Set the value of 't_kD':
480 't_kb' is 't_kD' becomes ~
481 CTRL-? CTRL-H
482 not CTRL-? CTRL-?
483
Bram Moolenaar82be4842021-01-11 19:40:15 +0100484 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000485
486 If your delete key terminal code is wrong, but the
487 code for backspace is alright, you can put this in
488 your .vimrc: >
489 :fixdel
490< This works no matter what the actual code for
491 backspace is.
492
493 If the backspace key terminal code is wrong you can
494 use this: >
495 :if &term == "termname"
496 : set t_kb=^V<BS>
497 : fixdel
498 :endif
499< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000500 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000501 with your terminal name.
502
503 If your <Delete> key sends a strange key sequence (not
504 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
505 :if &term == "termname"
506 : set t_kD=^V<Delete>
507 :endif
508< Where "^V" is CTRL-V and "<Delete>" is the delete key
509 (don't type eight characters!). Replace "termname"
510 with your terminal name.
511
512 *Linux-backspace*
513 Note about Linux: By default the backspace key
514 produces CTRL-?, which is wrong. You can fix it by
515 putting this line in your rc.local: >
516 echo "keycode 14 = BackSpace" | loadkeys
517<
518 *NetBSD-backspace*
519 Note about NetBSD: If your backspace doesn't produce
520 the right code, try this: >
521 xmodmap -e "keycode 22 = BackSpace"
522< If this works, add this in your .Xmodmap file: >
523 keysym 22 = BackSpace
524< You need to restart for this to take effect.
525
526==============================================================================
5272. Automatically setting options *auto-setting*
528
529Besides changing options with the ":set" command, there are three alternatives
530to set options automatically for one or more files:
531
5321. When starting Vim initializations are read from various places. See
533 |initialization|. Most of them are performed for all editing sessions,
534 and some of them depend on the directory where Vim is started.
535 You can create an initialization file with |:mkvimrc|, |:mkview| and
536 |:mksession|.
5372. If you start editing a new file, the automatic commands are executed.
538 This can be used to set options for files matching a particular pattern and
539 many other things. See |autocommand|.
5403. If you start editing a new file, and the 'modeline' option is on, a
541 number of lines at the beginning and end of the file are checked for
542 modelines. This is explained here.
543
544 *modeline* *vim:* *vi:* *ex:* *E520*
545There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100546 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100548[text{white}] empty or any text followed by at least one blank
549 character (<Space> or <Tab>); "ex:" always requires at
550 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200551{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200552[white] optional white space
553{options} a list of option settings, separated with white space
554 or ':', where each part between ':' is the argument
555 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556
Bram Moolenaar14b69452013-06-29 23:05:20 +0200557Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000558 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200559 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560
561The second form (this is compatible with some versions of Vi):
562
Bram Moolenaarade0d392020-01-21 22:33:58 +0100563 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
Bram Moolenaarade0d392020-01-21 22:33:58 +0100565[text{white}] empty or any text followed by at least one blank
566 character (<Space> or <Tab>); "ex:" always requires at
567 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200568{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
569[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200570se[t] the string "set " or "se " (note the space); When
571 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200572{options} a list of options, separated with white space, which
573 is the argument for a ":set" command
574: a colon
575[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576
Bram Moolenaar14b69452013-06-29 23:05:20 +0200577Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000578 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200579 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000580
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200581The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
582chance that a normal word like "lex:" is caught. There is one exception:
583"vi:" and "vim:" can also be at the start of the line (for compatibility with
584version 3.0). Using "ex:" at the start of the line will be ignored (this
585could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586
Hu Jialun9dcd3492021-08-28 20:42:50 +0200587If the modeline is disabled within a modeline, subsequent modelines will be
588ignored. This is to allow turning off modeline on a per-file basis. This is
589useful when a line looks like a modeline but isn't. For example, it would be
590good to start a YAML file containing strings like "vim:" with
591 # vim: nomodeline ~
592so as to avoid modeline misdetection. Following options on the same line
593after modeline deactivation, if any, are still evaluated (but you would
594normally not have any).
595
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596 *modeline-local*
597The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000598buffer and window that contain the file. Although it's possible to set global
599options from a modeline, this is unusual. If you have two windows open and
600the files in it set the same global option to a different value, the result
601depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000602
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000603When editing a file that was already loaded, only the window-local options
604from the modeline are used. Thus if you manually changed a buffer-local
605option after opening the file, it won't be changed if you edit the same buffer
606in another window. But window-local options will be set.
607
Bram Moolenaar071d4272004-06-13 20:20:40 +0000608 *modeline-version*
609If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200610number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 vim{vers}: version {vers} or later
612 vim<{vers}: version before {vers}
613 vim={vers}: version {vers}
614 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100615{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
616For example, to use a modeline only for Vim 7.0:
617 /* vim700: set foldmethod=marker */ ~
618To use a modeline for Vim after version 7.2:
619 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620There can be no blanks between "vim" and the ":".
621
622
623The number of lines that are checked can be set with the 'modelines' option.
624If 'modeline' is off or 'modelines' is 0 no lines are checked.
625
626Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000627like:
628 /* vi:ts=4: */ ~
629will give an error message for the trailing "*/". This line is OK:
630 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631
632If an error is detected the rest of the line is skipped.
633
634If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000635backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100636 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
637This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
638before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200639 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000641might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200642can be set. For some options a flag is set, so that when the value is used
643the |sandbox| is effective. Some options can only be set from the modeline
644when 'modelineexpr' is set (the default is off).
645
646Still, there is always a small risk that a modeline causes trouble. E.g.,
647when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
648So disable modelines before editing untrusted text. The mail ftplugin does
649this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650
651Hint: If you would like to do something else than setting an option, you could
652define an autocommand that checks the file for a specific string. For
653example: >
654 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
655And define a function SetVar() that does something with the line containing
656"VAR".
657
658==============================================================================
6593. Options summary *option-summary*
660
661In the list below all the options are mentioned with their full name and with
662an abbreviation if there is one. Both forms may be used.
663
664In this document when a boolean option is "set" that means that ":set option"
665is entered. When an option is "reset", ":set nooption" is used.
666
667For some options there are two default values: The "Vim default", which is
668used when 'compatible' is not set, and the "Vi default", which is used when
669'compatible' is set.
670
671Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000672are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673different value in each window. For example the 'list' option can be set in
674one window and reset in another for the same text, giving both types of view
675at the same time. There are a few options that are specific to a certain
676file. These can have a different value for each file or buffer. For example
677the 'textwidth' option can be 78 for a normal text file and 0 for a C
678program.
679
680 global one option for all buffers and windows
681 local to window each window has its own copy of this option
682 local to buffer each buffer has its own copy of this option
683
684When creating a new window the option values from the currently active window
685are used as a default value for the window-specific options. For the
686buffer-specific options this depends on the 's' and 'S' flags in the
687'cpoptions' option. If 's' is included (which is the default) the values for
688buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000689first entered. If 'S' is present the options are copied each time the buffer
690is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691present, the options are copied from the currently active buffer when the
692buffer is created.
693
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000694Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000696Not all options are supported in all versions. This depends on the supported
697features and sometimes on the system. A remark about this is in curly braces
698below. When an option is not supported it may still be set without getting an
699error, this is called a hidden option. You can't get the value of a hidden
700option though, it is not stored.
701
702To test if option "foo" can be used with ":set" use something like this: >
703 if exists('&foo')
704This also returns true for a hidden option. To test if option "foo" is really
705supported use something like this: >
706 if exists('+foo')
707<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708 *E355*
709A jump table for the options with a short description can be found at |Q_op|.
710
711 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100712'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714 {only available when compiled with the |+rightleft|
715 feature}
716 The ASCII code for the first letter of the Hebrew alphabet. The
717 routine that maps the keyboard in Hebrew mode, both in Insert mode
718 (when hkmap is set) and on the command-line (when hitting CTRL-_)
719 outputs the Hebrew characters in the range [aleph..aleph+26].
720 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
721 See |rileft.txt|.
722
723 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
724'allowrevins' 'ari' boolean (default off)
725 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726 {only available when compiled with the |+rightleft|
727 feature}
728 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
729 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
730 into reverse Insert mode, and don't know how to get out. See
731 'revins'.
732 NOTE: This option is reset when 'compatible' is set.
733
734 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
735'altkeymap' 'akm' boolean (default off)
736 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737 {only available when compiled with the |+farsi|
738 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100739 This option was for using Farsi, which has been removed. See
740 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741
742 *'ambiwidth'* *'ambw'*
743'ambiwidth' 'ambw' string (default: "single")
744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000745 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
746 Tells Vim what to do with characters with East Asian Width Class
747 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
748 letters, Cyrillic letters).
749
750 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000751 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 expected by most users.
753 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200754 *E834* *E835*
755 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100756 contains a character that would be double width. These errors may
757 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200758
759 The values are overruled for characters specified with
760 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761
762 There are a number of CJK fonts for which the width of glyphs for
763 those characters are solely based on how many octets they take in
764 legacy/traditional CJK encodings. In those encodings, Euro,
765 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000766 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000768 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 Vim is running inside a terminal (emulators) that uses a CJK font
770 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
771 this option should be set to "double" to match the width perceived
772 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100773 to be set to "double" under CJK MS-Windows when the system locale is
774 set to one of CJK locales. See Unicode Standard Annex #11
775 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100777 Vim may set this option automatically at startup time when Vim is
778 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200779 escape sequence to request cursor position report. The response can
780 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100781
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
783'antialias' 'anti' boolean (default: off)
784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200786 on macOS}
787 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
789 which can be easier to read at certain sizes on certain displays.
790 Setting this option can sometimes cause problems if 'guifont' is set
791 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100792 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793
794 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
795'autochdir' 'acd' boolean (default off)
796 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200797 {only available when compiled with it, use
798 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000799 When on, Vim will change the current working directory whenever you
800 open a file, switch buffers, delete a buffer or open/close a window.
801 It will change to the directory containing the file which was opened
Bram Moolenaare8008642022-08-19 17:15:35 +0100802 or selected. When a buffer has no name it also has no directory, thus
803 the current directory won't change when navigating to it.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000804 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200806 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
807'autoshelldir' 'asd' boolean (default off)
808 global
809 When on, Vim will change the current working directory whenever you
810 change the directory of the shell running in a terminal window. You
811 need proper setting-up, so whenever the shell's pwd changes an OSC 7
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100812 escape sequence will be emitted. For example, on Linux, you can
813 source /etc/profile.d/vte.sh in your shell profile if you use bash or
814 zsh. For bash this should work (put it in a bash init file): >
815 if [[ -n "$VIM_TERMINAL" ]]; then
816 PROMPT_COMMAND='_vim_sync_PWD'
817 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100818 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100819 }
820 fi
821<
822 Or, in a zsh init file: >
823 if [[ -n "$VIM_TERMINAL" ]]; then
824 autoload -Uz add-zsh-hook
825 add-zsh-hook -Uz chpwd _vim_sync_PWD
826 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100827 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100828 }
829 fi
830<
831 In a fish init file: >
832 if test -n "$VIM_TERMINAL"
833 function _vim_sync_PWD --on-variable=PWD
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100834 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100835 end
836 end
837<
838 You can find an alternative method at |terminal-autoshelldir|.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000839 When the parsing of the OSC sequence fails you get *E1179* .
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200840
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
842'arabic' 'arab' boolean (default off)
843 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844 {only available when compiled with the |+arabic|
845 feature}
846 This option can be set to start editing Arabic text.
847 Setting this option will:
848 - Set the 'rightleft' option, unless 'termbidi' is set.
849 - Set the 'arabicshape' option, unless 'termbidi' is set.
850 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
851 between typing English and Arabic key mapping.
852 - Set the 'delcombine' option
853 Note that 'encoding' must be "utf-8" for working with Arabic text.
854
855 Resetting this option will:
856 - Reset the 'rightleft' option.
857 - Disable the use of 'keymap' (without changing its value).
858 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200859 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100860 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861 Also see |arabic.txt|.
862
863 *'arabicshape'* *'arshape'*
864 *'noarabicshape'* *'noarshape'*
865'arabicshape' 'arshape' boolean (default on)
866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 {only available when compiled with the |+arabic|
868 feature}
869 When on and 'termbidi' is off, the required visual character
870 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200871 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872 one which encompasses:
873 a) the changing/morphing of characters based on their location
874 within a word (initial, medial, final and stand-alone).
875 b) the enabling of the ability to compose characters
876 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100877 When disabled the display shows each character's true stand-alone
878 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879 Arabic is a complex language which requires other settings, for
880 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100881 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882
883 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
884'autoindent' 'ai' boolean (default off)
885 local to buffer
886 Copy indent from current line when starting a new line (typing <CR>
887 in Insert mode or when using the "o" or "O" command). If you do not
888 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000889 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
890 to another line has the same effect, unless the 'I' flag is included
891 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000892 When autoindent is on, formatting (with the "gq" command or when you
893 reach 'textwidth' in Insert mode) uses the indentation of the first
894 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 When 'smartindent' or 'cindent' is on the indent is changed in
896 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200897 The 'autoindent' option is reset when the 'paste' option is set and
898 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899
900 *'autoread'* *'ar'* *'noautoread'* *'noar'*
901'autoread' 'ar' boolean (default off)
902 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903 When a file has been detected to have been changed outside of Vim and
904 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200905 When the file has been deleted this is not done, so you have the text
906 from before it was deleted. When it appears again then it is read.
907 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908 If this option has a local value, use this command to switch back to
909 using the global value: >
910 :set autoread<
911<
912 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
913'autowrite' 'aw' boolean (default off)
914 global
915 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000916 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000917 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
918 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000919 to another file.
920 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000921 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 Note that for some commands the 'autowrite' option is not used, see
923 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200924 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200925 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926
927 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
928'autowriteall' 'awa' boolean (default off)
929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
931 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
932 Setting this option also implies that Vim behaves like 'autowrite' has
933 been set.
934
935 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200936'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 When set to "dark", Vim will try to use colors that look good on a
939 dark background. When set to "light", Vim will try to use colors that
940 look good on a light background. Any other value is illegal.
941 Vim tries to set the default value according to the terminal used.
942 This will not always be correct.
943 Setting this option does not change the background color, it tells Vim
944 what the background color looks like. For changing the background
945 color, see |:hi-normal|.
946
947 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000948 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000949 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100950 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951 setting 'background' will cause the color scheme to be reloaded. If
952 the color scheme adjusts to the value of 'background' this will work.
953 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100954 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955
956 When setting 'background' to the default value with: >
957 :set background&
958< Vim will guess the value. In the GUI this should work correctly,
959 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200960 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200961 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200963 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200964 color from the terminal. If the returned RGB value is dark/light and
965 'background' is not dark/light, 'background' will be set and the
966 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200967 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100968 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200969
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 When starting the GUI, the default value for 'background' will be
971 "light". When the value is not set in the .gvimrc, and Vim detects
972 that the background is actually quite dark, 'background' is set to
973 "dark". But this happens only AFTER the .gvimrc file has been read
974 (because the window needs to be opened to find the actual background
975 color). To get around this, force the GUI window to be opened by
976 putting a ":gui" command in the .gvimrc file, before where the value
977 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200978
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100979 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200980 For other systems "dark" is used when 'term' is "linux",
981 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
982 background. Otherwise the default is "light".
983
Bram Moolenaarc572da52017-08-27 16:52:01 +0200984 The |:terminal| command and the |term_start()| function use the
985 'background' value to decide whether the terminal window will start
986 with a white or black background.
987
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988 Normally this option would be set in the .vimrc file. Possibly
989 depending on the terminal name. Example: >
990 :if &term == "pcterm"
991 : set background=dark
992 :endif
993< When this option is set, the default settings for the highlight groups
994 will change. To use other settings, place ":highlight" commands AFTER
995 the setting of the 'background' option.
996 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
997 to select the colors for syntax highlighting. After changing this
998 option, you must load syntax.vim again to see the result. This can be
999 done with ":syntax on".
1000
1001 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001002'backspace' 'bs' string (default "", set to "indent,eol,start"
1003 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1006 mode. This is a list of items, separated by commas. Each item allows
1007 a way to backspace over something:
1008 value effect ~
1009 indent allow backspacing over autoindent
1010 eol allow backspacing over line breaks (join lines)
1011 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1012 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001013 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1014 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015
Bram Moolenaar46eea442022-03-30 10:51:39 +01001016 When the value is empty, Vi compatible backspacing is used, none of
1017 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018
1019 For backwards compatibility with version 5.4 and earlier:
1020 value effect ~
1021 0 same as ":set backspace=" (Vi compatible)
1022 1 same as ":set backspace=indent,eol"
1023 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001024 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025
1026 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1027 NOTE: This option is set to "" when 'compatible' is set.
1028
1029 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1030'backup' 'bk' boolean (default off)
1031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032 Make a backup before overwriting a file. Leave it around after the
1033 file has been successfully written. If you do not want to keep the
1034 backup file, but you do want a backup while the file is being
1035 written, reset this option and set the 'writebackup' option (this is
1036 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001037 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038 |backup-table| for more explanations.
1039 When the 'backupskip' pattern matches, a backup is not made anyway.
1040 When 'patchmode' is set, the backup may be renamed to become the
1041 oldest version of a file.
1042 NOTE: This option is reset when 'compatible' is set.
1043
1044 *'backupcopy'* *'bkc'*
1045'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001046 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001048 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049
1050 The main values are:
1051 "yes" make a copy of the file and overwrite the original one
1052 "no" rename the file and write a new one
1053 "auto" one of the previous, what works best
1054
1055 Extra values that can be combined with the ones above are:
1056 "breaksymlink" always break symlinks when writing
1057 "breakhardlink" always break hardlinks when writing
1058
1059 Making a copy and overwriting the original file:
1060 - Takes extra time to copy the file.
1061 + When the file has special attributes, is a (hard/symbolic) link or
1062 has a resource fork, all this is preserved.
1063 - When the file is a link the backup will have the name of the link,
1064 not of the real file.
1065
1066 Renaming the file and writing a new one:
1067 + It's fast.
1068 - Sometimes not all attributes of the file can be copied to the new
1069 file.
1070 - When the file is a link the new file will not be a link.
1071
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001072 The "auto" value is the middle way: When Vim sees that renaming the
1073 file is possible without side effects (the attributes can be passed on
1074 and the file is not a link) that is used. When problems are expected,
1075 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001076
1077 The "breaksymlink" and "breakhardlink" values can be used in
1078 combination with any of "yes", "no" and "auto". When included, they
1079 force Vim to always break either symbolic or hard links by doing
1080 exactly what the "no" option does, renaming the original file to
1081 become the backup and writing a new file in its place. This can be
1082 useful for example in source trees where all the files are symbolic or
1083 hard links and any changes should stay in the local source tree, not
1084 be propagated back to the original source.
1085 *crontab*
1086 One situation where "no" and "auto" will cause problems: A program
1087 that opens a file, invokes Vim to edit that file, and then tests if
1088 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001089 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090 example.
1091
1092 When a copy is made, the original file is truncated and then filled
1093 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001094 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001095 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 group of the backup is set to the group of the original file. If this
1097 fails, the protection bits for the group are made the same as for
1098 others.
1099
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001100 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 the same attributes of the original file, and the newly written file
1102 is owned by the current user. When the file was a (hard/symbolic)
1103 link, the new file will not! That's why the "auto" value doesn't
1104 rename when the file is a link. The owner and group of the newly
1105 written file will be set to the same ones as the original file, but
1106 the system may refuse to do this. In that case the "auto" value will
1107 again not rename the file.
1108
Bram Moolenaar036986f2017-03-16 17:41:02 +01001109 NOTE: This option is set to the Vi default value when 'compatible' is
1110 set and to the Vim default value when 'compatible' is reset.
1111
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112 *'backupdir'* *'bdir'*
1113'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001114 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115 for Unix: ".,~/tmp,~/")
1116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 List of directories for the backup file, separated with commas.
1118 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001119 where this is possible. The directory must exist, Vim will not
1120 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001121 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122 impossible!). Writing may fail because of this.
1123 - A directory "." means to put the backup file in the same directory
1124 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001125 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1126 the backup file relative to where the edited file is. The leading
1127 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128 ("." inside a directory name has no special meaning).
1129 - Spaces after the comma are ignored, other spaces are considered part
1130 of the directory name. To have a space at the start of a directory
1131 name, precede it with a backslash.
1132 - To include a comma in a directory name precede it with a backslash.
1133 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001134 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001135 the backup file name will be built from the complete path to the
1136 file with all path separators changed to percent '%' signs. This
1137 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001138 On Win32, it is also possible to end with "\\". However, When a
1139 separating comma is following, you must use "//", since "\\" will
1140 include the comma in the file name. Therefore it is recommended to
1141 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142 - Environment variables are expanded |:set_env|.
1143 - Careful with '\' characters, type one before a space, type two to
1144 get one in the option (see |option-backslash|), for example: >
1145 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1146< - For backwards compatibility with Vim version 3.0 a '>' at the start
1147 of the option is removed.
1148 See also 'backup' and 'writebackup' options.
1149 If you want to hide your backup files on Unix, consider this value: >
1150 :set backupdir=./.backup,~/.backup,.,/tmp
1151< You must create a ".backup" directory in each directory and in your
1152 home directory for this to work properly.
1153 The use of |:set+=| and |:set-=| is preferred when adding or removing
1154 directories from the list. This avoids problems when a future version
1155 uses another default.
1156 This option cannot be set from a |modeline| or in the |sandbox|, for
1157 security reasons.
1158
1159 *'backupext'* *'bex'* *E589*
1160'backupext' 'bex' string (default "~", for VMS: "_")
1161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162 String which is appended to a file name to make the name of the
1163 backup file. The default is quite unusual, because this avoids
1164 accidentally overwriting existing files with a backup file. You might
1165 prefer using ".bak", but make sure that you don't have files with
1166 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001167 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001169 If you like to keep a lot of backups, you could use a BufWritePre
1170 autocommand to change 'backupext' just before writing the file to
1171 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001172 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001173< Use 'backupdir' to put the backup in a different directory.
1174
Bram Moolenaar071d4272004-06-13 20:20:40 +00001175 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001176'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1177 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1178 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 A list of file patterns. When one of the patterns matches with the
1181 name of the file which is written, no backup file is created. Both
1182 the specified file name and the full path name of the file are used.
1183 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1184 Watch out for special characters, see |option-backslash|.
1185 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001186 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001187
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001188 WARNING: Not having a backup file means that when Vim fails to write
1189 your buffer correctly and then, for whatever reason, Vim exits, you
1190 lose both the original file and what you were writing. Only disable
1191 backups if you don't care about losing the file.
1192
Bram Moolenaar02467872007-05-06 13:22:01 +00001193 Note that environment variables are not expanded. If you want to use
1194 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001195 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001196
1197< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001198 backup would be made by renaming the original file crontab won't see
1199 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001200
1201 *'balloondelay'* *'bdlay'*
1202'balloondelay' 'bdlay' number (default: 600)
1203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 {only available when compiled with the |+balloon_eval|
1205 feature}
1206 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1207
1208 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1209'ballooneval' 'beval' boolean (default off)
1210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001212 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001213 Switch on the |balloon-eval| functionality for the GUI.
1214
1215 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1216 *'nobevalterm'*
1217'balloonevalterm' 'bevalterm' boolean (default off)
1218 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001219 {only available when compiled with the
1220 |+balloon_eval_term| feature}
1221 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001222
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001223 *'balloonexpr'* *'bexpr'*
1224'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001225 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001226 {only available when compiled with the |+balloon_eval|
1227 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001228 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001229 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1230 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001231
1232 v:beval_bufnr number of the buffer in which balloon is going to show
1233 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001234 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001235 v:beval_lnum line number
1236 v:beval_col column number (byte index)
1237 v:beval_text word under or after the mouse pointer
1238
Bram Moolenaar54775062019-07-31 21:07:14 +02001239 Instead of showing a balloon, which is limited to plain text, consider
1240 using a popup window, see |popup_beval_example|. A popup window can
1241 use highlighting and show a border.
1242
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001243 The evaluation of the expression must not have side effects!
1244 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001245 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001246 return 'Cursor is at line ' .. v:beval_lnum ..
1247 \ ', column ' .. v:beval_col ..
1248 \ ' of file ' .. bufname(v:beval_bufnr) ..
1249 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001250 endfunction
1251 set bexpr=MyBalloonExpr()
1252 set ballooneval
1253<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001254 Also see |balloon_show()|, it can be used if the content of the balloon
1255 is to be fetched asynchronously. In that case evaluating
1256 'balloonexpr' should result in an empty string. If you get a balloon
1257 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001258
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001259 NOTE: The balloon is displayed only if the cursor is on a text
1260 character. If the result of evaluating 'balloonexpr' is not empty,
1261 Vim does not try to send a message to an external debugger (Netbeans
1262 or Sun Workshop).
1263
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001264 If the expression starts with s: or |<SID>|, then it is replaced with
1265 the script ID (|local-function|). Example: >
1266 set bexpr=s:MyBalloonExpr()
1267 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001268< Otherwise, the expression is evaluated in the context of the script
1269 where the option was set, thus script-local items are available.
1270
Bram Moolenaar30b65812012-07-12 22:01:11 +02001271 The expression will be evaluated in the |sandbox| when set from a
1272 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001273 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001274
1275 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001276 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001277
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001278 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001279 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001280< When they are supported "\n" characters will start a new line. If the
1281 expression evaluates to a |List| this is equal to using each List item
1282 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001283 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001284
Bram Moolenaar165bc692015-07-21 17:53:25 +02001285 *'belloff'* *'bo'*
1286'belloff' 'bo' string (default "")
1287 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001288 Specifies for which events the bell will not be rung. It is a comma
1289 separated list of items. For each item that is present, the bell
1290 will be silenced. This is most useful to specify specific events in
1291 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001292 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001293
1294 item meaning when present ~
1295 all All events.
1296 backspace When hitting <BS> or <Del> and deleting results in an
1297 error.
1298 cursor Fail to move around using the cursor keys or
1299 <PageUp>/<PageDown> in |Insert-mode|.
1300 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1301 |i_CTRL-X_CTRL-T|.
1302 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1303 |i_CTRL-E|.
1304 ctrlg Unknown Char after <C-G> in Insert mode.
1305 error Other Error occurred (e.g. try to join last line)
1306 (mostly used in |Normal-mode| or |Cmdline-mode|).
1307 esc hitting <Esc> in |Normal-mode|.
1308 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001309 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001310 insertmode Pressing <Esc> in 'insertmode'.
1311 lang Calling the beep module for Lua/Mzscheme/TCL.
1312 mess No output available for |g<|.
1313 showmatch Error occurred for 'showmatch' function.
1314 operator Empty region error |cpo-E|.
1315 register Unknown register after <C-R> in |Insert-mode|.
1316 shell Bell from shell output |:!|.
1317 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001318 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001319 wildmode More matches in |cmdline-completion| available
1320 (depends on the 'wildmode' setting).
1321
Bram Moolenaar036986f2017-03-16 17:41:02 +01001322 This is most useful to fine tune when in Insert mode the bell should
1323 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001324 indicate that an error occurred. It can be silenced by adding the
1325 "error" keyword.
1326
Bram Moolenaar071d4272004-06-13 20:20:40 +00001327 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1328'binary' 'bin' boolean (default off)
1329 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001330 This option should be set before editing a binary file. You can also
1331 use the |-b| Vim argument. When this option is switched on a few
1332 options will be changed (also when it already was on):
1333 'textwidth' will be set to 0
1334 'wrapmargin' will be set to 0
1335 'modeline' will be off
1336 'expandtab' will be off
1337 Also, 'fileformat' and 'fileformats' options will not be used, the
1338 file is read and written like 'fileformat' was "unix" (a single <NL>
1339 separates lines).
1340 The 'fileencoding' and 'fileencodings' options will not be used, the
1341 file is read without conversion.
1342 NOTE: When you start editing a(nother) file while the 'bin' option is
1343 on, settings from autocommands may change the settings again (e.g.,
1344 'textwidth'), causing trouble when editing. You might want to set
1345 'bin' again when the file has been loaded.
1346 The previous values of these options are remembered and restored when
1347 'bin' is switched from on to off. Each buffer has its own set of
1348 saved option values.
1349 To edit a file with 'binary' set you can use the |++bin| argument.
1350 This avoids you have to do ":set bin", which would have effect for all
1351 files you edit.
1352 When writing a file the <EOL> for the last line is only written if
1353 there was one in the original file (normally Vim appends an <EOL> to
1354 the last line if there is none; this would make the file longer). See
1355 the 'endofline' option.
1356
1357 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1358'bioskey' 'biosk' boolean (default on)
1359 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001360 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001361 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362
1363 *'bomb'* *'nobomb'*
1364'bomb' boolean (default off)
1365 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366 When writing a file and the following conditions are met, a BOM (Byte
1367 Order Mark) is prepended to the file:
1368 - this option is on
1369 - the 'binary' option is off
1370 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1371 endian variants.
1372 Some applications use the BOM to recognize the encoding of the file.
1373 Often used for UCS-2 files on MS-Windows. For other applications it
1374 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001375 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001376 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1377 check for the presence of the BOM is done and 'bomb' set accordingly.
1378 Unless 'binary' is set, it is removed from the first line, so that you
1379 don't see it when editing. When you don't change the options, the BOM
1380 will be restored when writing the file.
1381
1382 *'breakat'* *'brk'*
1383'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1384 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001385 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386 feature}
1387 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001388 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1389 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001391 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001392'breakindent' 'bri' boolean (default off)
1393 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001394 {not available when compiled without the |+linebreak|
1395 feature}
1396 Every wrapped line will continue visually indented (same amount of
1397 space as the beginning of that line), thus preserving horizontal blocks
1398 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001399 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001400
1401 *'breakindentopt'* *'briopt'*
1402'breakindentopt' 'briopt' string (default empty)
1403 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001404 {not available when compiled without the |+linebreak|
1405 feature}
1406 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001407 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001408 min:{n} Minimum text width that will be kept after
1409 applying 'breakindent', even if the resulting
1410 text should normally be narrower. This prevents
1411 text indented almost to the right window border
1412 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001413 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001414 shift:{n} After applying 'breakindent', the wrapped line's
1415 beginning will be shifted by the given number of
1416 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001417 indentation (negative) or emphasizing the line
1418 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001419 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001420 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001421 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001422 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001423 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001424 numbered or bulleted list (using the
1425 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001426 list:-1 Uses the length of a match with 'formatlistpat'
1427 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001428 (default: 0)
1429 column:{n} Indent at column {n}. Will overrule the other
1430 sub-options. Note: an additional indent may be
1431 added for the 'showbreak' setting.
1432 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001433
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001435'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001437 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001439 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001440 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441 buffer Use the directory of the related buffer.
1442 current Use the current directory.
1443 {path} Use the specified directory
1444
1445 *'bufhidden'* *'bh'*
1446'bufhidden' 'bh' string (default: "")
1447 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448 This option specifies what happens when a buffer is no longer
1449 displayed in a window:
1450 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001451 hide hide the buffer (don't unload it), even if 'hidden' is
1452 not set
1453 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001454 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001455 delete delete the buffer from the buffer list, even if
1456 'hidden' is set; the |:hide| command will also delete
1457 the buffer, making it behave like |:bdelete|
1458 wipe wipe the buffer from the buffer list, even if
1459 'hidden' is set; the |:hide| command will also wipe
1460 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001462 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001463 are lost without a warning. Also, these values may break autocommands
1464 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 This option is used together with 'buftype' and 'swapfile' to specify
1466 special kinds of buffers. See |special-buffers|.
1467
1468 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1469'buflisted' 'bl' boolean (default: on)
1470 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471 When this option is set, the buffer shows up in the buffer list. If
1472 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1473 This option is reset by Vim for buffers that are only used to remember
1474 a file name or marks. Vim sets it when starting to edit a buffer.
1475 But not when moving to a buffer with ":buffer".
1476
1477 *'buftype'* *'bt'* *E382*
1478'buftype' 'bt' string (default: "")
1479 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001480 The value of this option specifies the type of a buffer:
1481 <empty> normal buffer
1482 nofile buffer which is not related to a file and will not be
1483 written
1484 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001485 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001486 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001488 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 help help buffer (you are not supposed to set this
1490 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001491 terminal buffer for a |terminal| (you are not supposed to set
1492 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001493 prompt buffer where only the last line can be edited, meant
1494 to be used by a plugin, see |prompt-buffer|
1495 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001496 popup buffer used in a popup window, see |popup|.
1497 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498
1499 This option is used together with 'bufhidden' and 'swapfile' to
1500 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001501 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502
1503 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001504 One such effect is that Vim will not check the timestamp of the file,
1505 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506
Bram Moolenaar280f1262006-01-30 00:14:18 +00001507 A "quickfix" buffer is only used for the error list and the location
1508 list. This value is set by the |:cwindow| and |:lwindow| commands and
1509 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001510
1511 "nofile" and "nowrite" buffers are similar:
1512 both: The buffer is not to be written to disk, ":w" doesn't
1513 work (":w filename" does work though).
1514 both: The buffer is never considered to be |'modified'|.
1515 There is no warning when the changes will be lost, for
1516 example when you quit Vim.
1517 both: A swap file is only created when using too much memory
1518 (when 'swapfile' has been reset there is never a swap
1519 file).
1520 nofile only: The buffer name is fixed, it is not handled like a
1521 file name. It is not modified in response to a |:cd|
1522 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001523 both: When using ":e bufname" and already editing "bufname"
1524 the buffer is made empty and autocommands are
1525 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001526 *E676*
1527 "acwrite" implies that the buffer name is not related to a file, like
1528 "nofile", but it will be written. Thus, in contrast to "nofile" and
1529 "nowrite", ":w" does work and a modified buffer can't be abandoned
1530 without saving. For writing there must be matching |BufWriteCmd|,
1531 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532
1533 *'casemap'* *'cmp'*
1534'casemap' 'cmp' string (default: "internal,keepascii")
1535 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 Specifies details about changing the case of letters. It may contain
1537 these words, separated by a comma:
1538 internal Use internal case mapping functions, the current
1539 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001540 matters when 'encoding' is a Unicode encoding,
1541 "latin1" or "iso-8859-15". When "internal" is
1542 omitted, the towupper() and towlower() system library
1543 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1545 case mapping, the current locale is not effective.
1546 This probably only matters for Turkish.
1547
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001548 *'cdhome'* *'cdh'*
1549'cdhome' 'cdh' boolean (default: off)
1550 global
1551 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1552 current working directory to the |$HOME| directory like in Unix.
1553 When off, those commands just print the current directory name.
1554 On Unix this option has no effect.
1555 NOTE: This option is reset when 'compatible' is set.
1556
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 *'cdpath'* *'cd'* *E344* *E346*
1558'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1559 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001561 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1562 searched for has a relative path, not an absolute part starting with
1563 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001564 The 'cdpath' option's value has the same form and semantics as
1565 |'path'|. Also see |file-searching|.
1566 The default value is taken from $CDPATH, with a "," prepended to look
1567 in the current directory first.
1568 If the default value taken from $CDPATH is not what you want, include
1569 a modified version of the following command in your vimrc file to
1570 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001571 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001572< This option cannot be set from a |modeline| or in the |sandbox|, for
1573 security reasons.
1574 (parts of 'cdpath' can be passed to the shell to expand file names).
1575
1576 *'cedit'*
1577'cedit' string (Vi default: "", Vim default: CTRL-F)
1578 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001579 The key used in Command-line Mode to open the command-line window.
1580 The default is CTRL-F when 'compatible' is off.
1581 Only non-printable keys are allowed.
1582 The key can be specified as a single character, but it is difficult to
1583 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001584 :exe "set cedit=\<C-Y>"
1585 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001586< |Nvi| also has this option, but it only uses the first character.
1587 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001588 NOTE: This option is set to the Vim default value when 'compatible'
1589 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590
1591 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1592'charconvert' 'ccv' string (default "")
1593 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001594 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595 An expression that is used for character encoding conversion. It is
1596 evaluated when a file that is to be read or has been written has a
1597 different encoding from what is desired.
1598 'charconvert' is not used when the internal iconv() function is
1599 supported and is able to do the conversion. Using iconv() is
1600 preferred, because it is much faster.
1601 'charconvert' is not used when reading stdin |--|, because there is no
1602 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001603 The expression must return zero, false or an empty string for success,
1604 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 The possible encoding names encountered are in 'encoding'.
1606 Additionally, names given in 'fileencodings' and 'fileencoding' are
1607 used.
1608 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1609 is done internally by Vim, 'charconvert' is not used for this.
1610 'charconvert' is also used to convert the viminfo file, if the 'c'
1611 flag is present in 'viminfo'. Also used for Unicode conversion.
1612 Example: >
1613 set charconvert=CharConvert()
1614 fun CharConvert()
1615 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001616 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1617 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618 return v:shell_error
1619 endfun
1620< The related Vim variables are:
1621 v:charconvert_from name of the current encoding
1622 v:charconvert_to name of the desired encoding
1623 v:fname_in name of the input file
1624 v:fname_out name of the output file
1625 Note that v:fname_in and v:fname_out will never be the same.
1626 Note that v:charconvert_from and v:charconvert_to may be different
1627 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001628
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629 Encryption is not done by Vim when using 'charconvert'. If you want
1630 to encrypt the file after conversion, 'charconvert' should take care
1631 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001632
1633 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1634 replaced with the script ID (|local-function|). Example: >
1635 set charconvert=s:MyConvert()
1636 set charconvert=<SID>SomeConvert()
1637< Otherwise the expression is evaluated in the context of the script
1638 where the option was set, thus script-local items are available.
1639
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640 This option cannot be set from a |modeline| or in the |sandbox|, for
1641 security reasons.
1642
1643 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1644'cindent' 'cin' boolean (default off)
1645 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001646 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647 that trigger reindenting in insert mode and 'cinoptions' to set your
1648 preferred indent style.
1649 If 'indentexpr' is not empty, it overrules 'cindent'.
1650 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1651 the "=" operator indents using this algorithm rather than calling an
1652 external program.
1653 See |C-indenting|.
1654 When you don't like the way 'cindent' works, try the 'smartindent'
1655 option or 'indentexpr'.
1656 This option is not used when 'paste' is set.
1657 NOTE: This option is reset when 'compatible' is set.
1658
1659 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001660'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001661 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001662 A list of keys that, when typed in Insert mode, cause reindenting of
1663 the current line. Only used if 'cindent' is on and 'indentexpr' is
1664 empty.
1665 For the format of this option see |cinkeys-format|.
1666 See |C-indenting|.
1667
1668 *'cinoptions'* *'cino'*
1669'cinoptions' 'cino' string (default "")
1670 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1672 program. See |cinoptions-values| for the values of this option, and
1673 |C-indenting| for info on C indenting in general.
1674
1675
1676 *'cinwords'* *'cinw'*
1677'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1678 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 These keywords start an extra indent in the next line when
1680 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1681 an appropriate place (inside {}).
1682 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1683 matter, include the keyword both the uppercase and lowercase:
1684 "if,If,IF".
1685
Tom Praschan3506cf32022-04-07 12:39:08 +01001686 *'cinscopedecls'* *'cinsd'*
1687'cinscopedecls' 'cinsd' string (default "public,protected,private")
1688 local to buffer
Tom Praschan3506cf32022-04-07 12:39:08 +01001689 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1690 Useful e.g. for working with the Qt framework that defines additional
1691 scope declarations "signals", "public slots" and "private slots": >
1692 set cinscopedecls+=signals,public\ slots,private\ slots
1693
1694< *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1696 for X-windows, "" otherwise)
1697 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001698 {only in GUI versions or when the |+xterm_clipboard|
1699 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001700 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001701 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001702 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001703 prepend, e.g.: >
1704 set clipboard^=unnamed
1705< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001707 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 unnamed When included, Vim will use the clipboard register '*'
1709 for all yank, delete, change and put operations which
1710 would normally go to the unnamed register. When a
1711 register is explicitly specified, it will always be
1712 used regardless of whether "unnamed" is in 'clipboard'
1713 or not. The clipboard register can always be
1714 explicitly accessed using the "* notation. Also see
1715 |gui-clipboard|.
1716
Bram Moolenaar30b65812012-07-12 22:01:11 +02001717 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001718 unnamedplus A variant of the "unnamed" flag which uses the
1719 clipboard register '+' (|quoteplus|) instead of
1720 register '*' for all yank, delete, change and put
1721 operations which would normally go to the unnamed
1722 register. When "unnamed" is also included to the
1723 option, yank operations (but not delete, change or
1724 put) will additionally copy the text into register
1725 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001726 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001727 Availability can be checked with: >
1728 if has('unnamedplus')
1729<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001730 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 autoselect Works like the 'a' flag in 'guioptions': If present,
1732 then whenever Visual mode is started, or the Visual
1733 area extended, Vim tries to become the owner of the
1734 windowing system's global selection or put the
1735 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001736 register "*. See |'go-a'| and |quotestar| for details.
1737 When the GUI is active, the 'a' flag in 'guioptions'
1738 is used, when the GUI is not active, this "autoselect"
1739 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740 Also applies to the modeless selection.
1741
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001742 *clipboard-autoselectplus*
1743 autoselectplus Like "autoselect" but using the + register instead of
1744 the * register. Compare to the 'P' flag in
1745 'guioptions'.
1746
1747 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748 autoselectml Like "autoselect", but for the modeless selection
1749 only. Compare to the 'A' flag in 'guioptions'.
1750
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001751 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001752 html When the clipboard contains HTML, use this when
1753 pasting. When putting text on the clipboard, mark it
1754 as HTML. This works to copy rendered HTML from
1755 Firefox, paste it as raw HTML in Vim, select the HTML
1756 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001757 You probably want to add this only temporarily,
1758 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001759 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001760
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001761 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762 exclude:{pattern}
1763 Defines a pattern that is matched against the name of
1764 the terminal 'term'. If there is a match, no
1765 connection will be made to the X server. This is
1766 useful in this situation:
1767 - Running Vim in a console.
1768 - $DISPLAY is set to start applications on another
1769 display.
1770 - You do not want to connect to the X server in the
1771 console, but do want this in a terminal emulator.
1772 To never connect to the X server use: >
1773 exclude:.*
1774< This has the same effect as using the |-X| argument.
1775 Note that when there is no connection to the X server
1776 the window title won't be restored and the clipboard
1777 cannot be accessed.
1778 The value of 'magic' is ignored, {pattern} is
1779 interpreted as if 'magic' was on.
1780 The rest of the option value will be used for
1781 {pattern}, this must be the last entry.
1782
1783 *'cmdheight'* *'ch'*
1784'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001785 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001786 Number of screen lines to use for the command-line. A larger value
1787 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001788 The value of this option is stored with the tab page, so that each tab
1789 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790
1791 *'cmdwinheight'* *'cwh'*
1792'cmdwinheight' 'cwh' number (default 7)
1793 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794 Number of screen lines to use for the command-line window. |cmdwin|
1795
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001796 *'colorcolumn'* *'cc'*
1797'colorcolumn' 'cc' string (default "")
1798 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001799 {not available when compiled without the |+syntax|
1800 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001801 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001802 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1803 text. Will make screen redrawing slower.
1804 The screen column can be an absolute number, or a number preceded with
1805 '+' or '-', which is added to or subtracted from 'textwidth'. >
1806
1807 :set cc=+1 " highlight column after 'textwidth'
1808 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1809 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1810<
1811 When 'textwidth' is zero then the items with '-' and '+' are not used.
1812 A maximum of 256 columns are highlighted.
1813
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814 *'columns'* *'co'* *E594*
1815'columns' 'co' number (default 80 or terminal width)
1816 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001818 initialization and does not have to be set by hand. Also see
1819 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820 When Vim is running in the GUI or in a resizable window, setting this
1821 option will cause the window size to be changed. When you only want
1822 to use the size for the GUI, put the command in your |gvimrc| file.
1823 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001824 number of columns of the display, the display may be messed up. For
1825 the GUI it is always possible and Vim limits the number of columns to
1826 what fits on the screen. You can use this command to get the widest
1827 window possible: >
1828 :set columns=9999
1829< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830
1831 *'comments'* *'com'* *E524* *E525*
1832'comments' 'com' string (default
1833 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1834 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001835 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 |format-comments|. See |option-backslash| about using backslashes to
1837 insert a space.
1838
1839 *'commentstring'* *'cms'* *E537*
1840'commentstring' 'cms' string (default "/*%s*/")
1841 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842 {not available when compiled without the |+folding|
1843 feature}
1844 A template for a comment. The "%s" in the value is replaced with the
1845 comment text. Currently only used to add markers for folding, see
1846 |fold-marker|.
1847
1848 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001849'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001850 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852 This option has the effect of making Vim either more Vi-compatible, or
1853 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001854
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001856 other options are also changed as a side effect.
1857 NOTE: Setting or resetting this option can have a lot of unexpected
1858 effects: Mappings are interpreted in another way, undo behaves
1859 differently, etc. If you set this option in your vimrc file, you
1860 should probably put it at the very start.
1861
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862 By default this option is on and the Vi defaults are used for the
1863 options. This default was chosen for those people who want to use Vim
1864 just like Vi, and don't even (want to) know about the 'compatible'
1865 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001866 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001867 this option is switched off, and all options that have not been
1868 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001869 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001870 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001871 happen for the system-wide vimrc or gvimrc file, nor for a file given
1872 with the |-u| argument). Also see |compatible-default| and
1873 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874 You can also set this option with the "-C" argument, and reset it with
1875 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001876 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001877
Bram Moolenaar214641f2017-03-05 17:04:09 +01001878 When this option is set, numerous other options are set to make Vim as
1879 Vi-compatible as possible. When this option is unset, various options
1880 are set to make Vim more useful. The table below lists all the
1881 options affected.
1882 The {?} column indicates when the options are affected:
1883 + Means that the option is set to the value given in {set value} when
1884 'compatible' is set.
1885 & Means that the option is set to the value given in {set value} when
1886 'compatible' is set AND is set to its Vim default value when
1887 'compatible' is unset.
1888 - Means the option is NOT changed when setting 'compatible' but IS
1889 set to its Vim default when 'compatible' is unset.
1890 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891
Bram Moolenaar036986f2017-03-16 17:41:02 +01001892 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001893
1894 'allowrevins' + off no CTRL-_ command
1895 'antialias' + off don't use antialiased fonts
1896 'arabic' + off reset arabic-related options
1897 'arabicshape' + on correct character shapes
1898 'backspace' + "" normal backspace
1899 'backup' + off no backup file
1900 'backupcopy' & Unix: "yes" backup file is a copy
1901 else: "auto" copy or rename backup file
1902 'balloonexpr' + "" text to show in evaluation balloon
1903 'breakindent' + off don't indent when wrapping lines
1904 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001905 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001906 'cindent' + off no C code indentation
1907 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1908 'copyindent' + off don't copy indent structure
1909 'cpoptions' & (all flags) Vi-compatible flags
1910 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001911 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001912 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001913 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001914 'cscopeverbose' + off see |cscopeverbose|
1915 'delcombine' + off unicode: delete whole char combination
1916 'digraph' + off no digraphs
1917 'esckeys' & off no <Esc>-keys in Insert mode
1918 'expandtab' + off tabs not expanded to spaces
1919 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001920 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001921 'formatexpr' + "" use 'formatprg' for auto-formatting
1922 'formatoptions' & "vt" Vi compatible formatting
1923 'gdefault' + off no default 'g' flag for ":s"
1924 'history' & 0 no commandline history
1925 'hkmap' + off no Hebrew keyboard mapping
1926 'hkmapp' + off no phonetic Hebrew keyboard mapping
1927 'hlsearch' + off no highlighting of search matches
1928 'incsearch' + off no incremental searching
1929 'indentexpr' + "" no indenting by expression
1930 'insertmode' + off do not start in Insert mode
1931 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001933 'joinspaces' + on insert 2 spaces after period
1934 'modeline' & off no modelines
1935 'more' & off no pauses in listings
1936 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1937 'numberwidth' & 8 min number of columns for line number
1938 'preserveindent'+ off don't preserve current indent structure
1939 when changing it
1940 'revins' + off no reverse insert
1941 'ruler' + off no ruler
1942 'scrolljump' + 1 no jump scroll
1943 'scrolloff' + 0 no scroll offset
1944 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1945 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001946 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001947 'showcmd' & off command characters not shown
1948 'showmode' & off current mode not shown
1949 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1950 'smartcase' + off no automatic ignore case switch
1951 'smartindent' + off no smart indentation
1952 'smarttab' + off no smart tab size
1953 'softtabstop' + 0 tabs are always 'tabstop' positions
1954 'startofline' + on goto startofline with some commands
1955 'tagcase' & "followic" 'ignorecase' when searching tags file
1956 'tagrelative' & off tag file names are not relative
1957 'termguicolors' + off don't use highlight-(guifg|guibg)
1958 'textauto' & off no automatic textmode detection
1959 'textwidth' + 0 no automatic line wrap
1960 'tildeop' + off tilde is not an operator
1961 'ttimeout' + off no terminal timeout
1962 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001963 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001964 'virtualedit' + "" cursor can only be placed on characters
1965 'whichwrap' & "" left-right movements don't wrap
1966 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001968 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969
1970 *'complete'* *'cpt'* *E535*
1971'complete' 'cpt' string (default: ".,w,b,u,t,i")
1972 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973 This option specifies how keyword completion |ins-completion| works
1974 when CTRL-P or CTRL-N are used. It is also used for whole-line
1975 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001976 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001977 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001978 w scan buffers from other windows
1979 b scan other loaded buffers that are in the buffer list
1980 u scan the unloaded buffers that are in the buffer list
1981 U scan the buffers that are not in the buffer list
1982 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001983 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984 k{dict} scan the file {dict}. Several "k" flags can be given,
1985 patterns are valid too. For example: >
1986 :set cpt=k/usr/dict/*,k~/spanish
1987< s scan the files given with the 'thesaurus' option
1988 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1989 are valid too.
1990 i scan current and included files
1991 d scan current and included files for defined name or macro
1992 |i_CTRL-X_CTRL-D|
1993 ] tag completion
1994 t same as "]"
1995
1996 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1997 not executed, this may lead to unexpected completions from some files
1998 (gzipped files for example). Unloaded buffers are not scanned for
1999 whole-line completion.
2000
2001 The default is ".,w,b,u,t,i", which means to scan:
2002 1. the current buffer
2003 2. buffers in other windows
2004 3. other loaded buffers
2005 4. unloaded buffers
2006 5. tags
2007 6. included files
2008
2009 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002010 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2011 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002013 *'completefunc'* *'cfu'*
2014'completefunc' 'cfu' string (default: empty)
2015 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002016 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002017 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002018 This option specifies a function to be used for Insert mode completion
2019 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002020 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002021 invoked and what it should return. The value can be the name of a
2022 function, a |lambda| or a |Funcref|. See |option-value-function| for
2023 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002024 This option cannot be set from a |modeline| or in the |sandbox|, for
2025 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002026
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002027 *'completeslash'* *'csl'*
2028'completeslash' 'csl' string (default: "")
2029 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002030 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002031 When this option is set it overrules 'shellslash' for completion:
2032 - When this option is set to "slash", a forward slash is used for path
2033 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002034 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002035 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002036 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002037 - When this option is empty, same character is used as for
2038 'shellslash'.
2039 For Insert mode completion the buffer-local value is used. For
2040 command line completion the global value is used.
2041
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002042 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002043'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002044 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002045 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002046 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002047
2048 menu Use a popup menu to show the possible completions. The
2049 menu is only shown when there is more than one match and
2050 sufficient colors are available. |ins-completion-menu|
2051
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002052 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002053 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002054 match, e.g., what file it comes from.
2055
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002056 longest Only insert the longest common text of the matches. If
2057 the menu is displayed you can use CTRL-L to add more
2058 characters. Whether case is ignored depends on the kind
2059 of completion. For buffer text the 'ignorecase' option is
2060 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002061
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002062 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002063 completion in the preview window. Only works in
2064 combination with "menu" or "menuone".
2065
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002066 popup Show extra information about the currently selected
2067 completion in a popup window. Only works in combination
2068 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002069 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002070 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002071
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002072 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002073 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002074 |CompleteChanged| autocommand to fetch the info and call
2075 |popup_show()| once the popup has been filled.
2076 See the example at |complete-popuphidden|.
2077 {only works when compiled with the |+textprop| feature}
2078
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002079 noinsert Do not insert any text for a match until the user selects
2080 a match from the menu. Only works in combination with
2081 "menu" or "menuone". No effect if "longest" is present.
2082
2083 noselect Do not select a match in the menu, force the user to
2084 select one from the menu. Only works in combination with
2085 "menu" or "menuone".
2086
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002087
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002088 *'completepopup'* *'cpp'*
2089'completepopup' 'cpp' string (default empty)
2090 global
2091 {not available when compiled without the |+textprop|
2092 or |+quickfix| feature}
2093 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002094 properties of the info popup when it is created. If an info popup
2095 window already exists it is closed, so that the option value is
2096 applied when it is created again.
2097 You can also use |popup_findinfo()| and then set properties for an
2098 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002099
2100
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002101 *'concealcursor'* *'cocu'*
2102'concealcursor' 'cocu' string (default: "")
2103 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002104 {not available when compiled without the |+conceal|
2105 feature}
2106 Sets the modes in which text in the cursor line can also be concealed.
2107 When the current mode is listed then concealing happens just like in
2108 other lines.
2109 n Normal mode
2110 v Visual mode
2111 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002112 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002113
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002114 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002115 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002116 are moving around text is concealed, but when starting to insert text
2117 or selecting a Visual area the concealed text is displayed, so that
2118 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002119 Keep in mind that the cursor position is not always where it's
2120 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002121
2122
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002123 *'conceallevel'* *'cole'*
2124'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002125 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002126 {not available when compiled without the |+conceal|
2127 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002128 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2129 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002130
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002131 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002132 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002133 1 Each block of concealed text is replaced with one
2134 character. If the syntax item does not have a custom
2135 replacement character defined (see |:syn-cchar|) the
2136 character defined in 'listchars' is used (default is a
2137 space).
2138 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002139 2 Concealed text is completely hidden unless it has a
2140 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002141 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002142 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002143
Bram Moolenaara7781e02010-07-19 20:13:22 +02002144 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002145 edit and copy the text. This can be changed with the 'concealcursor'
2146 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002147
Bram Moolenaar071d4272004-06-13 20:20:40 +00002148 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2149'confirm' 'cf' boolean (default off)
2150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002151 When 'confirm' is on, certain operations that would normally
2152 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2153 instead raise a |dialog| asking if you wish to save the current
2154 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2155 If 'confirm' is off you can still activate confirmation for one
2156 command only (this is most useful in mappings) with the |:confirm|
2157 command.
2158 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2159
2160 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2161'conskey' 'consk' boolean (default off)
2162 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002163 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164
2165 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2166'copyindent' 'ci' boolean (default off)
2167 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168 Copy the structure of the existing lines indent when autoindenting a
2169 new line. Normally the new indent is reconstructed by a series of
2170 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2171 in which case only spaces are used). Enabling this option makes the
2172 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002173 existing line. 'expandtab' has no effect on these characters, a Tab
2174 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002175 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002176 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 Also see 'preserveindent'.
2178
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002179 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180'cpoptions' 'cpo' string (Vim default: "aABceFs",
2181 Vi default: all flags)
2182 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002184 this indicates Vi-compatible behavior. This is used for things where
2185 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186 'cpoptions' stands for "compatible-options".
2187 Commas can be added for readability.
2188 To avoid problems with flags that are added in the future, use the
2189 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002190
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191 NOTE: This option is set to the Vi default value when 'compatible' is
2192 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002193
2194 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2195 is saved, 'cpoptions' is set to the Vim default, and the saved value
2196 is restored at the end of the script. Changes to the value of
2197 'cpoptions' will be applied to the saved value, but keep in mind that
2198 removing a flag that is not present when 'cpoptions' is changed has no
2199 effect. In the |.vimrc| file the value is not restored, thus using
2200 `vim9script` in the |.vimrc| file results in using the Vim default.
2201
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002202 NOTE: This option is set to the POSIX default value at startup when
2203 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002204 variable exists |posix|. This means Vim tries to behave like the
2205 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206
2207 contains behavior ~
2208 *cpo-a*
2209 a When included, a ":read" command with a file name
2210 argument will set the alternate file name for the
2211 current window.
2212 *cpo-A*
2213 A When included, a ":write" command with a file name
2214 argument will set the alternate file name for the
2215 current window.
2216 *cpo-b*
2217 b "\|" in a ":map" command is recognized as the end of
2218 the map command. The '\' is included in the mapping,
2219 the text after the '|' is interpreted as the next
2220 command. Use a CTRL-V instead of a backslash to
2221 include the '|' in the mapping. Applies to all
2222 mapping, abbreviation, menu and autocmd commands.
2223 See also |map_bar|.
2224 *cpo-B*
2225 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002226 abbreviations, user commands and the "to" part of the
2227 menu commands. Remove this flag to be able to use a
2228 backslash like a CTRL-V. For example, the command
2229 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 'B' included: "\^[" (^[ is a real <Esc>)
2231 'B' excluded: "<Esc>" (5 characters)
2232 ('<' excluded in both cases)
2233 *cpo-c*
2234 c Searching continues at the end of any match at the
2235 cursor position, but not further than the start of the
2236 next line. When not present searching continues
2237 one character from the cursor position. With 'c'
2238 "abababababab" only gets three matches when repeating
2239 "/abab", without 'c' there are five matches.
2240 *cpo-C*
2241 C Do not concatenate sourced lines that start with a
2242 backslash. See |line-continuation|.
2243 *cpo-d*
2244 d Using "./" in the 'tags' option doesn't mean to use
2245 the tags file relative to the current file, but the
2246 tags file in the current directory.
2247 *cpo-D*
2248 D Can't use CTRL-K to enter a digraph after Normal mode
2249 commands with a character argument, like |r|, |f| and
2250 |t|.
2251 *cpo-e*
2252 e When executing a register with ":@r", always add a
2253 <CR> to the last line, also when the register is not
2254 linewise. If this flag is not present, the register
2255 is not linewise and the last line does not end in a
2256 <CR>, then the last line is put on the command-line
2257 and can be edited before hitting <CR>.
2258 *cpo-E*
2259 E It is an error when using "y", "d", "c", "g~", "gu" or
2260 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002261 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262 This makes "y0" fail in the first column.
2263 *cpo-f*
2264 f When included, a ":read" command with a file name
2265 argument will set the file name for the current buffer,
2266 if the current buffer doesn't have a file name yet.
2267 *cpo-F*
2268 F When included, a ":write" command with a file name
2269 argument will set the file name for the current
2270 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002271 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002272 *cpo-g*
2273 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002274 *cpo-H*
2275 H When using "I" on a line with only blanks, insert
2276 before the last blank. Without this flag insert after
2277 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278 *cpo-i*
2279 i When included, interrupting the reading of a file will
2280 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002281 *cpo-I*
2282 I When moving the cursor up or down just after inserting
2283 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002284 *cpo-j*
2285 j When joining lines, only add two spaces after a '.',
2286 not after '!' or '?'. Also see 'joinspaces'.
2287 *cpo-J*
2288 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002289 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290 white space.
2291 *cpo-k*
2292 k Disable the recognition of raw key codes in
2293 mappings, abbreviations, and the "to" part of menu
2294 commands. For example, if <Key> sends ^[OA (where ^[
2295 is <Esc>), the command ":map X ^[OA" results in X
2296 being mapped to:
2297 'k' included: "^[OA" (3 characters)
2298 'k' excluded: "<Key>" (one key code)
2299 Also see the '<' flag below.
2300 *cpo-K*
2301 K Don't wait for a key code to complete when it is
2302 halfway a mapping. This breaks mapping <F1><F1> when
2303 only part of the second <F1> has been read. It
2304 enables cancelling the mapping by typing <F1><Esc>.
2305 *cpo-l*
2306 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002307 literally, only "\]", "\^", "\-" and "\\" are special.
2308 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002309 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2310 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002311 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312 *cpo-L*
2313 L When the 'list' option is set, 'wrapmargin',
2314 'textwidth', 'softtabstop' and Virtual Replace mode
2315 (see |gR|) count a <Tab> as two characters, instead of
2316 the normal behavior of a <Tab>.
2317 *cpo-m*
2318 m When included, a showmatch will always wait half a
2319 second. When not included, a showmatch will wait half
2320 a second or until a character is typed. |'showmatch'|
2321 *cpo-M*
2322 M When excluded, "%" matching will take backslashes into
2323 account. Thus in "( \( )" and "\( ( \)" the outer
2324 parenthesis match. When included "%" ignores
2325 backslashes, which is Vi compatible.
2326 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002327 n When included, the column used for 'number' and
2328 'relativenumber' will also be used for text of wrapped
2329 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002330 *cpo-o*
2331 o Line offset to search command is not remembered for
2332 next search.
2333 *cpo-O*
2334 O Don't complain if a file is being overwritten, even
2335 when it didn't exist when editing it. This is a
2336 protection against a file unexpectedly created by
2337 someone else. Vi didn't complain about this.
2338 *cpo-p*
2339 p Vi compatible Lisp indenting. When not present, a
2340 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002341 *cpo-P*
2342 P When included, a ":write" command that appends to a
2343 file will set the file name for the current buffer, if
2344 the current buffer doesn't have a file name yet and
2345 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002346 *cpo-q*
2347 q When joining multiple lines leave the cursor at the
2348 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349 *cpo-r*
2350 r Redo ("." command) uses "/" to repeat a search
2351 command, instead of the actually used search string.
2352 *cpo-R*
2353 R Remove marks from filtered lines. Without this flag
2354 marks are kept like |:keepmarks| was used.
2355 *cpo-s*
2356 s Set buffer options when entering the buffer for the
2357 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002358 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359 set when the buffer is created.
2360 *cpo-S*
2361 S Set buffer options always when entering a buffer
2362 (except 'readonly', 'fileformat', 'filetype' and
2363 'syntax'). This is the (most) Vi compatible setting.
2364 The options are set to the values in the current
2365 buffer. When you change an option and go to another
2366 buffer, the value is copied. Effectively makes the
2367 buffer options global to all buffers.
2368
2369 's' 'S' copy buffer options
2370 no no when buffer created
2371 yes no when buffer first entered (default)
2372 X yes each time when buffer entered (vi comp.)
2373 *cpo-t*
2374 t Search pattern for the tag command is remembered for
2375 "n" command. Otherwise Vim only puts the pattern in
2376 the history for search pattern, but doesn't change the
2377 last used search pattern.
2378 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002379 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002380 *cpo-v*
2381 v Backspaced characters remain visible on the screen in
2382 Insert mode. Without this flag the characters are
2383 erased from the screen right away. With this flag the
2384 screen newly typed text overwrites backspaced
2385 characters.
2386 *cpo-w*
2387 w When using "cw" on a blank character, only change one
2388 character and not all blanks until the start of the
2389 next word.
2390 *cpo-W*
2391 W Don't overwrite a readonly file. When omitted, ":w!"
2392 overwrites a readonly file, if possible.
2393 *cpo-x*
2394 x <Esc> on the command-line executes the command-line.
2395 The default in Vim is to abandon the command-line,
2396 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002397 *cpo-X*
2398 X When using a count with "R" the replaced text is
2399 deleted only once. Also when repeating "R" with "."
2400 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002402 y A yank command can be redone with ".". Think twice if
2403 you really want to use this, it may break some
2404 plugins, since most people expect "." to only repeat a
2405 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002406 *cpo-Z*
2407 Z When using "w!" while the 'readonly' option is set,
2408 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409 *cpo-!*
2410 ! When redoing a filter command, use the last used
2411 external command, whatever it was. Otherwise the last
2412 used -filter- command is used.
2413 *cpo-$*
2414 $ When making a change to one line, don't redisplay the
2415 line, but put a '$' at the end of the changed text.
2416 The changed text will be overwritten when you type the
2417 new text. The line is redisplayed if you type any
2418 command that moves the cursor from the insertion
2419 point.
2420 *cpo-%*
2421 % Vi-compatible matching is done for the "%" command.
2422 Does not recognize "#if", "#endif", etc.
2423 Does not recognize "/*" and "*/".
2424 Parens inside single and double quotes are also
2425 counted, causing a string that contains a paren to
2426 disturb the matching. For example, in a line like
2427 "if (strcmp("foo(", s))" the first paren does not
2428 match the last one. When this flag is not included,
2429 parens inside single and double quotes are treated
2430 specially. When matching a paren outside of quotes,
2431 everything inside quotes is ignored. When matching a
2432 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002433 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002434 This flag is also used for other features, such as
2435 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002436 *cpo--*
2437 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002438 it would go above the first line or below the last
2439 line. Without it the cursor moves to the first or
2440 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002441 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002442 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002443 *cpo-+*
2444 + When included, a ":write file" command will reset the
2445 'modified' flag of the buffer, even though the buffer
2446 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002447 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448 * Use ":*" in the same way as ":@". When not included,
2449 ":*" is an alias for ":'<,'>", select the Visual area.
2450 *cpo-<*
2451 < Disable the recognition of special key codes in |<>|
2452 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002453 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002454 ":map X <Tab>" results in X being mapped to:
2455 '<' included: "<Tab>" (5 characters)
2456 '<' excluded: "^I" (^I is a real <Tab>)
2457 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002458 *cpo->*
2459 > When appending to a register, put a line break before
2460 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002461 *cpo-;*
2462 ; When using |,| or |;| to repeat the last |t| search
2463 and the cursor is right in front of the searched
2464 character, the cursor won't move. When not included,
2465 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002466 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002467
2468 POSIX flags. These are not included in the Vi default value, except
2469 when $VIM_POSIX was set on startup. |posix|
2470
2471 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002472 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002473 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002474 *cpo-&*
2475 & When ":preserve" was used keep the swap file when
2476 exiting normally while this buffer is still loaded.
2477 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002478 *cpo-\*
2479 \ Backslash in a [] range in a search pattern is taken
2480 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002481 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2482 '\' excluded: "/[ \-]" finds <Space> and '-'
2483 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002484 *cpo-/*
2485 / When "%" is used as the replacement string in a |:s|
2486 command, use the previous replacement string. |:s%|
2487 *cpo-{*
2488 { The |{| and |}| commands also stop at a "{" character
2489 at the start of a line.
2490 *cpo-.*
2491 . The ":chdir" and ":cd" commands fail if the current
2492 buffer is modified, unless ! is used. Vim doesn't
2493 need this, since it remembers the full path of an
2494 opened file.
2495 *cpo-bar*
2496 | The value of the $LINES and $COLUMNS environment
2497 variables overrule the terminal size values obtained
2498 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002499
Bram Moolenaar071d4272004-06-13 20:20:40 +00002500
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002501 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002502'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002503 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002504 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002505 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002506 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002507 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002508 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002509 blowfish Blowfish method. Medium strong encryption but it has
2510 an implementation flaw. Requires Vim 7.3 or later,
2511 files can NOT be read by Vim 7.2 and older. This adds
2512 a "seed" to the file, every time you write the file
2513 the encrypted bytes will be different.
2514 *blowfish2*
2515 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002516 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002517 and older. This adds a "seed" to the file, every time
2518 you write the file the encrypted bytes will be
2519 different. The whole undo file is encrypted, not just
2520 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002521 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002522 *E1197* *E1198* *E1199* *E1200* *E1201*
2523 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2524 Code. Medium strong till strong encryption.
2525 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002526 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002527 It adds a seed and a message authentication code (MAC)
2528 to the file. This needs at least a Vim 8.2.3022 to
2529 read the encrypted file.
2530 Encryption of swap files is not supported, therefore
2531 no swap file will be used when xchacha20 encryption is
2532 enabled.
2533 Encryption of undo files is not yet supported,
2534 therefore no undo file will currently be written.
2535 CURRENTLY EXPERIMENTAL: Files written with this method
2536 might have to be read back with the same version of
2537 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002538
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002539 You should use "blowfish2", also to re-encrypt older files.
2540
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002541 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002542 to the detected method of the file being read. Thus if you write it
2543 without changing 'cryptmethod' the same method will be used.
2544 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002545 explicitly write it, you don't get a warning unless there are other
2546 modifications. Also see |:X|.
2547
2548 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002549 the value "blowfish2". When setting the local value to an empty
2550 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002551
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002552 When a new encryption method is added in a later version of Vim, and
2553 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002554 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002555
2556
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557 *'cscopepathcomp'* *'cspc'*
2558'cscopepathcomp' 'cspc' number (default 0)
2559 global
2560 {not available when compiled without the |+cscope|
2561 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562 Determines how many components of the path to show in a list of tags.
2563 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002564 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565
2566 *'cscopeprg'* *'csprg'*
2567'cscopeprg' 'csprg' string (default "cscope")
2568 global
2569 {not available when compiled without the |+cscope|
2570 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 Specifies the command to execute cscope. See |cscopeprg|.
2572 This option cannot be set from a |modeline| or in the |sandbox|, for
2573 security reasons.
2574
2575 *'cscopequickfix'* *'csqf'*
2576'cscopequickfix' 'csqf' string (default "")
2577 global
2578 {not available when compiled without the |+cscope|
2579 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580 Specifies whether to use quickfix window to show cscope results.
2581 See |cscopequickfix|.
2582
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002583 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002584'cscoperelative' 'csre' boolean (default off)
2585 global
2586 {not available when compiled without the |+cscope|
2587 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002588 In the absence of a prefix (-P) for cscope. setting this option enables
2589 to use the basename of cscope.out path as the prefix.
2590 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002591 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002592
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2594'cscopetag' 'cst' boolean (default off)
2595 global
2596 {not available when compiled without the |+cscope|
2597 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 Use cscope for tag commands. See |cscope-options|.
2599 NOTE: This option is reset when 'compatible' is set.
2600
2601 *'cscopetagorder'* *'csto'*
2602'cscopetagorder' 'csto' number (default 0)
2603 global
2604 {not available when compiled without the |+cscope|
2605 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002606 Determines the order in which ":cstag" performs a search. See
2607 |cscopetagorder|.
2608 NOTE: This option is set to 0 when 'compatible' is set.
2609
2610 *'cscopeverbose'* *'csverb'*
2611 *'nocscopeverbose'* *'nocsverb'*
2612'cscopeverbose' 'csverb' boolean (default off)
2613 global
2614 {not available when compiled without the |+cscope|
2615 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616 Give messages when adding a cscope database. See |cscopeverbose|.
2617 NOTE: This option is reset when 'compatible' is set.
2618
Bram Moolenaar860cae12010-06-05 23:22:07 +02002619 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2620'cursorbind' 'crb' boolean (default off)
2621 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002622 When this option is set, as the cursor in the current
2623 window moves other cursorbound windows (windows that also have
2624 this option set) move their cursors to the corresponding line and
2625 column. This option is useful for viewing the
2626 differences between two versions of a file (see 'diff'); in diff mode,
2627 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002628 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002629
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002630
2631 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2632'cursorcolumn' 'cuc' boolean (default off)
2633 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002634 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002635 feature}
2636 Highlight the screen column of the cursor with CursorColumn
2637 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2638 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002639 If you only want the highlighting in the current window you can use
2640 these autocommands: >
2641 au WinLeave * set nocursorline nocursorcolumn
2642 au WinEnter * set cursorline cursorcolumn
2643<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002644
2645 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2646'cursorline' 'cul' boolean (default off)
2647 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002648 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002649 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002650 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2651 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002652 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002653 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002654
2655
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002656 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002657'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002658 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002659 {not available when compiled without the |+syntax|
2660 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002661 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002662 Valid values:
2663 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002664 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002665 "screenline" Highlight only the screen line of the cursor with
2666 CursorLine |hl-CursorLine|.
2667 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002668 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002669
2670 Special value:
2671 "both" Alias for the values "line,number".
2672
2673 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002674
2675
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676 *'debug'*
2677'debug' string (default "")
2678 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002679 These values can be used:
2680 msg Error messages that would otherwise be omitted will be given
2681 anyway.
2682 throw Error messages that would otherwise be omitted will be given
2683 anyway and also throw an exception and set |v:errmsg|.
2684 beep A message will be given when otherwise only a beep would be
2685 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002686 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002687 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2688 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002689
2690 *'define'* *'def'*
2691'define' 'def' string (default "^\s*#\s*define")
2692 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002693 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694 pattern, just like for the "/" command. This option is used for the
2695 commands like "[i" and "[d" |include-search|. The 'isident' option is
2696 used to recognize the defined name after the match:
2697 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2698 See |option-backslash| about inserting backslashes to include a space
2699 or backslash.
2700 The default value is for C programs. For C++ this value would be
2701 useful, to include const type declarations: >
2702 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002703< You can also use "\ze" just before the name and continue the pattern
2704 to check what is following. E.g. for Javascript, if a function is
2705 defined with "func_name = function(args)": >
2706 ^\s*\ze\i\+\s*=\s*function(
2707< If the function is defined with "func_name : function() {...": >
2708 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002710 To avoid that use `:let` with a single quote string: >
2711 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002712<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713
2714 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2715'delcombine' 'deco' boolean (default off)
2716 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717 If editing Unicode and this option is set, backspace and Normal mode
2718 "x" delete each combining character on its own. When it is off (the
2719 default) the character along with its combining characters are
2720 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002721 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722
2723 This is useful for Arabic, Hebrew and many other languages where one
2724 may have combining characters overtop of base characters, and want
2725 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002726 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727
2728 *'dictionary'* *'dict'*
2729'dictionary' 'dict' string (default "")
2730 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731 List of file names, separated by commas, that are used to lookup words
2732 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2733 contain a list of words. This can be one word per line, or several
2734 words per line, separated by non-keyword characters (white space is
2735 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002736
2737 When this option is empty or an entry "spell" is present, and spell
2738 checking is enabled, words in the word lists for the currently active
2739 'spelllang' are used. See |spell|.
2740
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002741 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 after a comma are ignored, otherwise spaces are included in the file
2743 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002744 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745 Where to find a list of words?
2746 - On FreeBSD, there is the file "/usr/share/dict/words".
2747 - In the Simtel archive, look in the "msdos/linguist" directory.
2748 - In "miscfiles" of the GNU collection.
2749 The use of |:set+=| and |:set-=| is preferred when adding or removing
2750 directories from the list. This avoids problems when a future version
2751 uses another default.
2752 Backticks cannot be used in this option for security reasons.
2753
2754 *'diff'* *'nodiff'*
2755'diff' boolean (default off)
2756 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 {not available when compiled without the |+diff|
2758 feature}
2759 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002760 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761
2762 *'dex'* *'diffexpr'*
2763'diffexpr' 'dex' string (default "")
2764 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 {not available when compiled without the |+diff|
2766 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002767 Expression which is evaluated to obtain a diff file (either ed-style
2768 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769 This option cannot be set from a |modeline| or in the |sandbox|, for
2770 security reasons.
2771
2772 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002773'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775 {not available when compiled without the |+diff|
2776 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002777 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 All are optional. Items must be separated by a comma.
2779
2780 filler Show filler lines, to keep the text
2781 synchronized with a window that has inserted
2782 lines at the same position. Mostly useful
2783 when windows are side-by-side and 'scrollbind'
2784 is set.
2785
2786 context:{n} Use a context of {n} lines between a change
2787 and a fold that contains unchanged lines.
2788 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002789 When using zero the context is actually one,
2790 since folds require a line in between, also
2791 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792 See |fold-diff|.
2793
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002794 iblank Ignore changes where lines are all blank. Adds
2795 the "-B" flag to the "diff" command if
2796 'diffexpr' is empty. Check the documentation
2797 of the "diff" command for what this does
2798 exactly.
2799 NOTE: the diff windows will get out of sync,
2800 because no differences between blank lines are
2801 taken into account.
2802
Bram Moolenaar071d4272004-06-13 20:20:40 +00002803 icase Ignore changes in case of text. "a" and "A"
2804 are considered the same. Adds the "-i" flag
2805 to the "diff" command if 'diffexpr' is empty.
2806
2807 iwhite Ignore changes in amount of white space. Adds
2808 the "-b" flag to the "diff" command if
2809 'diffexpr' is empty. Check the documentation
2810 of the "diff" command for what this does
2811 exactly. It should ignore adding trailing
2812 white space, but not leading white space.
2813
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002814 iwhiteall Ignore all white space changes. Adds
2815 the "-w" flag to the "diff" command if
2816 'diffexpr' is empty. Check the documentation
2817 of the "diff" command for what this does
2818 exactly.
2819
2820 iwhiteeol Ignore white space changes at end of line.
2821 Adds the "-Z" flag to the "diff" command if
2822 'diffexpr' is empty. Check the documentation
2823 of the "diff" command for what this does
2824 exactly.
2825
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002826 horizontal Start diff mode with horizontal splits (unless
2827 explicitly specified otherwise).
2828
2829 vertical Start diff mode with vertical splits (unless
2830 explicitly specified otherwise).
2831
Bram Moolenaarc8234772019-11-10 21:00:27 +01002832 closeoff When a window is closed where 'diff' is set
2833 and there is only one window remaining in the
2834 same tab page with 'diff' set, execute
2835 `:diffoff` in that window. This undoes a
2836 `:diffsplit` command.
2837
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002838 hiddenoff Do not use diff mode for a buffer when it
2839 becomes hidden.
2840
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002841 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2842 starting diff mode. Without this 2 is used.
2843
Bram Moolenaar4223d432021-02-10 13:18:17 +01002844 followwrap Follow the 'wrap' option and leave as it is.
2845
Bram Moolenaare828b762018-09-10 17:51:58 +02002846 internal Use the internal diff library. This is
2847 ignored when 'diffexpr' is set. *E960*
2848 When running out of memory when writing a
2849 buffer this item will be ignored for diffs
2850 involving that buffer. Set the 'verbose'
2851 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852
Bram Moolenaare828b762018-09-10 17:51:58 +02002853 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002854 Use the indent heuristic for the internal
2855 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002856
2857 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002858 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002859 algorithms are:
2860 myers the default algorithm
2861 minimal spend extra time to generate the
2862 smallest possible diff
2863 patience patience diff algorithm
2864 histogram histogram diff algorithm
2865
2866 Examples: >
2867 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002869 :set diffopt=internal,filler,foldcolumn:3
2870 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871<
2872 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2873'digraph' 'dg' boolean (default off)
2874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875 {not available when compiled without the |+digraphs|
2876 feature}
2877 Enable the entering of digraphs in Insert mode with {char1} <BS>
2878 {char2}. See |digraphs|.
2879 NOTE: This option is reset when 'compatible' is set.
2880
2881 *'directory'* *'dir'*
2882'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002883 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002884 for Unix: ".,~/tmp,/var/tmp,/tmp")
2885 global
2886 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002887 Recommended value: ".,~/vimswap//" - this will put the swap file next
2888 to the edited file if possible, and in your personal swap directory
2889 otherwise. Make sure "~/vimswap//" is only readable for you.
2890
2891 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 - The swap file will be created in the first directory where this is
2893 possible.
2894 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002895 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002896 - A directory "." means to put the swap file in the same directory as
2897 the edited file. On Unix, a dot is prepended to the file name, so
2898 it doesn't show in a directory listing. On MS-Windows the "hidden"
2899 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002900 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2901 the swap file relative to where the edited file is. The leading "."
2902 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002903 - For Unix and Win32, if a directory ends in two path separators "//",
2904 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002905 with all path separators replaced by percent '%' signs (including
2906 the colon following the drive letter on Win32). This will ensure
2907 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002908 On Win32, it is also possible to end with "\\". However, When a
2909 separating comma is following, you must use "//", since "\\" will
2910 include the comma in the file name. Therefore it is recommended to
2911 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912 - Spaces after the comma are ignored, other spaces are considered part
2913 of the directory name. To have a space at the start of a directory
2914 name, precede it with a backslash.
2915 - To include a comma in a directory name precede it with a backslash.
2916 - A directory name may end in an ':' or '/'.
2917 - Environment variables are expanded |:set_env|.
2918 - Careful with '\' characters, type one before a space, type two to
2919 get one in the option (see |option-backslash|), for example: >
2920 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2921< - For backwards compatibility with Vim version 3.0 a '>' at the start
2922 of the option is removed.
2923 Using "." first in the list is recommended. This means that editing
2924 the same file twice will result in a warning. Using "/tmp" on Unix is
2925 discouraged: When the system crashes you lose the swap file.
2926 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002927 choice than "/tmp". But others on the computer may be able to see the
2928 files, and it can contain a lot of files, your swap files get lost in
2929 the crowd. That is why a "tmp" directory in your home directory is
2930 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 The use of |:set+=| and |:set-=| is preferred when adding or removing
2932 directories from the list. This avoids problems when a future version
2933 uses another default.
2934 This option cannot be set from a |modeline| or in the |sandbox|, for
2935 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936
2937 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002938'display' 'dy' string (default "", set to "truncate" in
2939 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002941 Change the way text is displayed. This is comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942 flags:
2943 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002944 in a window will be displayed. "@@@" is put in the
2945 last columns of the last screen line to indicate the
2946 rest of the line is not displayed.
2947 truncate Like "lastline", but "@@@" is displayed in the first
2948 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949 uhex Show unprintable characters hexadecimal as <xx>
2950 instead of using ^C and ~C.
2951
Bram Moolenaard0796902016-09-16 20:02:31 +02002952 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002953 doesn't fit is replaced with "@" lines.
2954
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955 *'eadirection'* *'ead'*
2956'eadirection' 'ead' string (default "both")
2957 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 Tells when the 'equalalways' option applies:
2959 ver vertically, width of windows is not affected
2960 hor horizontally, height of windows is not affected
2961 both width and height of windows is affected
2962
2963 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2964'edcompatible' 'ed' boolean (default off)
2965 global
2966 Makes the 'g' and 'c' flags of the ":substitute" command to be
2967 toggled each time the flag is given. See |complex-change|. See
2968 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002969 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002970 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971
Bram Moolenaar03413f42016-04-12 21:07:15 +02002972 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002973'emoji' 'emo' boolean (default: on)
2974 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002975 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002976 This excludes "text emoji" characters, which are normally displayed as
2977 single width. Unfortunately there is no good specification for this
2978 and it has been determined on trial-and-error basis. Use the
2979 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002980
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002982'encoding' 'enc' string (default for MS-Windows: "utf-8",
2983 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 Sets the character encoding used inside Vim. It applies to text in
2986 the buffers, registers, Strings in expressions, text stored in the
2987 viminfo file, etc. It sets the kind of characters which Vim can work
2988 with. See |encoding-names| for the possible values.
2989
2990 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002991 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002993 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994
Bram Moolenaar865242e2010-07-14 21:12:05 +02002995 This option cannot be set from a |modeline|. It would most likely
2996 corrupt the text.
2997
Bram Moolenaar3df01732017-02-17 22:47:16 +01002998 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2999 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 'encoding', "utf-8" is the natural choice for the environment and
3001 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003002 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 versions, and to avoid changing the encoding of newly created files
3004 without your knowledge (in case 'fileencodings' is empty).
3005
3006 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003007 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 iconv() or as specified with 'charconvert'.
3009
Bram Moolenaar207f0092020-08-30 17:20:20 +02003010 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003011 can use: >
3012 if has("multi_byte_encoding")
3013<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 Normally 'encoding' will be equal to your current locale. This will
3015 be the default if Vim recognizes your environment settings. If
3016 'encoding' is not set to the current locale, 'termencoding' must be
3017 set to convert typed and displayed text. See |encoding-table|.
3018
3019 When you set this option, it fires the |EncodingChanged| autocommand
3020 event so that you can set up fonts if necessary.
3021
3022 When the option is set, the value is converted to lowercase. Thus
3023 you can set it with uppercase values too. Underscores are translated
3024 to '-' signs.
3025 When the encoding is recognized, it is changed to the standard name.
3026 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3027 "iso-8859-2" and "utf8" becomes "utf-8".
3028
3029 Note: "latin1" is also used when the encoding could not be detected.
3030 This only works when editing files in the same encoding! When the
3031 actual character set is not latin1, make sure 'fileencoding' and
3032 'fileencodings' are empty. When conversion is needed, switch to using
3033 utf-8.
3034
3035 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3036 You don't notice this while editing, but it does matter for the
3037 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3038 setting 'encoding' to one of these values instead of utf-8 only has
3039 effect for encoding used for files when 'fileencoding' is empty.
3040
Bram Moolenaar661b1822005-07-28 22:36:45 +00003041 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3042 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043
3044 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3045'endofline' 'eol' boolean (default on)
3046 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003048 is on, or 'fixeol' option is off, no <EOL> will be written for the
3049 last line in the file. This option is automatically set or reset when
3050 starting to edit a new file, depending on whether file has an <EOL>
3051 for the last line in the file. Normally you don't have to set or
3052 reset this option.
3053 When 'binary' is off and 'fixeol' is on the value is not used when
3054 writing the file. When 'binary' is on or 'fixeol' is off it is used
3055 to remember the presence of a <EOL> for the last line in the file, so
3056 that when you write the file the situation from the original file can
3057 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058
3059 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3060'equalalways' 'ea' boolean (default on)
3061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003063 splitting or closing a window. This also happens the moment the
3064 option is switched on. When off, splitting a window will reduce the
3065 size of the current window and leave the other windows the same. When
3066 closing a window the extra lines are given to the window next to it
3067 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 When mixing vertically and horizontally split windows, a minimal size
3069 is computed and some windows may be larger if there is room. The
3070 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003071 Changing the height and width of a window can be avoided by setting
3072 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003073 If a window size is specified when creating a new window sizes are
3074 currently not equalized (it's complicated, but may be implemented in
3075 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076
3077 *'equalprg'* *'ep'*
3078'equalprg' 'ep' string (default "")
3079 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003081 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003082 or 'indentexpr'. When Vim was compiled without internal formatting,
3083 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003084 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 about including spaces and backslashes.
3086 This option cannot be set from a |modeline| or in the |sandbox|, for
3087 security reasons.
3088
3089 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3090'errorbells' 'eb' boolean (default off)
3091 global
3092 Ring the bell (beep or screen flash) for error messages. This only
3093 makes a difference for error messages, the bell will be used always
3094 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003095 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003096 screen flash or do nothing. See 'belloff' to finetune when to ring the
3097 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098
3099 *'errorfile'* *'ef'*
3100'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3101 others: "errors.err")
3102 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 {not available when compiled without the |+quickfix|
3104 feature}
3105 Name of the errorfile for the QuickFix mode (see |:cf|).
3106 When the "-q" command-line argument is used, 'errorfile' is set to the
3107 following argument. See |-q|.
3108 NOT used for the ":make" command. See 'makeef' for that.
3109 Environment variables are expanded |:set_env|.
3110 See |option-backslash| about including spaces and backslashes.
3111 This option cannot be set from a |modeline| or in the |sandbox|, for
3112 security reasons.
3113
3114 *'errorformat'* *'efm'*
3115'errorformat' 'efm' string (default is very long)
3116 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117 {not available when compiled without the |+quickfix|
3118 feature}
3119 Scanf-like description of the format for the lines in the error file
3120 (see |errorformat|).
3121
3122 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3123'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3124 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 Function keys that start with an <Esc> are recognized in Insert
3126 mode. When this option is off, the cursor and function keys cannot be
3127 used in Insert mode if they start with an <Esc>. The advantage of
3128 this is that the single <Esc> is recognized immediately, instead of
3129 after one second. Instead of resetting this option, you might want to
3130 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3131 when 'esckeys' is off, you can still map anything, but the cursor keys
3132 won't work by default.
3133 NOTE: This option is set to the Vi default value when 'compatible' is
3134 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003135 NOTE: when this option is off then the |modifyOtherKeys| functionality
3136 is disabled while in Insert mode to avoid ending Insert mode with any
3137 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138
3139 *'eventignore'* *'ei'*
3140'eventignore' 'ei' string (default "")
3141 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003143 When set to "all" or when "all" is one of the items, all autocommand
3144 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003145 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 :set ei=WinEnter,WinLeave
3147<
3148 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3149'expandtab' 'et' boolean (default off)
3150 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003152 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3154 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003155 This option is reset when the 'paste' option is set and restored when
3156 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157 NOTE: This option is reset when 'compatible' is set.
3158
3159 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3160'exrc' 'ex' boolean (default off)
3161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003163 directory.
3164
3165 Setting this option is a potential security leak. E.g., consider
3166 unpacking a package or fetching files from github, a .vimrc in there
3167 might be a trojan horse. BETTER NOT SET THIS OPTION!
3168 Instead, define an autocommand in your .vimrc to set options for a
3169 matching directory.
3170
3171 If you do switch this option on you should also consider setting the
3172 'secure' option (see |initialization|).
3173 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 This option cannot be set from a |modeline| or in the |sandbox|, for
3175 security reasons.
3176
3177 *'fileencoding'* *'fenc'* *E213*
3178'fileencoding' 'fenc' string (default: "")
3179 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003181
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003183 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 When 'fileencoding' is empty, the same value as 'encoding' will be
3185 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003186 No error will be given when the value is set, only when it is used,
3187 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003188 Conversion will also be done when 'encoding' and 'fileencoding' are
3189 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3190 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003192 'encoding' is "utf-8" or another Unicode encoding, conversion
3193 is most likely done in a way that the reverse conversion
3194 results in the same text. When 'encoding' is not "utf-8" some
3195 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003196
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197 See 'encoding' for the possible values. Additionally, values may be
3198 specified that can be handled by the converter, see
3199 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003200
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 When reading a file 'fileencoding' will be set from 'fileencodings'.
3202 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003203 'fileencoding', use the |++enc| argument. One exception: when
3204 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003205 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003206
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3208 When the option is set, the value is converted to lowercase. Thus
3209 you can set it with uppercase values too. '_' characters are
3210 replaced with '-'. If a name is recognized from the list for
3211 'encoding', it is replaced by the standard name. For example
3212 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003213
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 When this option is set, after starting to edit a file, the 'modified'
3215 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003216
3217 Keep in mind that changing 'fenc' from a modeline happens
3218 AFTER the text has been read, thus it applies to when the file will be
3219 written. If you do set 'fenc' in a modeline, you might want to set
3220 'nomodified' to avoid not being able to ":q".
3221
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222 This option can not be changed when 'modifiable' is off.
3223
3224 *'fe'*
3225 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003226 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 old short name was 'fe', which is no longer used.
3228
3229 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003230'fileencodings' 'fencs' string (default: "ucs-bom",
3231 "ucs-bom,utf-8,default,latin1" when
3232 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 This is a list of character encodings considered when starting to edit
3235 an existing file. When a file is read, Vim tries to use the first
3236 mentioned character encoding. If an error is detected, the next one
3237 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003238 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 an empty string, which means the value of 'encoding' is used.
3240 WARNING: Conversion can cause loss of information! When
3241 'encoding' is "utf-8" (or one of the other Unicode variants)
3242 conversion is most likely done in a way that the reverse
3243 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003244 "utf-8" some non-ASCII characters may be lost! You can use
3245 the |++bad| argument to specify what is done with characters
3246 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 For an empty file or a file with only ASCII characters most encodings
3248 will work and the first entry of 'fileencodings' will be used (except
3249 "ucs-bom", which requires the BOM to be present). If you prefer
3250 another encoding use an BufReadPost autocommand event to test if your
3251 preferred encoding is to be used. Example: >
3252 au BufReadPost * if search('\S', 'w') == 0 |
3253 \ set fenc=iso-2022-jp | endif
3254< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3255 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003256 When the |++enc| argument is used then the value of 'fileencodings' is
3257 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003258 Note that 'fileencodings' is not used for a new file, the global value
3259 of 'fileencoding' is used instead. You can set it with: >
3260 :setglobal fenc=iso-8859-2
3261< This means that a non-existing file may get a different encoding than
3262 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 The special value "ucs-bom" can be used to check for a Unicode BOM
3264 (Byte Order Mark) at the start of the file. It must not be preceded
3265 by "utf-8" or another Unicode encoding for this to work properly.
3266 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3267 because Vim cannot detect an error, thus the encoding is always
3268 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003269 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003270 environment. On MS-Windows this is the system encoding. Otherwise
3271 this is the default value for 'encoding'. It is useful when
3272 'encoding' is set to "utf-8" and your environment uses a non-latin1
3273 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003274 When 'encoding' is "utf-8" and a file contains an illegal byte
3275 sequence it won't be recognized as UTF-8. You can use the |8g8|
3276 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277 WRONG VALUES: WHAT'S WRONG:
3278 latin1,utf-8 "latin1" will always be used
3279 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3280 file
3281 cp1250,latin1 "cp1250" will always be used
3282 If 'fileencodings' is empty, 'fileencoding' is not modified.
3283 See 'fileencoding' for the possible values.
3284 Setting this option does not have an effect until the next time a file
3285 is read.
3286
3287 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003288'fileformat' 'ff' string (MS-Windows default: "dos",
3289 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 This gives the <EOL> of the current buffer, which is used for
3292 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003293 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 unix <NL>
3295 mac <CR>
3296 When "dos" is used, CTRL-Z at the end of a file is ignored.
3297 See |file-formats| and |file-read|.
3298 For the character encoding of the file see 'fileencoding'.
3299 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003300 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 This option is set automatically when starting to edit a file and
3302 'fileformats' is not empty and 'binary' is off.
3303 When this option is set, after starting to edit a file, the 'modified'
3304 option is set, because the file would be different when written.
3305 This option can not be changed when 'modifiable' is off.
3306 For backwards compatibility: When this option is set to "dos",
3307 'textmode' is set, otherwise 'textmode' is reset.
3308
3309 *'fileformats'* *'ffs'*
3310'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003311 Vim+Vi MS-Windows: "dos,unix",
3312 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 Vi Cygwin: "unix,dos",
3314 Vi others: "")
3315 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316 This gives the end-of-line (<EOL>) formats that will be tried when
3317 starting to edit a new buffer and when reading a file into an existing
3318 buffer:
3319 - When empty, the format defined with 'fileformat' will be used
3320 always. It is not set automatically.
3321 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003322 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323 'fileformats' name will be used when a file is read into an existing
3324 buffer, no matter what 'fileformat' for that buffer is set to.
3325 - When more than one name is present, separated by commas, automatic
3326 <EOL> detection will be done when reading a file. When starting to
3327 edit a file, a check is done for the <EOL>:
3328 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3329 'fileformat' is set to "dos".
3330 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003331 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003333 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3334 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003335 This means that "mac" is only chosen when:
3336 "unix" is not present or no <NL> is found in the file, and
3337 "dos" is not present or no <CR><NL> is found in the file.
3338 Except: if "unix" was chosen, but there is a <CR> before
3339 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003340 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 4. If 'fileformat' is still not set, the first name from
3342 'fileformats' is used.
3343 When reading a file into an existing buffer, the same is done, but
3344 this happens like 'fileformat' has been set appropriately for that
3345 file only, the option is not changed.
3346 When 'binary' is set, the value of 'fileformats' is not used.
3347
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003348 When Vim starts up with an empty buffer the first item is used. You
3349 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003350
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3352 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3353 done:
3354 - When 'fileformats' is empty, there is no automatic detection. Dos
3355 format will be used.
3356 - When 'fileformats' is set to one or more names, automatic detection
3357 is done. This is based on the first <NL> in the file: If there is a
3358 <CR> in front of it, Dos format is used, otherwise Unix format is
3359 used.
3360 Also see |file-formats|.
3361 For backwards compatibility: When this option is set to an empty
3362 string or one format (no comma is included), 'textauto' is reset,
3363 otherwise 'textauto' is set.
3364 NOTE: This option is set to the Vi default value when 'compatible' is
3365 set and to the Vim default value when 'compatible' is reset.
3366
Bram Moolenaarbf884932013-04-05 22:26:15 +02003367 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3368'fileignorecase' 'fic' boolean (default on for systems where case in file
3369 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003370 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003371 When set case is ignored when using file names and directories.
3372 See 'wildignorecase' for only ignoring case when doing completion.
3373
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 *'filetype'* *'ft'*
3375'filetype' 'ft' string (default: "")
3376 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 When this option is set, the FileType autocommand event is triggered.
3378 All autocommands that match with the value of this option will be
3379 executed. Thus the value of 'filetype' is used in place of the file
3380 name.
3381 Otherwise this option does not always reflect the current file type.
3382 This option is normally set when the file type is detected. To enable
3383 this use the ":filetype on" command. |:filetype|
3384 Setting this option to a different value is most useful in a modeline,
3385 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003386 Example, for in an IDL file:
3387 /* vim: set filetype=idl : */ ~
3388 |FileType| |filetypes|
3389 When a dot appears in the value then this separates two filetype
3390 names. Example:
3391 /* vim: set filetype=c.doxygen : */ ~
3392 This will use the "c" filetype first, then the "doxygen" filetype.
3393 This works both for filetype plugins and for syntax files. More than
3394 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 This option is not copied to another buffer, independent of the 's' or
3396 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003397 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398
3399 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003400'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003401 global or local to window |global-local|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003402 {not available when compiled without the |+folding|
3403 feature}
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003404 Characters to fill the statuslines, vertical separators and special
3405 lines in the window.
3406 It is a comma-separated list of items. Each item has a name, a colon
3407 and the value of that item:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003409 item name default Used for ~
3410 stl ' ' or '^' statusline of the current window
3411 stlnc ' ' or '=' statusline of the non-current windows
3412 vert '|' vertical separators |:vsplit|
3413 fold '-' filling 'foldtext'
3414 foldopen '-' mark the beginning of a fold
3415 foldclose '+' show a closed fold
3416 foldsep '|' open fold middle character
3417 diff '-' deleted lines of the 'diff' option
3418 eob '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003420 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003421 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003422 otherwise.
3423
3424 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003425 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426< This is similar to the default, except that these characters will also
3427 be used when there is highlighting.
3428
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003429 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3430 single-byte and multibyte characters are supported. But double-width
3431 characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003432
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003434 item name highlight group ~
3435 stl StatusLine |hl-StatusLine|
3436 stlnc StatusLineNC |hl-StatusLineNC|
3437 vert VertSplit |hl-VertSplit|
3438 fold Folded |hl-Folded|
3439 diff DiffDelete |hl-DiffDelete|
3440 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003442 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3443'fixendofline' 'fixeol' boolean (default on)
3444 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003445 When writing a file and this option is on, <EOL> at the end of file
3446 will be restored if missing. Turn this option off if you want to
3447 preserve the situation from the original file.
3448 When the 'binary' option is set the value of this option doesn't
3449 matter.
3450 See the 'endofline' option.
3451
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003453'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 {only available when compiled with the |+rightleft|
3456 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003457 This option was for using Farsi, which has been removed. See
3458 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459
3460 *'foldclose'* *'fcl'*
3461'foldclose' 'fcl' string (default "")
3462 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 {not available when compiled without the |+folding|
3464 feature}
3465 When set to "all", a fold is closed when the cursor isn't in it and
3466 its level is higher than 'foldlevel'. Useful if you want folds to
3467 automatically close when moving out of them.
3468
3469 *'foldcolumn'* *'fdc'*
3470'foldcolumn' 'fdc' number (default 0)
3471 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 {not available when compiled without the |+folding|
3473 feature}
3474 When non-zero, a column with the specified width is shown at the side
3475 of the window which indicates open and closed folds. The maximum
3476 value is 12.
3477 See |folding|.
3478
3479 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3480'foldenable' 'fen' boolean (default on)
3481 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 {not available when compiled without the |+folding|
3483 feature}
3484 When off, all folds are open. This option can be used to quickly
3485 switch between showing all text unfolded and viewing the text with
3486 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003487 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 'foldenable' is off.
3489 This option is set by commands that create a new fold or close a fold.
3490 See |folding|.
3491
3492 *'foldexpr'* *'fde'*
3493'foldexpr' 'fde' string (default: "0")
3494 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003496 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003498 for each line to obtain its fold level. The context is set to the
3499 script where 'foldexpr' was set, script-local items can be accessed.
3500 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003501
Bram Moolenaar30b65812012-07-12 22:01:11 +02003502 The expression will be evaluated in the |sandbox| if set from a
3503 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003504 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003505 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003506
3507 It is not allowed to change text or jump to another window while
3508 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509
3510 *'foldignore'* *'fdi'*
3511'foldignore' 'fdi' string (default: "#")
3512 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 {not available when compiled without the |+folding|
3514 feature}
3515 Used only when 'foldmethod' is "indent". Lines starting with
3516 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003517 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 The default "#" works well for C programs. See |fold-indent|.
3519
3520 *'foldlevel'* *'fdl'*
3521'foldlevel' 'fdl' number (default: 0)
3522 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523 {not available when compiled without the |+folding|
3524 feature}
3525 Sets the fold level: Folds with a higher level will be closed.
3526 Setting this option to zero will close all folds. Higher numbers will
3527 close fewer folds.
3528 This option is set by commands like |zm|, |zM| and |zR|.
3529 See |fold-foldlevel|.
3530
3531 *'foldlevelstart'* *'fdls'*
3532'foldlevelstart' 'fdls' number (default: -1)
3533 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 {not available when compiled without the |+folding|
3535 feature}
3536 Sets 'foldlevel' when starting to edit another buffer in a window.
3537 Useful to always start editing with all folds closed (value zero),
3538 some folds closed (one) or no folds closed (99).
3539 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003540 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 ignores this option and closes all folds.
3542 It is also done before BufReadPre autocommands, to allow an autocmd to
3543 overrule the 'foldlevel' value for specific files.
3544 When the value is negative, it is not used.
3545
3546 *'foldmarker'* *'fmr'* *E536*
3547'foldmarker' 'fmr' string (default: "{{{,}}}")
3548 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 {not available when compiled without the |+folding|
3550 feature}
3551 The start and end marker used when 'foldmethod' is "marker". There
3552 must be one comma, which separates the start and end marker. The
3553 marker is a literal string (a regular expression would be too slow).
3554 See |fold-marker|.
3555
3556 *'foldmethod'* *'fdm'*
3557'foldmethod' 'fdm' string (default: "manual")
3558 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559 {not available when compiled without the |+folding|
3560 feature}
3561 The kind of folding used for the current window. Possible values:
3562 |fold-manual| manual Folds are created manually.
3563 |fold-indent| indent Lines with equal indent form a fold.
3564 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3565 |fold-marker| marker Markers are used to specify folds.
3566 |fold-syntax| syntax Syntax highlighting items specify folds.
3567 |fold-diff| diff Fold text that is not changed.
3568
3569 *'foldminlines'* *'fml'*
3570'foldminlines' 'fml' number (default: 1)
3571 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572 {not available when compiled without the |+folding|
3573 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003574 Sets the number of screen lines above which a fold can be displayed
3575 closed. Also for manually closed folds. With the default value of
3576 one a fold can only be closed if it takes up two or more screen lines.
3577 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003578 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579 "zc" to close a fold, which is displayed open because it's smaller
3580 than 'foldminlines', a following "zc" may close a containing fold.
3581
3582 *'foldnestmax'* *'fdn'*
3583'foldnestmax' 'fdn' number (default: 20)
3584 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 {not available when compiled without the |+folding|
3586 feature}
3587 Sets the maximum nesting of folds for the "indent" and "syntax"
3588 methods. This avoids that too many folds will be created. Using more
3589 than 20 doesn't work, because the internal limit is 20.
3590
3591 *'foldopen'* *'fdo'*
3592'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3593 search,tag,undo")
3594 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 {not available when compiled without the |+folding|
3596 feature}
3597 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003598 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003600 NOTE: When the command is part of a mapping this option is not used.
3601 Add the |zv| command to the mapping to get the same effect.
3602 (rationale: the mapping may want to control opening folds itself)
3603
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 item commands ~
3605 all any
3606 block "(", "{", "[[", "[{", etc.
3607 hor horizontal movements: "l", "w", "fx", etc.
3608 insert any command in Insert mode
3609 jump far jumps: "G", "gg", etc.
3610 mark jumping to a mark: "'m", CTRL-O, etc.
3611 percent "%"
3612 quickfix ":cn", ":crew", ":make", etc.
3613 search search for a pattern: "/", "n", "*", "gd", etc.
3614 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003615 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 tag jumping to a tag: ":ta", CTRL-T, etc.
3617 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618 When a movement command is used for an operator (e.g., "dl" or "y%")
3619 this option is not used. This means the operator will include the
3620 whole closed fold.
3621 Note that vertical movements are not here, because it would make it
3622 very difficult to move onto a closed fold.
3623 In insert mode the folds containing the cursor will always be open
3624 when text is inserted.
3625 To close folds you can re-apply 'foldlevel' with the |zx| command or
3626 set the 'foldclose' option to "all".
3627
3628 *'foldtext'* *'fdt'*
3629'foldtext' 'fdt' string (default: "foldtext()")
3630 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 {not available when compiled without the |+folding|
3632 feature}
3633 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003634 fold. The context is set to the script where 'foldexpr' was set,
3635 script-local items can be accessed. See |fold-foldtext| for the
3636 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637
Bram Moolenaar30b65812012-07-12 22:01:11 +02003638 The expression will be evaluated in the |sandbox| if set from a
3639 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003640 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003641
3642 It is not allowed to change text or jump to another window while
3643 evaluating 'foldtext' |textlock|.
3644
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003645 *'formatexpr'* *'fex'*
3646'formatexpr' 'fex' string (default "")
3647 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003648 {not available when compiled without the |+eval|
3649 feature}
3650 Expression which is evaluated to format a range of lines for the |gq|
3651 operator or automatic formatting (see 'formatoptions'). When this
3652 option is empty 'formatprg' is used.
3653
3654 The |v:lnum| variable holds the first line to be formatted.
3655 The |v:count| variable holds the number of lines to be formatted.
3656 The |v:char| variable holds the character that is going to be
3657 inserted if the expression is being evaluated due to
3658 automatic formatting. This can be empty. Don't insert
3659 it yet!
3660
3661 Example: >
3662 :set formatexpr=mylang#Format()
3663< This will invoke the mylang#Format() function in the
3664 autoload/mylang.vim file in 'runtimepath'. |autoload|
3665
3666 The expression is also evaluated when 'textwidth' is set and adding
3667 text beyond that limit. This happens under the same conditions as
3668 when internal formatting is used. Make sure the cursor is kept in the
3669 same spot relative to the text then! The |mode()| function will
3670 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003671
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003672 When the expression evaluates to non-zero Vim will fall back to using
3673 the internal format mechanism.
3674
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003675 If the expression starts with s: or |<SID>|, then it is replaced with
3676 the script ID (|local-function|). Example: >
3677 set formatexpr=s:MyFormatExpr()
3678 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003679< Otherwise, the expression is evaluated in the context of the script
3680 where the option was set, thus script-local items are available.
3681
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003682 The expression will be evaluated in the |sandbox| when set from a
3683 modeline, see |sandbox-option|. That stops the option from working,
3684 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003685 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003686 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003687
Bram Moolenaar86b68352004-12-27 21:59:20 +00003688 *'formatlistpat'* *'flp'*
3689'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3690 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003691 A pattern that is used to recognize a list header. This is used for
3692 the "n" flag in 'formatoptions'.
3693 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003694 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003695 while still checking more characters. There must be a character
3696 following the pattern, when it matches the whole line it is handled
3697 like there is no match.
3698 The default recognizes a number, followed by an optional punctuation
3699 character and white space.
3700
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003701 *'formatoptions'* *'fo'*
3702'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3703 local to buffer
3704 This is a sequence of letters which describes how automatic
3705 formatting is to be done. See |fo-table|. When the 'paste' option is
3706 on, no formatting is done (like 'formatoptions' is empty). Commas can
3707 be inserted for readability.
3708 To avoid problems with flags that are added in the future, use the
3709 "+=" and "-=" feature of ":set" |add-option-flags|.
3710 NOTE: This option is set to the Vi default value when 'compatible' is
3711 set and to the Vim default value when 'compatible' is reset.
3712
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 *'formatprg'* *'fp'*
3714'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003715 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003717 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003719 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003720 If the 'formatexpr' option is not empty it will be used instead.
3721 Otherwise, if 'formatprg' option is an empty string, the internal
3722 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003723 Environment variables are expanded |:set_env|. See |option-backslash|
3724 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003725 This option cannot be set from a |modeline| or in the |sandbox|, for
3726 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727
Bram Moolenaard94464e2015-11-02 15:28:18 +01003728 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003729'fsync' 'fs' boolean (default on)
3730 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003731 When on, the library function fsync() will be called after writing a
3732 file. This will flush a file to disk, ensuring that it is safely
3733 written even on filesystems which do metadata-only journaling. This
3734 will force the harddrive to spin up on Linux systems running in laptop
3735 mode, so it may be undesirable in some situations. Be warned that
3736 turning this off increases the chances of data loss after a crash. On
3737 systems without an fsync() implementation, this variable is always
3738 off.
3739 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003740 'fsync' also applies to |writefile()| (unless a flag is used to
3741 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003742 This option cannot be set from a |modeline| or in the |sandbox|, for
3743 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003744
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3746'gdefault' 'gd' boolean (default off)
3747 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 When on, the ":substitute" flag 'g' is default on. This means that
3749 all matches in a line are substituted instead of one. When a 'g' flag
3750 is given to a ":substitute" command, this will toggle the substitution
3751 of all or one match. See |complex-change|.
3752
3753 command 'gdefault' on 'gdefault' off ~
3754 :s/// subst. all subst. one
3755 :s///g subst. one subst. all
3756 :s///gg subst. all subst. one
3757
3758 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003759 DEPRECATED: Setting this option may break plugins that are not aware
3760 of this option. Also, many users get confused that adding the /g flag
3761 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003762 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763
3764 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003765'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 Format to recognize for the ":grep" command output.
3768 This is a scanf-like string that uses the same format as the
3769 'errorformat' option: see |errorformat|.
3770
3771 *'grepprg'* *'gp'*
3772'grepprg' 'gp' string (default "grep -n ",
3773 Unix: "grep -n $* /dev/null",
3774 Win32: "findstr /n" or "grep -n",
3775 VMS: "SEARCH/NUMBERS ")
3776 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003777 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778 and '#' characters, which are expanded like when used in a command-
3779 line. The placeholder "$*" is allowed to specify where the arguments
3780 will be included. Environment variables are expanded |:set_env|. See
3781 |option-backslash| about including spaces and backslashes.
3782 When your "grep" accepts the "-H" argument, use this to make ":grep"
3783 also work well with a single file: >
3784 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003785< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003786 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3787 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003788 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 apply equally to 'grepprg'.
3790 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3791 otherwise it's "grep -n".
3792 This option cannot be set from a |modeline| or in the |sandbox|, for
3793 security reasons.
3794
3795 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3796'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3797 ve:ver35-Cursor,
3798 o:hor50-Cursor,
3799 i-ci:ver25-Cursor/lCursor,
3800 r-cr:hor20-Cursor/lCursor,
3801 sm:block-Cursor
3802 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003803 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 "n-v-c:block,o:hor50,i-ci:hor15,
3805 r-cr:hor30,sm:block")
3806 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003808 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003810 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003811 height of the cursor can be changed. This can be done by specifying a
3812 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003813 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3814 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003816 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 mode-list and an argument-list:
3818 mode-list:argument-list,mode-list:argument-list,..
3819 The mode-list is a dash separated list of these modes:
3820 n Normal mode
3821 v Visual mode
3822 ve Visual mode with 'selection' "exclusive" (same as 'v',
3823 if not specified)
3824 o Operator-pending mode
3825 i Insert mode
3826 r Replace mode
3827 c Command-line Normal (append) mode
3828 ci Command-line Insert mode
3829 cr Command-line Replace mode
3830 sm showmatch in Insert mode
3831 a all modes
3832 The argument-list is a dash separated list of these arguments:
3833 hor{N} horizontal bar, {N} percent of the character height
3834 ver{N} vertical bar, {N} percent of the character width
3835 block block cursor, fills the whole character
3836 [only one of the above three should be present]
3837 blinkwait{N} *cursor-blinking*
3838 blinkon{N}
3839 blinkoff{N}
3840 blink times for cursor: blinkwait is the delay before
3841 the cursor starts blinking, blinkon is the time that
3842 the cursor is shown and blinkoff is the time that the
3843 cursor is not shown. The times are in msec. When one
3844 of the numbers is zero, there is no blinking. The
3845 default is: "blinkwait700-blinkon400-blinkoff250".
3846 These numbers are used for a missing entry. This
3847 means that blinking is enabled by default. To switch
3848 blinking off you can use "blinkon0". The cursor only
3849 blinks when Vim is waiting for input, not while
3850 executing a command.
3851 To make the cursor blink in an xterm, see
3852 |xterm-blink|.
3853 {group-name}
3854 a highlight group name, that sets the color and font
3855 for the cursor
3856 {group-name}/{group-name}
3857 Two highlight group names, the first is used when
3858 no language mappings are used, the other when they
3859 are. |language-mapping|
3860
3861 Examples of parts:
3862 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3863 block cursor with colors from the "nCursor"
3864 highlight group
3865 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3866 In Insert and Command-line Insert mode, use a
3867 30% vertical bar cursor with colors from the
3868 "iCursor" highlight group. Blink a bit
3869 faster.
3870
3871 The 'a' mode is different. It will set the given argument-list for
3872 all modes. It does not reset anything to defaults. This can be used
3873 to do a common setting for all modes. For example, to switch off
3874 blinking: "a:blinkon0"
3875
3876 Examples of cursor highlighting: >
3877 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3878 :highlight Cursor gui=NONE guifg=bg guibg=fg
3879<
3880 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003881 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882'guifont' 'gfn' string (default "")
3883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 {only available when compiled with GUI enabled}
3885 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003886 In its simplest form the value is just one font name.
3887 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888
3889 *'guifontset'* *'gfs'*
3890 *E250* *E252* *E234* *E597* *E598*
3891'guifontset' 'gfs' string (default "")
3892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 {only available when compiled with GUI enabled and
3894 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003895 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 When not empty, specifies two (or more) fonts to be used. The first
3897 one for normal English, the second one for your special language. See
3898 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003899
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3901'guifontwide' 'gfw' string (default "")
3902 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 {only available when compiled with GUI enabled}
3904 When not empty, specifies a comma-separated list of fonts to be used
3905 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003906 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003907
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 *'guiheadroom'* *'ghr'*
3909'guiheadroom' 'ghr' number (default 50)
3910 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003911 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 The number of pixels subtracted from the screen height when fitting
3913 the GUI window on the screen. Set this before the GUI is started,
3914 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003915 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 lines will be left for window decorations and other items on the
3917 screen. Set it to a negative value to allow windows taller than the
3918 screen.
3919
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003920 *'guiligatures'* *'gli'* *E1243*
3921'guiligatures' 'gli' string (default "")
3922 global
3923 {only for GTK GUI}
3924 List of ASCII characters that, when combined together, can create more
3925 complex shapes. Each character must be a printable ASCII character
3926 with a value in the 32-127 range.
3927 Example: >
3928 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3929< Changing this option updates screen output immediately. Set it to an
3930 empty string to disable ligatures.
3931
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003933'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3934 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003935 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003936 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003939 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 sequence of letters which describes what components and options of the
3941 GUI should be used.
3942 To avoid problems with flags that are added in the future, use the
3943 "+=" and "-=" feature of ":set" |add-option-flags|.
3944
Bram Moolenaar13568252018-03-16 20:46:58 +01003945 Valid characters are as follows:
3946 *'go-!'*
3947 '!' External commands are executed in a terminal window. Without
3948 this flag the MS-Windows GUI will open a console window to
3949 execute the command. The Unix GUI will simulate a dumb
3950 terminal to list the command output.
3951 The terminal window will be positioned at the bottom, and grow
3952 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003953 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 'a' Autoselect: If present, then whenever VISUAL mode is started,
3955 or the Visual area extended, Vim tries to become the owner of
3956 the windowing system's global selection. This means that the
3957 Visually highlighted text is available for pasting into other
3958 applications as well as into Vim itself. When the Visual mode
3959 ends, possibly due to an operation on the text, or when an
3960 application wants to paste the selection, the highlighted text
3961 is automatically yanked into the "* selection register.
3962 Thus the selection is still available for pasting into other
3963 applications after the VISUAL mode has ended.
3964 If not present, then Vim won't become the owner of the
3965 windowing system's global selection unless explicitly told to
3966 by a yank or delete operation for the "* register.
3967 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003968 *'go-P'*
3969 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003970 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003971 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003972 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 applies to the modeless selection.
3974
3975 'guioptions' autoselect Visual autoselect modeless ~
3976 "" - -
3977 "a" yes yes
3978 "A" - yes
3979 "aA" yes yes
3980
Bram Moolenaar02467872007-05-06 13:22:01 +00003981 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 'c' Use console dialogs instead of popup dialogs for simple
3983 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003984 *'go-d'*
3985 'd' Use dark theme variant if available. Currently only works for
3986 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003987 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003988 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003989 'guitablabel' can be used to change the text in the labels.
3990 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003991 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003992 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003993 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994 'f' Foreground: Don't use fork() to detach the GUI from the shell
3995 where it was started. Use this for programs that wait for the
3996 editor to finish (e.g., an e-mail program). Alternatively you
3997 can use "gvim -f" or ":gui -f" to start the GUI in the
3998 foreground. |gui-fork|
3999 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004000 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004001 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4003 corner of the window. It's black&white on non-GTK, because of
4004 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004005 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004007 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004008 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004010 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004012 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004013 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 'g' Grey menu items: Make menu items that are not active grey. If
4015 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004016 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 't' Include tearoff menu items. Currently only works for Win32,
4018 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004019 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004020 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4021 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004022 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004024 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 'R' Right-hand scrollbar is present when there is a vertically
4026 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004027 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004029 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 'L' Left-hand scrollbar is present when there is a vertically
4031 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004032 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4034 the longest visible line, or on the cursor line if the 'h'
4035 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004036 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 'h' Limit horizontal scrollbar size to the length of the cursor
4038 line. Reduces computations. |gui-horiz-scroll|
4039
4040 And yes, you may even have scrollbars on the left AND the right if
4041 you really want to :-). See |gui-scrollbars| for more information.
4042
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004043 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 'v' Use a vertical button layout for dialogs. When not included,
4045 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004046 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004047 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 'p' Use Pointer callbacks for X11 GUI. This is required for some
4049 window managers. If the cursor is not blinking or hollow at
4050 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004051 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004052 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004053 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004054 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004055 *'go-k'*
4056 'k' Keep the GUI window size when adding/removing a scrollbar, or
4057 toolbar, tabline, etc. Instead, the behavior is similar to
4058 when the window is maximized and will adjust 'lines' and
4059 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004060 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004061 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004062
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 *'guipty'* *'noguipty'*
4064'guipty' boolean (default on)
4065 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 {only available when compiled with GUI enabled}
4067 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4068 I/O to/from shell commands. See |gui-pty|.
4069
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004070 *'guitablabel'* *'gtl'*
4071'guitablabel' 'gtl' string (default empty)
4072 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004073 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004074 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004075 pages line. When empty and when the result is empty Vim will use a
4076 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004077
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004078 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004079 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004080 The expression will be evaluated in the |sandbox| when set from a
4081 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004082 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004083
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004084 Only used when the GUI tab pages line is displayed. 'e' must be
4085 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4086 used.
4087
Bram Moolenaar57657d82006-04-21 22:12:41 +00004088 *'guitabtooltip'* *'gtt'*
4089'guitabtooltip' 'gtt' string (default empty)
4090 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004091 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004092 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004093 pages line. When empty Vim will use a default tooltip.
4094 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004095 You can include a line break. Simplest method is to use |:let|: >
4096 :let &guitabtooltip = "line one\nline two"
4097<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004098
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004100'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 (others) "$VIMRUNTIME/doc/help.txt")
4102 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 Name of the main help file. All distributed help files should be
4104 placed together in one directory. Additionally, all "doc" directories
4105 in 'runtimepath' will be used.
4106 Environment variables are expanded |:set_env|. For example:
4107 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004108 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 spaces and backslashes.
4110 This option cannot be set from a |modeline| or in the |sandbox|, for
4111 security reasons.
4112
4113 *'helpheight'* *'hh'*
4114'helpheight' 'hh' number (default 20)
4115 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 Minimal initial height of the help window when it is opened with the
4117 ":help" command. The initial height of the help window is half of the
4118 current window, or (when the 'ea' option is on) the same as other
4119 windows. When the height is less than 'helpheight', the height is
4120 set to 'helpheight'. Set to zero to disable.
4121
4122 *'helplang'* *'hlg'*
4123'helplang' 'hlg' string (default: messages language or empty)
4124 global
4125 {only available when compiled with the |+multi_lang|
4126 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004127 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 for which the desired help can be found. The English help will always
4129 be used as a last resort. You can add "en" to prefer English over
4130 another language, but that will only find tags that exist in that
4131 language and not in the English help.
4132 Example: >
4133 :set helplang=de,it
4134< This will first search German, then Italian and finally English help
4135 files.
4136 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4137 try to find the tag in the current language before using this option.
4138 See |help-translated|.
4139
4140 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4141'hidden' 'hid' boolean (default off)
4142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 When off a buffer is unloaded when it is |abandon|ed. When on a
4144 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4145 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004146
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004148 hidden even if the 'hidden' option is off when these three are true:
4149 - the buffer is modified
4150 - 'autowrite' is off or writing is not possible
4151 - the '!' flag was used
4152 Also see |windows.txt|.
4153
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004154 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 This option is set for one command with ":hide {command}" |:hide|.
4156 WARNING: It's easy to forget that you have changes in hidden buffers.
4157 Think twice when using ":q!" or ":qa!".
4158
4159 *'highlight'* *'hl'*
4160'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004161 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4162 d:Directory,e:ErrorMsg,i:IncSearch,
4163 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004164 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004165 N:CursorLineNr,r:Question,s:StatusLine,
4166 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004167 v:Visual,V:VisualNOS,w:WarningMsg,
4168 W:WildMenu,f:Folded,F:FoldColumn,
4169 A:DiffAdd,C:DiffChange,D:DiffDelete,
4170 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004171 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004172 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004173 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4174 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004175 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004176 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004179 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004181 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004183 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4184 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 characters from 'showbreak'
4186 |hl-Directory| d directories in CTRL-D listing and other special
4187 things in listings
4188 |hl-ErrorMsg| e error messages
4189 h (obsolete, ignored)
4190 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004191 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4193 |hl-MoreMsg| m |more-prompt|
4194 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004195 |hl-LineNr| n line number for ":number" and ":#" commands, and
4196 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004197 |hl-LineNrAbove| a line number above the cursor for when the
4198 'relativenumber' option is set.
4199 |hl-LineNrBelow| b line number below the cursor for when the
4200 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004201 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4202 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 |hl-Question| r |hit-enter| prompt and yes/no questions
4204 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004205 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4207 |hl-VertSplit| c column used to separate vertically split windows
4208 |hl-Visual| v Visual mode
4209 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4210 Selection" Only X11 Gui's |gui-x11| and
4211 |xterm-clipboard|.
4212 |hl-WarningMsg| w warning messages
4213 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4214 |hl-Folded| f line used for closed folds
4215 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004216 |hl-DiffAdd| A added line in diff mode
4217 |hl-DiffChange| C changed line in diff mode
4218 |hl-DiffDelete| D deleted line in diff mode
4219 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004221 |hl-Conceal| - the placeholders used for concealed characters
4222 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004223 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004224 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004225 |hl-SpellRare| R rare word |spell|
4226 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004227 |hl-Pmenu| + popup menu normal line
4228 |hl-PmenuSel| = popup menu selected line
4229 |hl-PmenuSbar| x popup menu scrollbar
4230 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231
4232 The display modes are:
4233 r reverse (termcap entry "mr" and "me")
4234 i italic (termcap entry "ZH" and "ZR")
4235 b bold (termcap entry "md" and "me")
4236 s standout (termcap entry "so" and "se")
4237 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004238 c undercurl (termcap entry "Us" and "Ce")
4239 2 double underline (termcap entry "Ds" and "Ce")
4240 d dotted underline (termcap entry "ds" and "Ce")
4241 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004242 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 n no highlighting
4244 - no highlighting
4245 : use a highlight group
4246 The default is used for occasions that are not included.
4247 If you want to change what the display modes do, see |dos-colors|
4248 for an example.
4249 When using the ':' display mode, this must be followed by the name of
4250 a highlight group. A highlight group can be used to define any type
4251 of highlighting, including using color. See |:highlight| on how to
4252 define one. The default uses a different group for each occasion.
4253 See |highlight-default| for the default highlight groups.
4254
Bram Moolenaar071d4272004-06-13 20:20:40 +00004255 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004256'history' 'hi' number (Vim default: 50, Vi default: 0,
4257 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004260 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004262 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 NOTE: This option is set to the Vi default value when 'compatible' is
4264 set and to the Vim default value when 'compatible' is reset.
4265
4266 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4267'hkmap' 'hk' boolean (default off)
4268 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 {only available when compiled with the |+rightleft|
4270 feature}
4271 When on, the keyboard is mapped for the Hebrew character set.
4272 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4273 toggle this option. See |rileft.txt|.
4274 NOTE: This option is reset when 'compatible' is set.
4275
4276 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4277'hkmapp' 'hkp' boolean (default off)
4278 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 {only available when compiled with the |+rightleft|
4280 feature}
4281 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4282 This is useful if you have a non-Hebrew keyboard.
4283 See |rileft.txt|.
4284 NOTE: This option is reset when 'compatible' is set.
4285
Bram Moolenaar036986f2017-03-16 17:41:02 +01004286 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4287'hlsearch' 'hls' boolean (default off)
4288 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004289 {not available when compiled without the
4290 |+extra_search| feature}
4291 When there is a previous search pattern, highlight all its matches.
4292 The type of highlighting used can be set with the 'l' occasion in the
4293 'highlight' option. This uses the "Search" highlight group by
4294 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004295 are not applied. If the "CurSearch" highlight group is set then the
4296 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004297 See also: 'incsearch' and |:match|.
4298 When you get bored looking at the highlighted matches, you can turn it
4299 off with |:nohlsearch|. This does not change the option value, as
4300 soon as you use a search command, the highlighting comes back.
4301 'redrawtime' specifies the maximum time spent on finding matches.
4302 When the search pattern can match an end-of-line, Vim will try to
4303 highlight all of the matched text. However, this depends on where the
4304 search starts. This will be the first line in the window or the first
4305 line below a closed fold. A match in a previous line which is not
4306 drawn may not continue in a newly drawn line.
4307 You can specify whether the highlight status is restored on startup
4308 with the 'h' flag in 'viminfo' |viminfo-h|.
4309 NOTE: This option is reset when 'compatible' is set.
4310
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 *'icon'* *'noicon'*
4312'icon' boolean (default off, on when title can be restored)
4313 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 When on, the icon text of the window will be set to the value of
4315 'iconstring' (if it is not empty), or to the name of the file
4316 currently being edited. Only the last part of the name is used.
4317 Overridden by the 'iconstring' option.
4318 Only works if the terminal supports setting window icons (currently
4319 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4320 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4321 builtin termcap).
4322 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004323 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004324 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004325 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326
4327 *'iconstring'*
4328'iconstring' string (default "")
4329 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330 When this option is not empty, it will be used for the icon text of
4331 the window. This happens only when the 'icon' option is on.
4332 Only works if the terminal supports setting window icon text
4333 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004334 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 When Vim was compiled with HAVE_X11 defined, the original icon will be
4336 restored if possible |X11|.
4337 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004338 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004339 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004340 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341 {not available when compiled without the |+statusline| feature}
4342
4343 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4344'ignorecase' 'ic' boolean (default off)
4345 global
4346 Ignore case in search patterns. Also used when searching in the tags
4347 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004348 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 Can be overruled by using "\c" or "\C" in the pattern, see
4350 |/ignorecase|.
4351
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004352 *'imactivatefunc'* *'imaf'*
4353'imactivatefunc' 'imaf' string (default "")
4354 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004355 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004356 activate or deactivate the Input Method. The value can be the name of
4357 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4358 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004359 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004360 The expression will be evaluated in the |sandbox| when set from a
4361 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004362
4363 Example: >
4364 function ImActivateFunc(active)
4365 if a:active
4366 ... do something
4367 else
4368 ... do something
4369 endif
4370 " return value is not used
4371 endfunction
4372 set imactivatefunc=ImActivateFunc
4373<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 *'imactivatekey'* *'imak'*
4375'imactivatekey' 'imak' string (default "")
4376 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004378 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 Specifies the key that your Input Method in X-Windows uses for
4380 activation. When this is specified correctly, vim can fully control
4381 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4382 You can't use this option to change the activation key, the option
4383 tells Vim what the key is.
4384 Format:
4385 [MODIFIER_FLAG-]KEY_STRING
4386
4387 These characters can be used for MODIFIER_FLAG (case is ignored):
4388 S Shift key
4389 L Lock key
4390 C Control key
4391 1 Mod1 key
4392 2 Mod2 key
4393 3 Mod3 key
4394 4 Mod4 key
4395 5 Mod5 key
4396 Combinations are allowed, for example "S-C-space" or "SC-space" are
4397 both shift+ctrl+space.
4398 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4399
4400 Example: >
4401 :set imactivatekey=S-space
4402< "S-space" means shift+space. This is the activation key for kinput2 +
4403 canna (Japanese), and ami (Korean).
4404
4405 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4406'imcmdline' 'imc' boolean (default off)
4407 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 When set the Input Method is always on when starting to edit a command
4409 line, unless entering a search pattern (see 'imsearch' for that).
4410 Setting this option is useful when your input method allows entering
4411 English characters directly, e.g., when it's used to type accented
4412 characters with dead keys.
4413
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004414 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004415'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4416 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 When set the Input Method is never used. This is useful to disable
4418 the IM when it doesn't work properly.
4419 Currently this option is on by default for SGI/IRIX machines. This
4420 may change in later releases.
4421
4422 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004423'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 Specifies whether :lmap or an Input Method (IM) is to be used in
4426 Insert mode. Valid values:
4427 0 :lmap is off and IM is off
4428 1 :lmap is ON and IM is off
4429 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430 To always reset the option to zero when leaving Insert mode with <Esc>
4431 this can be used: >
4432 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4433< This makes :lmap and IM turn off automatically when leaving Insert
4434 mode.
4435 Note that this option changes when using CTRL-^ in Insert mode
4436 |i_CTRL-^|.
4437 The value is set to 1 when setting 'keymap' to a valid keymap name.
4438 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004439 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 methods. Use 'imdisable' to disable XIM then.
4441
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004442 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004443 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004444 |+multi_byte_ime| or |global-ime|.
4445
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004447'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004449 Specifies whether :lmap or an Input Method (IM) is to be used when
4450 entering a search pattern. Valid values:
4451 -1 the value of 'iminsert' is used, makes it look like
4452 'iminsert' is also used when typing a search pattern
4453 0 :lmap is off and IM is off
4454 1 :lmap is ON and IM is off
4455 2 :lmap is off and IM is ON
4456 Note that this option changes when using CTRL-^ in Command-line mode
4457 |c_CTRL-^|.
4458 The value is set to 1 when it is not -1 and setting the 'keymap'
4459 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004460 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461 methods. Use 'imdisable' to disable XIM then.
4462
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004463 *'imstatusfunc'* *'imsf'*
4464'imstatusfunc' 'imsf' string (default "")
4465 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004466 This option specifies a function that is called to obtain the status
4467 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004468 The value can be the name of a function, a |lambda| or a |Funcref|.
4469 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004470 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004471
4472 Example: >
4473 function ImStatusFunc()
4474 let is_active = ...do something
4475 return is_active ? 1 : 0
4476 endfunction
4477 set imstatusfunc=ImStatusFunc
4478<
4479 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004480 The expression will be evaluated in the |sandbox| when set from a
4481 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004482
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004483 *'imstyle'* *'imst'*
4484'imstyle' 'imst' number (default 1)
4485 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004486 {only available when compiled with |+xim| and
4487 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004488 This option specifies the input style of Input Method:
4489 0 use on-the-spot style
4490 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004491 See: |xim-input-style|
4492
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004493 For a long time on-the-spot style had been used in the GTK version of
4494 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004495 |single-repeat|, etc. Therefore over-the-spot style becomes the
4496 default now. This should work fine for most people, however if you
4497 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004498 The expression will be evaluated in the |sandbox| when set from a
4499 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004500
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 *'include'* *'inc'*
4502'include' 'inc' string (default "^\s*#\s*include")
4503 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 {not available when compiled without the
4505 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004506 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 pattern, just like for the "/" command (See |pattern|). The default
4508 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004509 "]I", "[d", etc.
4510 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004511 comes after the matched pattern. But if "\zs" appears in the pattern
4512 then the text matched from "\zs" to the end, or until "\ze" if it
4513 appears, is used as the file name. Use this to include characters
4514 that are not in 'isfname', such as a space. You can then use
4515 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004516 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517
4518 *'includeexpr'* *'inex'*
4519'includeexpr' 'inex' string (default "")
4520 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004522 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004524 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 :set includeexpr=substitute(v:fname,'\\.','/','g')
4526< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004527
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004529 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 Also used for |<cfile>|.
4531
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004532 If the expression starts with s: or |<SID>|, then it is replaced with
4533 the script ID (|local-function|). Example: >
4534 set includeexpr=s:MyIncludeExpr(v:fname)
4535 set includeexpr=<SID>SomeIncludeExpr(v:fname)
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004536< Otherwise, the expression is evaluated in the context of the script
4537 where the option was set, thus script-local items are available.
4538
Bram Moolenaar30b65812012-07-12 22:01:11 +02004539 The expression will be evaluated in the |sandbox| when set from a
4540 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004541 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004542
4543 It is not allowed to change text or jump to another window while
4544 evaluating 'includeexpr' |textlock|.
4545
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004547'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004548 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004551 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004552 While typing a search command, show where the pattern, as it was typed
4553 so far, matches. The matched string is highlighted. If the pattern
4554 is invalid or not found, nothing is shown. The screen will be updated
4555 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004556 Also applies to the pattern in commands: >
4557 :global
4558 :lvimgrep
4559 :lvimgrepadd
4560 :smagic
4561 :snomagic
4562 :sort
4563 :substitute
4564 :vglobal
4565 :vimgrep
4566 :vimgrepadd
4567< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004568 original position when no match is found and when pressing <Esc>. You
4569 still need to finish the search command with <Enter> to move the
4570 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004571 You can use the CTRL-G and CTRL-T keys to move to the next and
4572 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004573 When compiled with the |+reltime| feature Vim only searches for about
4574 half a second. With a complicated pattern and/or a lot of text the
4575 match may not be found. This is to avoid that Vim hangs while you
4576 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004577 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004578 When 'hlsearch' is on, all matched strings are highlighted too while
4579 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004580 If you don't want to turn 'hlsearch' on, but want to highlight all
4581 matches while searching, you can turn on and off 'hlsearch' with
4582 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004583 augroup vimrc-incsearch-highlight
4584 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004585 autocmd CmdlineEnter /,\? :set hlsearch
4586 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004587 augroup END
4588<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004589 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004590 to the command line. If 'ignorecase' and 'smartcase' are set and the
4591 command line has no uppercase characters, the added character is
4592 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004593 CTRL-R CTRL-W can be used to add the word at the end of the current
4594 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595 NOTE: This option is reset when 'compatible' is set.
4596
4597 *'indentexpr'* *'inde'*
4598'indentexpr' 'inde' string (default "")
4599 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004600 {not available when compiled without the |+eval|
4601 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 Expression which is evaluated to obtain the proper indent for a line.
4603 It is used when a new line is created, for the |=| operator and
4604 in Insert mode as specified with the 'indentkeys' option.
4605 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004606 'smartindent' indenting. When 'lisp' is set, this option is
4607 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004608 When 'paste' is set this option is not used for indenting.
4609 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004610 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004612
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004613 If the expression starts with s: or |<SID>|, then it is replaced with
4614 the script ID (|local-function|). Example: >
4615 set indentexpr=s:MyIndentExpr()
4616 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004617< Otherwise, the expression is evaluated in the context of the script
4618 where the option was set, thus script-local items are available.
4619
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 The expression must return the number of spaces worth of indent. It
4621 can return "-1" to keep the current indent (this means 'autoindent' is
4622 used for the indent).
4623 Functions useful for computing the indent are |indent()|, |cindent()|
4624 and |lispindent()|.
4625 The evaluation of the expression must not have side effects! It must
4626 not change the text, jump to another window, etc. Afterwards the
4627 cursor position is always restored, thus the cursor may be moved.
4628 Normally this option would be set to call a function: >
4629 :set indentexpr=GetMyIndent()
4630< Error messages will be suppressed, unless the 'debug' option contains
4631 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004632 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004633 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634
Bram Moolenaar30b65812012-07-12 22:01:11 +02004635 The expression will be evaluated in the |sandbox| when set from a
4636 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004637 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004638
4639 It is not allowed to change text or jump to another window while
4640 evaluating 'indentexpr' |textlock|.
4641
4642
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004644'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646 A list of keys that, when typed in Insert mode, cause reindenting of
4647 the current line. Only happens if 'indentexpr' isn't empty.
4648 The format is identical to 'cinkeys', see |indentkeys-format|.
4649 See |C-indenting| and |indent-expression|.
4650
4651 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4652'infercase' 'inf' boolean (default off)
4653 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004655 'ignorecase' is also on, the case of the match is adjusted depending
4656 on the typed text. If the typed text contains a lowercase letter
4657 where the match has an upper case letter, the completed part is made
4658 lowercase. If the typed text has no lowercase letters and the match
4659 has a lowercase letter where the typed text has an uppercase letter,
4660 and there is a letter before it, the completed part is made uppercase.
4661 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662
4663 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4664'insertmode' 'im' boolean (default off)
4665 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666 Makes Vim work in a way that Insert mode is the default mode. Useful
4667 if you want to use Vim as a modeless editor. Used for |evim|.
4668 These Insert mode commands will be useful:
4669 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004670 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 this is a mapping, it is executed as if 'insertmode' was off.
4672 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004674 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4675 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676
4677 These items change when 'insertmode' is set:
4678 - when starting to edit of a file, Vim goes to Insert mode.
4679 - <Esc> in Insert mode is a no-op and beeps.
4680 - <Esc> in Normal mode makes Vim go to Insert mode.
4681 - CTRL-L in Insert mode is a command, it is not inserted.
4682 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4683 However, when <Esc> is used inside a mapping, it behaves like
4684 'insertmode' was not set. This was done to be able to use the same
4685 mappings with 'insertmode' set or not set.
4686 When executing commands with |:normal| 'insertmode' is not used.
4687
4688 NOTE: This option is reset when 'compatible' is set.
4689
4690 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004691'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4693 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4694 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4695 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4696 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4697 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698 The characters specified by this option are included in file names and
4699 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004700 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 Multi-byte characters 256 and above are always included, only the
4702 characters up to 255 are specified with this option.
4703 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004704 Think twice before adding white space to this option. Although a
4705 space may appear inside a file name, the effect will be that Vim
4706 doesn't know where a file name starts or ends when doing completion.
4707 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004708
4709 Note that on systems using a backslash as path separator, Vim tries to
4710 do its best to make it work as you would expect. That is a bit
4711 tricky, since Vi originally used the backslash to escape special
4712 characters. Vim will not remove a backslash in front of a normal file
4713 name character on these systems, but it will on Unix and alikes. The
4714 '&' and '^' are not included by default, because these are special for
4715 cmd.exe.
4716
4717 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004718 Each part can be a single character number or a range. A range is two
4719 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 decimal number between 0 and 255 or the ASCII character itself (does
4721 not work for digits). Example:
4722 "_,-,128-140,#-43" (include '_' and '-' and the range
4723 128 to 140 and '#' to 43)
4724 If a part starts with '^', the following character number or range
4725 will be excluded from the option. The option is interpreted from left
4726 to right. Put the excluded character after the range where it is
4727 included. To include '^' itself use it as the last character of the
4728 option or the end of a range. Example:
4729 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4730 If the character is '@', all characters where isalpha() returns TRUE
4731 are included. Normally these are the characters a to z and A to Z,
4732 plus accented characters. To include '@' itself use "@-@". Examples:
4733 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004734 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735 "a-z,A-Z,@-@" All letters plus the '@' character.
4736 A comma can be included by using it where a character number is
4737 expected. Example:
4738 "48-57,,,_" Digits, comma and underscore.
4739 A comma can be excluded by prepending a '^'. Example:
4740 " -~,^,,9" All characters from space to '~', excluding
4741 comma, plus <Tab>.
4742 See |option-backslash| about including spaces and backslashes.
4743
4744 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004745'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004746 "@,48-57,_,128-167,224-235"
4747 otherwise: "@,48-57,_,192-255")
4748 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004749 The characters given by this option are included in identifiers.
4750 Identifiers are used in recognizing environment variables and after a
4751 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004752 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004753 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004755 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4757
4758 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004759'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760 "@,48-57,_,128-167,224-235"
4761 otherwise: "@,48-57,_,192-255"
4762 Vi default: "@,48-57,_")
4763 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004765 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004766 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004767 characters above 255 check the "word" character class (any character
4768 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004769 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770 For a help file it is set to all non-blank printable characters except
4771 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4772 command).
4773 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004774 This option also influences syntax highlighting, unless the syntax
4775 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 NOTE: This option is set to the Vi default value when 'compatible' is
4777 set and to the Vim default value when 'compatible' is reset.
4778
4779 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004780'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781 "@,~-255"; otherwise: "@,161-255")
4782 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 The characters given by this option are displayed directly on the
4784 screen. It is also used for "\p" in a |pattern|. The characters from
4785 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4786 even when they are not included in 'isprint' or excluded. See
4787 'isfname' for a description of the format of this option.
4788
4789 Non-printable characters are displayed with two characters:
4790 0 - 31 "^@" - "^_"
4791 32 - 126 always single characters
4792 127 "^?"
4793 128 - 159 "~@" - "~_"
4794 160 - 254 "| " - "|~"
4795 255 "~?"
4796 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4797 displayed as <xx>, with the hexadecimal value of the byte.
4798 When 'display' contains "uhex" all unprintable characters are
4799 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004800 The SpecialKey highlighting will be used for unprintable characters.
4801 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802
4803 Multi-byte characters 256 and above are always included, only the
4804 characters up to 255 are specified with this option. When a character
4805 is printable but it is not available in the current font, a
4806 replacement character will be shown.
4807 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4808 There is no option to specify these characters.
4809
4810 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4811'joinspaces' 'js' boolean (default on)
4812 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 Insert two spaces after a '.', '?' and '!' with a join command.
4814 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4815 Otherwise only one space is inserted.
4816 NOTE: This option is set when 'compatible' is set.
4817
4818 *'key'*
4819'key' string (default "")
4820 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004821 {only available when compiled with the |+cryptv|
4822 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004824 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004825 Careful: Do not set the key value by hand, someone might see the typed
4826 key. Use the |:X| command. But you can make 'key' empty: >
4827 :set key=
4828< It is not possible to get the value of this option with ":set key" or
4829 "echo &key". This is to avoid showing it to someone who shouldn't
4830 know. It also means you cannot see it yourself once you have set it,
4831 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004832 You can use "&key" in an expression to detect whether encryption is
4833 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834
4835 *'keymap'* *'kmp'* *E544*
4836'keymap' 'kmp' string (default "")
4837 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838 {only available when compiled with the |+keymap|
4839 feature}
4840 Name of a keyboard mapping. See |mbyte-keymap|.
4841 Setting this option to a valid keymap name has the side effect of
4842 setting 'iminsert' to one, so that the keymap becomes effective.
4843 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004844 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845
4846 *'keymodel'* *'km'*
4847'keymodel' 'km' string (default "")
4848 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004849 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850 can do. These values can be used:
4851 startsel Using a shifted special key starts selection (either
4852 Select mode or Visual mode, depending on "key" being
4853 present in 'selectmode').
4854 stopsel Using a not-shifted special key stops selection.
4855 Special keys in this context are the cursor keys, <End>, <Home>,
4856 <PageUp> and <PageDown>.
4857 The 'keymodel' option is set by the |:behave| command.
4858
4859 *'keywordprg'* *'kp'*
4860'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004861 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 Program to use for the |K| command. Environment variables are
4864 expanded |:set_env|. ":help" may be used to access the Vim internal
4865 help. (Note that previously setting the global option to the empty
4866 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004867 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01004868 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004869 When "man", "man -s" or an Ex command is used, Vim will automatically
4870 translate a count for the "K" command and pass it as the first
4871 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 See |option-backslash| about including spaces and backslashes.
4873 Example: >
4874 :set keywordprg=man\ -s
4875< This option cannot be set from a |modeline| or in the |sandbox|, for
4876 security reasons.
4877
4878 *'langmap'* *'lmap'* *E357* *E358*
4879'langmap' 'lmap' string (default "")
4880 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 {only available when compiled with the |+langmap|
4882 feature}
4883 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004884 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004885 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 care of translating these special characters to the original meaning
4887 of the key. This means you don't have to change the keyboard mode to
4888 be able to execute Normal mode commands.
4889 This is the opposite of the 'keymap' option, where characters are
4890 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004891 Also consider setting 'langremap' to off, to prevent 'langmap' from
4892 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004893 This option cannot be set from a |modeline| or in the |sandbox|, for
4894 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004896 Example (for Greek, in UTF-8): *greek* >
4897 :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 +00004898< Example (exchanges meaning of z and y for commands): >
4899 :set langmap=zy,yz,ZY,YZ
4900<
4901 The 'langmap' option is a list of parts, separated with commas. Each
4902 part can be in one of two forms:
4903 1. A list of pairs. Each pair is a "from" character immediately
4904 followed by the "to" character. Examples: "aA", "aAbBcC".
4905 2. A list of "from" characters, a semi-colon and a list of "to"
4906 characters. Example: "abc;ABC"
4907 Example: "aA,fgh;FGH,cCdDeE"
4908 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004909 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910
4911 This will allow you to activate vim actions without having to switch
4912 back and forth between the languages. Your language characters will
4913 be understood as normal vim English characters (according to the
4914 langmap mappings) in the following cases:
4915 o Normal/Visual mode (commands, buffer/register names, user mappings)
4916 o Insert/Replace Mode: Register names after CTRL-R
4917 o Insert/Replace Mode: Mappings
4918 Characters entered in Command-line mode will NOT be affected by
4919 this option. Note that this option can be changed at any time
4920 allowing to switch between mappings for different languages/encodings.
4921 Use a mapping to avoid having to type it each time!
4922
4923 *'langmenu'* *'lm'*
4924'langmenu' 'lm' string (default "")
4925 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004926 {only available when compiled with the |+menu| and
4927 |+multi_lang| features}
4928 Language to use for menu translation. Tells which file is loaded
4929 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004930 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931< (without the spaces). For example, to always use the Dutch menus, no
4932 matter what $LANG is set to: >
4933 :set langmenu=nl_NL.ISO_8859-1
4934< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004935 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004936 If your $LANG is set to a non-English language but you do want to use
4937 the English menus: >
4938 :set langmenu=none
4939< This option must be set before loading menus, switching on filetype
4940 detection or syntax highlighting. Once the menus are defined setting
4941 this option has no effect. But you could do this: >
4942 :source $VIMRUNTIME/delmenu.vim
4943 :set langmenu=de_DE.ISO_8859-1
4944 :source $VIMRUNTIME/menu.vim
4945< Warning: This deletes all menus that you defined yourself!
4946
Bram Moolenaard94464e2015-11-02 15:28:18 +01004947 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004948'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004949 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004950 {only available when compiled with the |+langmap|
4951 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004952 This is just like 'langremap' but with the value inverted. It only
4953 exists for backwards compatibility. When setting 'langremap' then
4954 'langnoremap' is set to the inverted value, and the other way around.
4955
4956 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004957'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004958 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004959 {only available when compiled with the |+langmap|
4960 feature}
4961 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004962 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004963 'langmap' disables some of your mappings, try resetting this option.
4964 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004965 that works for you to avoid mappings to break.
4966
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967 *'laststatus'* *'ls'*
4968'laststatus' 'ls' number (default 1)
4969 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 The value of this option influences when the last window will have a
4971 status line:
4972 0: never
4973 1: only if there are at least two windows
4974 2: always
4975 The screen looks nicer with a status line if you have several
4976 windows, but it takes another screen line. |status-line|
4977
4978 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4979'lazyredraw' 'lz' boolean (default off)
4980 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 When this option is set, the screen will not be redrawn while
4982 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004983 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01004985 This may occasionally cause display errors. It is only meant to be set
4986 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01004987 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988
4989 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4990'linebreak' 'lbr' boolean (default off)
4991 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004992 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004994 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995 than at the last character that fits on the screen. Unlike
4996 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004997 it only affects the way the file is displayed, not its contents.
4998 If 'breakindent' is set, line is visually indented. Then, the value
4999 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005000 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 Note that <Tab> characters after an <EOL> are mostly not displayed
5002 with the right amount of white space.
5003
5004 *'lines'* *E593*
5005'lines' number (default 24 or terminal height)
5006 global
5007 Number of lines of the Vim window.
5008 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005009 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005010 When Vim is running in the GUI or in a resizable window, setting this
5011 option will cause the window size to be changed. When you only want
5012 to use the size for the GUI, put the command in your |gvimrc| file.
5013 Vim limits the number of lines to what fits on the screen. You can
5014 use this command to get the tallest window possible: >
5015 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005016< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005017 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018 When you set this option and Vim is unable to change the physical
5019 number of lines of the display, the display may be messed up.
5020
5021 *'linespace'* *'lsp'*
5022'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005024 {only in the GUI}
5025 Number of pixel lines inserted between characters. Useful if the font
5026 uses the full character cell height, making lines touch each other.
5027 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005028 With some fonts there can be too much room between lines (to have
5029 space for ascents and descents). Then it makes sense to set
5030 'linespace' to a negative value. This may cause display problems
5031 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005032
5033 *'lisp'* *'nolisp'*
5034'lisp' boolean (default off)
5035 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 Lisp mode: When <Enter> is typed in insert mode set the indent for
5037 the next line to Lisp standards (well, sort of). Also happens with
5038 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5039 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5040 better. Also see 'lispwords'.
5041 The '-' character is included in keyword characters. Redefines the
5042 "=" operator to use this same indentation algorithm rather than
5043 calling an external program if 'equalprg' is empty.
5044 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045
5046 *'lispwords'* *'lw'*
5047'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005048 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005049 Comma-separated list of words that influence the Lisp indenting when
5050 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051
5052 *'list'* *'nolist'*
5053'list' boolean (default off)
5054 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005055 List mode: By default show tabs as CTRL-I is displayed, display $
5056 after end of line. Useful to see the difference between tabs and
5057 spaces and for trailing blanks. Further changed by the 'listchars'
5058 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005059
5060 The cursor is displayed at the start of the space a Tab character
5061 occupies, not at the end as usual in Normal mode. To get this cursor
5062 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005063 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005064<
5065 Note that list mode will also affect formatting (set with 'textwidth'
5066 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 changing the way tabs are displayed.
5068
5069 *'listchars'* *'lcs'*
5070'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005071 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005072 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005073 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005074 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 eol:c Character to show at the end of each line. When
5076 omitted, there is no extra character at the end of the
5077 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005078 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005079 tab:xy[z] Two or three characters to be used to show a tab.
5080 The third character is optional.
5081
5082 tab:xy The 'x' is always used, then 'y' as many times as will
5083 fit. Thus "tab:>-" displays:
5084 >
5085 >-
5086 >--
5087 etc.
5088
5089 tab:xyz The 'z' is always used, then 'x' is prepended, and
5090 then 'y' is used as many times as will fit. Thus
5091 "tab:<->" displays:
5092 >
5093 <>
5094 <->
5095 <-->
5096 etc.
5097
5098 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005099 *lcs-space*
5100 space:c Character to show for a space. When omitted, spaces
5101 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005102 *lcs-multispace*
5103 multispace:c...
5104 One or more characters to use cyclically to show for
5105 multiple consecutive spaces. Overrides the "space"
5106 setting, except for single spaces. When omitted, the
5107 "space" setting is used. For example,
5108 `:set listchars=multispace:---+` shows ten consecutive
5109 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005110 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005111 *lcs-lead*
5112 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005113 leading spaces are blank. Overrides the "space" and
5114 "multispace" settings for leading spaces. You can
5115 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005116 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005117< *lcs-leadmultispace*
5118 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005119 Like the |lcs-multispace| value, but for leading
5120 spaces only. Also overrides |lcs-lead| for leading
5121 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005122 `:set listchars=leadmultispace:---+` shows ten
5123 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005124 ---+---+--XXX ~
5125 Where "XXX" denotes the first non-blank characters in
5126 the line.
5127 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005128 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005129 trailing spaces are blank. Overrides the "space" and
5130 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005131 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132 extends:c Character to show in the last column, when 'wrap' is
5133 off and the line continues beyond the right of the
5134 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005135 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005136 precedes:c Character to show in the first visible column of the
5137 physical line, when there is text preceding the
5138 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005139 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005140 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005141 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005142 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005143 nbsp:c Character to show for a non-breakable space character
5144 (0xA0 (160 decimal) and U+202F). Left blank when
5145 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005146
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005147 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005149 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005150
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005151 Each character can be specified as hex: >
5152 set listchars=eol:\\x24
5153 set listchars=eol:\\u21b5
5154 set listchars=eol:\\U000021b5
5155< Note that a double backslash is used. The number of hex characters
5156 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5157
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 Examples: >
5159 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005160 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161 :set lcs=extends:>,precedes:<
5162< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005163 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5164 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005165 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005166
5167 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5168'loadplugins' 'lpl' boolean (default on)
5169 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 When on the plugin scripts are loaded when starting up |load-plugins|.
5171 This option can be reset in your |vimrc| file to disable the loading
5172 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005173 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5174 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175
Bram Moolenaard94464e2015-11-02 15:28:18 +01005176 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005177'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005178 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005179 {only available when compiled with the |+lua/dyn|
5180 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005181 Specifies the name of the Lua shared library. The default is
5182 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005183 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005184 This option cannot be set from a |modeline| or in the |sandbox|, for
5185 security reasons.
5186
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005187 *'macatsui'* *'nomacatsui'*
5188'macatsui' boolean (default on)
5189 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005190 {not supported}
5191 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005192
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 *'magic'* *'nomagic'*
5194'magic' boolean (default on)
5195 global
5196 Changes the special characters that can be used in search patterns.
5197 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005198 WARNING: Switching this option off most likely breaks plugins! That
5199 is because many patterns assume it's on and will fail when it's off.
5200 Only switch it off when working with old Vi scripts. In any other
5201 situation write patterns that work when 'magic' is on. Include "\M"
5202 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005203 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5204 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205
5206 *'makeef'* *'mef'*
5207'makeef' 'mef' string (default: "")
5208 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 {not available when compiled without the |+quickfix|
5210 feature}
5211 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5212 and the |:grep| command.
5213 When it is empty, an internally generated temp file will be used.
5214 When "##" is included, it is replaced by a number to make the name
5215 unique. This makes sure that the ":make" command doesn't overwrite an
5216 existing file.
5217 NOT used for the ":cf" command. See 'errorfile' for that.
5218 Environment variables are expanded |:set_env|.
5219 See |option-backslash| about including spaces and backslashes.
5220 This option cannot be set from a |modeline| or in the |sandbox|, for
5221 security reasons.
5222
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005223 *'makeencoding'* *'menc'*
5224'makeencoding' 'menc' string (default "")
5225 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005226 Encoding used for reading the output of external commands. When empty,
5227 encoding is not converted.
5228 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5229 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5230 and `:laddfile`.
5231
5232 This would be mostly useful when you use MS-Windows and set 'encoding'
5233 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5234 'makeencoding' to "char" has the same effect as setting to the system
5235 locale encoding. Example: >
5236 :set encoding=utf-8
5237 :set makeencoding=char " system locale is used
5238<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005239 *'makeprg'* *'mp'*
5240'makeprg' 'mp' string (default "make", VMS: "MMS")
5241 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005242 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005243 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5244 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005245 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005246 Environment variables are expanded |:set_env|. See |option-backslash|
5247 about including spaces and backslashes.
5248 Note that a '|' must be escaped twice: once for ":set" and once for
5249 the interpretation of a command. When you use a filter called
5250 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005251 :set makeprg=gmake\ \\\|\ myfilter
5252< The placeholder "$*" can be given (even multiple times) to specify
5253 where the arguments will be included, for example: >
5254 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5255< This option cannot be set from a |modeline| or in the |sandbox|, for
5256 security reasons.
5257
5258 *'matchpairs'* *'mps'*
5259'matchpairs' 'mps' string (default "(:),{:},[:]")
5260 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005261 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005262 other.
5263 Only character pairs are allowed that are different, thus you cannot
5264 jump between two double quotes.
5265 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005266 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005267 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268 :set mps+=<:>
5269
5270< A more exotic example, to jump between the '=' and ';' in an
5271 assignment, useful for languages like C and Java: >
5272 :au FileType c,cpp,java set mps+==:;
5273
5274< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005275 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276
5277 *'matchtime'* *'mat'*
5278'matchtime' 'mat' number (default 5)
5279 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 Tenths of a second to show the matching paren, when 'showmatch' is
5281 set. Note that this is not in milliseconds, like other options that
5282 set a time. This is to be compatible with Nvi.
5283
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005284 *'maxcombine'* *'mco'*
5285'maxcombine' 'mco' number (default 2)
5286 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005287 The maximum number of combining characters supported for displaying.
5288 Only used when 'encoding' is "utf-8".
5289 The default is OK for most languages. Hebrew may require 4.
5290 Maximum value is 6.
5291 Even when this option is set to 2 you can still edit text with more
5292 combining characters, you just can't see them. Use |g8| or |ga|.
5293 See |mbyte-combining|.
5294
Bram Moolenaar071d4272004-06-13 20:20:40 +00005295 *'maxfuncdepth'* *'mfd'*
5296'maxfuncdepth' 'mfd' number (default 100)
5297 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005298 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005299 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 Maximum depth of function calls for user functions. This normally
5301 catches endless recursion. When using a recursive function with
5302 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5303 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005304 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005305 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005306 See also |:function|.
5307
5308 *'maxmapdepth'* *'mmd'* *E223*
5309'maxmapdepth' 'mmd' number (default 1000)
5310 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 Maximum number of times a mapping is done without resulting in a
5312 character to be used. This normally catches endless mappings, like
5313 ":map x y" with ":map y x". It still does not catch ":map g wg",
5314 because the 'w' is used before the next mapping is done. See also
5315 |key-mapping|.
5316
5317 *'maxmem'* *'mm'*
5318'maxmem' 'mm' number (default between 256 to 5120 (system
5319 dependent) or half the amount of memory
5320 available)
5321 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005322 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5323 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005324 other memory to be freed.
5325 The maximum usable value is about 2000000. Use this to work without a
5326 limit.
5327 The value is ignored when 'swapfile' is off.
5328 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005329
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005330 *'maxmempattern'* *'mmp'*
5331'maxmempattern' 'mmp' number (default 1000)
5332 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005333 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005334 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005335 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005336 When Vim runs into the limit it gives an error message and mostly
5337 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005338 Running into the limit often means that the pattern is very
5339 inefficient or too complex. This may already happen with the pattern
5340 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005341 Might also happen on redraw, when syntax rules try to match a complex
5342 text structure.
5343 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5344 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005345
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346 *'maxmemtot'* *'mmt'*
5347'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5348 dependent) or half the amount of memory
5349 available)
5350 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005351 Maximum amount of memory in Kbyte to use for all buffers together.
5352 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005353 without a limit.
5354 On 64 bit machines higher values might work. But hey, do you really
5355 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005356 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005357 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005358 Buffers with 'swapfile' off still count to the total amount of memory
5359 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005360 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005361
5362 *'menuitems'* *'mis'*
5363'menuitems' 'mis' number (default 25)
5364 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005365 {not available when compiled without the |+menu|
5366 feature}
5367 Maximum number of items to use in a menu. Used for menus that are
5368 generated from a list of items, e.g., the Buffers menu. Changing this
5369 option has no direct effect, the menu must be refreshed first.
5370
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005371 *'mkspellmem'* *'msm'*
5372'mkspellmem' 'msm' string (default "460000,2000,500")
5373 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005374 {not available when compiled without the |+syntax|
5375 feature}
5376 Parameters for |:mkspell|. This tunes when to start compressing the
5377 word tree. Compression can be slow when there are many words, but
5378 it's needed to avoid running out of memory. The amount of memory used
5379 per word depends very much on how similar the words are, that's why
5380 this tuning is complicated.
5381
5382 There are three numbers, separated by commas:
5383 {start},{inc},{added}
5384
5385 For most languages the uncompressed word tree fits in memory. {start}
5386 gives the amount of memory in Kbyte that can be used before any
5387 compression is done. It should be a bit smaller than the amount of
5388 memory that is available to Vim.
5389
5390 When going over the {start} limit the {inc} number specifies the
5391 amount of memory in Kbyte that can be allocated before another
5392 compression is done. A low number means compression is done after
5393 less words are added, which is slow. A high number means more memory
5394 will be allocated.
5395
5396 After doing compression, {added} times 1024 words can be added before
5397 the {inc} limit is ignored and compression is done when any extra
5398 amount of memory is needed. A low number means there is a smaller
5399 chance of hitting the {inc} limit, less memory is used but it's
5400 slower.
5401
5402 The languages for which these numbers are important are Italian and
5403 Hungarian. The default works for when you have about 512 Mbyte. If
5404 you have 1 Gbyte you could use: >
5405 :set mkspellmem=900000,3000,800
5406< If you have less than 512 Mbyte |:mkspell| may fail for some
5407 languages, no matter what you set 'mkspellmem' to.
5408
Bram Moolenaar07607392019-05-26 19:20:43 +02005409 This option cannot be set from a |modeline| or in the |sandbox|.
5410
Bram Moolenaar071d4272004-06-13 20:20:40 +00005411 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005412'modeline' 'ml' boolean (Vim default: on (off for root),
5413 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005415 If 'modeline' is on 'modelines' gives the number of lines that is
5416 checked for set commands. If 'modeline' is off or 'modelines' is zero
5417 no lines are checked. See |modeline|.
5418
5419 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5420'modelineexpr' 'mle' boolean (default: off)
5421 global
5422 When on allow some options that are an expression to be set in the
5423 modeline. Check the option for whether it is affected by
5424 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005425 This option cannot be set from a |modeline| or in the |sandbox|, for
5426 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005427
Bram Moolenaar071d4272004-06-13 20:20:40 +00005428 *'modelines'* *'mls'*
5429'modelines' 'mls' number (default 5)
5430 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431 If 'modeline' is on 'modelines' gives the number of lines that is
5432 checked for set commands. If 'modeline' is off or 'modelines' is zero
5433 no lines are checked. See |modeline|.
5434 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5435 set and to the Vim default value when 'compatible' is reset.
5436
5437 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005438 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439'modifiable' 'ma' boolean (default on)
5440 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 When off the buffer contents cannot be changed. The 'fileformat' and
5442 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005443 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444
5445 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5446'modified' 'mod' boolean (default off)
5447 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448 When on, the buffer is considered to be modified. This option is set
5449 when:
5450 1. A change was made to the text since it was last written. Using the
5451 |undo| command to go back to the original text will reset the
5452 option. But undoing changes that were made before writing the
5453 buffer will set the option again, since the text is different from
5454 when it was written.
5455 2. 'fileformat' or 'fileencoding' is different from its original
5456 value. The original value is set when the buffer is read or
5457 written. A ":set nomodified" command also resets the original
5458 values to the current values and the 'modified' option will be
5459 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005460 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005461 This option is not set when a change is made to the buffer as the
5462 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5463 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5464 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5466 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005467 Note that the text may actually be the same, e.g. 'modified' is set
5468 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469
5470 *'more'* *'nomore'*
5471'more' boolean (Vim default: on, Vi default: off)
5472 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005473 When on, listings pause when the whole screen is filled. You will get
5474 the |more-prompt|. When this option is off there are no pauses, the
5475 listing continues until finished.
5476 NOTE: This option is set to the Vi default value when 'compatible' is
5477 set and to the Vim default value when 'compatible' is reset.
5478
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005479 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005480'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005481 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005483 Enable the use of the mouse. Works for most terminals (xterm, Win32
5484 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5485 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5486 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005487 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488 v Visual mode
5489 i Insert mode
5490 c Command-line mode
5491 h all previous modes when editing a help file
5492 a all previous modes
5493 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005494 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005496< If your terminal can't overrule the mouse events going to the
5497 application, use: >
5498 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005499< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005500 back to Vim using the mouse events.
5501 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5502 "xterm".
5503
5504 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505 modeless selection. This doesn't move the text cursor.
5506
5507 See |mouse-using|. Also see |'clipboard'|.
5508
5509 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005510 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005511 the mouse buttons can still be used by keeping the shift key pressed.
5512 Also see the 'clipboard' option.
5513
5514 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5515'mousefocus' 'mousef' boolean (default off)
5516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005517 {only works in the GUI}
5518 The window that the mouse pointer is on is automatically activated.
5519 When changing the window layout or window focus in another way, the
5520 mouse pointer is moved to the window with keyboard focus. Off is the
5521 default because it makes using the pull down menus a little goofy, as
5522 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005523 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005524 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525
5526 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5527'mousehide' 'mh' boolean (default on)
5528 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005529 {only works in the GUI}
5530 When on, the mouse pointer is hidden when characters are typed.
5531 The mouse pointer is restored when the mouse is moved.
5532
5533 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005534'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005536 Sets the model to use for the mouse. The name mostly specifies what
5537 the right mouse button is used for:
5538 extend Right mouse button extends a selection. This works
5539 like in an xterm.
5540 popup Right mouse button pops up a menu. The shifted left
5541 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005542 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543 popup_setpos Like "popup", but the cursor will be moved to the
5544 position where the mouse was clicked, and thus the
5545 selected operation will act upon the clicked object.
5546 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005547 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 course, that right clicking outside a selection will
5549 end Visual mode.
5550 Overview of what button does what for each model:
5551 mouse extend popup(_setpos) ~
5552 left click place cursor place cursor
5553 left drag start selection start selection
5554 shift-left search word extend selection
5555 right click extend selection popup menu (place cursor)
5556 right drag extend selection -
5557 middle click paste paste
5558
5559 In the "popup" model the right mouse button produces a pop-up menu.
5560 You need to define this first, see |popup-menu|.
5561
5562 Note that you can further refine the meaning of buttons with mappings.
5563 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5564 selection (because that's handled in the GUI code directly).
5565
5566 The 'mousemodel' option is set by the |:behave| command.
5567
Ernie Raelc4cb5442022-04-03 15:47:28 +01005568 *'mousemoveevent'* *'mousemev'*
5569'mousemoveevent' 'mousemev' boolean (default off)
5570 global
5571 {only works in the GUI}
5572 When on, mouse move events are delivered to the input queue and are
5573 available for mapping. The default, off, avoids the mouse movement
5574 overhead except when needed. See |gui-mouse-mapping|.
5575 Warning: Setting this option can make pending mappings to be aborted
5576 when the mouse is moved.
5577 Currently only works in the GUI, may be made to work in a terminal
5578 later.
5579
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005581'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5582 vs:leftright,vd:lrsizing,m:no,
5583 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005584 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585 {only available when compiled with the |+mouseshape|
5586 feature}
5587 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005588 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 like used for 'guicursor'. Each part consist of a mode/location-list
5590 and an argument-list:
5591 mode-list:shape,mode-list:shape,..
5592 The mode-list is a dash separated list of these modes/locations:
5593 In a normal window: ~
5594 n Normal mode
5595 v Visual mode
5596 ve Visual mode with 'selection' "exclusive" (same as 'v',
5597 if not specified)
5598 o Operator-pending mode
5599 i Insert mode
5600 r Replace mode
5601
5602 Others: ~
5603 c appending to the command-line
5604 ci inserting in the command-line
5605 cr replacing in the command-line
5606 m at the 'Hit ENTER' or 'More' prompts
5607 ml idem, but cursor in the last line
5608 e any mode, pointer below last window
5609 s any mode, pointer on a status line
5610 sd any mode, while dragging a status line
5611 vs any mode, pointer on a vertical separator line
5612 vd any mode, while dragging a vertical separator line
5613 a everywhere
5614
5615 The shape is one of the following:
5616 avail name looks like ~
5617 w x arrow Normal mouse pointer
5618 w x blank no pointer at all (use with care!)
5619 w x beam I-beam
5620 w x updown up-down sizing arrows
5621 w x leftright left-right sizing arrows
5622 w x busy The system's usual busy pointer
5623 w x no The system's usual 'no input' pointer
5624 x udsizing indicates up-down resizing
5625 x lrsizing indicates left-right resizing
5626 x crosshair like a big thin +
5627 x hand1 black hand
5628 x hand2 white hand
5629 x pencil what you write with
5630 x question big ?
5631 x rightup-arrow arrow pointing right-up
5632 w x up-arrow arrow pointing up
5633 x <number> any X11 pointer number (see X11/cursorfont.h)
5634
5635 The "avail" column contains a 'w' if the shape is available for Win32,
5636 x for X11.
5637 Any modes not specified or shapes not available use the normal mouse
5638 pointer.
5639
5640 Example: >
5641 :set mouseshape=s:udsizing,m:no
5642< will make the mouse turn to a sizing arrow over the status lines and
5643 indicate no input when the hit-enter prompt is displayed (since
5644 clicking the mouse has no effect in this state.)
5645
5646 *'mousetime'* *'mouset'*
5647'mousetime' 'mouset' number (default 500)
5648 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005649 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005650 time in msec between two mouse clicks for the second click to be
5651 recognized as a multi click.
5652
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005653 *'mzschemedll'*
5654'mzschemedll' string (default depends on the build)
5655 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005656 {only available when compiled with the |+mzscheme/dyn|
5657 feature}
5658 Specifies the name of the MzScheme shared library. The default is
5659 DYNAMIC_MZSCH_DLL which was specified at compile time.
5660 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005661 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005662 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005663 This option cannot be set from a |modeline| or in the |sandbox|, for
5664 security reasons.
5665
5666 *'mzschemegcdll'*
5667'mzschemegcdll' string (default depends on the build)
5668 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005669 {only available when compiled with the |+mzscheme/dyn|
5670 feature}
5671 Specifies the name of the MzScheme GC shared library. The default is
5672 DYNAMIC_MZGC_DLL which was specified at compile time.
5673 The value can be equal to 'mzschemedll' if it includes the GC code.
5674 Environment variables are expanded |:set_env|.
5675 This option cannot be set from a |modeline| or in the |sandbox|, for
5676 security reasons.
5677
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005678 *'mzquantum'* *'mzq'*
5679'mzquantum' 'mzq' number (default 100)
5680 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005681 {not available when compiled without the |+mzscheme|
5682 feature}
5683 The number of milliseconds between polls for MzScheme threads.
5684 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005685 NOTE: This option is set to the Vim default value when 'compatible'
5686 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005687
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005689'nrformats' 'nf' string (default "bin,octal,hex",
5690 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 This defines what bases Vim will consider for numbers when using the
5693 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5694 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005695 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005697 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005698 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005700 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 considered to be hexadecimal. Example: Using CTRL-X on
5702 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005703 bin If included, numbers starting with "0b" or "0B" will be
5704 considered to be binary. Example: Using CTRL-X on
5705 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005706 unsigned If included, numbers are recognized as unsigned. Thus a
5707 leading dash or negative sign won't be considered as part of
5708 the number. Examples:
5709 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5710 (without "unsigned" it would become "9-2021").
5711 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5712 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005713 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5714 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005715 Numbers which simply begin with a digit in the range 1-9 are always
5716 considered decimal. This also happens for numbers that are not
5717 recognized as octal or hex.
5718
5719 *'number'* *'nu'* *'nonumber'* *'nonu'*
5720'number' 'nu' boolean (default off)
5721 local to window
5722 Print the line number in front of each line. When the 'n' option is
5723 excluded from 'cpoptions' a wrapped line will not use the column of
5724 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005725 The 'numberwidth' option can be used to set the room used for the line
5726 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 When a long, wrapped line doesn't start with the first character, '-'
5728 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005729 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5730 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005731 *number_relativenumber*
5732 The 'relativenumber' option changes the displayed number to be
5733 relative to the cursor. Together with 'number' there are these
5734 four combinations (cursor in line 3):
5735
Bram Moolenaar3848e002016-03-19 18:42:29 +01005736 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005737 'nornu' 'nornu' 'rnu' 'rnu'
5738
5739 |apple | 1 apple | 2 apple | 2 apple
5740 |pear | 2 pear | 1 pear | 1 pear
5741 |nobody | 3 nobody | 0 nobody |3 nobody
5742 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005744 *'numberwidth'* *'nuw'*
5745'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5746 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005747 {only available when compiled with the |+linebreak|
5748 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005749 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005750 when the 'number' or 'relativenumber' option is set or printing lines
5751 with a line number. Since one space is always between the number and
5752 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005753 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005754 fit the highest line number in the buffer respectively the number of
5755 rows in the window, depending on whether 'number' or 'relativenumber'
5756 is set. Thus with the Vim default of 4 there is room for a line number
5757 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005758 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005759 NOTE: This option is set to the Vi default value when 'compatible' is
5760 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005761
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005762 *'omnifunc'* *'ofu'*
5763'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005764 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005765 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005766 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005767 This option specifies a function to be used for Insert mode omni
5768 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005769 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005770 invoked and what it should return. The value can be the name of a
5771 function, a |lambda| or a |Funcref|. See |option-value-function| for
5772 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005773 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005774 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005775 This option cannot be set from a |modeline| or in the |sandbox|, for
5776 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005777
5778
Bram Moolenaar02467872007-05-06 13:22:01 +00005779 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005780'opendevice' 'odev' boolean (default off)
5781 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005782 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005783 Enable reading and writing from devices. This may get Vim stuck on a
5784 device that can be opened but doesn't actually do the I/O. Therefore
5785 it is off by default.
5786 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5787 result in editing a device.
5788
5789
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005790 *'operatorfunc'* *'opfunc'*
5791'operatorfunc' 'opfunc' string (default: empty)
5792 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005793 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005794 See |:map-operator| for more info and an example. The value can be
5795 the name of a function, a |lambda| or a |Funcref|. See
5796 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005797
5798 This option cannot be set from a |modeline| or in the |sandbox|, for
5799 security reasons.
5800
5801
Bram Moolenaar251e1912011-06-19 05:09:16 +02005802 *'osfiletype'* *'oft'*
5803'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005804 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005805 This option was supported on RISC OS, which has been removed.
5806
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005808 *'packpath'* *'pp'*
5809'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005810 Directories used to find packages. See |packages|.
5811
5812
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005814'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815 global
5816 Specifies the nroff macros that separate paragraphs. These are pairs
5817 of two letters (see |object-motions|).
5818
5819 *'paste'* *'nopaste'*
5820'paste' boolean (default off)
5821 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005822 Put Vim in Paste mode. This is useful if you want to cut or copy
5823 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824 unexpected effects.
5825 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005826 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005827 knows about pasting and will mostly do the right thing without 'paste'
5828 being set. The same is true for a terminal where Vim handles the
5829 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005830 This option is reset when starting the GUI. Thus if you set it in
5831 your .vimrc it will work in a terminal, but not in the GUI. Setting
5832 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5833 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005834 When the 'paste' option is switched on (also when it was already on):
5835 - mapping in Insert mode and Command-line mode is disabled
5836 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005838 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005839 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005840 - 'revins' is reset
5841 - 'ruler' is reset
5842 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005843 - 'smarttab' is reset
5844 - 'softtabstop' is set to 0
5845 - 'textwidth' is set to 0
5846 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005847 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005848 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005850 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005851 - 'indentexpr'
5852 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005853 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005854 NOTE: When you start editing another file while the 'paste' option is
5855 on, settings from the modelines or autocommands may change the
5856 settings again, causing trouble when pasting text. You might want to
5857 set the 'paste' option again.
5858 When the 'paste' option is reset the mentioned options are restored to
5859 the value before the moment 'paste' was switched from off to on.
5860 Resetting 'paste' before ever setting it does not have any effect.
5861 Since mapping doesn't work while 'paste' is active, you need to use
5862 the 'pastetoggle' option to toggle the 'paste' option with some key.
5863
5864 *'pastetoggle'* *'pt'*
5865'pastetoggle' 'pt' string (default "")
5866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005867 When non-empty, specifies the key sequence that toggles the 'paste'
5868 option. This is like specifying a mapping: >
5869 :map {keys} :set invpaste<CR>
5870< Where {keys} is the value of 'pastetoggle'.
5871 The difference is that it will work even when 'paste' is set.
5872 'pastetoggle' works in Insert mode and Normal mode, but not in
5873 Command-line mode.
5874 Mappings are checked first, thus overrule 'pastetoggle'. However,
5875 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5876 this: >
5877 :map <F10> :set paste<CR>
5878 :map <F11> :set nopaste<CR>
5879 :imap <F10> <C-O>:set paste<CR>
5880 :imap <F11> <nop>
5881 :set pastetoggle=<F11>
5882< This will make <F10> start paste mode and <F11> stop paste mode.
5883 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5884 mode everything is inserted literally, except the 'pastetoggle' key
5885 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005886 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005887
5888 *'pex'* *'patchexpr'*
5889'patchexpr' 'pex' string (default "")
5890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891 {not available when compiled without the |+diff|
5892 feature}
5893 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005894 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005895
Bram Moolenaardbc28022014-07-26 13:40:44 +02005896 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897'patchmode' 'pm' string (default "")
5898 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 When non-empty the oldest version of a file is kept. This can be used
5900 to keep the original version of a file if you are changing files in a
5901 source distribution. Only the first time that a file is written a
5902 copy of the original file will be kept. The name of the copy is the
5903 name of the original file with the string in the 'patchmode' option
5904 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005905 ".orig" or ".org". 'backupdir' must not be empty for this to work
5906 (Detail: The backup file is renamed to the patchmode file after the
5907 new file has been successfully written, that's why it must be possible
5908 to write a backup file). If there was no file to be backed up, an
5909 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910 When the 'backupskip' pattern matches, a patchmode file is not made.
5911 Using 'patchmode' for compressed files appends the extension at the
5912 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5913 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005914 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005915
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005916 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918 other systems: ".,,")
5919 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005921 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5922 provided that the file being searched for has a relative path (not
5923 starting with "/", "./" or "../"). The directories in the 'path'
5924 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 - Use commas to separate directory names: >
5926 :set path=.,/usr/local/include,/usr/include
5927< - Spaces can also be used to separate directory names (for backwards
5928 compatibility with version 3.0). To have a space in a directory
5929 name, precede it with an extra backslash, and escape the space: >
5930 :set path=.,/dir/with\\\ space
5931< - To include a comma in a directory name precede it with an extra
5932 backslash: >
5933 :set path=.,/dir/with\\,comma
5934< - To search relative to the directory of the current file, use: >
5935 :set path=.
5936< - To search in the current directory use an empty string between two
5937 commas: >
5938 :set path=,,
5939< - A directory name may end in a ':' or '/'.
5940 - Environment variables are expanded |:set_env|.
5941 - When using |netrw.vim| URLs can be used. For example, adding
5942 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005943 - Search upwards and downwards in a directory tree using "*", "**" and
5944 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005945 - Careful with '\' characters, type two to get one in the option: >
5946 :set path=.,c:\\include
5947< Or just use '/' instead: >
5948 :set path=.,c:/include
5949< Don't forget "." or files won't even be found in the same directory as
5950 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005951 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005952 it is something like 256 or 1024 characters.
5953 You can check if all the include files are found, using the value of
5954 'path', see |:checkpath|.
5955 The use of |:set+=| and |:set-=| is preferred when adding or removing
5956 directories from the list. This avoids problems when a future version
5957 uses another default. To remove the current directory use: >
5958 :set path-=
5959< To add the current directory use: >
5960 :set path+=
5961< To use an environment variable, you probably need to replace the
5962 separator. Here is an example to append $INCL, in which directory
5963 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005964 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005965< Replace the ';' with a ':' or whatever separator is used. Note that
5966 this doesn't work when $INCL contains a comma or white space.
5967
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005968 *'perldll'*
5969'perldll' string (default depends on the build)
5970 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005971 {only available when compiled with the |+perl/dyn|
5972 feature}
5973 Specifies the name of the Perl shared library. The default is
5974 DYNAMIC_PERL_DLL, which was specified at compile time.
5975 Environment variables are expanded |:set_env|.
5976 This option cannot be set from a |modeline| or in the |sandbox|, for
5977 security reasons.
5978
Bram Moolenaar071d4272004-06-13 20:20:40 +00005979 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5980'preserveindent' 'pi' boolean (default off)
5981 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005982 When changing the indent of the current line, preserve as much of the
5983 indent structure as possible. Normally the indent is replaced by a
5984 series of tabs followed by spaces as required (unless |'expandtab'| is
5985 enabled, in which case only spaces are used). Enabling this option
5986 means the indent will preserve as many existing characters as possible
5987 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005988 'expandtab' does not apply to the preserved white space, a Tab remains
5989 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005990 NOTE: When using ">>" multiple times the resulting indent is a mix of
5991 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005992 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005993 Also see 'copyindent'.
5994 Use |:retab| to clean up white space.
5995
5996 *'previewheight'* *'pvh'*
5997'previewheight' 'pvh' number (default 12)
5998 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005999 {not available when compiled without the |+quickfix|
6000 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006002 commands. Used for |CTRL-W_}| when no count is given. Not used when
6003 'previewpopup' is set.
6004
6005 *'previewpopup'* *'pvp'*
6006'previewpopup' 'pvp' string (default empty)
6007 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006008 {not available when compiled without the |+textprop|
6009 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006010 When not empty a popup window is used for commands that would open a
6011 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006012 Not used for the insert completion info, add "popup" to
6013 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006014
6015 *'previewwindow'* *'nopreviewwindow'*
6016 *'pvw'* *'nopvw'* *E590*
6017'previewwindow' 'pvw' boolean (default off)
6018 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006019 {not available when compiled without the |+quickfix|
6020 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006021 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006022 set. It's normally not set directly, but by using one of the commands
6023 |:ptag|, |:pedit|, etc.
6024
6025 *'printdevice'* *'pdev'*
6026'printdevice' 'pdev' string (default empty)
6027 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028 {only available when compiled with the |+printer|
6029 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006030 The name of the printer to be used for |:hardcopy|.
6031 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006032 This option cannot be set from a |modeline| or in the |sandbox|, for
6033 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006034
Bram Moolenaar8299df92004-07-10 09:47:34 +00006035 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006036'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006037 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 {only available when compiled with the |+printer|
6039 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006040 Sets the character encoding used when printing.
6041 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042
6043 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006044'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046 {only available when compiled with the |+printer|
6047 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006048 Expression used to print the PostScript produced with |:hardcopy|.
6049 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006050 This option cannot be set from a |modeline| or in the |sandbox|, for
6051 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006052
Bram Moolenaar8299df92004-07-10 09:47:34 +00006053 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054'printfont' 'pfn' string (default "courier")
6055 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006056 {only available when compiled with the |+printer|
6057 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006058 The name of the font that will be used for |:hardcopy|.
6059 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006060
6061 *'printheader'* *'pheader'*
6062'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6063 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006064 {only available when compiled with the |+printer|
6065 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006066 The format of the header produced in |:hardcopy| output.
6067 See |pheader-option|.
6068
6069 *'printmbcharset'* *'pmbcs'*
6070'printmbcharset' 'pmbcs' string (default "")
6071 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006072 {only available when compiled with the |+printer|
6073 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006074 The CJK character set to be used for CJK output from |:hardcopy|.
6075 See |pmbcs-option|.
6076
6077 *'printmbfont'* *'pmbfn'*
6078'printmbfont' 'pmbfn' string (default "")
6079 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006080 {only available when compiled with the |+printer|
6081 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006082 List of font names to be used for CJK output from |:hardcopy|.
6083 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084
6085 *'printoptions'* *'popt'*
6086'printoptions' 'popt' string (default "")
6087 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006088 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006089 List of items that control the format of the output of |:hardcopy|.
6090 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006092 *'prompt'* *'noprompt'*
6093'prompt' boolean (default on)
6094 global
6095 When on a ":" prompt is used in Ex mode.
6096
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006097 *'pumheight'* *'ph'*
6098'pumheight' 'ph' number (default 0)
6099 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006100 Determines the maximum number of items to show in the popup menu for
6101 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006102 |ins-completion-menu|.
6103
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006104 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006105'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006106 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006107 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006108 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006109
Bram Moolenaard94464e2015-11-02 15:28:18 +01006110 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006111'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006112 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006113 {only available when compiled with the |+python/dyn|
6114 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006115 Specifies the name of the Python 2.x shared library. The default is
6116 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006117 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006118 This option cannot be set from a |modeline| or in the |sandbox|, for
6119 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006120
Bram Moolenaar94073162018-01-31 21:49:05 +01006121 *'pythonhome'*
6122'pythonhome' string (default "")
6123 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006124 {only available when compiled with the |+python/dyn|
6125 feature}
6126 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6127 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6128 which was specified at compile time, will be used for the Python 2.x
6129 home directory.
6130 Environment variables are expanded |:set_env|.
6131 This option cannot be set from a |modeline| or in the |sandbox|, for
6132 security reasons.
6133
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006134 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006135'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006136 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006137 {only available when compiled with the |+python3/dyn|
6138 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006139 Specifies the name of the Python 3 shared library. The default is
6140 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006141 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006142 This option cannot be set from a |modeline| or in the |sandbox|, for
6143 security reasons.
6144
Bram Moolenaar94073162018-01-31 21:49:05 +01006145 *'pythonthreehome'*
6146'pythonthreehome' string (default "")
6147 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006148 {only available when compiled with the |+python3/dyn|
6149 feature}
6150 Specifies the name of the Python 3 home directory. When
6151 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6152 PYTHON3_HOME, which was specified at compile time, will be used for
6153 the Python 3 home directory.
6154 Environment variables are expanded |:set_env|.
6155 This option cannot be set from a |modeline| or in the |sandbox|, for
6156 security reasons.
6157
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006158 *'pyxversion'* *'pyx'*
6159'pyxversion' 'pyx' number (default depends on the build)
6160 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006161 {only available when compiled with the |+python| or
6162 the |+python3| feature}
6163 Specifies the python version used for pyx* functions and commands
6164 |python_x|. The default value is as follows:
6165
6166 Compiled with Default ~
6167 |+python| and |+python3| 0
6168 only |+python| 2
6169 only |+python3| 3
6170
6171 Available values are 0, 2 and 3.
6172 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6173 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6174 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6175 to 2 if Python 2 is available.
6176 See also: |has-pythonx|
6177
6178 If Vim is compiled with only |+python| or |+python3| setting
6179 'pyxversion' has no effect. The pyx* functions and commands are
6180 always the same as the compiled version.
6181
6182 This option cannot be set from a |modeline| or in the |sandbox|, for
6183 security reasons.
6184
Bram Moolenaar858ba062020-05-31 23:11:59 +02006185 *'quickfixtextfunc'* *'qftf'*
6186'quickfixtextfunc' 'qftf' string (default "")
6187 global
6188 {only available when compiled with the |+quickfix|
6189 feature}
6190 This option specifies a function to be used to get the text to display
6191 in the quickfix and location list windows. This can be used to
6192 customize the information displayed in the quickfix or location window
6193 for each entry in the corresponding quickfix or location list. See
6194 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006195 function and an example. The value can be the name of a function, a
6196 |lambda| or a |Funcref|. See |option-value-function| for more
6197 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006198
6199 This option cannot be set from a |modeline| or in the |sandbox|, for
6200 security reasons.
6201
Bram Moolenaar677ee682005-01-27 14:41:15 +00006202 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006203'quoteescape' 'qe' string (default "\")
6204 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006205 The characters that are used to escape quotes in a string. Used for
6206 objects like a', a" and a` |a'|.
6207 When one of the characters in this option is found inside a string,
6208 the following character will be skipped. The default value makes the
6209 text "foo\"bar\\" considered to be one string.
6210
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6212'readonly' 'ro' boolean (default off)
6213 local to buffer
6214 If on, writes fail unless you use a '!'. Protects you from
6215 accidentally overwriting a file. Default on when Vim is started
6216 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006217 When using ":w!" the 'readonly' option is reset for the current
6218 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006219 When using the ":view" command the 'readonly' option is set for the
6220 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006221 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006222
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006223 *'redrawtime'* *'rdt'*
6224'redrawtime' 'rdt' number (default 2000)
6225 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006226 {only available when compiled with the |+reltime|
6227 feature}
6228 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006229 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006230 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006231 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006232 matches will be highlighted.
6233 For syntax highlighting the time applies per window. When over the
6234 limit syntax highlighting is disabled until |CTRL-L| is used.
6235 This is used to avoid that Vim hangs when using a very complicated
6236 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006237
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006238 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006239'regexpengine' 're' number (default 0)
6240 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006241 This selects the default regexp engine. |two-engines|
6242 The possible values are:
6243 0 automatic selection
6244 1 old engine
6245 2 NFA engine
6246 Note that when using the NFA engine and the pattern contains something
6247 that is not supported the pattern will not match. This is only useful
6248 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006249 Using automatic selection enables Vim to switch the engine, if the
6250 default engine becomes too costly. E.g., when the NFA engine uses too
6251 many states. This should prevent Vim from hanging on a combination of
6252 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006253
Bram Moolenaar64486672010-05-16 15:46:46 +02006254 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6255'relativenumber' 'rnu' boolean (default off)
6256 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006257 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006258 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006259 precede some vertical motion commands (e.g. j k + -) with, without
6260 having to calculate it yourself. Especially useful in combination with
6261 other commands (e.g. y d c < > gq gw =).
6262 When the 'n' option is excluded from 'cpoptions' a wrapped
6263 line will not use the column of line numbers (this is the default when
6264 'compatible' isn't set).
6265 The 'numberwidth' option can be used to set the room used for the line
6266 number.
6267 When a long, wrapped line doesn't start with the first character, '-'
6268 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006269 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6270 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006271
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006272 The number in front of the cursor line also depends on the value of
6273 'number', see |number_relativenumber| for all combinations of the two
6274 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006275
Bram Moolenaar071d4272004-06-13 20:20:40 +00006276 *'remap'* *'noremap'*
6277'remap' boolean (default on)
6278 global
6279 Allows for mappings to work recursively. If you do not want this for
6280 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006281 NOTE: To avoid portability problems with Vim scripts, always keep
6282 this option at the default "on". Only switch it off when working with
6283 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006285 *'renderoptions'* *'rop'*
6286'renderoptions' 'rop' string (default: empty)
6287 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006288 {only available when compiled with GUI and DIRECTX on
6289 MS-Windows}
6290 Select a text renderer and set its options. The options depend on the
6291 renderer.
6292
6293 Syntax: >
6294 set rop=type:{renderer}(,{name}:{value})*
6295<
6296 Currently, only one optional renderer is available.
6297
6298 render behavior ~
6299 directx Vim will draw text using DirectX (DirectWrite). It makes
6300 drawn glyphs more beautiful than default GDI.
6301 It requires 'encoding' is "utf-8", and only works on
6302 MS-Windows Vista or newer version.
6303
6304 Options:
6305 name meaning type value ~
6306 gamma gamma float 1.0 - 2.2 (maybe)
6307 contrast enhancedContrast float (unknown)
6308 level clearTypeLevel float (unknown)
6309 geom pixelGeometry int 0 - 2 (see below)
6310 renmode renderingMode int 0 - 6 (see below)
6311 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006312 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006313
Bram Moolenaar92467d32017-12-05 13:22:16 +01006314 See this URL for detail (except for scrlines):
6315 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006316
6317 For geom: structure of a device pixel.
6318 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6319 1 - DWRITE_PIXEL_GEOMETRY_RGB
6320 2 - DWRITE_PIXEL_GEOMETRY_BGR
6321
6322 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006323 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006324
6325 For renmode: method of rendering glyphs.
6326 0 - DWRITE_RENDERING_MODE_DEFAULT
6327 1 - DWRITE_RENDERING_MODE_ALIASED
6328 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6329 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6330 4 - DWRITE_RENDERING_MODE_NATURAL
6331 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6332 6 - DWRITE_RENDERING_MODE_OUTLINE
6333
6334 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006335 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006336
6337 For taamode: antialiasing mode used for drawing text.
6338 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6339 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6340 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6341 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6342
6343 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006344 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6345
Bram Moolenaara338adc2018-01-31 20:51:47 +01006346 For scrlines:
6347 This was used for optimizing scrolling behavior, however this
6348 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006349
6350 Example: >
6351 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006352 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006353 set rop=type:directx
6354<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006355 If select a raster font (Courier, Terminal or FixedSys which
6356 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006357 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006358
6359 NOTE: It is known that some fonts and options combination
6360 causes trouble on drawing glyphs.
6361
Bram Moolenaar92467d32017-12-05 13:22:16 +01006362 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006363 special made fonts (True-Type fonts which includes only
6364 bitmap glyphs).
6365 - 'taamode:3' will not work with some vector fonts.
6366
6367 NOTE: With this option, you can display colored emoji
6368 (emoticon) in Windows 8.1 or later. To display colored emoji,
6369 there are some conditions which you should notice.
6370
6371 - If your font includes non-colored emoji already, it will
6372 be used.
6373 - If your font doesn't have emoji, the system chooses an
6374 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6375 will be used.
6376 - When this alternative font didn't have fixed width glyph,
6377 emoji might be rendered beyond the bounding box of drawing
6378 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006379
6380 Other render types are currently not supported.
6381
Bram Moolenaar071d4272004-06-13 20:20:40 +00006382 *'report'*
6383'report' number (default 2)
6384 global
6385 Threshold for reporting number of lines changed. When the number of
6386 changed lines is more than 'report' a message will be given for most
6387 ":" commands. If you want it always, set 'report' to 0.
6388 For the ":substitute" command the number of substitutions is used
6389 instead of the number of lines.
6390
6391 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6392'restorescreen' 'rs' boolean (default on)
6393 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006394 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395 When set, the screen contents is restored when exiting Vim. This also
6396 happens when executing external commands.
6397
6398 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6399 options in your .vimrc. To disable restoring:
6400 set t_ti= t_te=
6401 To enable restoring (for an xterm):
6402 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6403 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6404
6405 *'revins'* *'ri'* *'norevins'* *'nori'*
6406'revins' 'ri' boolean (default off)
6407 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408 {only available when compiled with the |+rightleft|
6409 feature}
6410 Inserting characters in Insert mode will work backwards. See "typing
6411 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6412 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006413 NOTE: This option is reset when 'compatible' is set.
6414 This option is reset when 'paste' is set and restored when 'paste' is
6415 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416
6417 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6418'rightleft' 'rl' boolean (default off)
6419 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 {only available when compiled with the |+rightleft|
6421 feature}
6422 When on, display orientation becomes right-to-left, i.e., characters
6423 that are stored in the file appear from the right to the left.
6424 Using this option, it is possible to edit files for languages that
6425 are written from the right to the left such as Hebrew and Arabic.
6426 This option is per window, so it is possible to edit mixed files
6427 simultaneously, or to view the same file in both ways (this is
6428 useful whenever you have a mixed text file with both right-to-left
6429 and left-to-right strings so that both sets are displayed properly
6430 in different windows). Also see |rileft.txt|.
6431
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006432 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433'rightleftcmd' 'rlc' string (default "search")
6434 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006435 {only available when compiled with the |+rightleft|
6436 feature}
6437 Each word in this option enables the command line editing to work in
6438 right-to-left mode for a group of commands:
6439
6440 search "/" and "?" commands
6441
6442 This is useful for languages such as Hebrew, Arabic and Farsi.
6443 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6444
Bram Moolenaard94464e2015-11-02 15:28:18 +01006445 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006446'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006447 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006448 {only available when compiled with the |+ruby/dyn|
6449 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006450 Specifies the name of the Ruby shared library. The default is
6451 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006452 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006453 This option cannot be set from a |modeline| or in the |sandbox|, for
6454 security reasons.
6455
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006457'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 {not available when compiled without the
6460 |+cmdline_info| feature}
6461 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006462 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463 text in the file is shown on the far right:
6464 Top first line is visible
6465 Bot last line is visible
6466 All first and last line are visible
6467 45% relative position in the file
6468 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006469 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006470 ruler is shown there. Otherwise it is shown in the last line of the
6471 screen. If the statusline is given by 'statusline' (i.e. not empty),
6472 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006474 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475 the text column (byte number) and the screen column are shown,
6476 separated with a dash.
6477 For an empty line "0-1" is shown.
6478 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006479 This option is reset when 'paste' is set and restored when 'paste' is
6480 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481 If you don't want to see the ruler all the time but want to know where
6482 you are, use "g CTRL-G" |g_CTRL-G|.
6483 NOTE: This option is reset when 'compatible' is set.
6484
6485 *'rulerformat'* *'ruf'*
6486'rulerformat' 'ruf' string (default empty)
6487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 {not available when compiled without the |+statusline|
6489 feature}
6490 When this option is not empty, it determines the content of the ruler
6491 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006492 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006493 This option cannot be set in a modeline when 'modelineexpr' is off.
6494
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 The default ruler width is 17 characters. To make the ruler 15
6496 characters wide, put "%15(" at the start and "%)" at the end.
6497 Example: >
6498 :set rulerformat=%15(%c%V\ %p%%%)
6499<
6500 *'runtimepath'* *'rtp'* *vimfiles*
6501'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006502 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 $VIM/vimfiles,
6504 $VIMRUNTIME,
6505 $VIM/vimfiles/after,
6506 $HOME/.vim/after"
6507 Amiga: "home:vimfiles,
6508 $VIM/vimfiles,
6509 $VIMRUNTIME,
6510 $VIM/vimfiles/after,
6511 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006512 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513 $VIM/vimfiles,
6514 $VIMRUNTIME,
6515 $VIM/vimfiles/after,
6516 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006517 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 $VIMRUNTIME,
6519 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006520 Haiku: "$BE_USER_SETTINGS/vim,
6521 $VIM/vimfiles,
6522 $VIMRUNTIME,
6523 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006524 $BE_USER_SETTINGS/vim/after"
6525 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 $VIM/vimfiles,
6527 $VIMRUNTIME,
6528 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006529 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531 This is a list of directories which will be searched for runtime
6532 files:
6533 filetype.vim filetypes by file name |new-filetype|
6534 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006535 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 colors/ color scheme files |:colorscheme|
6537 compiler/ compiler files |:compiler|
6538 doc/ documentation |write-local-help|
6539 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006540 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541 indent/ indent scripts |indent-expression|
6542 keymap/ key mapping files |mbyte-keymap|
6543 lang/ menu translations |:menutrans|
6544 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006545 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 plugin/ plugin scripts |write-plugin|
6547 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006548 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 syntax/ syntax files |mysyntaxfile|
6550 tutor/ files for vimtutor |tutor|
6551
6552 And any other file searched for with the |:runtime| command.
6553
6554 The defaults for most systems are setup to search five locations:
6555 1. In your home directory, for your personal preferences.
6556 2. In a system-wide Vim directory, for preferences from the system
6557 administrator.
6558 3. In $VIMRUNTIME, for files distributed with Vim.
6559 *after-directory*
6560 4. In the "after" directory in the system-wide Vim directory. This is
6561 for the system administrator to overrule or add to the distributed
6562 defaults (rarely needed)
6563 5. In the "after" directory in your home directory. This is for
6564 personal preferences to overrule or add to the distributed defaults
6565 or system-wide settings (rarely needed).
6566
Bram Moolenaard0796902016-09-16 20:02:31 +02006567 More entries are added when using |packages|. If it gets very long
6568 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6569 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006570
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6572 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006573 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006574 wildcards.
6575 See |:runtime|.
6576 Example: >
6577 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6578< This will use the directory "~/vimruntime" first (containing your
6579 personal Vim runtime files), then "/mygroup/vim" (shared between a
6580 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6581 files).
6582 You probably should always include $VIMRUNTIME somewhere, to use the
6583 distributed runtime files. You can put a directory before $VIMRUNTIME
6584 to find files which replace a distributed runtime files. You can put
6585 a directory after $VIMRUNTIME to find files which add to distributed
6586 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006587 When Vim is started with |--clean| the home directory entries are not
6588 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006589 This option cannot be set from a |modeline| or in the |sandbox|, for
6590 security reasons.
6591
6592 *'scroll'* *'scr'*
6593'scroll' 'scr' number (default: half the window height)
6594 local to window
6595 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6596 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006597 changes. This may happen when enabling the |status-line| or
6598 'tabline' option after setting the 'scroll' option.
6599 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006600 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006601 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006602
6603 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6604'scrollbind' 'scb' boolean (default off)
6605 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006606 See also |scroll-binding|. When this option is set, the current
6607 window scrolls as other scrollbind windows (windows that also have
6608 this option set) scroll. This option is useful for viewing the
6609 differences between two versions of a file, see 'diff'.
6610 See |'scrollopt'| for options that determine how this option should be
6611 interpreted.
6612 This option is mostly reset when splitting a window to edit another
6613 file. This means that ":split | edit file" results in two windows
6614 with scroll-binding, but ":split file" does not.
6615
Bram Moolenaarae20f342019-11-05 21:09:23 +01006616 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6617'scrollfocus' 'scf' boolean (default off)
6618 global
6619 {only for MS-Windows GUI}
6620 When using the scroll wheel and this option is set, the window under
6621 the mouse pointer is scrolled. With this option off the current
6622 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006623 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006624
Bram Moolenaar071d4272004-06-13 20:20:40 +00006625 *'scrolljump'* *'sj'*
6626'scrolljump' 'sj' number (default 1)
6627 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006628 Minimal number of lines to scroll when the cursor gets off the
6629 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6630 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006631 When set to a negative number from -1 to -100 this is used as the
6632 percentage of the window height. Thus -50 scrolls half the window
6633 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 NOTE: This option is set to 1 when 'compatible' is set.
6635
6636 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006637'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006638 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 Minimal number of screen lines to keep above and below the cursor.
6640 This will make some context visible around where you are working. If
6641 you set it to a very large value (999) the cursor line will always be
6642 in the middle of the window (except at the start or end of the file or
6643 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006644 After using the local value, go back the global value with one of
6645 these two: >
6646 setlocal scrolloff<
6647 setlocal scrolloff=-1
6648< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 NOTE: This option is set to 0 when 'compatible' is set.
6650
6651 *'scrollopt'* *'sbo'*
6652'scrollopt' 'sbo' string (default "ver,jump")
6653 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006655 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6656 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 The following words are available:
6658 ver Bind vertical scrolling for 'scrollbind' windows
6659 hor Bind horizontal scrolling for 'scrollbind' windows
6660 jump Applies to the offset between two windows for vertical
6661 scrolling. This offset is the difference in the first
6662 displayed line of the bound windows. When moving
6663 around in a window, another 'scrollbind' window may
6664 reach a position before the start or after the end of
6665 the buffer. The offset is not changed though, when
6666 moving back the 'scrollbind' window will try to scroll
6667 to the desired position when possible.
6668 When now making that window the current one, two
6669 things can be done with the relative offset:
6670 1. When "jump" is not included, the relative offset is
6671 adjusted for the scroll position in the new current
6672 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006673 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 2. When "jump" is included, the other windows are
6675 scrolled to keep the same relative offset. When
6676 going back to the other window, it still uses the
6677 same relative offset.
6678 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006679 When 'diff' mode is active there always is vertical scroll binding,
6680 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681
6682 *'sections'* *'sect'*
6683'sections' 'sect' string (default "SHNHH HUnhsh")
6684 global
6685 Specifies the nroff macros that separate sections. These are pairs of
6686 two letters (See |object-motions|). The default makes a section start
6687 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6688
6689 *'secure'* *'nosecure'* *E523*
6690'secure' boolean (default off)
6691 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 When on, ":autocmd", shell and write commands are not allowed in
6693 ".vimrc" and ".exrc" in the current directory and map commands are
6694 displayed. Switch it off only if you know that you will not run into
6695 problems, or when the 'exrc' option is off. On Unix this option is
6696 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006697 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006698 'secure' at the end of your ~/.vimrc then.
6699 This option cannot be set from a |modeline| or in the |sandbox|, for
6700 security reasons.
6701
6702 *'selection'* *'sel'*
6703'selection' 'sel' string (default "inclusive")
6704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 This option defines the behavior of the selection. It is only used
6706 in Visual and Select mode.
6707 Possible values:
6708 value past line inclusive ~
6709 old no yes
6710 inclusive yes yes
6711 exclusive yes no
6712 "past line" means that the cursor is allowed to be positioned one
6713 character past the line.
6714 "inclusive" means that the last character of the selection is included
6715 in an operation. For example, when "x" is used to delete the
6716 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006717 When "old" is used and 'virtualedit' allows the cursor to move past
6718 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 Note that when "exclusive" is used and selecting from the end
6720 backwards, you cannot include the last character of a line, when
6721 starting in Normal mode and 'virtualedit' empty.
6722
6723 The 'selection' option is set by the |:behave| command.
6724
6725 *'selectmode'* *'slm'*
6726'selectmode' 'slm' string (default "")
6727 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006728 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729 Select mode instead of Visual mode, when a selection is started.
6730 Possible values:
6731 mouse when using the mouse
6732 key when using shifted special keys
6733 cmd when using "v", "V" or CTRL-V
6734 See |Select-mode|.
6735 The 'selectmode' option is set by the |:behave| command.
6736
6737 *'sessionoptions'* *'ssop'*
6738'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006739 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006741 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742 feature}
6743 Changes the effect of the |:mksession| command. It is a comma
6744 separated list of words. Each word enables saving and restoring
6745 something:
6746 word save and restore ~
6747 blank empty windows
6748 buffers hidden and unloaded buffers, not just those in windows
6749 curdir the current directory
6750 folds manually created folds, opened/closed folds and local
6751 fold options
6752 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006753 and contain at least one lowercase letter. Only
6754 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 help the help window
6756 localoptions options and mappings local to a window or buffer (not
6757 global values for local options)
6758 options all options and mappings (also global values for local
6759 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006760 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 resize size of the Vim window: 'lines' and 'columns'
6762 sesdir the directory in which the session file is located
6763 will become the current directory (useful with
6764 projects accessed over a network from different
6765 systems)
6766 slash backslashes in file names replaced with forward
6767 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006768 tabpages all tab pages; without this only the current tab page
6769 is restored, so that you can make a session for each
6770 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006771 terminal include terminal windows where the command can be
6772 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 unix with Unix end-of-line format (single <NL>), even when
6774 on Windows or DOS
6775 winpos position of the whole Vim window
6776 winsize window sizes
6777
6778 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006779 When neither "curdir" nor "sesdir" is included, file names are stored
6780 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006781 If you leave out "options" many things won't work well after restoring
6782 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 "slash" and "unix" are useful on Windows when sharing session files
6784 with Unix. The Unix version of Vim cannot source dos format scripts,
6785 but the Windows version of Vim can source unix format scripts.
6786
6787 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006788'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 global
6790 Name of the shell to use for ! and :! commands. When changing the
6791 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6792 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006793 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794 See |option-backslash| about including spaces and backslashes.
6795 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006796
Bram Moolenaara2baa732022-02-04 16:09:54 +00006797 In |restricted-mode| shell commands will not be possible. This mode
6798 is used if the value of $SHELL ends in "false" or "nologin".
6799
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006800 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006801 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006802 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6803< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006804 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006806 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006807 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006808 Example with escaped space (Vim will do this when initializing the
6809 option from $SHELL): >
6810 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006811< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006812 backslashes are consumed by `:set`.
6813
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 Under MS-Windows, when the executable ends in ".com" it must be
6815 included. Thus setting the shell to "command.com" or "4dos.com"
6816 works, but "command" and "4dos" do not work for all commands (e.g.,
6817 filtering).
6818 For unknown reasons, when using "4dos.com" the current directory is
6819 changed to "C:\". To avoid this set 'shell' like this: >
6820 :set shell=command.com\ /c\ 4dos
6821< This option cannot be set from a |modeline| or in the |sandbox|, for
6822 security reasons.
6823
6824 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006825'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006826 Win32, when 'shell' contains "powershell":
6827 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006828 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006831 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6832 For MS-Windows, the default is set according to the value of 'shell',
6833 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006834 On Unix it can have more than one flag. Each white space separated
6835 part is passed as an argument to the shell command.
6836 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006837 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 This option cannot be set from a |modeline| or in the |sandbox|, for
6839 security reasons.
6840
6841 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006842'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6843 "2>&1| tee", or
6844 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 {not available when compiled without the |+quickfix|
6847 feature}
6848 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006849 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006850 including spaces and backslashes.
6851 The name of the temporary file can be represented by "%s" if necessary
6852 (the file name is appended automatically if no %s appears in the value
6853 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006854 For the Amiga the default is ">". For MS-Windows using powershell the
6855 default is "2>&1 | Out-File -Encoding default", otherwise the default
6856 is ">%s 2>&1". The output is directly saved in a file and not echoed
6857 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006858 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 in a file and echoed to the screen. If the 'shell' option is "csh" or
6860 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006861 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006862 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6863 means that stderr is also included. Before using the 'shell' option a
6864 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006865 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6866 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 The initialization of this option is done after reading the ".vimrc"
6868 and the other initializations, so that when the 'shell' option is set
6869 there, the 'shellpipe' option changes automatically, unless it was
6870 explicitly set before.
6871 When 'shellpipe' is set to an empty string, no redirection of the
6872 ":make" output will be done. This is useful if you use a 'makeprg'
6873 that writes to 'makeef' by itself. If you want no piping, but do
6874 want to include the 'makeef', set 'shellpipe' to a single space.
6875 Don't forget to precede the space with a backslash: ":set sp=\ ".
6876 In the future pipes may be used for filtering and this option will
6877 become obsolete (at least for Unix).
6878 This option cannot be set from a |modeline| or in the |sandbox|, for
6879 security reasons.
6880
6881 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006882'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 Quoting character(s), put around the command passed to the shell, for
6885 the "!" and ":!" commands. The redirection is kept outside of the
6886 quoting. See 'shellxquote' to include the redirection. It's
6887 probably not useful to set both options.
6888 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006889 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006890 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 This option cannot be set from a |modeline| or in the |sandbox|, for
6892 security reasons.
6893
6894 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006895'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6896 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006897 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898 String to be used to put the output of a filter command in a temporary
6899 file. See also |:!|. See |option-backslash| about including spaces
6900 and backslashes.
6901 The name of the temporary file can be represented by "%s" if necessary
6902 (the file name is appended automatically if no %s appears in the value
6903 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006904 The default is ">". For Unix, if the 'shell' option is "csh" or
6905 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006906 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006907 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6908 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006909 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6910 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006911 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6912 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 The initialization of this option is done after reading the ".vimrc"
6914 and the other initializations, so that when the 'shell' option is set
6915 there, the 'shellredir' option changes automatically unless it was
6916 explicitly set before.
6917 In the future pipes may be used for filtering and this option will
6918 become obsolete (at least for Unix).
6919 This option cannot be set from a |modeline| or in the |sandbox|, for
6920 security reasons.
6921
6922 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6923'shellslash' 'ssl' boolean (default off)
6924 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006925 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006927 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006928 powershell.exe. Backward slashes can still be typed, but they are
6929 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930 Note that setting or resetting this option has no effect for some
6931 existing file names, thus this option needs to be set before opening
6932 any file for best results. This might change in the future.
6933 'shellslash' only works when a backslash can be used as a path
6934 separator. To test if this is so use: >
6935 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006936< Also see 'completeslash'.
6937
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006938 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6939'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6940 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006941 When on, use temp files for shell commands. When off use a pipe.
6942 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006943 Currently a pipe is only supported on Unix and MS-Windows 2K and
6944 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006945 :if has("filterpipe")
6946< The advantage of using a pipe is that nobody can read the temp file
6947 and the 'shell' command does not need to support redirection.
6948 The advantage of using a temp file is that the file type and encoding
6949 can be detected.
6950 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6951 |FilterWritePost| autocommands event are not triggered when
6952 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006953 The `system()` function does not respect this option and always uses
6954 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006955 NOTE: This option is set to the Vim default value when 'compatible'
6956 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006957
Bram Moolenaar071d4272004-06-13 20:20:40 +00006958 *'shelltype'* *'st'*
6959'shelltype' 'st' number (default 0)
6960 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006961 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962 On the Amiga this option influences the way how the commands work
6963 which use a shell.
6964 0 and 1: always use the shell
6965 2 and 3: use the shell only to filter lines
6966 4 and 5: use shell only for ':sh' command
6967 When not using the shell, the command is executed directly.
6968
6969 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6970 1 and 3: use "shell cmd" to start external commands
6971
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006972 *'shellxescape'* *'sxe'*
6973'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006974 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006975 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006976 When 'shellxquote' is set to "(" then the characters listed in this
6977 option will be escaped with a '^' character. This makes it possible
6978 to execute most external commands with cmd.exe.
6979
Bram Moolenaar071d4272004-06-13 20:20:40 +00006980 *'shellxquote'* *'sxq'*
6981'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006982 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006983 for Win32, when 'shell' is
6984 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006985 for Win32, when 'shell' contains "sh"
6986 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006987 for Unix, when using system(): "\"")
6988 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989 Quoting character(s), put around the command passed to the shell, for
6990 the "!" and ":!" commands. Includes the redirection. See
6991 'shellquote' to exclude the redirection. It's probably not useful
6992 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006993 When the value is '(' then ')' is appended. When the value is '"('
6994 then ')"' is appended.
6995 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006996 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006997 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6998 pwsh.exe which automatically strips off the first and last quote on a
6999 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7000 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007001 'shell', to reduce the need to set this option by the user. See
7002 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003 This option cannot be set from a |modeline| or in the |sandbox|, for
7004 security reasons.
7005
7006 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7007'shiftround' 'sr' boolean (default off)
7008 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 Round indent to multiple of 'shiftwidth'. Applies to > and <
7010 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7011 a multiple of 'shiftwidth' (this is Vi compatible).
7012 NOTE: This option is reset when 'compatible' is set.
7013
7014 *'shiftwidth'* *'sw'*
7015'shiftwidth' 'sw' number (default 8)
7016 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007017 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007018 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007019 When zero the 'ts' value will be used. Use the |shiftwidth()|
7020 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021
7022 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007023'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7024 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007025 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007026 This option helps to avoid all the |hit-enter| prompts caused by file
7027 messages, for example with CTRL-G, and to avoid some other messages.
7028 It is a list of flags:
7029 flag meaning when present ~
7030 f use "(3 of 5)" instead of "(file 3 of 5)"
7031 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02007032 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007033 m use "[+]" instead of "[Modified]"
7034 n use "[New]" instead of "[New File]"
7035 r use "[RO]" instead of "[readonly]"
7036 w use "[w]" instead of "written" for file write message
7037 and "[a]" instead of "appended" for ':w >> file' command
7038 x use "[dos]" instead of "[dos format]", "[unix]" instead of
7039 "[unix format]" and "[mac]" instead of "[mac format]".
7040 a all of the above abbreviations
7041
7042 o overwrite message for writing a file with subsequent message
7043 for reading a file (useful for ":wn" or when 'autowrite' on)
7044 O message for reading a file overwrites any previous message.
7045 Also for quickfix message (e.g., ":cn").
7046 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02007047 hit TOP, continuing at BOTTOM" messages; when using the search
7048 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 t truncate file message at the start if it is too long to fit
7050 on the command-line, "<" will appear in the left most column.
7051 Ignored in Ex mode.
7052 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00007053 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007054 Ignored in Ex mode.
7055 W don't give "written" or "[w]" when writing a file
7056 A don't give the "ATTENTION" message when an existing swap file
7057 is found.
7058 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02007059 c don't give |ins-completion-menu| messages. For example,
7060 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
7061 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01007062 q use "recording" instead of "recording @a"
7063 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02007064 was used for the command; note that this also affects messages
7065 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007066 S do not show search count message when searching, e.g.
7067 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068
7069 This gives you the opportunity to avoid that a change between buffers
7070 requires you to hit <Enter>, but still gives as useful a message as
7071 possible for the space available. To get the whole message that you
7072 would have got with 'shm' empty, use ":file!"
7073 Useful values:
7074 shm= No abbreviation of message.
7075 shm=a Abbreviation, but no loss of information.
7076 shm=at Abbreviation, and truncate message when necessary.
7077
7078 NOTE: This option is set to the Vi default value when 'compatible' is
7079 set and to the Vim default value when 'compatible' is reset.
7080
7081 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7082'shortname' 'sn' boolean (default off)
7083 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 Filenames are assumed to be 8 characters plus one extension of 3
7085 characters. Multiple dots in file names are not allowed. When this
7086 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007087 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007088 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007089 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090
7091 *'showbreak'* *'sbr'* *E595*
7092'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007093 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007094 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 feature}
7096 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007097 values are "> " or "+++ ": >
7098 :set showbreak=>\
7099< Note the backslash to escape the trailing space. It's easier like
7100 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007101 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007102< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 comma (in a future version the comma might be used to separate the
7104 part that is shown at the end and at the start of a line).
7105 The characters are highlighted according to the '@' flag in
7106 'highlight'.
7107 Note that tabs after the showbreak will be displayed differently.
7108 If you want the 'showbreak' to appear in between line numbers, add the
7109 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007110 A window-local value overrules a global value. If the global value is
7111 set and you want no value in the current window use NONE: >
7112 :setlocal showbreak=NONE
7113<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007115'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7116 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007117 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118 {not available when compiled without the
7119 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007120 Show (partial) command in the last line of the screen. Set this
7121 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007122 In Visual mode the size of the selected area is shown:
7123 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007124 If the number of bytes is different it is also displayed: "2-6"
7125 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007127 - When selecting a block, the size in screen characters:
7128 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 NOTE: This option is set to the Vi default value when 'compatible' is
7130 set and to the Vim default value when 'compatible' is reset.
7131
7132 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7133'showfulltag' 'sft' boolean (default off)
7134 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007135 When completing a word in insert mode (see |ins-completion|) from the
7136 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007137 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 matched a C function, you can see a template for what arguments are
7139 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007140 Note that this doesn't work well together with having "longest" in
7141 'completeopt', because the completion from the search pattern may not
7142 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143
7144 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7145'showmatch' 'sm' boolean (default off)
7146 global
7147 When a bracket is inserted, briefly jump to the matching one. The
7148 jump is only done if the match can be seen on the screen. The time to
7149 show the match can be set with 'matchtime'.
7150 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007151 seen or not).
7152 This option is reset when 'paste' is set and restored when 'paste' is
7153 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154 When the 'm' flag is not included in 'cpoptions', typing a character
7155 will immediately move the cursor back to where it belongs.
7156 See the "sm" field in 'guicursor' for setting the cursor shape and
7157 blinking when showing the match.
7158 The 'matchpairs' option can be used to specify the characters to show
7159 matches for. 'rightleft' and 'revins' are used to look for opposite
7160 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007161 Also see the matchparen plugin for highlighting the match when moving
7162 around |pi_paren.txt|.
7163 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164
7165 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7166'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7167 global
7168 If in Insert, Replace or Visual mode put a message on the last line.
7169 Use the 'M' flag in 'highlight' to set the type of highlighting for
7170 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007171 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 doesn't mean XIM is really active, especially when 'imactivatekey' is
7173 not set.
7174 NOTE: This option is set to the Vi default value when 'compatible' is
7175 set and to the Vim default value when 'compatible' is reset.
7176
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007177 *'showtabline'* *'stal'*
7178'showtabline' 'stal' number (default 1)
7179 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007180 The value of this option specifies when the line with tab page labels
7181 will be displayed:
7182 0: never
7183 1: only if there are at least two tab pages
7184 2: always
7185 This is both for the GUI and non-GUI implementation of the tab pages
7186 line.
7187 See |tab-page| for more information about tab pages.
7188
Bram Moolenaar071d4272004-06-13 20:20:40 +00007189 *'sidescroll'* *'ss'*
7190'sidescroll' 'ss' number (default 0)
7191 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007192 The minimal number of columns to scroll horizontally. Used only when
7193 the 'wrap' option is off and the cursor is moved off of the screen.
7194 When it is zero the cursor will be put in the middle of the screen.
7195 When using a slow terminal set it to a large number or 0. When using
7196 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7197 commands.
7198
7199 *'sidescrolloff'* *'siso'*
7200'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007201 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007203 right of the cursor if 'nowrap' is set. Setting this option to a
7204 value greater than 0 while having |'sidescroll'| also at a non-zero
7205 value makes some context visible in the line you are scrolling in
7206 horizontally (except at beginning of the line). Setting this option
7207 to a large value (like 999) has the effect of keeping the cursor
7208 horizontally centered in the window, as long as one does not come too
7209 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007210 After using the local value, go back the global value with one of
7211 these two: >
7212 setlocal sidescrolloff<
7213 setlocal sidescrolloff=-1
7214< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215
7216 Example: Try this together with 'sidescroll' and 'listchars' as
7217 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007218 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219
7220 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7221 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007222<
7223 *'signcolumn'* *'scl'*
7224'signcolumn' 'scl' string (default "auto")
7225 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007226 {not available when compiled without the |+signs|
7227 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007228 Whether or not to draw the signcolumn. Valid values are:
7229 "auto" only when there is a sign to display
7230 "no" never
7231 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007232 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007233 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234
7235
7236 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7237'smartcase' 'scs' boolean (default off)
7238 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239 Override the 'ignorecase' option if the search pattern contains upper
7240 case characters. Only used when the search pattern is typed and
7241 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007242 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7244 recalling the search pattern from history and hitting <Enter>.
7245 NOTE: This option is reset when 'compatible' is set.
7246
7247 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7248'smartindent' 'si' boolean (default off)
7249 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007250 Do smart autoindenting when starting a new line. Works for C-like
7251 programs, but can also be used for other languages. 'cindent' does
7252 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007253 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007254 setting 'si' has no effect. 'indentexpr' is a more advanced
7255 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007256 Normally 'autoindent' should also be on when using 'smartindent'.
7257 An indent is automatically inserted:
7258 - After a line ending in '{'.
7259 - After a line starting with a keyword from 'cinwords'.
7260 - Before a line starting with '}' (only with the "O" command).
7261 When typing '}' as the first character in a new line, that line is
7262 given the same indent as the matching '{'.
7263 When typing '#' as the first character in a new line, the indent for
7264 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007265 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7267 When using the ">>" command, lines starting with '#' are not shifted
7268 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007269 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007270 This option is reset when 'paste' is set and restored when 'paste' is
7271 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007272
7273 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7274'smarttab' 'sta' boolean (default off)
7275 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007277 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7278 <BS> will delete a 'shiftwidth' worth of space at the start of the
7279 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007280 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007281 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7282 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007283 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007285 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007286 This option is reset when 'paste' is set and restored when 'paste' is
7287 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 NOTE: This option is reset when 'compatible' is set.
7289
7290 *'softtabstop'* *'sts'*
7291'softtabstop' 'sts' number (default 0)
7292 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007293 Number of spaces that a <Tab> counts for while performing editing
7294 operations, like inserting a <Tab> or using <BS>. It "feels" like
7295 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7296 used. This is useful to keep the 'ts' setting at its standard value
7297 of 8, while being able to edit like it is set to 'sts'. However,
7298 commands like "x" still work on the actual characters.
7299 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007300 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007301 'softtabstop' is set to 0 when the 'paste' option is set and restored
7302 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007303 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7304 spaces is minimized by using <Tab>s.
7305 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7306 set.
7307 NOTE: This option is set to 0 when 'compatible' is set.
7308
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007309 If Vim is compiled with the |+vartabs| feature then the value of
7310 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7311 anything other than an empty string.
7312
Bram Moolenaar217ad922005-03-20 22:37:15 +00007313 *'spell'* *'nospell'*
7314'spell' boolean (default off)
7315 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007316 {not available when compiled without the |+syntax|
7317 feature}
7318 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007319 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007320
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007321 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007322'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007323 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007324 {not available when compiled without the |+syntax|
7325 feature}
7326 Pattern to locate the end of a sentence. The following word will be
7327 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007328 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007329 When this check is not wanted make this option empty.
7330 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007331 Be careful with special characters, see |option-backslash| about
7332 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007333 To set this option automatically depending on the language, see
7334 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007335
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007336 *'spellfile'* *'spf'*
7337'spellfile' 'spf' string (default empty)
7338 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007339 {not available when compiled without the |+syntax|
7340 feature}
7341 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007342 commands. It must end in ".{encoding}.add". You need to include the
7343 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007344 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007345 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007346 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007347 |zg| and |zw| commands can be used to access each. This allows using
7348 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007349 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007350 you: Using the first directory in 'runtimepath' that is writable. If
7351 there is no "spell" directory yet it will be created. For the file
7352 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007353 ignoring the region.
7354 The resulting ".spl" file will be used for spell checking, it does not
7355 have to appear in 'spelllang'.
7356 Normally one file is used for all regions, but you can add the region
7357 name if you want to. However, it will then only be used when
7358 'spellfile' is set to it, for entries in 'spelllang' only files
7359 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007360 This option cannot be set from a |modeline| or in the |sandbox|, for
7361 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007362
Bram Moolenaar217ad922005-03-20 22:37:15 +00007363 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007364'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007365 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007366 {not available when compiled without the |+syntax|
7367 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007368 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007369 on spellchecking will be done for these languages. Example: >
7370 set spelllang=en_us,nl,medical
7371< This means US English, Dutch and medical words are recognized. Words
7372 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007373 The word list name must consist of alphanumeric characters, a dash or
7374 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007375 recommended to separate the two letter language name from a
7376 specification. Thus "en-rare" is used for rare English words.
7377 A region name must come last and have the form "_xx", where "xx" is
7378 the two-letter, lower case region name. You can use more than one
7379 region by listing them: "en_us,en_ca" supports both US and Canadian
7380 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007381 Britain. (Note: currently en_au and en_nz dictionaries are older than
7382 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007383 If the name "cjk" is included East Asian characters are excluded from
7384 spell checking. This is useful when editing text that also has Asian
7385 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007386 Note that the "medical" dictionary does not exist, it is just an
7387 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007388 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007389 As a special case the name of a .spl file can be given as-is. The
7390 first "_xx" in the name is removed and used as the region name
7391 (_xx is an underscore, two letters and followed by a non-letter).
7392 This is mainly for testing purposes. You must make sure the correct
7393 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007394 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007395 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7396 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007397 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007398
Bram Moolenaar98692072006-02-04 00:57:42 +00007399 If the |spellfile.vim| plugin is active and you use a language name
7400 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7401 will ask you if you want to download the file.
7402
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007403 After this option has been set successfully, Vim will source the files
7404 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007405 up to the first character that is not an ASCII letter or number and
7406 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007407
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007408 *'spelloptions'* *'spo'*
7409'spelloptions' 'spo' string (default "")
7410 local to buffer
7411 {not available when compiled without the |+syntax|
7412 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007413 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007414 camel When a word is CamelCased, assume "Cased" is a
7415 separate word: every upper-case character in a word
7416 that comes after a lower case character indicates the
7417 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007418
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007419 *'spellsuggest'* *'sps'*
7420'spellsuggest' 'sps' string (default "best")
7421 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007422 {not available when compiled without the |+syntax|
7423 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007424 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007425 the |spellsuggest()| function. This is a comma-separated list of
7426 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007427
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007428 best Internal method that works best for English. Finds
7429 changes like "fast" and uses a bit of sound-a-like
7430 scoring to improve the ordering.
7431
7432 double Internal method that uses two methods and mixes the
7433 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007434 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007435 word. That only works when the language specifies
7436 sound folding. Can be slow and doesn't always give
7437 better results.
7438
7439 fast Internal method that only checks for simple changes:
7440 character inserts/deletes/swaps. Works well for
7441 simple typing mistakes.
7442
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007443 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007444 Not used for |spellsuggest()|. The number of
7445 suggestions is never more than the value of 'lines'
7446 minus two.
7447
Bram Moolenaar585ee072022-01-29 11:22:17 +00007448 timeout:{millisec} Limit the time searching for suggestions to
7449 {millisec} milli seconds. Applies to the following
7450 methods. When omitted the limit is 5000. When
7451 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007452 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007453
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007454 file:{filename} Read file {filename}, which must have two columns,
7455 separated by a slash. The first column contains the
7456 bad word, the second column the suggested good word.
7457 Example:
7458 theribal/terrible ~
7459 Use this for common mistakes that do not appear at the
7460 top of the suggestion list with the internal methods.
7461 Lines without a slash are ignored, use this for
7462 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007463 The word in the second column must be correct,
7464 otherwise it will not be used. Add the word to an
7465 ".add" file if it is currently flagged as a spelling
7466 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007467 The file is used for all languages.
7468
7469 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7470 trouble with spaces. |v:val| holds the badly spelled
7471 word. The expression must evaluate to a List of
7472 Lists, each with a suggestion and a score.
7473 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007474 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007475 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007476 internal methods use. A lower score is better.
7477 This may invoke |spellsuggest()| if you temporarily
7478 set 'spellsuggest' to exclude the "expr:" part.
7479 Errors are silently ignored, unless you set the
7480 'verbose' option to a non-zero value.
7481
7482 Only one of "best", "double" or "fast" may be used. The others may
7483 appear several times in any order. Example: >
7484 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7485<
7486 This option cannot be set from a |modeline| or in the |sandbox|, for
7487 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007488
7489
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7491'splitbelow' 'sb' boolean (default off)
7492 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 When on, splitting a window will put the new window below the current
7494 one. |:split|
7495
7496 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7497'splitright' 'spr' boolean (default off)
7498 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007499 When on, splitting a window will put the new window right of the
7500 current one. |:vsplit|
7501
Luuk van Baal29ab5242022-09-11 16:59:53 +01007502 *'splitscroll'* *'spsc'* *'nosplitscroll'* *'nospsc'*
7503'splitscroll' 'spsc' boolean (default on)
7504 global
7505 The value of this option determines the scroll behavior when opening,
7506 closing or resizing horizontal splits. When "on", splitting a window
7507 horizontally will keep the same relative cursor position in the old and
7508 new window, as well windows that are resized. When "off", scrolling
7509 will be avoided to stabilize the window content. Instead, the cursor
7510 position will be changed when necessary. In this case, the jumplist
7511 will be populated with the previous cursor position. Scrolling cannot
7512 be guaranteed to be avoided when 'wrap' is enabled.
7513
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7515'startofline' 'sol' boolean (default on)
7516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007518 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007519 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007520 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007521 with a linewise operator, with "%" with a count and to buffer changing
7522 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7523 only has a line number, e.g., ":25" or ":+".
7524 In case of buffer changing commands the cursor is placed at the column
7525 where it was the last time the buffer was edited.
7526 NOTE: This option is set when 'compatible' is set.
7527
Bram Moolenaar00654022011-02-25 14:42:19 +01007528 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007530 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 {not available when compiled without the |+statusline|
7532 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007533 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007534 Also see |status-line|.
7535
7536 The option consists of printf style '%' items interspersed with
7537 normal text. Each status line item is of the form:
7538 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007539 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007540 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007541
Bram Moolenaar238a5642006-02-21 22:12:05 +00007542 When the option starts with "%!" then it is used as an expression,
7543 evaluated and the result is used as the option value. Example: >
7544 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007545< The *g:statusline_winid* variable will be set to the |window-ID| of the
7546 window that the status line belongs to.
7547 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007548 Note that the "%!" expression is evaluated in the context of the
7549 current window and buffer, while %{} items are evaluated in the
7550 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007551
7552 When there is error while evaluating the option then it will be made
7553 empty to avoid further errors. Otherwise screen updating would loop.
7554
Bram Moolenaar071d4272004-06-13 20:20:40 +00007555 Note that the only effect of 'ruler' when this option is set (and
7556 'laststatus' is 2) is controlling the output of |CTRL-G|.
7557
7558 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007559 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007561 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 minwid Minimum width of the item, padding as set by '-' & '0'.
7563 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007564 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007565 on the left for text items. Numeric items will be
7566 shifted down to maxwid-2 digits followed by '>'number
7567 where number is the amount of missing digits, much like
7568 an exponential notation.
7569 item A one letter code as described below.
7570
7571 Following is a description of the possible statusline items. The
7572 second character in "item" is the type:
7573 N for number
7574 S for string
7575 F for flags as described below
7576 - not applicable
7577
7578 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007579 f S Path to the file in the buffer, as typed or relative to current
7580 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581 F S Full path to the file in the buffer.
7582 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007583 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007585 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007587 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007589 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007590 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007591 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007593 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007594 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7595 being used: "<keymap>"
7596 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007597 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007598 B N As above, in hexadecimal.
7599 o N Byte number in file of byte under cursor, first byte is 1.
7600 Mnemonic: Offset from start of file (with one added)
7601 {not available when compiled without |+byte_offset| feature}
7602 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007603 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007604 l N Line number.
7605 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007606 c N Column number (byte index).
7607 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007608 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609 p N Percentage through file in lines as in |CTRL-G|.
7610 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007611 percentage described for 'ruler'. Always 3 in length, unless
7612 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007613 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007615 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007616 Note that there is no '%' before the closing '}'. The
7617 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007618 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007619 {% - This is almost same as { except the result of the expression is
7620 re-evaluated as a statusline format string. Thus if the
7621 return value of expr contains % items they will get expanded.
7622 The expression can contain the } character, the end of
7623 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007624 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007625 func! Stl_filename() abort
7626 return "%t"
7627 endfunc
7628< `stl=%{Stl_filename()}` results in `"%t"`
7629 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007630 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007631 ( - Start of item group. Can be used for setting the width and
7632 alignment of a section. Must be followed by %) somewhere.
7633 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007634 T N For 'tabline': start of tab page N label. Use %T after the last
7635 label. This information is used for mouse clicks.
7636 X N For 'tabline': start of close tab N label. Use %X after the
7637 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7638 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639 < - Where to truncate line if too long. Default is at the start.
7640 No width fields allowed.
7641 = - Separation point between left and right aligned items.
7642 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007643 # - Set highlight group. The name must follow and then a # again.
7644 Thus use %#HLname# for highlight group HLname. The same
7645 highlighting is used, also for the statusline of non-current
7646 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007648 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 The difference between User{N} and StatusLine will be applied
7650 to StatusLineNC for the statusline of non-current windows.
7651 The number N must be between 1 and 9. See |hl-User1..9|
7652
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007653 When displaying a flag, Vim removes the leading comma, if any, when
7654 that flag comes right after plaintext. This will make a nice display
7655 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007656
Bram Moolenaar582fd852005-03-28 20:58:01 +00007657 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007658 not set) and a minwid is not set for the group, the whole group will
7659 become empty. This will make a group like the following disappear
7660 completely from the statusline when none of the flags are set. >
7661 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007662< Beware that an expression is evaluated each and every time the status
7663 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007664 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007665 While evaluating %{} the current buffer and current window will be set
7666 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007667 currently being drawn. The expression will evaluate in this context.
7668 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7669 real current buffer and "g:actual_curwin" to the |window-ID| of the
7670 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007671
Bram Moolenaar30b65812012-07-12 22:01:11 +02007672 The 'statusline' option will be evaluated in the |sandbox| if set from
7673 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007674 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007675
7676 It is not allowed to change text or jump to another window while
7677 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007678
7679 If the statusline is not updated when you want it (e.g., after setting
7680 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007681 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007683 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684 Otherwise the result is taken as flag text and applied to the rules
7685 described above.
7686
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007687 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007688 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007689 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690
7691 Examples:
7692 Emulate standard status line with 'ruler' set >
7693 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7694< Similar, but add ASCII value of char under the cursor (like "ga") >
7695 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7696< Display byte count and byte value, modified flag in red. >
7697 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7698 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7699< Display a ,GZ flag if a compressed file is loaded >
7700 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7701< In the |:autocmd|'s: >
7702 :let b:gzflag = 1
7703< And: >
7704 :unlet b:gzflag
7705< And define this function: >
7706 :function VarExists(var, val)
7707 : if exists(a:var) | return a:val | else | return '' | endif
7708 :endfunction
7709<
7710 *'suffixes'* *'su'*
7711'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7712 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007713 Files with these suffixes get a lower priority when multiple files
7714 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007715 suffixes. Spaces after the comma are ignored. A dot is also seen as
7716 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007717 separator, precede it with a backslash (see |option-backslash| about
7718 including spaces and backslashes).
7719 See 'wildignore' for completely ignoring files.
7720 The use of |:set+=| and |:set-=| is preferred when adding or removing
7721 suffixes from the list. This avoids problems when a future version
7722 uses another default.
7723
7724 *'suffixesadd'* *'sua'*
7725'suffixesadd' 'sua' string (default "")
7726 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007727 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007728 file for the "gf", "[I", etc. commands. Example: >
7729 :set suffixesadd=.java
7730<
7731 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7732'swapfile' 'swf' boolean (default on)
7733 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007734 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007735 swapfile is not wanted for a specific buffer. For example, with
7736 confidential information that even root must not be able to access.
7737 Careful: All text will be in memory:
7738 - Don't use this for big files.
7739 - Recovery will be impossible!
7740 A swapfile will only be present when |'updatecount'| is non-zero and
7741 'swapfile' is set.
7742 When 'swapfile' is reset, the swap file for the current buffer is
7743 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7744 non-zero, a swap file is immediately created.
7745 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007746 If you want to open a new buffer without creating a swap file for it,
7747 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007748 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007749
7750 This option is used together with 'bufhidden' and 'buftype' to
7751 specify special kinds of buffers. See |special-buffers|.
7752
7753 *'swapsync'* *'sws'*
7754'swapsync' 'sws' string (default "fsync")
7755 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007756 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007757 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758 When this option is empty parts of the swap file may be in memory and
7759 not written to disk. When the system crashes you may lose more work.
7760 On Unix the system does a sync now and then without Vim asking for it,
7761 so the disadvantage of setting this option off is small. On some
7762 systems the swap file will not be written at all. For a unix system
7763 setting it to "sync" will use the sync() call instead of the default
7764 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007765 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007766
7767 *'switchbuf'* *'swb'*
7768'switchbuf' 'swb' string (default "")
7769 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007770 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007771 Mostly for |quickfix| commands some values are also used for other
7772 commands, as mentioned below.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007773 Possible values (comma-separated list):
Bram Moolenaar071d4272004-06-13 20:20:40 +00007774 useopen If included, jump to the first open window that
7775 contains the specified buffer (if there is one).
7776 Otherwise: Do not examine other windows.
7777 This setting is checked with |quickfix| commands, when
7778 jumping to errors (":cc", ":cn", "cp", etc.). It is
7779 also used in all buffer related split commands, for
7780 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007781 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007782 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007783 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007784 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007785 Otherwise: do not split, use current window (when used
7786 in the quickfix window: the previously used window or
7787 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007788 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007789 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007790 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007791 uselast If included, jump to the previously used window when
7792 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007793
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007794 *'synmaxcol'* *'smc'*
7795'synmaxcol' 'smc' number (default 3000)
7796 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007797 {not available when compiled without the |+syntax|
7798 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007799 Maximum column in which to search for syntax items. In long lines the
7800 text after this column is not highlighted and following lines may not
7801 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007802 This helps to avoid very slow redrawing for an XML file that is one
7803 long line.
7804 Set to zero to remove the limit.
7805
Bram Moolenaar071d4272004-06-13 20:20:40 +00007806 *'syntax'* *'syn'*
7807'syntax' 'syn' string (default empty)
7808 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809 {not available when compiled without the |+syntax|
7810 feature}
7811 When this option is set, the syntax with this name is loaded, unless
7812 syntax highlighting has been switched off with ":syntax off".
7813 Otherwise this option does not always reflect the current syntax (the
7814 b:current_syntax variable does).
7815 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007816 not automatically recognized. Example, in an IDL file:
7817 /* vim: set syntax=idl : */ ~
7818 When a dot appears in the value then this separates two filetype
7819 names. Example:
7820 /* vim: set syntax=c.doxygen : */ ~
7821 This will use the "c" syntax first, then the "doxygen" syntax.
7822 Note that the second one must be prepared to be loaded as an addition,
7823 otherwise it will be skipped. More than one dot may appear.
7824 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007825 :set syntax=OFF
7826< To switch syntax highlighting on according to the current value of the
7827 'filetype' option: >
7828 :set syntax=ON
7829< What actually happens when setting the 'syntax' option is that the
7830 Syntax autocommand event is triggered with the value as argument.
7831 This option is not copied to another buffer, independent of the 's' or
7832 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007833 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007834
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007835 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007836'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007837 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00007838 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007839 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007840 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007841
7842 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007843 option and only when there is no GUI tab line. When 'e' is in
7844 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007845 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007846
7847 The value is evaluated like with 'statusline'. You can use
7848 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007849 the text to be displayed. Use "%1T" for the first label, "%2T" for
7850 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007851
Bram Moolenaare12bab32019-01-08 22:02:56 +01007852 When changing something that is used in 'tabline' that does not
7853 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007854 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007855
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007856 Keep in mind that only one of the tab pages is the current one, others
7857 are invisible and you can't jump to their windows.
7858
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007859
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007860 *'tabpagemax'* *'tpm'*
7861'tabpagemax' 'tpm' number (default 10)
7862 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007863 Maximum number of tab pages to be opened by the |-p| command line
7864 argument or the ":tab all" command. |tabpage|
7865
7866
7867 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007868'tabstop' 'ts' number (default 8)
7869 local to buffer
7870 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007871 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872
7873 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007874 appear wrong in many places, e.g., when printing it.
7875 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876
7877 There are four main ways to use tabs in Vim:
7878 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7879 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007880 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881 behave like a tab appears every 4 (or 3) characters.
7882 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7883 'expandtab'. This way you will always insert spaces. The
7884 formatting will never be messed up when 'tabstop' is changed.
7885 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007886 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 works when using Vim to edit the file.
7888 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7889 'noexpandtab'. This should then work (for initial indents only)
7890 for any tabstop setting that people use. It might be nice to have
7891 tabs after the first non-blank inserted as spaces if you do this
7892 though. Otherwise aligned comments will be wrong when 'tabstop' is
7893 changed.
7894
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007895 If Vim is compiled with the |+vartabs| feature then the value of
7896 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7897 than an empty string.
7898
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7900'tagbsearch' 'tbs' boolean (default on)
7901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007903 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007904 searching makes searching for a tag a LOT faster, but a linear search
7905 will find more tags if the tags file wasn't properly sorted.
7906 Vim normally assumes that your tags files are sorted, or indicate that
7907 they are not sorted. Only when this is not the case does the
7908 'tagbsearch' option need to be switched off.
7909
7910 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007911 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007912 certain files, or retry all files with a linear search. When
7913 'tagbsearch' is off, only a linear search is done.
7914
7915 Linear searching is done anyway, for one file, when Vim finds a line
7916 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007917 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918< [The whitespace before and after the '0' must be a single <Tab>]
7919
7920 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007921 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922 instead of a normal tag name, a retry is done with a linear search.
7923 Tags in unsorted tags files, and matches with different case will only
7924 be found in the retry.
7925
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007926 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007927 linear search can be avoided when case is ignored. Use a value of '2'
7928 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7929 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00007930 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
7931 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
7932 used for this as well. Note that case must be folded to uppercase for
7933 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007934
7935 By default, tag searches are case-sensitive. Case is ignored when
7936 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7937 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007938 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7939 'tagcase' is "smart", and the pattern contains only lowercase
7940 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007941
7942 When 'tagbsearch' is off, tags searching is slower when a full match
7943 exists, but faster when no full match exists. Tags in unsorted tags
7944 files may only be found with 'tagbsearch' off.
7945 When the tags file is not sorted, or sorted in a wrong way (not on
7946 ASCII byte value), 'tagbsearch' should be off, or the line given above
7947 must be included in the tags file.
7948 This option doesn't affect commands that find all matching tags (e.g.,
7949 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007951 *'tagcase'* *'tc'*
7952'tagcase' 'tc' string (default "followic")
7953 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007954 This option specifies how case is handled when searching the tags
7955 file:
7956 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007957 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007958 ignore Ignore case
7959 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007960 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007961 NOTE: This option is set to the Vi default value when 'compatible' is
7962 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007963
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007964 *'tagfunc'* *'tfu'*
7965'tagfunc' 'tfu' string (default: empty)
7966 local to buffer
7967 {not available when compiled without the |+eval|
7968 feature}
7969 This option specifies a function to be used to perform tag searches.
7970 The function gets the tag pattern and should return a List of matching
7971 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007972 function and an example. The value can be the name of a function, a
7973 |lambda| or a |Funcref|. See |option-value-function| for more
7974 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007975
Bram Moolenaar071d4272004-06-13 20:20:40 +00007976 *'taglength'* *'tl'*
7977'taglength' 'tl' number (default 0)
7978 global
7979 If non-zero, tags are significant up to this number of characters.
7980
7981 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7982'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7983 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007984 If on and using a tags file in another directory, file names in that
7985 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986 NOTE: This option is set to the Vi default value when 'compatible' is
7987 set and to the Vim default value when 'compatible' is reset.
7988
7989 *'tags'* *'tag'* *E433*
7990'tags' 'tag' string (default "./tags,tags", when compiled with
7991 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7992 global or local to buffer |global-local|
7993 Filenames for the tag command, separated by spaces or commas. To
7994 include a space or comma in a file name, precede it with a backslash
7995 (see |option-backslash| about including spaces and backslashes).
7996 When a file name starts with "./", the '.' is replaced with the path
7997 of the current file. But only when the 'd' flag is not included in
7998 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7999 |tags-option|.
8000 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008001 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8002 find all files named "tags" below "/lib". The filename itself cannot
8003 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008004 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008005 The |tagfiles()| function can be used to get a list of the file names
8006 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008007 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8008 files are also supported. They are automatically recognized. The
8009 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8010 differences are ignored (MS-Windows). |emacs-tags|
8011 The use of |:set+=| and |:set-=| is preferred when adding or removing
8012 file names from the list. This avoids problems when a future version
8013 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008014
8015 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8016'tagstack' 'tgst' boolean (default on)
8017 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008018 When on, the |tagstack| is used normally. When off, a ":tag" or
8019 ":tselect" command with an argument will not push the tag onto the
8020 tagstack. A following ":tag" without an argument, a ":pop" command or
8021 any other command that uses the tagstack will use the unmodified
8022 tagstack, but does change the pointer to the active entry.
8023 Resetting this option is useful when using a ":tag" command in a
8024 mapping which should not change the tagstack.
8025
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008026 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008027'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008028 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008029 {only available when compiled with the |+tcl/dyn|
8030 feature}
8031 Specifies the name of the Tcl shared library. The default is
8032 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008033 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008034 This option cannot be set from a |modeline| or in the |sandbox|, for
8035 security reasons.
8036
Bram Moolenaar071d4272004-06-13 20:20:40 +00008037 *'term'* *E529* *E530* *E531*
8038'term' string (default is $TERM, if that fails:
8039 in the GUI: "builtin_gui"
8040 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008041 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008042 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043 on Unix: "ansi"
8044 on VMS: "ansi"
8045 on Win 32: "win32")
8046 global
8047 Name of the terminal. Used for choosing the terminal control
8048 characters. Environment variables are expanded |:set_env|.
8049 For example: >
8050 :set term=$TERM
8051< See |termcap|.
8052
8053 *'termbidi'* *'tbidi'*
8054 *'notermbidi'* *'notbidi'*
8055'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8056 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008057 {only available when compiled with the |+arabic|
8058 feature}
8059 The terminal is in charge of Bi-directionality of text (as specified
8060 by Unicode). The terminal is also expected to do the required shaping
8061 that some languages (such as Arabic) require.
8062 Setting this option implies that 'rightleft' will not be set when
8063 'arabic' is set and the value of 'arabicshape' will be ignored.
8064 Note that setting 'termbidi' has the immediate effect that
8065 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8066 This option is reset when the GUI is started.
8067 For further details see |arabic.txt|.
8068
8069 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008070'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008072 Encoding used for the terminal. This specifies what character
8073 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008074 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008075 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008076 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008077 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8079 Any attempts to set a different value will be rejected, and an error
8080 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008081 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082 because the Win32 system always passes Unicode characters.
8083 When empty, the same encoding is used as for the 'encoding' option.
8084 This is the normal value.
8085 Not all combinations for 'termencoding' and 'encoding' are valid. See
8086 |encoding-table|.
8087 The value for this option must be supported by internal conversions or
8088 iconv(). When this is not possible no conversion will be done and you
8089 will probably experience problems with non-ASCII characters.
8090 Example: You are working with the locale set to euc-jp (Japanese) and
8091 want to edit a UTF-8 file: >
8092 :let &termencoding = &encoding
8093 :set encoding=utf-8
8094< You need to do this when your system has no locale support for UTF-8.
8095
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008096 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008097'termguicolors' 'tgc' boolean (default off)
8098 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008099 {not available when compiled without the
8100 |+termguicolors| feature}
8101 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008102 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008103
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008104 Requires a ISO-8613-3 compatible terminal. If setting this option
8105 does not work (produces a colorless UI) reading |xterm-true-color|
8106 might help.
8107
8108 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8109 is required. Use this check to find out: >
8110 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008111< This requires Vim to be built with the |+vtp| feature.
8112
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008113 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008114
8115 When using Vim with Windows Terminal, the background of Windows
8116 Terminal is normally filled with the Vim background color. Setting
8117 'termguicolors' and the guibg of the Normal highlight group to NONE
8118 will make the background transparent: >
8119 :hi Normal guibg=NONE
8120<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008121 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008122
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008123 *'termwinkey'* *'twk'*
8124'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008125 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008126 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008127 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008128 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008129 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008130< The string must be one key stroke but can be multiple bytes.
8131 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008132 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008133 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008134
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008135 *'termwinscroll'* *'twsl'*
8136'termwinscroll' 'twsl' number (default 10000)
8137 local to buffer
8138 {not available when compiled without the
8139 |+terminal| feature}
8140 Number of scrollback lines to keep. When going over this limit the
8141 first 10% of the scrollback lines are deleted. This is just to reduce
8142 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008143 Also used as a limit for text sent to the terminal in one write,
8144 multiplied by the number of columns times 3 (average number of bytes
8145 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008146
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008147 *'termwinsize'* *'tws'*
8148'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008149 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008150 Size used when opening the |terminal| window. Format:
8151 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008152 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008153 - When set with a "x" (e.g., "24x80") the terminal size is not
8154 adjusted to the window size. If the window is smaller only the
8155 top-left part is displayed.
8156 - When set with a "*" (e.g., "10*50") the terminal size follows the
8157 window size, but will not be smaller than the specified rows and/or
8158 columns.
8159 - When rows is zero then use the height of the window.
8160 - When columns is zero then use the width of the window.
8161 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008162 - Can be overruled in the |term_start()| options with "term_rows" and
8163 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008164
8165 Examples:
8166 "30x0" uses 30 rows and the current window width.
8167 "20*0" uses at least 20 rows and the current window width.
8168 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008169 Note that the command running in the terminal window may still change
8170 the size of the terminal. In that case the Vim window will be
8171 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008172
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008173 *'termwintype'* *'twt'*
8174'termwintype' 'twt' string (default "")
8175 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008176 {only available when compiled with the |terminal|
8177 feature on MS-Windows}
8178 Specify the virtual console (pty) used when opening the terminal
8179 window.
8180
8181 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008182 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008183 "winpty" use winpty, fail if not supported
8184 "conpty" use |ConPTY|, fail if not supported
8185
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008186 |ConPTY| support depends on the platform. Windows 10 October 2018
8187 Update is the first version that supports ConPTY, however it is still
8188 considered unstable. ConPTY might become stable in the next release
8189 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008190 supported then you cannot open a terminal window.
8191
Bram Moolenaar071d4272004-06-13 20:20:40 +00008192 *'terse'* *'noterse'*
8193'terse' boolean (default off)
8194 global
8195 When set: Add 's' flag to 'shortmess' option (this makes the message
8196 for a search that hits the start or end of the file not being
8197 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8198 shortens a lot of messages}
8199
8200 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8201'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8202 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008203 This option is obsolete. Use 'fileformats'.
8204 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8205 set to the default value for the current system. When 'textauto' is
8206 reset, 'fileformats' is made empty.
8207 NOTE: This option is set to the Vi default value when 'compatible' is
8208 set and to the Vim default value when 'compatible' is reset.
8209
8210 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008211'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008212 others: default off)
8213 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214 This option is obsolete. Use 'fileformat'.
8215 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8216 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8217 "unix".
8218
8219 *'textwidth'* *'tw'*
8220'textwidth' 'tw' number (default 0)
8221 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008222 Maximum width of text that is being inserted. A longer line will be
8223 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008224 this.
8225 'textwidth' is set to 0 when the 'paste' option is set and restored
8226 when 'paste' is reset.
8227 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008228 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008229 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008230 NOTE: This option is set to 0 when 'compatible' is set.
8231
8232 *'thesaurus'* *'tsr'*
8233'thesaurus' 'tsr' string (default "")
8234 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008235 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008236 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8237 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008238
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008239 This option is not used if 'thesaurusfunc' is set, either for the
8240 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008241
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008242 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008243 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008244 name. See |option-backslash| about using backslashes. The use of
8245 |:set+=| and |:set-=| is preferred when adding or removing directories
8246 from the list. This avoids problems when a future version uses
8247 another default. Backticks cannot be used in this option for security
8248 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008249
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008250 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008251'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008252 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008253 {not available when compiled without the |+eval|
8254 feature}
8255 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008256 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008257 The value can be the name of a function, a |lambda| or a |Funcref|.
8258 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008259
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008260 This option cannot be set from a |modeline| or in the |sandbox|, for
8261 security reasons.
8262
Bram Moolenaar071d4272004-06-13 20:20:40 +00008263 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8264'tildeop' 'top' boolean (default off)
8265 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008266 When on: The tilde command "~" behaves like an operator.
8267 NOTE: This option is reset when 'compatible' is set.
8268
8269 *'timeout'* *'to'* *'notimeout'* *'noto'*
8270'timeout' 'to' boolean (default on)
8271 global
8272 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008273'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008275 These two options together determine the behavior when part of a
8276 mapped key sequence or keyboard code has been received:
8277
8278 'timeout' 'ttimeout' action ~
8279 off off do not time out
8280 on on or off time out on :mappings and key codes
8281 off on time out on key codes
8282
8283 If both options are off, Vim will wait until either the complete
8284 mapping or key sequence has been received, or it is clear that there
8285 is no mapping or key sequence for the received characters. For
8286 example: if you have mapped "vl" and Vim has received 'v', the next
8287 character is needed to see if the 'v' is followed by an 'l'.
8288 When one of the options is on, Vim will wait for about 1 second for
8289 the next character to arrive. After that the already received
8290 characters are interpreted as single characters. The waiting time can
8291 be changed with the 'timeoutlen' option.
8292 On slow terminals or very busy systems timing out may cause
8293 malfunctioning cursor keys. If both options are off, Vim waits
8294 forever after an entered <Esc> if there are key codes that start
8295 with <Esc>. You will have to type <Esc> twice. If you do not have
8296 problems with key codes, but would like to have :mapped key
8297 sequences not timing out in 1 second, set the 'ttimeout' option and
8298 reset the 'timeout' option.
8299
8300 NOTE: 'ttimeout' is reset when 'compatible' is set.
8301
8302 *'timeoutlen'* *'tm'*
8303'timeoutlen' 'tm' number (default 1000)
8304 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008305
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008307'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008308 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008309 The time in milliseconds that is waited for a key code or mapped key
8310 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8311 when part of a command has been typed.
8312 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8313 different timeout value for key codes is desired set 'ttimeoutlen' to
8314 a non-negative number.
8315
8316 ttimeoutlen mapping delay key code delay ~
8317 < 0 'timeoutlen' 'timeoutlen'
8318 >= 0 'timeoutlen' 'ttimeoutlen'
8319
8320 The timeout only happens when the 'timeout' and 'ttimeout' options
8321 tell so. A useful setting would be >
8322 :set timeout timeoutlen=3000 ttimeoutlen=100
8323< (time out on mapping after three seconds, time out on key codes after
8324 a tenth of a second).
8325
8326 *'title'* *'notitle'*
8327'title' boolean (default off, on when title can be restored)
8328 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008329 When on, the title of the window will be set to the value of
8330 'titlestring' (if it is not empty), or to:
8331 filename [+=-] (path) - VIM
8332 Where:
8333 filename the name of the file being edited
8334 - indicates the file cannot be modified, 'ma' off
8335 + indicates the file was modified
8336 = indicates the file is read-only
8337 =+ indicates the file is read-only and modified
8338 (path) is the path of the file being edited
8339 - VIM the server name |v:servername| or "VIM"
8340 Only works if the terminal supports setting window titles
8341 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008342 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008343 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8344 *X11*
8345 When Vim was compiled with HAVE_X11 defined, the original title will
8346 be restored if possible. The output of ":version" will include "+X11"
8347 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8348 works for the icon name |'icon'|.
8349 But: When Vim was started with the |-X| argument, restoring the title
8350 will not work (except in the GUI).
8351 If the title cannot be restored, it is set to the value of 'titleold'.
8352 You might want to restore the title outside of Vim then.
8353 When using an xterm from a remote machine you can use this command:
8354 rsh machine_name xterm -display $DISPLAY &
8355 then the WINDOWID environment variable should be inherited and the
8356 title of the window should change back to what it should be after
8357 exiting Vim.
8358
8359 *'titlelen'*
8360'titlelen' number (default 85)
8361 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008363 title. When the title is longer, only the end of the path name is
8364 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365 Using a percentage makes this adapt to the width of the window. But
8366 it won't work perfectly, because the actual number of characters
8367 available also depends on the font used and other things in the title
8368 bar. When 'titlelen' is zero the full path is used. Otherwise,
8369 values from 1 to 30000 percent can be used.
8370 'titlelen' is also used for the 'titlestring' option.
8371
8372 *'titleold'*
8373'titleold' string (default "Thanks for flying Vim")
8374 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 This option will be used for the window title when exiting Vim if the
8376 original title cannot be restored. Only happens if 'title' is on or
8377 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008378 This option cannot be set from a |modeline| or in the |sandbox|, for
8379 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008380 *'titlestring'*
8381'titlestring' string (default "")
8382 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008383 When this option is not empty, it will be used for the title of the
8384 window. This happens only when the 'title' option is on.
8385 Only works if the terminal supports setting window titles (currently
8386 Amiga console, Win32 console, all GUI versions and terminals with a
8387 non-empty 't_ts' option).
8388 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008389 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008390
Bram Moolenaar071d4272004-06-13 20:20:40 +00008391 When this option contains printf-style '%' items, they will be
8392 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008393 This option cannot be set in a modeline when 'modelineexpr' is off.
8394
Bram Moolenaar071d4272004-06-13 20:20:40 +00008395 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008396 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008397 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8398< The value of 'titlelen' is used to align items in the middle or right
8399 of the available space.
8400 Some people prefer to have the file name first: >
8401 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8402< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008403 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008404 separating space only when needed.
8405 NOTE: Use of special characters in 'titlestring' may cause the display
8406 to be garbled (e.g., when it contains a CR or NL character).
8407 {not available when compiled without the |+statusline| feature}
8408
8409 *'toolbar'* *'tb'*
8410'toolbar' 'tb' string (default "icons,tooltips")
8411 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008412 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008413 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008414 possible values are:
8415 icons Toolbar buttons are shown with icons.
8416 text Toolbar buttons shown with text.
8417 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008418 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008419 tooltips Tooltips are active for toolbar buttons.
8420 Tooltips refer to the popup help text which appears after the mouse
8421 cursor is placed over a toolbar button for a brief moment.
8422
8423 If you want the toolbar to be shown with icons as well as text, do the
8424 following: >
8425 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008426< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008427 will show icons if both are requested.
8428
8429 If none of the strings specified in 'toolbar' are valid or if
8430 'toolbar' is empty, this option is ignored. If you want to disable
8431 the toolbar, you need to set the 'guioptions' option. For example: >
8432 :set guioptions-=T
8433< Also see |gui-toolbar|.
8434
8435 *'toolbariconsize'* *'tbis'*
8436'toolbariconsize' 'tbis' string (default "small")
8437 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008438 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008439 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008440 tiny Use tiny icons.
8441 small Use small icons (default).
8442 medium Use medium-sized icons.
8443 large Use large icons.
8444 huge Use even larger icons.
8445 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008446 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008447 the current theme. Common dimensions are giant=48x48, huge=32x32,
8448 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449
8450 If 'toolbariconsize' is empty, the global default size as determined
8451 by user preferences or the current theme is used.
8452
8453 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8454'ttybuiltin' 'tbi' boolean (default on)
8455 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008456 When on, the builtin termcaps are searched before the external ones.
8457 When off the builtin termcaps are searched after the external ones.
8458 When this option is changed, you should set the 'term' option next for
8459 the change to take effect, for example: >
8460 :set notbi term=$TERM
8461< See also |termcap|.
8462 Rationale: The default for this option is "on", because the builtin
8463 termcap entries are generally better (many systems contain faulty
8464 xterm entries...).
8465
8466 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8467'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8468 sun-cmd, screen, rxvt, dtterm or
8469 iris-ansi; also on when running Vim in
8470 a DOS console)
8471 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008472 Indicates a fast terminal connection. More characters will be sent to
8473 the screen for redrawing, instead of using insert/delete line
8474 commands. Improves smoothness of redrawing when there are multiple
8475 windows and the terminal does not support a scrolling region.
8476 Also enables the extra writing of characters at the end of each screen
8477 line for lines that wrap. This helps when using copy/paste with the
8478 mouse in an xterm and other terminals.
8479
8480 *'ttymouse'* *'ttym'*
8481'ttymouse' 'ttym' string (default depends on 'term')
8482 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008483 {only in Unix and VMS, doesn't work in the GUI; not
8484 available when compiled without |+mouse|}
8485 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008486 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 *xterm-mouse*
8488 xterm xterm-like mouse handling. The mouse generates
8489 "<Esc>[Mscr", where "scr" is three bytes:
8490 "s" = button state
8491 "c" = column plus 33
8492 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008493 This only works up to 223 columns! See "dec",
8494 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008495 xterm2 Works like "xterm", but with the xterm reporting the
8496 mouse position while the mouse is dragged. This works
8497 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008498 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008499 work. See below for how Vim detects this
8500 automatically.
8501 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008502 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008503 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008504 for the row and column. No other mouse events are
8505 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008506 *dec-mouse*
8507 dec DEC terminal mouse handling. The mouse generates a
8508 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008509 This is also available for an Xterm, if it was
8510 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008511 *jsbterm-mouse*
8512 jsbterm JSB term mouse handling.
8513 *pterm-mouse*
8514 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008515 *urxvt-mouse*
8516 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008517 The mouse works only if the terminal supports this
8518 encoding style, but it does not have 223 columns limit
8519 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008520 *sgr-mouse*
8521 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008522 mouse reporting. The mouse works even in columns
8523 beyond 223. This option is backward compatible with
8524 "xterm2" because it can also decode "xterm2" style
8525 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008526
8527 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008528 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8529 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008530 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8531 recognized, if enabled at compile time. DEC terminal mouse codes
8532 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008533 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8534 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008535 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008536 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8537 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8538 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008539 Additionally, if vim is compiled with the |+termresponse| feature and
8540 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008541 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008542 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008543 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8544 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8545 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008546 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8547 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008548 :set t_RV=
8549<
8550 *'ttyscroll'* *'tsl'*
8551'ttyscroll' 'tsl' number (default 999)
8552 global
8553 Maximum number of lines to scroll the screen. If there are more lines
8554 to scroll the window is redrawn. For terminals where scrolling is
8555 very slow and redrawing is not slow this can be set to a small number,
8556 e.g., 3, to speed up displaying.
8557
8558 *'ttytype'* *'tty'*
8559'ttytype' 'tty' string (default from $TERM)
8560 global
8561 Alias for 'term', see above.
8562
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008563 *'undodir'* *'udir'*
8564'undodir' 'udir' string (default ".")
8565 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008566 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008567 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008568 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008569 "." means using the directory of the file. The undo file name for
8570 "file.txt" is ".file.txt.un~".
8571 For other directories the file name is the full path of the edited
8572 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008573 When writing: The first directory that exists is used. "." always
8574 works, no directories after "." will be used for writing.
8575 When reading all entries are tried to find an undo file. The first
8576 undo file that exists is used. When it cannot be read an error is
8577 given, no further entry is used.
8578 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008579 This option cannot be set from a |modeline| or in the |sandbox|, for
8580 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008581
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008582 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008583'undofile' 'udf' boolean (default off)
8584 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008585 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008586 When on, Vim automatically saves undo history to an undo file when
8587 writing a buffer to a file, and restores undo history from the same
8588 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008589 The directory where the undo file is stored is specified by 'undodir'.
8590 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008591 The undo file is not read when 'undoreload' causes the buffer from
8592 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008593 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008594 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008595
Bram Moolenaar071d4272004-06-13 20:20:40 +00008596 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008597'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008598 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008599 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008600 is kept in memory, higher numbers will cause more memory to be used.
8601 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008602 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8603 itself: >
8604 set ul=0
8605< But you can also get Vi compatibility by including the 'u' flag in
8606 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008607 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008608 Set to -1 for no undo at all. You might want to do this only for the
8609 current buffer: >
8610 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008611< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008612
8613 The local value is set to -123456 when the global value is to be used.
8614
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008615 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008616
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008617 *'undoreload'* *'ur'*
8618'undoreload' 'ur' number (default 10000)
8619 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008620 Save the whole buffer for undo when reloading it. This applies to the
8621 ":e!" command and reloading for when the buffer changed outside of
8622 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008623 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008624 of lines is smaller than the value of this option.
8625 Set this option to zero to disable undo for a reload.
8626
8627 When saving undo for a reload, any undo file is not read.
8628
8629 Note that this causes the whole buffer to be stored in memory. Set
8630 this option to a lower value if you run out of memory.
8631
Bram Moolenaar071d4272004-06-13 20:20:40 +00008632 *'updatecount'* *'uc'*
8633'updatecount' 'uc' number (default: 200)
8634 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008635 After typing this many characters the swap file will be written to
8636 disk. When zero, no swap file will be created at all (see chapter on
8637 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8638 Vim with the "-n" option, see |startup|. When editing in readonly
8639 mode this option will be initialized to 10000.
8640 The swapfile can be disabled per buffer with |'swapfile'|.
8641 When 'updatecount' is set from zero to non-zero, swap files are
8642 created for all buffers that have 'swapfile' set. When 'updatecount'
8643 is set to zero, existing swap files are not deleted.
8644 Also see |'swapsync'|.
8645 This option has no meaning in buffers where |'buftype'| is "nofile"
8646 or "nowrite".
8647
8648 *'updatetime'* *'ut'*
8649'updatetime' 'ut' number (default 4000)
8650 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008651 If this many milliseconds nothing is typed the swap file will be
8652 written to disk (see |crash-recovery|). Also used for the
8653 |CursorHold| autocommand event.
8654
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008655 *'varsofttabstop'* *'vsts'*
8656'varsofttabstop' 'vsts' string (default "")
8657 local to buffer
8658 {only available when compiled with the |+vartabs|
8659 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008660 A list of the number of spaces that a <Tab> counts for while editing,
8661 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8662 width <Tab>s are being inserted, while in fact a mixture of spaces
8663 and <Tab>s is used. Tab widths are separated with commas, with the
8664 final value applying to all subsequent tabs.
8665
8666 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008667 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008668 to use the following: >
8669 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008670< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8671 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008672
8673 Note that the value of |'softtabstop'| will be ignored while
8674 'varsofttabstop' is set.
8675
8676 *'vartabstop'* *'vts'*
8677'vartabstop' 'vts' string (default "")
8678 local to buffer
8679 {only available when compiled with the |+vartabs|
8680 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008681 A list of the number of spaces that a <Tab> in the file counts for,
8682 separated by commas. Each value corresponds to one tab, with the
8683 final value applying to all subsequent tabs. For example: >
8684 :set vartabstop=4,20,10,8
8685< This will make the first tab 4 spaces wide, the second 20 spaces,
8686 the third 10 spaces, and all following tabs 8 spaces.
8687
8688 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8689 is set.
8690
Bram Moolenaar071d4272004-06-13 20:20:40 +00008691 *'verbose'* *'vbs'*
8692'verbose' 'vbs' number (default 0)
8693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694 When bigger than zero, Vim will give messages about what it is doing.
8695 Currently, these messages are given:
8696 >= 1 When the viminfo file is read or written.
8697 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008698 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008699 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008700 >= 8 Files for which a group of autocommands is executed.
8701 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008702 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008703 >= 12 Every executed function.
8704 >= 13 When an exception is thrown, caught, finished, or discarded.
8705 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008706 >= 15 Every executed Ex command from a script (truncated at 200
8707 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008708 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709
8710 This option can also be set with the "-V" argument. See |-V|.
8711 This option is also set by the |:verbose| command.
8712
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008713 When the 'verbosefile' option is set then the verbose messages are not
8714 displayed.
8715
8716 *'verbosefile'* *'vfile'*
8717'verbosefile' 'vfile' string (default empty)
8718 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008719 When not empty all messages are written in a file with this name.
8720 When the file exists messages are appended.
8721 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008722 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008723 Setting 'verbosefile' to a new value is like making it empty first.
8724 The difference with |:redir| is that verbose messages are not
8725 displayed when 'verbosefile' is set.
8726
Bram Moolenaar071d4272004-06-13 20:20:40 +00008727 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008728'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008729 "$VIM/vimfiles/view",
8730 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008731 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008732 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008734 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008735 feature}
8736 Name of the directory where to store files for |:mkview|.
8737 This option cannot be set from a |modeline| or in the |sandbox|, for
8738 security reasons.
8739
8740 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008741'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008742 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008743 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008744 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008745 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008746 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008747 word save and restore ~
8748 cursor cursor position in file and in window
8749 folds manually created folds, opened/closed folds and local
8750 fold options
8751 options options and mappings local to a window or buffer (not
8752 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008753 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 slash backslashes in file names replaced with forward
8755 slashes
8756 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008757 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008758 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008759
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008760 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008761 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008762 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763
8764 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008765'viminfo' 'vi' string (Vi default: "", Vim default for
8766 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008767 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8768 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008769 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008770 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771 feature}
8772 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008773 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8774 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008775 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008776 consisting of a single character identifying the particular parameter,
8777 followed by a number or string which specifies the value of that
8778 parameter. If a particular character is left out, then the default
8779 value is used for that parameter. The following is a list of the
8780 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008781 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008782 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008783 ! When included, save and restore global variables that start
8784 with an uppercase letter, and don't contain a lowercase
8785 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008786 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008787 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008788 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008789 " Maximum number of lines saved for each register. Old name of
8790 the '<' item, with the disadvantage that you need to put a
8791 backslash before the ", otherwise it will be recognized as the
8792 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008793 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008794 % When included, save and restore the buffer list. If Vim is
8795 started with a file name argument, the buffer list is not
8796 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008797 buffer list is restored from the viminfo file. Quickfix
8798 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8799 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008800 When followed by a number, the number specifies the maximum
8801 number of buffers that are stored. Without a number all
8802 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008803 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008804 ' Maximum number of previously edited files for which the marks
8805 are remembered. This parameter must always be included when
8806 'viminfo' is non-empty.
8807 Including this item also means that the |jumplist| and the
8808 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008809 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008810 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008811 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008812 patterns are also saved. When not included, the value of
8813 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008814 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008815 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008816 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008817 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818 < Maximum number of lines saved for each register. If zero then
8819 registers are not saved. When not included, all lines are
8820 saved. '"' is the old name for this item.
8821 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008822 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008823 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008824 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008825 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826 c When included, convert the text in the viminfo file from the
8827 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008828 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008829 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008830 f Whether file marks need to be stored. If zero, file marks ('0
8831 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008832 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008833 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008834 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008835 h Disable the effect of 'hlsearch' when loading the viminfo
8836 file. When not included, it depends on whether ":nohlsearch"
8837 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008838 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008839 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008840 the 'n'. Must be at the end of the option! If the
8841 'viminfofile' option is set, that file name overrides the one
8842 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008843 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008844 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008845 r Removable media. The argument is a string (up to the next
8846 ','). This parameter can be given several times. Each
8847 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008848 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008849 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8850 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8851 ignored. Maximum length of each 'r' argument is 50
8852 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008853 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 s Maximum size of an item in Kbyte. If zero then registers are
8855 not saved. Currently only applies to registers. The default
8856 "s10" will exclude registers with more than 10 Kbyte of text.
8857 Also see the '<' item above: line count limit.
8858
8859 Example: >
8860 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8861<
8862 '50 Marks will be remembered for the last 50 files you
8863 edited.
8864 <1000 Contents of registers (up to 1000 lines each) will be
8865 remembered.
8866 s100 Registers with more than 100 Kbyte text are skipped.
8867 :0 Command-line history will not be saved.
8868 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8869 no / Since '/' is not specified, the default will be used,
8870 that is, save all of the search history, and also the
8871 previous search and substitute patterns.
8872 no % The buffer list will not be saved nor read back.
8873 no h 'hlsearch' highlighting will be restored.
8874
8875 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8876 load the contents of the file, this is not done automatically.
8877
8878 This option cannot be set from a |modeline| or in the |sandbox|, for
8879 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008880 NOTE: This option is set to the Vim default value when 'compatible'
8881 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008882
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008883 *'viminfofile'* *'vif'*
8884'viminfofile' 'vif' string (default: "")
8885 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008886 {not available when compiled without the |+viminfo|
8887 feature}
8888 When non-empty, overrides the file name used for viminfo.
8889 When equal to "NONE" no viminfo file will be read or written.
8890 This option can be set with the |-i| command line flag. The |--clean|
8891 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008892 This option cannot be set from a |modeline| or in the |sandbox|, for
8893 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008894
Bram Moolenaar071d4272004-06-13 20:20:40 +00008895 *'virtualedit'* *'ve'*
8896'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008897 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008898 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008899 block Allow virtual editing in Visual block mode.
8900 insert Allow virtual editing in Insert mode.
8901 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008902 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008903 none When used as the local value, do not allow virtual
8904 editing even when the global value is set. When used
8905 as the global value, "none" is the same as "".
8906 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008907
Bram Moolenaar071d4272004-06-13 20:20:40 +00008908 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008909 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008910 of the line. Useful for selecting a rectangle in Visual mode and
8911 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008912 "onemore" is not the same, it will only allow moving the cursor just
8913 after the last character of the line. This makes some commands more
8914 consistent. Previously the cursor was always past the end of the line
8915 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008916 break some plugins or Vim scripts. For example because |l| can move
8917 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008918 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008919 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008920 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008921 It doesn't make sense to combine "all" with "onemore", but you will
8922 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008923 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008924 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008925
8926 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8927'visualbell' 'vb' boolean (default off)
8928 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008929 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008930 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008931 use: >
8932 :set vb t_vb=
8933< If you want a short flash, you can use this on many terminals: >
8934 :set vb t_vb=[?5h$<100>[?5l
8935< Here $<100> specifies the time, you can use a smaller or bigger value
8936 to get a shorter or longer flash.
8937
8938 Note: Vim will limit the bell to once per half a second. This avoids
8939 having to wait for the flashing to finish when there are lots of
8940 bells, e.g. on key repeat. This also happens without 'visualbell'
8941 set.
8942
Bram Moolenaar071d4272004-06-13 20:20:40 +00008943 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8944 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8945 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008946
8947 Note: When the GUI starts, 't_vb' is reset to its default value. You
8948 might want to set it again in your |gvimrc|.
8949
Bram Moolenaar071d4272004-06-13 20:20:40 +00008950 Does not work on the Amiga, you always get a screen flash.
8951 Also see 'errorbells'.
8952
8953 *'warn'* *'nowarn'*
8954'warn' boolean (default on)
8955 global
8956 Give a warning message when a shell command is used while the buffer
8957 has been changed.
8958
8959 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8960'weirdinvert' 'wiv' boolean (default off)
8961 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008962 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008963 It is provided for backwards compatibility with version 4.x.
8964 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8965 vice versa. Has no effect when the GUI is running.
8966
8967 *'whichwrap'* *'ww'*
8968'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8969 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008970 Allow specified keys that move the cursor left/right to move to the
8971 previous/next line when the cursor is on the first/last character in
8972 the line. Concatenate characters to allow this for these keys:
8973 char key mode ~
8974 b <BS> Normal and Visual
8975 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008976 h "h" Normal and Visual (not recommended)
8977 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008978 < <Left> Normal and Visual
8979 > <Right> Normal and Visual
8980 ~ "~" Normal
8981 [ <Left> Insert and Replace
8982 ] <Right> Insert and Replace
8983 For example: >
8984 :set ww=<,>,[,]
8985< allows wrap only when cursor keys are used.
8986 When the movement keys are used in combination with a delete or change
8987 operator, the <EOL> also counts for a character. This makes "3h"
8988 different from "3dh" when the cursor crosses the end of a line. This
8989 is also true for "x" and "X", because they do the same as "dl" and
8990 "dh". If you use this, you may also want to use the mapping
8991 ":map <BS> X" to make backspace delete the character in front of the
8992 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008993 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008994 line (not an empty line) then it will not move to the next line. This
8995 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008996 NOTE: This option is set to the Vi default value when 'compatible' is
8997 set and to the Vim default value when 'compatible' is reset.
8998
8999 *'wildchar'* *'wc'*
9000'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9001 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009002 Character you have to type to start wildcard expansion in the
9003 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009004 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005 The character is not recognized when used inside a macro. See
9006 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009007 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009008 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009009 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009010< NOTE: This option is set to the Vi default value when 'compatible' is
9011 set and to the Vim default value when 'compatible' is reset.
9012
9013 *'wildcharm'* *'wcm'*
9014'wildcharm' 'wcm' number (default: none (0))
9015 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009017 recognized when used inside a macro. You can find "spare" command-line
9018 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019 you'll never actually type 'wildcharm', just use it in mappings that
9020 automatically invoke completion mode, e.g.: >
9021 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009022 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009023< Then after typing :ss you can use CTRL-P & CTRL-N.
9024
9025 *'wildignore'* *'wig'*
9026'wildignore' 'wig' string (default "")
9027 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009028 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009029 patterns is ignored when expanding |wildcards|, completing file or
9030 directory names, and influences the result of |expand()|, |glob()| and
9031 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009032 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9033 Also see 'suffixes'.
9034 Example: >
9035 :set wildignore=*.o,*.obj
9036< The use of |:set+=| and |:set-=| is preferred when adding or removing
9037 a pattern from the list. This avoids problems when a future version
9038 uses another default.
9039
Bram Moolenaar94950a92010-12-02 16:01:29 +01009040
Bram Moolenaar81af9252010-12-10 20:35:50 +01009041 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009042'wildignorecase' 'wic' boolean (default off)
9043 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009044 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009045 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009046 Does not apply when the shell is used to expand wildcards, which
9047 happens when there are special characters.
9048
9049
Bram Moolenaar071d4272004-06-13 20:20:40 +00009050 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009051'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009052 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009053 When 'wildmenu' is on, command-line completion operates in an enhanced
9054 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009055 the possible matches are shown.
9056 When 'wildoptions' contains "pum", then the completion matches are
9057 shown in a popup menu. Otherwise they are displayed just above the
9058 command line, with the first match highlighted (overwriting the status
9059 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009060 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009061 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9062 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9063 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009064 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009065 If there are more matches than can fit in the line, a ">" is shown on
9066 the right and/or a "<" is shown on the left. The status line scrolls
9067 as needed.
9068 The "wildmenu" mode is abandoned when a key is hit that is not used
9069 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009070 While the "wildmenu" is active, not using the popup menu, the
9071 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009072
9073 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9074 <Down> - in filename/menu name completion: move into a
9075 subdirectory or submenu.
9076 <CR> - in menu completion, when the cursor is just after a
9077 dot: move into a submenu.
9078 <Up> - in filename/menu name completion: move up into
9079 parent directory or parent menu.
9080
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009081 When using the popup menu for command line completion, the following
9082 keys have special meanings:
9083 <Down> - select next match (like CTRL-N)
9084 <Left> - in filename/menu name completion: move up into
9085 parent directory or parent menu.
9086 <Right> - in filename/menu name completion: move into a
9087 subdirectory or submenu.
9088 <Up> - select previous match (like CTRL-P)
9089 CTRL-E - end completion, go back to what was there before
9090 selecting a match.
9091 CTRL-N - go to the next entry
9092 CTRL-P - go to the previous entry
9093 CTRL-Y - accept the currently selected match and stop
9094 completion.
9095
Bram Moolenaar071d4272004-06-13 20:20:40 +00009096 This makes the menus accessible from the console |console-menus|.
9097
9098 If you prefer the <Left> and <Right> keys to move the cursor instead
9099 of selecting a different match, use this: >
9100 :cnoremap <Left> <Space><BS><Left>
9101 :cnoremap <Right> <Space><BS><Right>
9102<
9103 The "WildMenu" highlighting is used for displaying the current match
9104 |hl-WildMenu|.
9105
9106 *'wildmode'* *'wim'*
9107'wildmode' 'wim' string (Vim default: "full")
9108 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009109 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009110 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009111 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009112 first part specifies the behavior for the first use of 'wildchar',
9113 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009114
9115 Each part consists of a colon separated list consisting of the
9116 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009117 "" Complete only the first match.
9118 "full" Complete the next full match. After the last match,
9119 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009120 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009121 "longest" Complete till longest common string. If this doesn't
9122 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009123 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009124 "lastused" When completing buffer names and more than one buffer
9125 matches, sort buffers by time last used (other than
9126 the current buffer).
9127 When there is only a single match, it is fully completed in all cases.
9128
9129 Examples of useful colon-separated values:
9130 "longest:full" Like "longest", but also start 'wildmenu' if it is
9131 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009132 "list:full" When more than one match, list all matches and
9133 complete first match.
9134 "list:longest" When more than one match, list all matches and
9135 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009136 "list:lastused" When more than one buffer matches, list all matches
9137 and sort buffers by time last used (other than the
9138 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009139
9140 Examples: >
9141 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009142< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009143 :set wildmode=longest,full
9144< Complete longest common string, then each full match >
9145 :set wildmode=list:full
9146< List all matches and complete each full match >
9147 :set wildmode=list,full
9148< List all matches without completing, then each full match >
9149 :set wildmode=longest,list
9150< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009151 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009152
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009153 *'wildoptions'* *'wop'*
9154'wildoptions' 'wop' string (default "")
9155 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009156 A list of words that change how |cmdline-completion| is done.
9157 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009158 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009159 this value is specified, wildcard expansion will not
9160 be used for completion. The matches will be sorted by
9161 the "best match" rather than alphabetically sorted.
9162 This will find more matches than the wildcard
9163 expansion. Currently fuzzy matching based completion
9164 is not supported for file and directory names and
9165 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009166 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009167 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009168 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009169 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009170 is displayed per line. Often used tag kinds are:
9171 d #define
9172 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009173
Bram Moolenaar071d4272004-06-13 20:20:40 +00009174 *'winaltkeys'* *'wak'*
9175'winaltkeys' 'wak' string (default "menu")
9176 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009177 {only used in Win32, Motif, GTK and Photon GUI}
9178 Some GUI versions allow the access to menu entries by using the ALT
9179 key in combination with a character that appears underlined in the
9180 menu. This conflicts with the use of the ALT key for mappings and
9181 entering special characters. This option tells what to do:
9182 no Don't use ALT keys for menus. ALT key combinations can be
9183 mapped, but there is no automatic handling. This can then be
9184 done with the |:simalt| command.
9185 yes ALT key handling is done by the windowing system. ALT key
9186 combinations cannot be mapped.
9187 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009188 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009189 keys can be mapped.
9190 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9191 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009192 This option is not used for <F10>; on Win32 and with GTK <F10> will
9193 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009194
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009195 *'wincolor'* *'wcr'*
9196'wincolor' 'wcr' string (default empty)
9197 local to window
9198 Highlight group name to use for this window instead of the Normal
9199 color |hl-Normal|.
9200
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009201 *'window'* *'wi'*
9202'window' 'wi' number (default screen height - 1)
9203 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009204 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9205 window and the value is smaller than 'lines' minus one. The screen
9206 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009207 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9208 in a much smarter way, taking care of wrapping lines.
9209 When resizing the Vim window, the value is smaller than 1 or more than
9210 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009211 Note: Do not confuse this with the height of the Vim window, use
9212 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009213
Bram Moolenaar071d4272004-06-13 20:20:40 +00009214 *'winheight'* *'wh'* *E591*
9215'winheight' 'wh' number (default 1)
9216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009217 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009218 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009219 focus goes to a window that is smaller, its size is increased, at the
9220 cost of the height of other windows.
9221 Set 'winheight' to a small number for normal editing.
9222 Set it to 999 to make the current window fill most of the screen.
9223 Other windows will be only 'winminheight' high. This has the drawback
9224 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9225 to create only two windows, set the option after startup is done,
9226 using the |VimEnter| event: >
9227 au VimEnter * set winheight=999
9228< Minimum value is 1.
9229 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009230 height of the current window.
9231 'winheight' applies to the current window. Use 'winminheight' to set
9232 the minimal height for other windows.
9233
9234 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9235'winfixheight' 'wfh' boolean (default off)
9236 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009237 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009238 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9239 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009240 The height may be changed anyway when running out of room.
9241
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009242 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9243'winfixwidth' 'wfw' boolean (default off)
9244 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009245 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009246 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009247 The width may be changed anyway when running out of room.
9248
Bram Moolenaar071d4272004-06-13 20:20:40 +00009249 *'winminheight'* *'wmh'*
9250'winminheight' 'wmh' number (default 1)
9251 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009252 The minimal height of a window, when it's not the current window.
9253 This is a hard minimum, windows will never become smaller.
9254 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9255 status bar) if necessary. They will return to at least one line when
9256 they become active (since the cursor has to have somewhere to go.)
9257 Use 'winheight' to set the minimal height of the current window.
9258 This option is only checked when making a window smaller. Don't use a
9259 large number, it will cause errors when opening more than a few
9260 windows. A value of 0 to 3 is reasonable.
9261
9262 *'winminwidth'* *'wmw'*
9263'winminwidth' 'wmw' number (default 1)
9264 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009265 The minimal width of a window, when it's not the current window.
9266 This is a hard minimum, windows will never become smaller.
9267 When set to zero, windows may be "squashed" to zero columns (i.e. just
9268 a vertical separator) if necessary. They will return to at least one
9269 line when they become active (since the cursor has to have somewhere
9270 to go.)
9271 Use 'winwidth' to set the minimal width of the current window.
9272 This option is only checked when making a window smaller. Don't use a
9273 large number, it will cause errors when opening more than a few
9274 windows. A value of 0 to 12 is reasonable.
9275
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009276 *'winptydll'*
9277'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9278 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009279 {only available when compiled with the |terminal|
9280 feature on MS-Windows}
9281 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009282 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009283 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009284 a fallback.
9285 Environment variables are expanded |:set_env|.
9286 This option cannot be set from a |modeline| or in the |sandbox|, for
9287 security reasons.
9288
Bram Moolenaar071d4272004-06-13 20:20:40 +00009289 *'winwidth'* *'wiw'* *E592*
9290'winwidth' 'wiw' number (default 20)
9291 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009292 Minimal number of columns for the current window. This is not a hard
9293 minimum, Vim will use fewer columns if there is not enough room. If
9294 the current window is smaller, its size is increased, at the cost of
9295 the width of other windows. Set it to 999 to make the current window
9296 always fill the screen. Set it to a small number for normal editing.
9297 The width is not adjusted after one of the commands to change the
9298 width of the current window.
9299 'winwidth' applies to the current window. Use 'winminwidth' to set
9300 the minimal width for other windows.
9301
9302 *'wrap'* *'nowrap'*
9303'wrap' boolean (default on)
9304 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009305 This option changes how text is displayed. It doesn't change the text
9306 in the buffer, see 'textwidth' for that.
9307 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009308 displaying continues on the next line. When off lines will not wrap
9309 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009310 moved to a part that is not shown, the screen will scroll
9311 horizontally.
9312 The line will be broken in the middle of a word if necessary. See
9313 'linebreak' to get the break at a word boundary.
9314 To make scrolling horizontally a bit more useful, try this: >
9315 :set sidescroll=5
9316 :set listchars+=precedes:<,extends:>
9317< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009318 This option can't be set from a |modeline| when the 'diff' option is
9319 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009320
9321 *'wrapmargin'* *'wm'*
9322'wrapmargin' 'wm' number (default 0)
9323 local to buffer
9324 Number of characters from the right window border where wrapping
9325 starts. When typing text beyond this limit, an <EOL> will be inserted
9326 and inserting continues on the next line.
9327 Options that add a margin, such as 'number' and 'foldcolumn', cause
9328 the text width to be further reduced. This is Vi compatible.
9329 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009330 This option is set to 0 when 'paste' is set and restored when 'paste'
9331 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009332 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009333
9334 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9335'wrapscan' 'ws' boolean (default on) *E384* *E385*
9336 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009337 Searches wrap around the end of the file. Also applies to |]s| and
9338 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009339
9340 *'write'* *'nowrite'*
9341'write' boolean (default on)
9342 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009343 Allows writing files. When not set, writing a file is not allowed.
9344 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009345 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009346 argument. Filtering text is still possible, even though this requires
9347 writing a temporary file.
9348
9349 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9350'writeany' 'wa' boolean (default off)
9351 global
9352 Allows writing to any file with no need for "!" override.
9353
9354 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9355'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9356 otherwise)
9357 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009358 Make a backup before overwriting a file. The backup is removed after
9359 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009360 also on.
9361 WARNING: Switching this option off means that when Vim fails to write
9362 your buffer correctly and then, for whatever reason, Vim exits, you
9363 lose both the original file and what you were writing. Only reset
9364 this option if your file system is almost full and it makes the write
9365 fail (and make sure not to exit Vim until the write was successful).
9366 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009367 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009368 Depending on 'backupcopy' the backup is a new file or the original
9369 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009370 NOTE: This option is set to the default value when 'compatible' is
9371 set.
9372
9373 *'writedelay'* *'wd'*
9374'writedelay' 'wd' number (default 0)
9375 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009376 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009377 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009378 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009379
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009380 *'xtermcodes'* *'noxtermcodes'*
9381'xtermcodes' boolean (default on)
9382 global
9383 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009384 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009385 key codes and number of colors from the terminal. This takes care of
9386 various configuration options of the terminal that cannot be obtained
9387 from the termlib/terminfo entry, see |xterm-codes|.
9388 A side effect may be that t_Co changes and Vim will redraw the
9389 display.
9390
9391
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009392 vim:tw=78:ts=8:noet:ft=help:norl: