blob: 4ea75ba2db367707f49ee95709637abea00c136d [file] [log] [blame]
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001*options.txt* For Vim version 9.0. Last change: 2022 Sep 27
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
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001705< When using the GUI see |'go-A'|.
1706 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001708 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 unnamed When included, Vim will use the clipboard register '*'
1710 for all yank, delete, change and put operations which
1711 would normally go to the unnamed register. When a
1712 register is explicitly specified, it will always be
1713 used regardless of whether "unnamed" is in 'clipboard'
1714 or not. The clipboard register can always be
1715 explicitly accessed using the "* notation. Also see
1716 |gui-clipboard|.
1717
Bram Moolenaar30b65812012-07-12 22:01:11 +02001718 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001719 unnamedplus A variant of the "unnamed" flag which uses the
1720 clipboard register '+' (|quoteplus|) instead of
1721 register '*' for all yank, delete, change and put
1722 operations which would normally go to the unnamed
1723 register. When "unnamed" is also included to the
1724 option, yank operations (but not delete, change or
1725 put) will additionally copy the text into register
1726 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001727 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001728 Availability can be checked with: >
1729 if has('unnamedplus')
1730<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001731 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 autoselect Works like the 'a' flag in 'guioptions': If present,
1733 then whenever Visual mode is started, or the Visual
1734 area extended, Vim tries to become the owner of the
1735 windowing system's global selection or put the
1736 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001737 register "*. See |'go-a'| and |quotestar| for details.
1738 When the GUI is active, the 'a' flag in 'guioptions'
1739 is used, when the GUI is not active, this "autoselect"
1740 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741 Also applies to the modeless selection.
1742
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001743 *clipboard-autoselectplus*
1744 autoselectplus Like "autoselect" but using the + register instead of
1745 the * register. Compare to the 'P' flag in
1746 'guioptions'.
1747
1748 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749 autoselectml Like "autoselect", but for the modeless selection
1750 only. Compare to the 'A' flag in 'guioptions'.
1751
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001752 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001753 html When the clipboard contains HTML, use this when
1754 pasting. When putting text on the clipboard, mark it
1755 as HTML. This works to copy rendered HTML from
1756 Firefox, paste it as raw HTML in Vim, select the HTML
1757 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001758 You probably want to add this only temporarily,
1759 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001760 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001761
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001762 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763 exclude:{pattern}
1764 Defines a pattern that is matched against the name of
1765 the terminal 'term'. If there is a match, no
1766 connection will be made to the X server. This is
1767 useful in this situation:
1768 - Running Vim in a console.
1769 - $DISPLAY is set to start applications on another
1770 display.
1771 - You do not want to connect to the X server in the
1772 console, but do want this in a terminal emulator.
1773 To never connect to the X server use: >
1774 exclude:.*
1775< This has the same effect as using the |-X| argument.
1776 Note that when there is no connection to the X server
1777 the window title won't be restored and the clipboard
1778 cannot be accessed.
1779 The value of 'magic' is ignored, {pattern} is
1780 interpreted as if 'magic' was on.
1781 The rest of the option value will be used for
1782 {pattern}, this must be the last entry.
1783
1784 *'cmdheight'* *'ch'*
1785'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001786 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001787 Number of screen lines to use for the command-line. A larger value
1788 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001789 The value of this option is stored with the tab page, so that each tab
1790 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791
1792 *'cmdwinheight'* *'cwh'*
1793'cmdwinheight' 'cwh' number (default 7)
1794 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001795 Number of screen lines to use for the command-line window. |cmdwin|
1796
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001797 *'colorcolumn'* *'cc'*
1798'colorcolumn' 'cc' string (default "")
1799 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001800 {not available when compiled without the |+syntax|
1801 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001802 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001803 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1804 text. Will make screen redrawing slower.
1805 The screen column can be an absolute number, or a number preceded with
1806 '+' or '-', which is added to or subtracted from 'textwidth'. >
1807
1808 :set cc=+1 " highlight column after 'textwidth'
1809 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1810 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1811<
1812 When 'textwidth' is zero then the items with '-' and '+' are not used.
1813 A maximum of 256 columns are highlighted.
1814
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 *'columns'* *'co'* *E594*
1816'columns' 'co' number (default 80 or terminal width)
1817 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001819 initialization and does not have to be set by hand. Also see
1820 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 When Vim is running in the GUI or in a resizable window, setting this
1822 option will cause the window size to be changed. When you only want
1823 to use the size for the GUI, put the command in your |gvimrc| file.
1824 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001825 number of columns of the display, the display may be messed up. For
1826 the GUI it is always possible and Vim limits the number of columns to
1827 what fits on the screen. You can use this command to get the widest
1828 window possible: >
1829 :set columns=9999
1830< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831
1832 *'comments'* *'com'* *E524* *E525*
1833'comments' 'com' string (default
1834 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1835 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001836 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837 |format-comments|. See |option-backslash| about using backslashes to
1838 insert a space.
1839
1840 *'commentstring'* *'cms'* *E537*
1841'commentstring' 'cms' string (default "/*%s*/")
1842 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843 {not available when compiled without the |+folding|
1844 feature}
1845 A template for a comment. The "%s" in the value is replaced with the
1846 comment text. Currently only used to add markers for folding, see
1847 |fold-marker|.
1848
1849 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001850'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001851 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853 This option has the effect of making Vim either more Vi-compatible, or
1854 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001855
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001857 other options are also changed as a side effect.
1858 NOTE: Setting or resetting this option can have a lot of unexpected
1859 effects: Mappings are interpreted in another way, undo behaves
1860 differently, etc. If you set this option in your vimrc file, you
1861 should probably put it at the very start.
1862
Bram Moolenaar071d4272004-06-13 20:20:40 +00001863 By default this option is on and the Vi defaults are used for the
1864 options. This default was chosen for those people who want to use Vim
1865 just like Vi, and don't even (want to) know about the 'compatible'
1866 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001867 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001868 this option is switched off, and all options that have not been
1869 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001870 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001871 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001872 happen for the system-wide vimrc or gvimrc file, nor for a file given
1873 with the |-u| argument). Also see |compatible-default| and
1874 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875 You can also set this option with the "-C" argument, and reset it with
1876 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001877 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878
Bram Moolenaar214641f2017-03-05 17:04:09 +01001879 When this option is set, numerous other options are set to make Vim as
1880 Vi-compatible as possible. When this option is unset, various options
1881 are set to make Vim more useful. The table below lists all the
1882 options affected.
1883 The {?} column indicates when the options are affected:
1884 + Means that the option is set to the value given in {set value} when
1885 'compatible' is set.
1886 & Means that the option is set to the value given in {set value} when
1887 'compatible' is set AND is set to its Vim default value when
1888 'compatible' is unset.
1889 - Means the option is NOT changed when setting 'compatible' but IS
1890 set to its Vim default when 'compatible' is unset.
1891 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892
Bram Moolenaar036986f2017-03-16 17:41:02 +01001893 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001894
1895 'allowrevins' + off no CTRL-_ command
1896 'antialias' + off don't use antialiased fonts
1897 'arabic' + off reset arabic-related options
1898 'arabicshape' + on correct character shapes
1899 'backspace' + "" normal backspace
1900 'backup' + off no backup file
1901 'backupcopy' & Unix: "yes" backup file is a copy
1902 else: "auto" copy or rename backup file
1903 'balloonexpr' + "" text to show in evaluation balloon
1904 'breakindent' + off don't indent when wrapping lines
1905 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001906 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001907 'cindent' + off no C code indentation
1908 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1909 'copyindent' + off don't copy indent structure
1910 'cpoptions' & (all flags) Vi-compatible flags
1911 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001912 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001913 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001914 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001915 'cscopeverbose' + off see |cscopeverbose|
1916 'delcombine' + off unicode: delete whole char combination
1917 'digraph' + off no digraphs
1918 'esckeys' & off no <Esc>-keys in Insert mode
1919 'expandtab' + off tabs not expanded to spaces
1920 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001921 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001922 'formatexpr' + "" use 'formatprg' for auto-formatting
1923 'formatoptions' & "vt" Vi compatible formatting
1924 'gdefault' + off no default 'g' flag for ":s"
1925 'history' & 0 no commandline history
1926 'hkmap' + off no Hebrew keyboard mapping
1927 'hkmapp' + off no phonetic Hebrew keyboard mapping
1928 'hlsearch' + off no highlighting of search matches
1929 'incsearch' + off no incremental searching
1930 'indentexpr' + "" no indenting by expression
1931 'insertmode' + off do not start in Insert mode
1932 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001934 'joinspaces' + on insert 2 spaces after period
1935 'modeline' & off no modelines
1936 'more' & off no pauses in listings
1937 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1938 'numberwidth' & 8 min number of columns for line number
1939 'preserveindent'+ off don't preserve current indent structure
1940 when changing it
1941 'revins' + off no reverse insert
1942 'ruler' + off no ruler
1943 'scrolljump' + 1 no jump scroll
1944 'scrolloff' + 0 no scroll offset
1945 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1946 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001947 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001948 'showcmd' & off command characters not shown
1949 'showmode' & off current mode not shown
1950 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1951 'smartcase' + off no automatic ignore case switch
1952 'smartindent' + off no smart indentation
1953 'smarttab' + off no smart tab size
1954 'softtabstop' + 0 tabs are always 'tabstop' positions
1955 'startofline' + on goto startofline with some commands
1956 'tagcase' & "followic" 'ignorecase' when searching tags file
1957 'tagrelative' & off tag file names are not relative
1958 'termguicolors' + off don't use highlight-(guifg|guibg)
1959 'textauto' & off no automatic textmode detection
1960 'textwidth' + 0 no automatic line wrap
1961 'tildeop' + off tilde is not an operator
1962 'ttimeout' + off no terminal timeout
1963 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001964 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001965 'virtualedit' + "" cursor can only be placed on characters
1966 'whichwrap' & "" left-right movements don't wrap
1967 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001969 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001970
1971 *'complete'* *'cpt'* *E535*
1972'complete' 'cpt' string (default: ".,w,b,u,t,i")
1973 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974 This option specifies how keyword completion |ins-completion| works
1975 when CTRL-P or CTRL-N are used. It is also used for whole-line
1976 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001977 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001978 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979 w scan buffers from other windows
1980 b scan other loaded buffers that are in the buffer list
1981 u scan the unloaded buffers that are in the buffer list
1982 U scan the buffers that are not in the buffer list
1983 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001984 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001985 k{dict} scan the file {dict}. Several "k" flags can be given,
1986 patterns are valid too. For example: >
1987 :set cpt=k/usr/dict/*,k~/spanish
1988< s scan the files given with the 'thesaurus' option
1989 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1990 are valid too.
1991 i scan current and included files
1992 d scan current and included files for defined name or macro
1993 |i_CTRL-X_CTRL-D|
1994 ] tag completion
1995 t same as "]"
1996
1997 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1998 not executed, this may lead to unexpected completions from some files
1999 (gzipped files for example). Unloaded buffers are not scanned for
2000 whole-line completion.
2001
2002 The default is ".,w,b,u,t,i", which means to scan:
2003 1. the current buffer
2004 2. buffers in other windows
2005 3. other loaded buffers
2006 4. unloaded buffers
2007 5. tags
2008 6. included files
2009
2010 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002011 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2012 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002014 *'completefunc'* *'cfu'*
2015'completefunc' 'cfu' string (default: empty)
2016 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002017 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002018 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002019 This option specifies a function to be used for Insert mode completion
2020 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002021 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002022 invoked and what it should return. The value can be the name of a
2023 function, a |lambda| or a |Funcref|. See |option-value-function| for
2024 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002025 This option cannot be set from a |modeline| or in the |sandbox|, for
2026 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002027
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002028 *'completeslash'* *'csl'*
2029'completeslash' 'csl' string (default: "")
2030 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002031 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002032 When this option is set it overrules 'shellslash' for completion:
2033 - When this option is set to "slash", a forward slash is used for path
2034 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002035 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002036 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002037 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002038 - When this option is empty, same character is used as for
2039 'shellslash'.
2040 For Insert mode completion the buffer-local value is used. For
2041 command line completion the global value is used.
2042
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002043 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002044'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002045 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002046 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002047 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002048
2049 menu Use a popup menu to show the possible completions. The
2050 menu is only shown when there is more than one match and
2051 sufficient colors are available. |ins-completion-menu|
2052
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002053 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002054 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002055 match, e.g., what file it comes from.
2056
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002057 longest Only insert the longest common text of the matches. If
2058 the menu is displayed you can use CTRL-L to add more
2059 characters. Whether case is ignored depends on the kind
2060 of completion. For buffer text the 'ignorecase' option is
2061 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002062
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002063 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002064 completion in the preview window. Only works in
2065 combination with "menu" or "menuone".
2066
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002067 popup Show extra information about the currently selected
2068 completion in a popup window. Only works in combination
2069 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002070 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002071 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002072
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002073 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002074 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002075 |CompleteChanged| autocommand to fetch the info and call
2076 |popup_show()| once the popup has been filled.
2077 See the example at |complete-popuphidden|.
2078 {only works when compiled with the |+textprop| feature}
2079
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002080 noinsert Do not insert any text for a match until the user selects
2081 a match from the menu. Only works in combination with
2082 "menu" or "menuone". No effect if "longest" is present.
2083
2084 noselect Do not select a match in the menu, force the user to
2085 select one from the menu. Only works in combination with
2086 "menu" or "menuone".
2087
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002088
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002089 *'completepopup'* *'cpp'*
2090'completepopup' 'cpp' string (default empty)
2091 global
2092 {not available when compiled without the |+textprop|
2093 or |+quickfix| feature}
2094 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002095 properties of the info popup when it is created. If an info popup
2096 window already exists it is closed, so that the option value is
2097 applied when it is created again.
2098 You can also use |popup_findinfo()| and then set properties for an
2099 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002100
2101
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002102 *'concealcursor'* *'cocu'*
2103'concealcursor' 'cocu' string (default: "")
2104 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002105 {not available when compiled without the |+conceal|
2106 feature}
2107 Sets the modes in which text in the cursor line can also be concealed.
2108 When the current mode is listed then concealing happens just like in
2109 other lines.
2110 n Normal mode
2111 v Visual mode
2112 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002113 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002114
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002115 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002116 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002117 are moving around text is concealed, but when starting to insert text
2118 or selecting a Visual area the concealed text is displayed, so that
2119 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002120 Keep in mind that the cursor position is not always where it's
2121 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002122
2123
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002124 *'conceallevel'* *'cole'*
2125'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002126 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002127 {not available when compiled without the |+conceal|
2128 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002129 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2130 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002131
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002132 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002133 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002134 1 Each block of concealed text is replaced with one
2135 character. If the syntax item does not have a custom
2136 replacement character defined (see |:syn-cchar|) the
2137 character defined in 'listchars' is used (default is a
2138 space).
2139 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002140 2 Concealed text is completely hidden unless it has a
2141 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002142 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002143 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002144
Bram Moolenaara7781e02010-07-19 20:13:22 +02002145 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002146 edit and copy the text. This can be changed with the 'concealcursor'
2147 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002148
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2150'confirm' 'cf' boolean (default off)
2151 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152 When 'confirm' is on, certain operations that would normally
2153 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2154 instead raise a |dialog| asking if you wish to save the current
2155 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2156 If 'confirm' is off you can still activate confirmation for one
2157 command only (this is most useful in mappings) with the |:confirm|
2158 command.
2159 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2160
2161 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2162'conskey' 'consk' boolean (default off)
2163 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002164 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165
2166 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2167'copyindent' 'ci' boolean (default off)
2168 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002169 Copy the structure of the existing lines indent when autoindenting a
2170 new line. Normally the new indent is reconstructed by a series of
2171 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2172 in which case only spaces are used). Enabling this option makes the
2173 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002174 existing line. 'expandtab' has no effect on these characters, a Tab
2175 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002177 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 Also see 'preserveindent'.
2179
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002180 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181'cpoptions' 'cpo' string (Vim default: "aABceFs",
2182 Vi default: all flags)
2183 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002185 this indicates Vi-compatible behavior. This is used for things where
2186 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 'cpoptions' stands for "compatible-options".
2188 Commas can be added for readability.
2189 To avoid problems with flags that are added in the future, use the
2190 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002191
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192 NOTE: This option is set to the Vi default value when 'compatible' is
2193 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002194
2195 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2196 is saved, 'cpoptions' is set to the Vim default, and the saved value
2197 is restored at the end of the script. Changes to the value of
2198 'cpoptions' will be applied to the saved value, but keep in mind that
2199 removing a flag that is not present when 'cpoptions' is changed has no
2200 effect. In the |.vimrc| file the value is not restored, thus using
2201 `vim9script` in the |.vimrc| file results in using the Vim default.
2202
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002203 NOTE: This option is set to the POSIX default value at startup when
2204 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002205 variable exists |posix|. This means Vim tries to behave like the
2206 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207
2208 contains behavior ~
2209 *cpo-a*
2210 a When included, a ":read" command with a file name
2211 argument will set the alternate file name for the
2212 current window.
2213 *cpo-A*
2214 A When included, a ":write" command with a file name
2215 argument will set the alternate file name for the
2216 current window.
2217 *cpo-b*
2218 b "\|" in a ":map" command is recognized as the end of
2219 the map command. The '\' is included in the mapping,
2220 the text after the '|' is interpreted as the next
2221 command. Use a CTRL-V instead of a backslash to
2222 include the '|' in the mapping. Applies to all
2223 mapping, abbreviation, menu and autocmd commands.
2224 See also |map_bar|.
2225 *cpo-B*
2226 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002227 abbreviations, user commands and the "to" part of the
2228 menu commands. Remove this flag to be able to use a
2229 backslash like a CTRL-V. For example, the command
2230 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231 'B' included: "\^[" (^[ is a real <Esc>)
2232 'B' excluded: "<Esc>" (5 characters)
2233 ('<' excluded in both cases)
2234 *cpo-c*
2235 c Searching continues at the end of any match at the
2236 cursor position, but not further than the start of the
2237 next line. When not present searching continues
2238 one character from the cursor position. With 'c'
2239 "abababababab" only gets three matches when repeating
2240 "/abab", without 'c' there are five matches.
2241 *cpo-C*
2242 C Do not concatenate sourced lines that start with a
2243 backslash. See |line-continuation|.
2244 *cpo-d*
2245 d Using "./" in the 'tags' option doesn't mean to use
2246 the tags file relative to the current file, but the
2247 tags file in the current directory.
2248 *cpo-D*
2249 D Can't use CTRL-K to enter a digraph after Normal mode
2250 commands with a character argument, like |r|, |f| and
2251 |t|.
2252 *cpo-e*
2253 e When executing a register with ":@r", always add a
2254 <CR> to the last line, also when the register is not
2255 linewise. If this flag is not present, the register
2256 is not linewise and the last line does not end in a
2257 <CR>, then the last line is put on the command-line
2258 and can be edited before hitting <CR>.
2259 *cpo-E*
2260 E It is an error when using "y", "d", "c", "g~", "gu" or
2261 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002262 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263 This makes "y0" fail in the first column.
2264 *cpo-f*
2265 f When included, a ":read" command with a file name
2266 argument will set the file name for the current buffer,
2267 if the current buffer doesn't have a file name yet.
2268 *cpo-F*
2269 F When included, a ":write" command with a file name
2270 argument will set the file name for the current
2271 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002272 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273 *cpo-g*
2274 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002275 *cpo-H*
2276 H When using "I" on a line with only blanks, insert
2277 before the last blank. Without this flag insert after
2278 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 *cpo-i*
2280 i When included, interrupting the reading of a file will
2281 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002282 *cpo-I*
2283 I When moving the cursor up or down just after inserting
2284 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285 *cpo-j*
2286 j When joining lines, only add two spaces after a '.',
2287 not after '!' or '?'. Also see 'joinspaces'.
2288 *cpo-J*
2289 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002290 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291 white space.
2292 *cpo-k*
2293 k Disable the recognition of raw key codes in
2294 mappings, abbreviations, and the "to" part of menu
2295 commands. For example, if <Key> sends ^[OA (where ^[
2296 is <Esc>), the command ":map X ^[OA" results in X
2297 being mapped to:
2298 'k' included: "^[OA" (3 characters)
2299 'k' excluded: "<Key>" (one key code)
2300 Also see the '<' flag below.
2301 *cpo-K*
2302 K Don't wait for a key code to complete when it is
2303 halfway a mapping. This breaks mapping <F1><F1> when
2304 only part of the second <F1> has been read. It
2305 enables cancelling the mapping by typing <F1><Esc>.
2306 *cpo-l*
2307 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002308 literally, only "\]", "\^", "\-" and "\\" are special.
2309 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002310 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2311 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002312 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002313 *cpo-L*
2314 L When the 'list' option is set, 'wrapmargin',
2315 'textwidth', 'softtabstop' and Virtual Replace mode
2316 (see |gR|) count a <Tab> as two characters, instead of
2317 the normal behavior of a <Tab>.
2318 *cpo-m*
2319 m When included, a showmatch will always wait half a
2320 second. When not included, a showmatch will wait half
2321 a second or until a character is typed. |'showmatch'|
2322 *cpo-M*
2323 M When excluded, "%" matching will take backslashes into
2324 account. Thus in "( \( )" and "\( ( \)" the outer
2325 parenthesis match. When included "%" ignores
2326 backslashes, which is Vi compatible.
2327 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002328 n When included, the column used for 'number' and
2329 'relativenumber' will also be used for text of wrapped
2330 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331 *cpo-o*
2332 o Line offset to search command is not remembered for
2333 next search.
2334 *cpo-O*
2335 O Don't complain if a file is being overwritten, even
2336 when it didn't exist when editing it. This is a
2337 protection against a file unexpectedly created by
2338 someone else. Vi didn't complain about this.
2339 *cpo-p*
2340 p Vi compatible Lisp indenting. When not present, a
2341 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002342 *cpo-P*
2343 P When included, a ":write" command that appends to a
2344 file will set the file name for the current buffer, if
2345 the current buffer doesn't have a file name yet and
2346 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002347 *cpo-q*
2348 q When joining multiple lines leave the cursor at the
2349 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002350 *cpo-r*
2351 r Redo ("." command) uses "/" to repeat a search
2352 command, instead of the actually used search string.
2353 *cpo-R*
2354 R Remove marks from filtered lines. Without this flag
2355 marks are kept like |:keepmarks| was used.
2356 *cpo-s*
2357 s Set buffer options when entering the buffer for the
2358 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002359 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 set when the buffer is created.
2361 *cpo-S*
2362 S Set buffer options always when entering a buffer
2363 (except 'readonly', 'fileformat', 'filetype' and
2364 'syntax'). This is the (most) Vi compatible setting.
2365 The options are set to the values in the current
2366 buffer. When you change an option and go to another
2367 buffer, the value is copied. Effectively makes the
2368 buffer options global to all buffers.
2369
2370 's' 'S' copy buffer options
2371 no no when buffer created
2372 yes no when buffer first entered (default)
2373 X yes each time when buffer entered (vi comp.)
2374 *cpo-t*
2375 t Search pattern for the tag command is remembered for
2376 "n" command. Otherwise Vim only puts the pattern in
2377 the history for search pattern, but doesn't change the
2378 last used search pattern.
2379 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002380 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002381 *cpo-v*
2382 v Backspaced characters remain visible on the screen in
2383 Insert mode. Without this flag the characters are
2384 erased from the screen right away. With this flag the
2385 screen newly typed text overwrites backspaced
2386 characters.
2387 *cpo-w*
2388 w When using "cw" on a blank character, only change one
2389 character and not all blanks until the start of the
2390 next word.
2391 *cpo-W*
2392 W Don't overwrite a readonly file. When omitted, ":w!"
2393 overwrites a readonly file, if possible.
2394 *cpo-x*
2395 x <Esc> on the command-line executes the command-line.
2396 The default in Vim is to abandon the command-line,
2397 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002398 *cpo-X*
2399 X When using a count with "R" the replaced text is
2400 deleted only once. Also when repeating "R" with "."
2401 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002403 y A yank command can be redone with ".". Think twice if
2404 you really want to use this, it may break some
2405 plugins, since most people expect "." to only repeat a
2406 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002407 *cpo-Z*
2408 Z When using "w!" while the 'readonly' option is set,
2409 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 *cpo-!*
2411 ! When redoing a filter command, use the last used
2412 external command, whatever it was. Otherwise the last
2413 used -filter- command is used.
2414 *cpo-$*
2415 $ When making a change to one line, don't redisplay the
2416 line, but put a '$' at the end of the changed text.
2417 The changed text will be overwritten when you type the
2418 new text. The line is redisplayed if you type any
2419 command that moves the cursor from the insertion
2420 point.
2421 *cpo-%*
2422 % Vi-compatible matching is done for the "%" command.
2423 Does not recognize "#if", "#endif", etc.
2424 Does not recognize "/*" and "*/".
2425 Parens inside single and double quotes are also
2426 counted, causing a string that contains a paren to
2427 disturb the matching. For example, in a line like
2428 "if (strcmp("foo(", s))" the first paren does not
2429 match the last one. When this flag is not included,
2430 parens inside single and double quotes are treated
2431 specially. When matching a paren outside of quotes,
2432 everything inside quotes is ignored. When matching a
2433 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002434 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002435 This flag is also used for other features, such as
2436 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002437 *cpo--*
2438 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002439 it would go above the first line or below the last
2440 line. Without it the cursor moves to the first or
2441 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002442 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002443 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002444 *cpo-+*
2445 + When included, a ":write file" command will reset the
2446 'modified' flag of the buffer, even though the buffer
2447 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002448 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449 * Use ":*" in the same way as ":@". When not included,
2450 ":*" is an alias for ":'<,'>", select the Visual area.
2451 *cpo-<*
2452 < Disable the recognition of special key codes in |<>|
2453 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002454 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455 ":map X <Tab>" results in X being mapped to:
2456 '<' included: "<Tab>" (5 characters)
2457 '<' excluded: "^I" (^I is a real <Tab>)
2458 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002459 *cpo->*
2460 > When appending to a register, put a line break before
2461 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002462 *cpo-;*
2463 ; When using |,| or |;| to repeat the last |t| search
2464 and the cursor is right in front of the searched
2465 character, the cursor won't move. When not included,
2466 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002467 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002468
2469 POSIX flags. These are not included in the Vi default value, except
2470 when $VIM_POSIX was set on startup. |posix|
2471
2472 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002473 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002474 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002475 *cpo-&*
2476 & When ":preserve" was used keep the swap file when
2477 exiting normally while this buffer is still loaded.
2478 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002479 *cpo-\*
2480 \ Backslash in a [] range in a search pattern is taken
2481 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002482 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2483 '\' excluded: "/[ \-]" finds <Space> and '-'
2484 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002485 *cpo-/*
2486 / When "%" is used as the replacement string in a |:s|
2487 command, use the previous replacement string. |:s%|
2488 *cpo-{*
2489 { The |{| and |}| commands also stop at a "{" character
2490 at the start of a line.
2491 *cpo-.*
2492 . The ":chdir" and ":cd" commands fail if the current
2493 buffer is modified, unless ! is used. Vim doesn't
2494 need this, since it remembers the full path of an
2495 opened file.
2496 *cpo-bar*
2497 | The value of the $LINES and $COLUMNS environment
2498 variables overrule the terminal size values obtained
2499 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002500
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002502 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002503'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002504 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002505 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002506 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002507 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002508 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002509 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002510 blowfish Blowfish method. Medium strong encryption but it has
2511 an implementation flaw. Requires Vim 7.3 or later,
2512 files can NOT be read by Vim 7.2 and older. This adds
2513 a "seed" to the file, every time you write the file
2514 the encrypted bytes will be different.
2515 *blowfish2*
2516 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002517 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002518 and older. This adds a "seed" to the file, every time
2519 you write the file the encrypted bytes will be
2520 different. The whole undo file is encrypted, not just
2521 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002522 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002523 *E1197* *E1198* *E1199* *E1200* *E1201*
2524 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2525 Code. Medium strong till strong encryption.
2526 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002527 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002528 It adds a seed and a message authentication code (MAC)
2529 to the file. This needs at least a Vim 8.2.3022 to
2530 read the encrypted file.
2531 Encryption of swap files is not supported, therefore
2532 no swap file will be used when xchacha20 encryption is
2533 enabled.
2534 Encryption of undo files is not yet supported,
2535 therefore no undo file will currently be written.
2536 CURRENTLY EXPERIMENTAL: Files written with this method
2537 might have to be read back with the same version of
2538 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002539
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002540 You should use "blowfish2", also to re-encrypt older files.
2541
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002542 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002543 to the detected method of the file being read. Thus if you write it
2544 without changing 'cryptmethod' the same method will be used.
2545 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002546 explicitly write it, you don't get a warning unless there are other
2547 modifications. Also see |:X|.
2548
2549 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002550 the value "blowfish2". When setting the local value to an empty
2551 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002552
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002553 When a new encryption method is added in a later version of Vim, and
2554 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002555 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002556
2557
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558 *'cscopepathcomp'* *'cspc'*
2559'cscopepathcomp' 'cspc' number (default 0)
2560 global
2561 {not available when compiled without the |+cscope|
2562 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 Determines how many components of the path to show in a list of tags.
2564 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002565 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566
2567 *'cscopeprg'* *'csprg'*
2568'cscopeprg' 'csprg' string (default "cscope")
2569 global
2570 {not available when compiled without the |+cscope|
2571 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572 Specifies the command to execute cscope. See |cscopeprg|.
2573 This option cannot be set from a |modeline| or in the |sandbox|, for
2574 security reasons.
2575
2576 *'cscopequickfix'* *'csqf'*
2577'cscopequickfix' 'csqf' string (default "")
2578 global
2579 {not available when compiled without the |+cscope|
2580 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 Specifies whether to use quickfix window to show cscope results.
2582 See |cscopequickfix|.
2583
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002584 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002585'cscoperelative' 'csre' boolean (default off)
2586 global
2587 {not available when compiled without the |+cscope|
2588 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002589 In the absence of a prefix (-P) for cscope. setting this option enables
2590 to use the basename of cscope.out path as the prefix.
2591 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002592 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002593
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2595'cscopetag' 'cst' boolean (default off)
2596 global
2597 {not available when compiled without the |+cscope|
2598 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002599 Use cscope for tag commands. See |cscope-options|.
2600 NOTE: This option is reset when 'compatible' is set.
2601
2602 *'cscopetagorder'* *'csto'*
2603'cscopetagorder' 'csto' number (default 0)
2604 global
2605 {not available when compiled without the |+cscope|
2606 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002607 Determines the order in which ":cstag" performs a search. See
2608 |cscopetagorder|.
2609 NOTE: This option is set to 0 when 'compatible' is set.
2610
2611 *'cscopeverbose'* *'csverb'*
2612 *'nocscopeverbose'* *'nocsverb'*
2613'cscopeverbose' 'csverb' boolean (default off)
2614 global
2615 {not available when compiled without the |+cscope|
2616 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002617 Give messages when adding a cscope database. See |cscopeverbose|.
2618 NOTE: This option is reset when 'compatible' is set.
2619
Bram Moolenaar860cae12010-06-05 23:22:07 +02002620 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2621'cursorbind' 'crb' boolean (default off)
2622 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002623 When this option is set, as the cursor in the current
2624 window moves other cursorbound windows (windows that also have
2625 this option set) move their cursors to the corresponding line and
2626 column. This option is useful for viewing the
2627 differences between two versions of a file (see 'diff'); in diff mode,
2628 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002629 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002630
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002631
2632 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2633'cursorcolumn' 'cuc' boolean (default off)
2634 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002635 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002636 feature}
2637 Highlight the screen column of the cursor with CursorColumn
2638 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2639 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002640 If you only want the highlighting in the current window you can use
2641 these autocommands: >
2642 au WinLeave * set nocursorline nocursorcolumn
2643 au WinEnter * set cursorline cursorcolumn
2644<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002645
2646 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2647'cursorline' 'cul' boolean (default off)
2648 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002649 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002650 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002651 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2652 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002653 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002654 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002655
2656
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002657 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002658'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002659 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002660 {not available when compiled without the |+syntax|
2661 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002662 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002663 Valid values:
2664 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002665 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002666 "screenline" Highlight only the screen line of the cursor with
2667 CursorLine |hl-CursorLine|.
2668 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002669 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002670
2671 Special value:
2672 "both" Alias for the values "line,number".
2673
2674 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002675
2676
Bram Moolenaar071d4272004-06-13 20:20:40 +00002677 *'debug'*
2678'debug' string (default "")
2679 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002680 These values can be used:
2681 msg Error messages that would otherwise be omitted will be given
2682 anyway.
2683 throw Error messages that would otherwise be omitted will be given
2684 anyway and also throw an exception and set |v:errmsg|.
2685 beep A message will be given when otherwise only a beep would be
2686 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002687 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002688 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2689 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690
2691 *'define'* *'def'*
2692'define' 'def' string (default "^\s*#\s*define")
2693 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002694 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 pattern, just like for the "/" command. This option is used for the
2696 commands like "[i" and "[d" |include-search|. The 'isident' option is
2697 used to recognize the defined name after the match:
2698 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2699 See |option-backslash| about inserting backslashes to include a space
2700 or backslash.
2701 The default value is for C programs. For C++ this value would be
2702 useful, to include const type declarations: >
2703 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002704< You can also use "\ze" just before the name and continue the pattern
2705 to check what is following. E.g. for Javascript, if a function is
2706 defined with "func_name = function(args)": >
2707 ^\s*\ze\i\+\s*=\s*function(
2708< If the function is defined with "func_name : function() {...": >
2709 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002711 To avoid that use `:let` with a single quote string: >
2712 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002713<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714
2715 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2716'delcombine' 'deco' boolean (default off)
2717 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718 If editing Unicode and this option is set, backspace and Normal mode
2719 "x" delete each combining character on its own. When it is off (the
2720 default) the character along with its combining characters are
2721 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002722 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723
2724 This is useful for Arabic, Hebrew and many other languages where one
2725 may have combining characters overtop of base characters, and want
2726 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002727 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728
2729 *'dictionary'* *'dict'*
2730'dictionary' 'dict' string (default "")
2731 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732 List of file names, separated by commas, that are used to lookup words
2733 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2734 contain a list of words. This can be one word per line, or several
2735 words per line, separated by non-keyword characters (white space is
2736 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002737
2738 When this option is empty or an entry "spell" is present, and spell
2739 checking is enabled, words in the word lists for the currently active
2740 'spelllang' are used. See |spell|.
2741
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002742 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743 after a comma are ignored, otherwise spaces are included in the file
2744 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002745 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 Where to find a list of words?
2747 - On FreeBSD, there is the file "/usr/share/dict/words".
2748 - In the Simtel archive, look in the "msdos/linguist" directory.
2749 - In "miscfiles" of the GNU collection.
2750 The use of |:set+=| and |:set-=| is preferred when adding or removing
2751 directories from the list. This avoids problems when a future version
2752 uses another default.
2753 Backticks cannot be used in this option for security reasons.
2754
2755 *'diff'* *'nodiff'*
2756'diff' boolean (default off)
2757 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758 {not available when compiled without the |+diff|
2759 feature}
2760 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002761 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762
2763 *'dex'* *'diffexpr'*
2764'diffexpr' 'dex' string (default "")
2765 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 {not available when compiled without the |+diff|
2767 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002768 Expression which is evaluated to obtain a diff file (either ed-style
2769 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 This option cannot be set from a |modeline| or in the |sandbox|, for
2771 security reasons.
2772
2773 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002774'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776 {not available when compiled without the |+diff|
2777 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002778 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002779 All are optional. Items must be separated by a comma.
2780
2781 filler Show filler lines, to keep the text
2782 synchronized with a window that has inserted
2783 lines at the same position. Mostly useful
2784 when windows are side-by-side and 'scrollbind'
2785 is set.
2786
2787 context:{n} Use a context of {n} lines between a change
2788 and a fold that contains unchanged lines.
2789 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002790 When using zero the context is actually one,
2791 since folds require a line in between, also
2792 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793 See |fold-diff|.
2794
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002795 iblank Ignore changes where lines are all blank. Adds
2796 the "-B" flag to the "diff" command if
2797 'diffexpr' is empty. Check the documentation
2798 of the "diff" command for what this does
2799 exactly.
2800 NOTE: the diff windows will get out of sync,
2801 because no differences between blank lines are
2802 taken into account.
2803
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 icase Ignore changes in case of text. "a" and "A"
2805 are considered the same. Adds the "-i" flag
2806 to the "diff" command if 'diffexpr' is empty.
2807
2808 iwhite Ignore changes in amount of white space. Adds
2809 the "-b" flag to the "diff" command if
2810 'diffexpr' is empty. Check the documentation
2811 of the "diff" command for what this does
2812 exactly. It should ignore adding trailing
2813 white space, but not leading white space.
2814
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002815 iwhiteall Ignore all white space changes. Adds
2816 the "-w" flag to the "diff" command if
2817 'diffexpr' is empty. Check the documentation
2818 of the "diff" command for what this does
2819 exactly.
2820
2821 iwhiteeol Ignore white space changes at end of line.
2822 Adds the "-Z" flag to the "diff" command if
2823 'diffexpr' is empty. Check the documentation
2824 of the "diff" command for what this does
2825 exactly.
2826
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002827 horizontal Start diff mode with horizontal splits (unless
2828 explicitly specified otherwise).
2829
2830 vertical Start diff mode with vertical splits (unless
2831 explicitly specified otherwise).
2832
Bram Moolenaarc8234772019-11-10 21:00:27 +01002833 closeoff When a window is closed where 'diff' is set
2834 and there is only one window remaining in the
2835 same tab page with 'diff' set, execute
2836 `:diffoff` in that window. This undoes a
2837 `:diffsplit` command.
2838
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002839 hiddenoff Do not use diff mode for a buffer when it
2840 becomes hidden.
2841
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002842 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2843 starting diff mode. Without this 2 is used.
2844
Bram Moolenaar4223d432021-02-10 13:18:17 +01002845 followwrap Follow the 'wrap' option and leave as it is.
2846
Bram Moolenaare828b762018-09-10 17:51:58 +02002847 internal Use the internal diff library. This is
2848 ignored when 'diffexpr' is set. *E960*
2849 When running out of memory when writing a
2850 buffer this item will be ignored for diffs
2851 involving that buffer. Set the 'verbose'
2852 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853
Bram Moolenaare828b762018-09-10 17:51:58 +02002854 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002855 Use the indent heuristic for the internal
2856 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002857
2858 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002859 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002860 algorithms are:
2861 myers the default algorithm
2862 minimal spend extra time to generate the
2863 smallest possible diff
2864 patience patience diff algorithm
2865 histogram histogram diff algorithm
2866
2867 Examples: >
2868 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002870 :set diffopt=internal,filler,foldcolumn:3
2871 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872<
2873 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2874'digraph' 'dg' boolean (default off)
2875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 {not available when compiled without the |+digraphs|
2877 feature}
2878 Enable the entering of digraphs in Insert mode with {char1} <BS>
2879 {char2}. See |digraphs|.
2880 NOTE: This option is reset when 'compatible' is set.
2881
2882 *'directory'* *'dir'*
2883'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002884 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 for Unix: ".,~/tmp,/var/tmp,/tmp")
2886 global
2887 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002888 Recommended value: ".,~/vimswap//" - this will put the swap file next
2889 to the edited file if possible, and in your personal swap directory
2890 otherwise. Make sure "~/vimswap//" is only readable for you.
2891
2892 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 - The swap file will be created in the first directory where this is
2894 possible.
2895 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002896 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897 - A directory "." means to put the swap file in the same directory as
2898 the edited file. On Unix, a dot is prepended to the file name, so
2899 it doesn't show in a directory listing. On MS-Windows the "hidden"
2900 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002901 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2902 the swap file relative to where the edited file is. The leading "."
2903 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002904 - For Unix and Win32, if a directory ends in two path separators "//",
2905 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002906 with all path separators replaced by percent '%' signs (including
2907 the colon following the drive letter on Win32). This will ensure
2908 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002909 On Win32, it is also possible to end with "\\". However, When a
2910 separating comma is following, you must use "//", since "\\" will
2911 include the comma in the file name. Therefore it is recommended to
2912 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913 - Spaces after the comma are ignored, other spaces are considered part
2914 of the directory name. To have a space at the start of a directory
2915 name, precede it with a backslash.
2916 - To include a comma in a directory name precede it with a backslash.
2917 - A directory name may end in an ':' or '/'.
2918 - Environment variables are expanded |:set_env|.
2919 - Careful with '\' characters, type one before a space, type two to
2920 get one in the option (see |option-backslash|), for example: >
2921 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2922< - For backwards compatibility with Vim version 3.0 a '>' at the start
2923 of the option is removed.
2924 Using "." first in the list is recommended. This means that editing
2925 the same file twice will result in a warning. Using "/tmp" on Unix is
2926 discouraged: When the system crashes you lose the swap file.
2927 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002928 choice than "/tmp". But others on the computer may be able to see the
2929 files, and it can contain a lot of files, your swap files get lost in
2930 the crowd. That is why a "tmp" directory in your home directory is
2931 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002932 The use of |:set+=| and |:set-=| is preferred when adding or removing
2933 directories from the list. This avoids problems when a future version
2934 uses another default.
2935 This option cannot be set from a |modeline| or in the |sandbox|, for
2936 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937
2938 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002939'display' 'dy' string (default "", set to "truncate" in
2940 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002942 Change the way text is displayed. This is comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 flags:
2944 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002945 in a window will be displayed. "@@@" is put in the
2946 last columns of the last screen line to indicate the
2947 rest of the line is not displayed.
2948 truncate Like "lastline", but "@@@" is displayed in the first
2949 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 uhex Show unprintable characters hexadecimal as <xx>
2951 instead of using ^C and ~C.
2952
Bram Moolenaard0796902016-09-16 20:02:31 +02002953 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002954 doesn't fit is replaced with "@" lines.
2955
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 *'eadirection'* *'ead'*
2957'eadirection' 'ead' string (default "both")
2958 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 Tells when the 'equalalways' option applies:
2960 ver vertically, width of windows is not affected
2961 hor horizontally, height of windows is not affected
2962 both width and height of windows is affected
2963
2964 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2965'edcompatible' 'ed' boolean (default off)
2966 global
2967 Makes the 'g' and 'c' flags of the ":substitute" command to be
2968 toggled each time the flag is given. See |complex-change|. See
2969 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002970 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002971 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972
Bram Moolenaar03413f42016-04-12 21:07:15 +02002973 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002974'emoji' 'emo' boolean (default: on)
2975 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002976 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002977 This excludes "text emoji" characters, which are normally displayed as
2978 single width. Unfortunately there is no good specification for this
2979 and it has been determined on trial-and-error basis. Use the
2980 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002981
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002983'encoding' 'enc' string (default for MS-Windows: "utf-8",
2984 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 Sets the character encoding used inside Vim. It applies to text in
2987 the buffers, registers, Strings in expressions, text stored in the
2988 viminfo file, etc. It sets the kind of characters which Vim can work
2989 with. See |encoding-names| for the possible values.
2990
2991 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002992 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002994 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995
Bram Moolenaar865242e2010-07-14 21:12:05 +02002996 This option cannot be set from a |modeline|. It would most likely
2997 corrupt the text.
2998
Bram Moolenaar3df01732017-02-17 22:47:16 +01002999 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3000 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 'encoding', "utf-8" is the natural choice for the environment and
3002 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003003 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 versions, and to avoid changing the encoding of newly created files
3005 without your knowledge (in case 'fileencodings' is empty).
3006
3007 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003008 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 iconv() or as specified with 'charconvert'.
3010
Bram Moolenaar207f0092020-08-30 17:20:20 +02003011 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003012 can use: >
3013 if has("multi_byte_encoding")
3014<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 Normally 'encoding' will be equal to your current locale. This will
3016 be the default if Vim recognizes your environment settings. If
3017 'encoding' is not set to the current locale, 'termencoding' must be
3018 set to convert typed and displayed text. See |encoding-table|.
3019
3020 When you set this option, it fires the |EncodingChanged| autocommand
3021 event so that you can set up fonts if necessary.
3022
3023 When the option is set, the value is converted to lowercase. Thus
3024 you can set it with uppercase values too. Underscores are translated
3025 to '-' signs.
3026 When the encoding is recognized, it is changed to the standard name.
3027 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3028 "iso-8859-2" and "utf8" becomes "utf-8".
3029
3030 Note: "latin1" is also used when the encoding could not be detected.
3031 This only works when editing files in the same encoding! When the
3032 actual character set is not latin1, make sure 'fileencoding' and
3033 'fileencodings' are empty. When conversion is needed, switch to using
3034 utf-8.
3035
3036 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3037 You don't notice this while editing, but it does matter for the
3038 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3039 setting 'encoding' to one of these values instead of utf-8 only has
3040 effect for encoding used for files when 'fileencoding' is empty.
3041
Bram Moolenaar661b1822005-07-28 22:36:45 +00003042 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3043 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044
3045 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3046'endofline' 'eol' boolean (default on)
3047 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003049 is on, or 'fixeol' option is off, no <EOL> will be written for the
3050 last line in the file. This option is automatically set or reset when
3051 starting to edit a new file, depending on whether file has an <EOL>
3052 for the last line in the file. Normally you don't have to set or
3053 reset this option.
3054 When 'binary' is off and 'fixeol' is on the value is not used when
3055 writing the file. When 'binary' is on or 'fixeol' is off it is used
3056 to remember the presence of a <EOL> for the last line in the file, so
3057 that when you write the file the situation from the original file can
3058 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003059
3060 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3061'equalalways' 'ea' boolean (default on)
3062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003064 splitting or closing a window. This also happens the moment the
3065 option is switched on. When off, splitting a window will reduce the
3066 size of the current window and leave the other windows the same. When
3067 closing a window the extra lines are given to the window next to it
3068 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069 When mixing vertically and horizontally split windows, a minimal size
3070 is computed and some windows may be larger if there is room. The
3071 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003072 Changing the height and width of a window can be avoided by setting
3073 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003074 If a window size is specified when creating a new window sizes are
3075 currently not equalized (it's complicated, but may be implemented in
3076 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077
3078 *'equalprg'* *'ep'*
3079'equalprg' 'ep' string (default "")
3080 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003082 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003083 or 'indentexpr'. When Vim was compiled without internal formatting,
3084 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003085 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086 about including spaces and backslashes.
3087 This option cannot be set from a |modeline| or in the |sandbox|, for
3088 security reasons.
3089
3090 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3091'errorbells' 'eb' boolean (default off)
3092 global
3093 Ring the bell (beep or screen flash) for error messages. This only
3094 makes a difference for error messages, the bell will be used always
3095 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003096 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003097 screen flash or do nothing. See 'belloff' to finetune when to ring the
3098 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099
3100 *'errorfile'* *'ef'*
3101'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3102 others: "errors.err")
3103 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104 {not available when compiled without the |+quickfix|
3105 feature}
3106 Name of the errorfile for the QuickFix mode (see |:cf|).
3107 When the "-q" command-line argument is used, 'errorfile' is set to the
3108 following argument. See |-q|.
3109 NOT used for the ":make" command. See 'makeef' for that.
3110 Environment variables are expanded |:set_env|.
3111 See |option-backslash| about including spaces and backslashes.
3112 This option cannot be set from a |modeline| or in the |sandbox|, for
3113 security reasons.
3114
3115 *'errorformat'* *'efm'*
3116'errorformat' 'efm' string (default is very long)
3117 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118 {not available when compiled without the |+quickfix|
3119 feature}
3120 Scanf-like description of the format for the lines in the error file
3121 (see |errorformat|).
3122
3123 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3124'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3125 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126 Function keys that start with an <Esc> are recognized in Insert
3127 mode. When this option is off, the cursor and function keys cannot be
3128 used in Insert mode if they start with an <Esc>. The advantage of
3129 this is that the single <Esc> is recognized immediately, instead of
3130 after one second. Instead of resetting this option, you might want to
3131 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3132 when 'esckeys' is off, you can still map anything, but the cursor keys
3133 won't work by default.
3134 NOTE: This option is set to the Vi default value when 'compatible' is
3135 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003136 NOTE: when this option is off then the |modifyOtherKeys| functionality
3137 is disabled while in Insert mode to avoid ending Insert mode with any
3138 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139
3140 *'eventignore'* *'ei'*
3141'eventignore' 'ei' string (default "")
3142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003144 When set to "all" or when "all" is one of the items, all autocommand
3145 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003146 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147 :set ei=WinEnter,WinLeave
3148<
3149 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3150'expandtab' 'et' boolean (default off)
3151 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003153 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3155 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003156 This option is reset when the 'paste' option is set and restored when
3157 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 NOTE: This option is reset when 'compatible' is set.
3159
3160 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3161'exrc' 'ex' boolean (default off)
3162 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003164 directory.
3165
3166 Setting this option is a potential security leak. E.g., consider
3167 unpacking a package or fetching files from github, a .vimrc in there
3168 might be a trojan horse. BETTER NOT SET THIS OPTION!
3169 Instead, define an autocommand in your .vimrc to set options for a
3170 matching directory.
3171
3172 If you do switch this option on you should also consider setting the
3173 'secure' option (see |initialization|).
3174 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175 This option cannot be set from a |modeline| or in the |sandbox|, for
3176 security reasons.
3177
3178 *'fileencoding'* *'fenc'* *E213*
3179'fileencoding' 'fenc' string (default: "")
3180 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003182
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003184 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 When 'fileencoding' is empty, the same value as 'encoding' will be
3186 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003187 No error will be given when the value is set, only when it is used,
3188 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003189 Conversion will also be done when 'encoding' and 'fileencoding' are
3190 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3191 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003193 'encoding' is "utf-8" or another Unicode encoding, conversion
3194 is most likely done in a way that the reverse conversion
3195 results in the same text. When 'encoding' is not "utf-8" some
3196 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003197
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 See 'encoding' for the possible values. Additionally, values may be
3199 specified that can be handled by the converter, see
3200 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003201
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 When reading a file 'fileencoding' will be set from 'fileencodings'.
3203 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003204 'fileencoding', use the |++enc| argument. One exception: when
3205 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003206 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003207
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3209 When the option is set, the value is converted to lowercase. Thus
3210 you can set it with uppercase values too. '_' characters are
3211 replaced with '-'. If a name is recognized from the list for
3212 'encoding', it is replaced by the standard name. For example
3213 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003214
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 When this option is set, after starting to edit a file, the 'modified'
3216 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003217
3218 Keep in mind that changing 'fenc' from a modeline happens
3219 AFTER the text has been read, thus it applies to when the file will be
3220 written. If you do set 'fenc' in a modeline, you might want to set
3221 'nomodified' to avoid not being able to ":q".
3222
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 This option can not be changed when 'modifiable' is off.
3224
3225 *'fe'*
3226 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003227 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 old short name was 'fe', which is no longer used.
3229
3230 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003231'fileencodings' 'fencs' string (default: "ucs-bom",
3232 "ucs-bom,utf-8,default,latin1" when
3233 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 This is a list of character encodings considered when starting to edit
3236 an existing file. When a file is read, Vim tries to use the first
3237 mentioned character encoding. If an error is detected, the next one
3238 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003239 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 an empty string, which means the value of 'encoding' is used.
3241 WARNING: Conversion can cause loss of information! When
3242 'encoding' is "utf-8" (or one of the other Unicode variants)
3243 conversion is most likely done in a way that the reverse
3244 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003245 "utf-8" some non-ASCII characters may be lost! You can use
3246 the |++bad| argument to specify what is done with characters
3247 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 For an empty file or a file with only ASCII characters most encodings
3249 will work and the first entry of 'fileencodings' will be used (except
3250 "ucs-bom", which requires the BOM to be present). If you prefer
3251 another encoding use an BufReadPost autocommand event to test if your
3252 preferred encoding is to be used. Example: >
3253 au BufReadPost * if search('\S', 'w') == 0 |
3254 \ set fenc=iso-2022-jp | endif
3255< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3256 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003257 When the |++enc| argument is used then the value of 'fileencodings' is
3258 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003259 Note that 'fileencodings' is not used for a new file, the global value
3260 of 'fileencoding' is used instead. You can set it with: >
3261 :setglobal fenc=iso-8859-2
3262< This means that a non-existing file may get a different encoding than
3263 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 The special value "ucs-bom" can be used to check for a Unicode BOM
3265 (Byte Order Mark) at the start of the file. It must not be preceded
3266 by "utf-8" or another Unicode encoding for this to work properly.
3267 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3268 because Vim cannot detect an error, thus the encoding is always
3269 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003270 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003271 environment. On MS-Windows this is the system encoding. Otherwise
3272 this is the default value for 'encoding'. It is useful when
3273 'encoding' is set to "utf-8" and your environment uses a non-latin1
3274 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003275 When 'encoding' is "utf-8" and a file contains an illegal byte
3276 sequence it won't be recognized as UTF-8. You can use the |8g8|
3277 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278 WRONG VALUES: WHAT'S WRONG:
3279 latin1,utf-8 "latin1" will always be used
3280 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3281 file
3282 cp1250,latin1 "cp1250" will always be used
3283 If 'fileencodings' is empty, 'fileencoding' is not modified.
3284 See 'fileencoding' for the possible values.
3285 Setting this option does not have an effect until the next time a file
3286 is read.
3287
3288 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003289'fileformat' 'ff' string (MS-Windows default: "dos",
3290 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292 This gives the <EOL> of the current buffer, which is used for
3293 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003294 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 unix <NL>
3296 mac <CR>
3297 When "dos" is used, CTRL-Z at the end of a file is ignored.
3298 See |file-formats| and |file-read|.
3299 For the character encoding of the file see 'fileencoding'.
3300 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003301 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003302 This option is set automatically when starting to edit a file and
3303 'fileformats' is not empty and 'binary' is off.
3304 When this option is set, after starting to edit a file, the 'modified'
3305 option is set, because the file would be different when written.
3306 This option can not be changed when 'modifiable' is off.
3307 For backwards compatibility: When this option is set to "dos",
3308 'textmode' is set, otherwise 'textmode' is reset.
3309
3310 *'fileformats'* *'ffs'*
3311'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003312 Vim+Vi MS-Windows: "dos,unix",
3313 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 Vi Cygwin: "unix,dos",
3315 Vi others: "")
3316 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 This gives the end-of-line (<EOL>) formats that will be tried when
3318 starting to edit a new buffer and when reading a file into an existing
3319 buffer:
3320 - When empty, the format defined with 'fileformat' will be used
3321 always. It is not set automatically.
3322 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003323 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 'fileformats' name will be used when a file is read into an existing
3325 buffer, no matter what 'fileformat' for that buffer is set to.
3326 - When more than one name is present, separated by commas, automatic
3327 <EOL> detection will be done when reading a file. When starting to
3328 edit a file, a check is done for the <EOL>:
3329 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3330 'fileformat' is set to "dos".
3331 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003332 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003333 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003334 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3335 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003336 This means that "mac" is only chosen when:
3337 "unix" is not present or no <NL> is found in the file, and
3338 "dos" is not present or no <CR><NL> is found in the file.
3339 Except: if "unix" was chosen, but there is a <CR> before
3340 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003341 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 4. If 'fileformat' is still not set, the first name from
3343 'fileformats' is used.
3344 When reading a file into an existing buffer, the same is done, but
3345 this happens like 'fileformat' has been set appropriately for that
3346 file only, the option is not changed.
3347 When 'binary' is set, the value of 'fileformats' is not used.
3348
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003349 When Vim starts up with an empty buffer the first item is used. You
3350 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003351
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3353 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3354 done:
3355 - When 'fileformats' is empty, there is no automatic detection. Dos
3356 format will be used.
3357 - When 'fileformats' is set to one or more names, automatic detection
3358 is done. This is based on the first <NL> in the file: If there is a
3359 <CR> in front of it, Dos format is used, otherwise Unix format is
3360 used.
3361 Also see |file-formats|.
3362 For backwards compatibility: When this option is set to an empty
3363 string or one format (no comma is included), 'textauto' is reset,
3364 otherwise 'textauto' is set.
3365 NOTE: This option is set to the Vi default value when 'compatible' is
3366 set and to the Vim default value when 'compatible' is reset.
3367
Bram Moolenaarbf884932013-04-05 22:26:15 +02003368 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3369'fileignorecase' 'fic' boolean (default on for systems where case in file
3370 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003371 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003372 When set case is ignored when using file names and directories.
3373 See 'wildignorecase' for only ignoring case when doing completion.
3374
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375 *'filetype'* *'ft'*
3376'filetype' 'ft' string (default: "")
3377 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 When this option is set, the FileType autocommand event is triggered.
3379 All autocommands that match with the value of this option will be
3380 executed. Thus the value of 'filetype' is used in place of the file
3381 name.
3382 Otherwise this option does not always reflect the current file type.
3383 This option is normally set when the file type is detected. To enable
3384 this use the ":filetype on" command. |:filetype|
3385 Setting this option to a different value is most useful in a modeline,
3386 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003387 Example, for in an IDL file:
3388 /* vim: set filetype=idl : */ ~
3389 |FileType| |filetypes|
3390 When a dot appears in the value then this separates two filetype
3391 names. Example:
3392 /* vim: set filetype=c.doxygen : */ ~
3393 This will use the "c" filetype first, then the "doxygen" filetype.
3394 This works both for filetype plugins and for syntax files. More than
3395 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 This option is not copied to another buffer, independent of the 's' or
3397 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003398 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399
3400 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003401'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003402 global or local to window |global-local|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003403 {not available when compiled without the |+folding|
3404 feature}
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003405 Characters to fill the statuslines, vertical separators and special
3406 lines in the window.
3407 It is a comma-separated list of items. Each item has a name, a colon
3408 and the value of that item:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003410 item name default Used for ~
3411 stl ' ' or '^' statusline of the current window
3412 stlnc ' ' or '=' statusline of the non-current windows
3413 vert '|' vertical separators |:vsplit|
3414 fold '-' filling 'foldtext'
3415 foldopen '-' mark the beginning of a fold
3416 foldclose '+' show a closed fold
3417 foldsep '|' open fold middle character
3418 diff '-' deleted lines of the 'diff' option
3419 eob '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003421 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003422 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 otherwise.
3424
3425 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003426 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427< This is similar to the default, except that these characters will also
3428 be used when there is highlighting.
3429
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003430 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3431 single-byte and multibyte characters are supported. But double-width
3432 characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003433
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003435 item name highlight group ~
3436 stl StatusLine |hl-StatusLine|
3437 stlnc StatusLineNC |hl-StatusLineNC|
3438 vert VertSplit |hl-VertSplit|
3439 fold Folded |hl-Folded|
3440 diff DiffDelete |hl-DiffDelete|
3441 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003442
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003443 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3444'fixendofline' 'fixeol' boolean (default on)
3445 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003446 When writing a file and this option is on, <EOL> at the end of file
3447 will be restored if missing. Turn this option off if you want to
3448 preserve the situation from the original file.
3449 When the 'binary' option is set the value of this option doesn't
3450 matter.
3451 See the 'endofline' option.
3452
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003454'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 {only available when compiled with the |+rightleft|
3457 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003458 This option was for using Farsi, which has been removed. See
3459 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460
3461 *'foldclose'* *'fcl'*
3462'foldclose' 'fcl' string (default "")
3463 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 {not available when compiled without the |+folding|
3465 feature}
3466 When set to "all", a fold is closed when the cursor isn't in it and
3467 its level is higher than 'foldlevel'. Useful if you want folds to
3468 automatically close when moving out of them.
3469
3470 *'foldcolumn'* *'fdc'*
3471'foldcolumn' 'fdc' number (default 0)
3472 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 {not available when compiled without the |+folding|
3474 feature}
3475 When non-zero, a column with the specified width is shown at the side
3476 of the window which indicates open and closed folds. The maximum
3477 value is 12.
3478 See |folding|.
3479
3480 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3481'foldenable' 'fen' boolean (default on)
3482 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 {not available when compiled without the |+folding|
3484 feature}
3485 When off, all folds are open. This option can be used to quickly
3486 switch between showing all text unfolded and viewing the text with
3487 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003488 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 'foldenable' is off.
3490 This option is set by commands that create a new fold or close a fold.
3491 See |folding|.
3492
3493 *'foldexpr'* *'fde'*
3494'foldexpr' 'fde' string (default: "0")
3495 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003497 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003499 for each line to obtain its fold level. The context is set to the
3500 script where 'foldexpr' was set, script-local items can be accessed.
3501 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003502
Bram Moolenaar30b65812012-07-12 22:01:11 +02003503 The expression will be evaluated in the |sandbox| if set from a
3504 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003505 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003506 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003507
3508 It is not allowed to change text or jump to another window while
3509 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510
3511 *'foldignore'* *'fdi'*
3512'foldignore' 'fdi' string (default: "#")
3513 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 {not available when compiled without the |+folding|
3515 feature}
3516 Used only when 'foldmethod' is "indent". Lines starting with
3517 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003518 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519 The default "#" works well for C programs. See |fold-indent|.
3520
3521 *'foldlevel'* *'fdl'*
3522'foldlevel' 'fdl' number (default: 0)
3523 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524 {not available when compiled without the |+folding|
3525 feature}
3526 Sets the fold level: Folds with a higher level will be closed.
3527 Setting this option to zero will close all folds. Higher numbers will
3528 close fewer folds.
3529 This option is set by commands like |zm|, |zM| and |zR|.
3530 See |fold-foldlevel|.
3531
3532 *'foldlevelstart'* *'fdls'*
3533'foldlevelstart' 'fdls' number (default: -1)
3534 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 {not available when compiled without the |+folding|
3536 feature}
3537 Sets 'foldlevel' when starting to edit another buffer in a window.
3538 Useful to always start editing with all folds closed (value zero),
3539 some folds closed (one) or no folds closed (99).
3540 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003541 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 ignores this option and closes all folds.
3543 It is also done before BufReadPre autocommands, to allow an autocmd to
3544 overrule the 'foldlevel' value for specific files.
3545 When the value is negative, it is not used.
3546
3547 *'foldmarker'* *'fmr'* *E536*
3548'foldmarker' 'fmr' string (default: "{{{,}}}")
3549 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 {not available when compiled without the |+folding|
3551 feature}
3552 The start and end marker used when 'foldmethod' is "marker". There
3553 must be one comma, which separates the start and end marker. The
3554 marker is a literal string (a regular expression would be too slow).
3555 See |fold-marker|.
3556
3557 *'foldmethod'* *'fdm'*
3558'foldmethod' 'fdm' string (default: "manual")
3559 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 {not available when compiled without the |+folding|
3561 feature}
3562 The kind of folding used for the current window. Possible values:
3563 |fold-manual| manual Folds are created manually.
3564 |fold-indent| indent Lines with equal indent form a fold.
3565 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3566 |fold-marker| marker Markers are used to specify folds.
3567 |fold-syntax| syntax Syntax highlighting items specify folds.
3568 |fold-diff| diff Fold text that is not changed.
3569
3570 *'foldminlines'* *'fml'*
3571'foldminlines' 'fml' number (default: 1)
3572 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 {not available when compiled without the |+folding|
3574 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003575 Sets the number of screen lines above which a fold can be displayed
3576 closed. Also for manually closed folds. With the default value of
3577 one a fold can only be closed if it takes up two or more screen lines.
3578 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003579 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 "zc" to close a fold, which is displayed open because it's smaller
3581 than 'foldminlines', a following "zc" may close a containing fold.
3582
3583 *'foldnestmax'* *'fdn'*
3584'foldnestmax' 'fdn' number (default: 20)
3585 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 {not available when compiled without the |+folding|
3587 feature}
3588 Sets the maximum nesting of folds for the "indent" and "syntax"
3589 methods. This avoids that too many folds will be created. Using more
3590 than 20 doesn't work, because the internal limit is 20.
3591
3592 *'foldopen'* *'fdo'*
3593'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3594 search,tag,undo")
3595 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 {not available when compiled without the |+folding|
3597 feature}
3598 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003599 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003601 NOTE: When the command is part of a mapping this option is not used.
3602 Add the |zv| command to the mapping to get the same effect.
3603 (rationale: the mapping may want to control opening folds itself)
3604
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605 item commands ~
3606 all any
3607 block "(", "{", "[[", "[{", etc.
3608 hor horizontal movements: "l", "w", "fx", etc.
3609 insert any command in Insert mode
3610 jump far jumps: "G", "gg", etc.
3611 mark jumping to a mark: "'m", CTRL-O, etc.
3612 percent "%"
3613 quickfix ":cn", ":crew", ":make", etc.
3614 search search for a pattern: "/", "n", "*", "gd", etc.
3615 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003616 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003617 tag jumping to a tag: ":ta", CTRL-T, etc.
3618 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 When a movement command is used for an operator (e.g., "dl" or "y%")
3620 this option is not used. This means the operator will include the
3621 whole closed fold.
3622 Note that vertical movements are not here, because it would make it
3623 very difficult to move onto a closed fold.
3624 In insert mode the folds containing the cursor will always be open
3625 when text is inserted.
3626 To close folds you can re-apply 'foldlevel' with the |zx| command or
3627 set the 'foldclose' option to "all".
3628
3629 *'foldtext'* *'fdt'*
3630'foldtext' 'fdt' string (default: "foldtext()")
3631 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 {not available when compiled without the |+folding|
3633 feature}
3634 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003635 fold. The context is set to the script where 'foldexpr' was set,
3636 script-local items can be accessed. See |fold-foldtext| for the
3637 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638
Bram Moolenaar30b65812012-07-12 22:01:11 +02003639 The expression will be evaluated in the |sandbox| if set from a
3640 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003641 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003642
3643 It is not allowed to change text or jump to another window while
3644 evaluating 'foldtext' |textlock|.
3645
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003646 *'formatexpr'* *'fex'*
3647'formatexpr' 'fex' string (default "")
3648 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003649 {not available when compiled without the |+eval|
3650 feature}
3651 Expression which is evaluated to format a range of lines for the |gq|
3652 operator or automatic formatting (see 'formatoptions'). When this
3653 option is empty 'formatprg' is used.
3654
3655 The |v:lnum| variable holds the first line to be formatted.
3656 The |v:count| variable holds the number of lines to be formatted.
3657 The |v:char| variable holds the character that is going to be
3658 inserted if the expression is being evaluated due to
3659 automatic formatting. This can be empty. Don't insert
3660 it yet!
3661
3662 Example: >
3663 :set formatexpr=mylang#Format()
3664< This will invoke the mylang#Format() function in the
3665 autoload/mylang.vim file in 'runtimepath'. |autoload|
3666
3667 The expression is also evaluated when 'textwidth' is set and adding
3668 text beyond that limit. This happens under the same conditions as
3669 when internal formatting is used. Make sure the cursor is kept in the
3670 same spot relative to the text then! The |mode()| function will
3671 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003672
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003673 When the expression evaluates to non-zero Vim will fall back to using
3674 the internal format mechanism.
3675
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003676 If the expression starts with s: or |<SID>|, then it is replaced with
3677 the script ID (|local-function|). Example: >
3678 set formatexpr=s:MyFormatExpr()
3679 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003680< Otherwise, the expression is evaluated in the context of the script
3681 where the option was set, thus script-local items are available.
3682
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003683 The expression will be evaluated in the |sandbox| when set from a
3684 modeline, see |sandbox-option|. That stops the option from working,
3685 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003686 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003687 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003688
Bram Moolenaar86b68352004-12-27 21:59:20 +00003689 *'formatlistpat'* *'flp'*
3690'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3691 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003692 A pattern that is used to recognize a list header. This is used for
3693 the "n" flag in 'formatoptions'.
3694 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003695 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003696 while still checking more characters. There must be a character
3697 following the pattern, when it matches the whole line it is handled
3698 like there is no match.
3699 The default recognizes a number, followed by an optional punctuation
3700 character and white space.
3701
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003702 *'formatoptions'* *'fo'*
3703'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3704 local to buffer
3705 This is a sequence of letters which describes how automatic
3706 formatting is to be done. See |fo-table|. When the 'paste' option is
3707 on, no formatting is done (like 'formatoptions' is empty). Commas can
3708 be inserted for readability.
3709 To avoid problems with flags that are added in the future, use the
3710 "+=" and "-=" feature of ":set" |add-option-flags|.
3711 NOTE: This option is set to the Vi default value when 'compatible' is
3712 set and to the Vim default value when 'compatible' is reset.
3713
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 *'formatprg'* *'fp'*
3715'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003716 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003718 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003720 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003721 If the 'formatexpr' option is not empty it will be used instead.
3722 Otherwise, if 'formatprg' option is an empty string, the internal
3723 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003724 Environment variables are expanded |:set_env|. See |option-backslash|
3725 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003726 This option cannot be set from a |modeline| or in the |sandbox|, for
3727 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728
Bram Moolenaard94464e2015-11-02 15:28:18 +01003729 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003730'fsync' 'fs' boolean (default on)
3731 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003732 When on, the library function fsync() will be called after writing a
3733 file. This will flush a file to disk, ensuring that it is safely
3734 written even on filesystems which do metadata-only journaling. This
3735 will force the harddrive to spin up on Linux systems running in laptop
3736 mode, so it may be undesirable in some situations. Be warned that
3737 turning this off increases the chances of data loss after a crash. On
3738 systems without an fsync() implementation, this variable is always
3739 off.
3740 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003741 'fsync' also applies to |writefile()| (unless a flag is used to
3742 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003743 This option cannot be set from a |modeline| or in the |sandbox|, for
3744 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003745
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3747'gdefault' 'gd' boolean (default off)
3748 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749 When on, the ":substitute" flag 'g' is default on. This means that
3750 all matches in a line are substituted instead of one. When a 'g' flag
3751 is given to a ":substitute" command, this will toggle the substitution
3752 of all or one match. See |complex-change|.
3753
3754 command 'gdefault' on 'gdefault' off ~
3755 :s/// subst. all subst. one
3756 :s///g subst. one subst. all
3757 :s///gg subst. all subst. one
3758
3759 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003760 DEPRECATED: Setting this option may break plugins that are not aware
3761 of this option. Also, many users get confused that adding the /g flag
3762 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003763 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764
3765 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003766'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 Format to recognize for the ":grep" command output.
3769 This is a scanf-like string that uses the same format as the
3770 'errorformat' option: see |errorformat|.
3771
3772 *'grepprg'* *'gp'*
3773'grepprg' 'gp' string (default "grep -n ",
3774 Unix: "grep -n $* /dev/null",
3775 Win32: "findstr /n" or "grep -n",
3776 VMS: "SEARCH/NUMBERS ")
3777 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003778 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 and '#' characters, which are expanded like when used in a command-
3780 line. The placeholder "$*" is allowed to specify where the arguments
3781 will be included. Environment variables are expanded |:set_env|. See
3782 |option-backslash| about including spaces and backslashes.
3783 When your "grep" accepts the "-H" argument, use this to make ":grep"
3784 also work well with a single file: >
3785 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003786< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003787 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3788 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003789 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 apply equally to 'grepprg'.
3791 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3792 otherwise it's "grep -n".
3793 This option cannot be set from a |modeline| or in the |sandbox|, for
3794 security reasons.
3795
3796 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3797'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3798 ve:ver35-Cursor,
3799 o:hor50-Cursor,
3800 i-ci:ver25-Cursor/lCursor,
3801 r-cr:hor20-Cursor/lCursor,
3802 sm:block-Cursor
3803 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003804 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 "n-v-c:block,o:hor50,i-ci:hor15,
3806 r-cr:hor30,sm:block")
3807 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003809 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003811 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003812 height of the cursor can be changed. This can be done by specifying a
3813 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003814 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3815 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003817 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 mode-list and an argument-list:
3819 mode-list:argument-list,mode-list:argument-list,..
3820 The mode-list is a dash separated list of these modes:
3821 n Normal mode
3822 v Visual mode
3823 ve Visual mode with 'selection' "exclusive" (same as 'v',
3824 if not specified)
3825 o Operator-pending mode
3826 i Insert mode
3827 r Replace mode
3828 c Command-line Normal (append) mode
3829 ci Command-line Insert mode
3830 cr Command-line Replace mode
3831 sm showmatch in Insert mode
3832 a all modes
3833 The argument-list is a dash separated list of these arguments:
3834 hor{N} horizontal bar, {N} percent of the character height
3835 ver{N} vertical bar, {N} percent of the character width
3836 block block cursor, fills the whole character
3837 [only one of the above three should be present]
3838 blinkwait{N} *cursor-blinking*
3839 blinkon{N}
3840 blinkoff{N}
3841 blink times for cursor: blinkwait is the delay before
3842 the cursor starts blinking, blinkon is the time that
3843 the cursor is shown and blinkoff is the time that the
3844 cursor is not shown. The times are in msec. When one
3845 of the numbers is zero, there is no blinking. The
3846 default is: "blinkwait700-blinkon400-blinkoff250".
3847 These numbers are used for a missing entry. This
3848 means that blinking is enabled by default. To switch
3849 blinking off you can use "blinkon0". The cursor only
3850 blinks when Vim is waiting for input, not while
3851 executing a command.
3852 To make the cursor blink in an xterm, see
3853 |xterm-blink|.
3854 {group-name}
3855 a highlight group name, that sets the color and font
3856 for the cursor
3857 {group-name}/{group-name}
3858 Two highlight group names, the first is used when
3859 no language mappings are used, the other when they
3860 are. |language-mapping|
3861
3862 Examples of parts:
3863 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3864 block cursor with colors from the "nCursor"
3865 highlight group
3866 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3867 In Insert and Command-line Insert mode, use a
3868 30% vertical bar cursor with colors from the
3869 "iCursor" highlight group. Blink a bit
3870 faster.
3871
3872 The 'a' mode is different. It will set the given argument-list for
3873 all modes. It does not reset anything to defaults. This can be used
3874 to do a common setting for all modes. For example, to switch off
3875 blinking: "a:blinkon0"
3876
3877 Examples of cursor highlighting: >
3878 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3879 :highlight Cursor gui=NONE guifg=bg guibg=fg
3880<
3881 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003882 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883'guifont' 'gfn' string (default "")
3884 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 {only available when compiled with GUI enabled}
3886 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003887 In its simplest form the value is just one font name.
3888 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889
3890 *'guifontset'* *'gfs'*
3891 *E250* *E252* *E234* *E597* *E598*
3892'guifontset' 'gfs' string (default "")
3893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 {only available when compiled with GUI enabled and
3895 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003896 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 When not empty, specifies two (or more) fonts to be used. The first
3898 one for normal English, the second one for your special language. See
3899 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003900
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3902'guifontwide' 'gfw' string (default "")
3903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 {only available when compiled with GUI enabled}
3905 When not empty, specifies a comma-separated list of fonts to be used
3906 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003907 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003908
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 *'guiheadroom'* *'ghr'*
3910'guiheadroom' 'ghr' number (default 50)
3911 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003912 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 The number of pixels subtracted from the screen height when fitting
3914 the GUI window on the screen. Set this before the GUI is started,
3915 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003916 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 lines will be left for window decorations and other items on the
3918 screen. Set it to a negative value to allow windows taller than the
3919 screen.
3920
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003921 *'guiligatures'* *'gli'* *E1243*
3922'guiligatures' 'gli' string (default "")
3923 global
3924 {only for GTK GUI}
3925 List of ASCII characters that, when combined together, can create more
3926 complex shapes. Each character must be a printable ASCII character
3927 with a value in the 32-127 range.
3928 Example: >
3929 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3930< Changing this option updates screen output immediately. Set it to an
3931 empty string to disable ligatures.
3932
Bram Moolenaar071d4272004-06-13 20:20:40 +00003933 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003934'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3935 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003936 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003937 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003940 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 sequence of letters which describes what components and options of the
3942 GUI should be used.
3943 To avoid problems with flags that are added in the future, use the
3944 "+=" and "-=" feature of ":set" |add-option-flags|.
3945
Bram Moolenaar13568252018-03-16 20:46:58 +01003946 Valid characters are as follows:
3947 *'go-!'*
3948 '!' External commands are executed in a terminal window. Without
3949 this flag the MS-Windows GUI will open a console window to
3950 execute the command. The Unix GUI will simulate a dumb
3951 terminal to list the command output.
3952 The terminal window will be positioned at the bottom, and grow
3953 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003954 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 'a' Autoselect: If present, then whenever VISUAL mode is started,
3956 or the Visual area extended, Vim tries to become the owner of
3957 the windowing system's global selection. This means that the
3958 Visually highlighted text is available for pasting into other
3959 applications as well as into Vim itself. When the Visual mode
3960 ends, possibly due to an operation on the text, or when an
3961 application wants to paste the selection, the highlighted text
3962 is automatically yanked into the "* selection register.
3963 Thus the selection is still available for pasting into other
3964 applications after the VISUAL mode has ended.
3965 If not present, then Vim won't become the owner of the
3966 windowing system's global selection unless explicitly told to
3967 by a yank or delete operation for the "* register.
3968 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003969 *'go-P'*
3970 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003971 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003972 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003973 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003974 applies to the modeless selection.
3975
3976 'guioptions' autoselect Visual autoselect modeless ~
3977 "" - -
3978 "a" yes yes
3979 "A" - yes
3980 "aA" yes yes
3981
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01003982 When using a terminal see the 'clipboard' option.
3983
Bram Moolenaar02467872007-05-06 13:22:01 +00003984 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 'c' Use console dialogs instead of popup dialogs for simple
3986 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003987 *'go-d'*
3988 'd' Use dark theme variant if available. Currently only works for
3989 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003990 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003991 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003992 'guitablabel' can be used to change the text in the labels.
3993 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003994 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003995 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003996 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 'f' Foreground: Don't use fork() to detach the GUI from the shell
3998 where it was started. Use this for programs that wait for the
3999 editor to finish (e.g., an e-mail program). Alternatively you
4000 can use "gvim -f" or ":gui -f" to start the GUI in the
4001 foreground. |gui-fork|
4002 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004003 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004004 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4006 corner of the window. It's black&white on non-GTK, because of
4007 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004008 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004010 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004011 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004013 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004015 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004016 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 'g' Grey menu items: Make menu items that are not active grey. If
4018 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004019 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 't' Include tearoff menu items. Currently only works for Win32,
4021 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004022 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004023 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4024 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004025 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004027 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 'R' Right-hand scrollbar is present when there is a vertically
4029 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004030 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004032 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 'L' Left-hand scrollbar is present when there is a vertically
4034 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004035 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4037 the longest visible line, or on the cursor line if the 'h'
4038 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004039 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 'h' Limit horizontal scrollbar size to the length of the cursor
4041 line. Reduces computations. |gui-horiz-scroll|
4042
4043 And yes, you may even have scrollbars on the left AND the right if
4044 you really want to :-). See |gui-scrollbars| for more information.
4045
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004046 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 'v' Use a vertical button layout for dialogs. When not included,
4048 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004049 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004050 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051 'p' Use Pointer callbacks for X11 GUI. This is required for some
4052 window managers. If the cursor is not blinking or hollow at
4053 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004054 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004056 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004057 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004058 *'go-k'*
4059 'k' Keep the GUI window size when adding/removing a scrollbar, or
4060 toolbar, tabline, etc. Instead, the behavior is similar to
4061 when the window is maximized and will adjust 'lines' and
4062 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004063 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004064 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004065
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 *'guipty'* *'noguipty'*
4067'guipty' boolean (default on)
4068 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069 {only available when compiled with GUI enabled}
4070 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4071 I/O to/from shell commands. See |gui-pty|.
4072
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004073 *'guitablabel'* *'gtl'*
4074'guitablabel' 'gtl' string (default empty)
4075 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004076 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004077 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004078 pages line. When empty and when the result is empty Vim will use a
4079 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004080
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004081 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004082 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004083 The expression will be evaluated in the |sandbox| when set from a
4084 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004085 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004086
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004087 Only used when the GUI tab pages line is displayed. 'e' must be
4088 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4089 used.
4090
Bram Moolenaar57657d82006-04-21 22:12:41 +00004091 *'guitabtooltip'* *'gtt'*
4092'guitabtooltip' 'gtt' string (default empty)
4093 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004094 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004095 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004096 pages line. When empty Vim will use a default tooltip.
4097 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004098 You can include a line break. Simplest method is to use |:let|: >
4099 :let &guitabtooltip = "line one\nline two"
4100<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004101
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004103'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 (others) "$VIMRUNTIME/doc/help.txt")
4105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 Name of the main help file. All distributed help files should be
4107 placed together in one directory. Additionally, all "doc" directories
4108 in 'runtimepath' will be used.
4109 Environment variables are expanded |:set_env|. For example:
4110 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004111 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 spaces and backslashes.
4113 This option cannot be set from a |modeline| or in the |sandbox|, for
4114 security reasons.
4115
4116 *'helpheight'* *'hh'*
4117'helpheight' 'hh' number (default 20)
4118 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 Minimal initial height of the help window when it is opened with the
4120 ":help" command. The initial height of the help window is half of the
4121 current window, or (when the 'ea' option is on) the same as other
4122 windows. When the height is less than 'helpheight', the height is
4123 set to 'helpheight'. Set to zero to disable.
4124
4125 *'helplang'* *'hlg'*
4126'helplang' 'hlg' string (default: messages language or empty)
4127 global
4128 {only available when compiled with the |+multi_lang|
4129 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004130 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 for which the desired help can be found. The English help will always
4132 be used as a last resort. You can add "en" to prefer English over
4133 another language, but that will only find tags that exist in that
4134 language and not in the English help.
4135 Example: >
4136 :set helplang=de,it
4137< This will first search German, then Italian and finally English help
4138 files.
4139 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4140 try to find the tag in the current language before using this option.
4141 See |help-translated|.
4142
4143 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4144'hidden' 'hid' boolean (default off)
4145 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 When off a buffer is unloaded when it is |abandon|ed. When on a
4147 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4148 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004149
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004151 hidden even if the 'hidden' option is off when these three are true:
4152 - the buffer is modified
4153 - 'autowrite' is off or writing is not possible
4154 - the '!' flag was used
4155 Also see |windows.txt|.
4156
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004157 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 This option is set for one command with ":hide {command}" |:hide|.
4159 WARNING: It's easy to forget that you have changes in hidden buffers.
4160 Think twice when using ":q!" or ":qa!".
4161
4162 *'highlight'* *'hl'*
4163'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004164 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4165 d:Directory,e:ErrorMsg,i:IncSearch,
4166 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004167 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004168 N:CursorLineNr,r:Question,s:StatusLine,
4169 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004170 v:Visual,V:VisualNOS,w:WarningMsg,
4171 W:WildMenu,f:Folded,F:FoldColumn,
4172 A:DiffAdd,C:DiffChange,D:DiffDelete,
4173 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004174 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004175 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004176 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4177 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004178 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004179 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004182 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004184 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004186 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4187 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188 characters from 'showbreak'
4189 |hl-Directory| d directories in CTRL-D listing and other special
4190 things in listings
4191 |hl-ErrorMsg| e error messages
4192 h (obsolete, ignored)
4193 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004194 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4196 |hl-MoreMsg| m |more-prompt|
4197 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004198 |hl-LineNr| n line number for ":number" and ":#" commands, and
4199 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004200 |hl-LineNrAbove| a line number above the cursor for when the
4201 'relativenumber' option is set.
4202 |hl-LineNrBelow| b line number below the cursor for when the
4203 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004204 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4205 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 |hl-Question| r |hit-enter| prompt and yes/no questions
4207 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004208 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4210 |hl-VertSplit| c column used to separate vertically split windows
4211 |hl-Visual| v Visual mode
4212 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4213 Selection" Only X11 Gui's |gui-x11| and
4214 |xterm-clipboard|.
4215 |hl-WarningMsg| w warning messages
4216 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4217 |hl-Folded| f line used for closed folds
4218 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004219 |hl-DiffAdd| A added line in diff mode
4220 |hl-DiffChange| C changed line in diff mode
4221 |hl-DiffDelete| D deleted line in diff mode
4222 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004224 |hl-Conceal| - the placeholders used for concealed characters
4225 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004226 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004227 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004228 |hl-SpellRare| R rare word |spell|
4229 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004230 |hl-Pmenu| + popup menu normal line
4231 |hl-PmenuSel| = popup menu selected line
4232 |hl-PmenuSbar| x popup menu scrollbar
4233 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234
4235 The display modes are:
4236 r reverse (termcap entry "mr" and "me")
4237 i italic (termcap entry "ZH" and "ZR")
4238 b bold (termcap entry "md" and "me")
4239 s standout (termcap entry "so" and "se")
4240 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004241 c undercurl (termcap entry "Us" and "Ce")
4242 2 double underline (termcap entry "Ds" and "Ce")
4243 d dotted underline (termcap entry "ds" and "Ce")
4244 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004245 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246 n no highlighting
4247 - no highlighting
4248 : use a highlight group
4249 The default is used for occasions that are not included.
4250 If you want to change what the display modes do, see |dos-colors|
4251 for an example.
4252 When using the ':' display mode, this must be followed by the name of
4253 a highlight group. A highlight group can be used to define any type
4254 of highlighting, including using color. See |:highlight| on how to
4255 define one. The default uses a different group for each occasion.
4256 See |highlight-default| for the default highlight groups.
4257
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004259'history' 'hi' number (Vim default: 50, Vi default: 0,
4260 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004263 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004265 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 NOTE: This option is set to the Vi default value when 'compatible' is
4267 set and to the Vim default value when 'compatible' is reset.
4268
4269 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4270'hkmap' 'hk' boolean (default off)
4271 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004272 {only available when compiled with the |+rightleft|
4273 feature}
4274 When on, the keyboard is mapped for the Hebrew character set.
4275 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4276 toggle this option. See |rileft.txt|.
4277 NOTE: This option is reset when 'compatible' is set.
4278
4279 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4280'hkmapp' 'hkp' boolean (default off)
4281 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 {only available when compiled with the |+rightleft|
4283 feature}
4284 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4285 This is useful if you have a non-Hebrew keyboard.
4286 See |rileft.txt|.
4287 NOTE: This option is reset when 'compatible' is set.
4288
Bram Moolenaar036986f2017-03-16 17:41:02 +01004289 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4290'hlsearch' 'hls' boolean (default off)
4291 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004292 {not available when compiled without the
4293 |+extra_search| feature}
4294 When there is a previous search pattern, highlight all its matches.
4295 The type of highlighting used can be set with the 'l' occasion in the
4296 'highlight' option. This uses the "Search" highlight group by
4297 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004298 are not applied. If the "CurSearch" highlight group is set then the
4299 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004300 See also: 'incsearch' and |:match|.
4301 When you get bored looking at the highlighted matches, you can turn it
4302 off with |:nohlsearch|. This does not change the option value, as
4303 soon as you use a search command, the highlighting comes back.
4304 'redrawtime' specifies the maximum time spent on finding matches.
4305 When the search pattern can match an end-of-line, Vim will try to
4306 highlight all of the matched text. However, this depends on where the
4307 search starts. This will be the first line in the window or the first
4308 line below a closed fold. A match in a previous line which is not
4309 drawn may not continue in a newly drawn line.
4310 You can specify whether the highlight status is restored on startup
4311 with the 'h' flag in 'viminfo' |viminfo-h|.
4312 NOTE: This option is reset when 'compatible' is set.
4313
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 *'icon'* *'noicon'*
4315'icon' boolean (default off, on when title can be restored)
4316 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 When on, the icon text of the window will be set to the value of
4318 'iconstring' (if it is not empty), or to the name of the file
4319 currently being edited. Only the last part of the name is used.
4320 Overridden by the 'iconstring' option.
4321 Only works if the terminal supports setting window icons (currently
4322 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4323 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4324 builtin termcap).
4325 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004326 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004328 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329
4330 *'iconstring'*
4331'iconstring' string (default "")
4332 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 When this option is not empty, it will be used for the icon text of
4334 the window. This happens only when the 'icon' option is on.
4335 Only works if the terminal supports setting window icon text
4336 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004337 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 When Vim was compiled with HAVE_X11 defined, the original icon will be
4339 restored if possible |X11|.
4340 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004341 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004343 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 {not available when compiled without the |+statusline| feature}
4345
4346 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4347'ignorecase' 'ic' boolean (default off)
4348 global
4349 Ignore case in search patterns. Also used when searching in the tags
4350 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004351 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 Can be overruled by using "\c" or "\C" in the pattern, see
4353 |/ignorecase|.
4354
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004355 *'imactivatefunc'* *'imaf'*
4356'imactivatefunc' 'imaf' string (default "")
4357 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004358 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004359 activate or deactivate the Input Method. The value can be the name of
4360 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4361 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004362 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004363 The expression will be evaluated in the |sandbox| when set from a
4364 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004365
4366 Example: >
4367 function ImActivateFunc(active)
4368 if a:active
4369 ... do something
4370 else
4371 ... do something
4372 endif
4373 " return value is not used
4374 endfunction
4375 set imactivatefunc=ImActivateFunc
4376<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 *'imactivatekey'* *'imak'*
4378'imactivatekey' 'imak' string (default "")
4379 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004381 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382 Specifies the key that your Input Method in X-Windows uses for
4383 activation. When this is specified correctly, vim can fully control
4384 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4385 You can't use this option to change the activation key, the option
4386 tells Vim what the key is.
4387 Format:
4388 [MODIFIER_FLAG-]KEY_STRING
4389
4390 These characters can be used for MODIFIER_FLAG (case is ignored):
4391 S Shift key
4392 L Lock key
4393 C Control key
4394 1 Mod1 key
4395 2 Mod2 key
4396 3 Mod3 key
4397 4 Mod4 key
4398 5 Mod5 key
4399 Combinations are allowed, for example "S-C-space" or "SC-space" are
4400 both shift+ctrl+space.
4401 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4402
4403 Example: >
4404 :set imactivatekey=S-space
4405< "S-space" means shift+space. This is the activation key for kinput2 +
4406 canna (Japanese), and ami (Korean).
4407
4408 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4409'imcmdline' 'imc' boolean (default off)
4410 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 When set the Input Method is always on when starting to edit a command
4412 line, unless entering a search pattern (see 'imsearch' for that).
4413 Setting this option is useful when your input method allows entering
4414 English characters directly, e.g., when it's used to type accented
4415 characters with dead keys.
4416
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004417 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004418'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4419 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 When set the Input Method is never used. This is useful to disable
4421 the IM when it doesn't work properly.
4422 Currently this option is on by default for SGI/IRIX machines. This
4423 may change in later releases.
4424
4425 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004426'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 Specifies whether :lmap or an Input Method (IM) is to be used in
4429 Insert mode. Valid values:
4430 0 :lmap is off and IM is off
4431 1 :lmap is ON and IM is off
4432 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 To always reset the option to zero when leaving Insert mode with <Esc>
4434 this can be used: >
4435 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4436< This makes :lmap and IM turn off automatically when leaving Insert
4437 mode.
4438 Note that this option changes when using CTRL-^ in Insert mode
4439 |i_CTRL-^|.
4440 The value is set to 1 when setting 'keymap' to a valid keymap name.
4441 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004442 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 methods. Use 'imdisable' to disable XIM then.
4444
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004445 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004446 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004447 |+multi_byte_ime| or |global-ime|.
4448
Bram Moolenaar071d4272004-06-13 20:20:40 +00004449 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004450'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452 Specifies whether :lmap or an Input Method (IM) is to be used when
4453 entering a search pattern. Valid values:
4454 -1 the value of 'iminsert' is used, makes it look like
4455 'iminsert' is also used when typing a search pattern
4456 0 :lmap is off and IM is off
4457 1 :lmap is ON and IM is off
4458 2 :lmap is off and IM is ON
4459 Note that this option changes when using CTRL-^ in Command-line mode
4460 |c_CTRL-^|.
4461 The value is set to 1 when it is not -1 and setting the 'keymap'
4462 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004463 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464 methods. Use 'imdisable' to disable XIM then.
4465
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004466 *'imstatusfunc'* *'imsf'*
4467'imstatusfunc' 'imsf' string (default "")
4468 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004469 This option specifies a function that is called to obtain the status
4470 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004471 The value can be the name of a function, a |lambda| or a |Funcref|.
4472 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004473 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004474
4475 Example: >
4476 function ImStatusFunc()
4477 let is_active = ...do something
4478 return is_active ? 1 : 0
4479 endfunction
4480 set imstatusfunc=ImStatusFunc
4481<
4482 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004483 The expression will be evaluated in the |sandbox| when set from a
4484 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004485
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004486 *'imstyle'* *'imst'*
4487'imstyle' 'imst' number (default 1)
4488 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004489 {only available when compiled with |+xim| and
4490 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004491 This option specifies the input style of Input Method:
4492 0 use on-the-spot style
4493 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004494 See: |xim-input-style|
4495
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004496 For a long time on-the-spot style had been used in the GTK version of
4497 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004498 |single-repeat|, etc. Therefore over-the-spot style becomes the
4499 default now. This should work fine for most people, however if you
4500 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004501 The expression will be evaluated in the |sandbox| when set from a
4502 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004503
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 *'include'* *'inc'*
4505'include' 'inc' string (default "^\s*#\s*include")
4506 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 {not available when compiled without the
4508 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004509 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 pattern, just like for the "/" command (See |pattern|). The default
4511 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004512 "]I", "[d", etc.
4513 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004514 comes after the matched pattern. But if "\zs" appears in the pattern
4515 then the text matched from "\zs" to the end, or until "\ze" if it
4516 appears, is used as the file name. Use this to include characters
4517 that are not in 'isfname', such as a space. You can then use
4518 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004519 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520
4521 *'includeexpr'* *'inex'*
4522'includeexpr' 'inex' string (default "")
4523 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004525 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004527 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 :set includeexpr=substitute(v:fname,'\\.','/','g')
4529< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004530
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004532 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533 Also used for |<cfile>|.
4534
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004535 If the expression starts with s: or |<SID>|, then it is replaced with
4536 the script ID (|local-function|). Example: >
4537 set includeexpr=s:MyIncludeExpr(v:fname)
4538 set includeexpr=<SID>SomeIncludeExpr(v:fname)
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004539< Otherwise, the expression is evaluated in the context of the script
4540 where the option was set, thus script-local items are available.
4541
Bram Moolenaar30b65812012-07-12 22:01:11 +02004542 The expression will be evaluated in the |sandbox| when set from a
4543 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004544 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004545
4546 It is not allowed to change text or jump to another window while
4547 evaluating 'includeexpr' |textlock|.
4548
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004550'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004551 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004554 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004555 While typing a search command, show where the pattern, as it was typed
4556 so far, matches. The matched string is highlighted. If the pattern
4557 is invalid or not found, nothing is shown. The screen will be updated
4558 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004559 Also applies to the pattern in commands: >
4560 :global
4561 :lvimgrep
4562 :lvimgrepadd
4563 :smagic
4564 :snomagic
4565 :sort
4566 :substitute
4567 :vglobal
4568 :vimgrep
4569 :vimgrepadd
4570< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004571 original position when no match is found and when pressing <Esc>. You
4572 still need to finish the search command with <Enter> to move the
4573 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004574 You can use the CTRL-G and CTRL-T keys to move to the next and
4575 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004576 When compiled with the |+reltime| feature Vim only searches for about
4577 half a second. With a complicated pattern and/or a lot of text the
4578 match may not be found. This is to avoid that Vim hangs while you
4579 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004580 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004581 When 'hlsearch' is on, all matched strings are highlighted too while
4582 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004583 If you don't want to turn 'hlsearch' on, but want to highlight all
4584 matches while searching, you can turn on and off 'hlsearch' with
4585 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004586 augroup vimrc-incsearch-highlight
4587 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004588 autocmd CmdlineEnter /,\? :set hlsearch
4589 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004590 augroup END
4591<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004592 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004593 to the command line. If 'ignorecase' and 'smartcase' are set and the
4594 command line has no uppercase characters, the added character is
4595 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004596 CTRL-R CTRL-W can be used to add the word at the end of the current
4597 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598 NOTE: This option is reset when 'compatible' is set.
4599
4600 *'indentexpr'* *'inde'*
4601'indentexpr' 'inde' string (default "")
4602 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004603 {not available when compiled without the |+eval|
4604 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 Expression which is evaluated to obtain the proper indent for a line.
4606 It is used when a new line is created, for the |=| operator and
4607 in Insert mode as specified with the 'indentkeys' option.
4608 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004609 'smartindent' indenting. When 'lisp' is set, this option is
4610 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 When 'paste' is set this option is not used for indenting.
4612 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004613 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004614 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004615
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004616 If the expression starts with s: or |<SID>|, then it is replaced with
4617 the script ID (|local-function|). Example: >
4618 set indentexpr=s:MyIndentExpr()
4619 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004620< Otherwise, the expression is evaluated in the context of the script
4621 where the option was set, thus script-local items are available.
4622
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623 The expression must return the number of spaces worth of indent. It
4624 can return "-1" to keep the current indent (this means 'autoindent' is
4625 used for the indent).
4626 Functions useful for computing the indent are |indent()|, |cindent()|
4627 and |lispindent()|.
4628 The evaluation of the expression must not have side effects! It must
4629 not change the text, jump to another window, etc. Afterwards the
4630 cursor position is always restored, thus the cursor may be moved.
4631 Normally this option would be set to call a function: >
4632 :set indentexpr=GetMyIndent()
4633< Error messages will be suppressed, unless the 'debug' option contains
4634 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004635 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004636 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637
Bram Moolenaar30b65812012-07-12 22:01:11 +02004638 The expression will be evaluated in the |sandbox| when set from a
4639 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004640 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004641
4642 It is not allowed to change text or jump to another window while
4643 evaluating 'indentexpr' |textlock|.
4644
4645
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004647'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649 A list of keys that, when typed in Insert mode, cause reindenting of
4650 the current line. Only happens if 'indentexpr' isn't empty.
4651 The format is identical to 'cinkeys', see |indentkeys-format|.
4652 See |C-indenting| and |indent-expression|.
4653
4654 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4655'infercase' 'inf' boolean (default off)
4656 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004658 'ignorecase' is also on, the case of the match is adjusted depending
4659 on the typed text. If the typed text contains a lowercase letter
4660 where the match has an upper case letter, the completed part is made
4661 lowercase. If the typed text has no lowercase letters and the match
4662 has a lowercase letter where the typed text has an uppercase letter,
4663 and there is a letter before it, the completed part is made uppercase.
4664 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665
4666 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4667'insertmode' 'im' boolean (default off)
4668 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669 Makes Vim work in a way that Insert mode is the default mode. Useful
4670 if you want to use Vim as a modeless editor. Used for |evim|.
4671 These Insert mode commands will be useful:
4672 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004673 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004674 this is a mapping, it is executed as if 'insertmode' was off.
4675 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004677 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4678 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679
4680 These items change when 'insertmode' is set:
4681 - when starting to edit of a file, Vim goes to Insert mode.
4682 - <Esc> in Insert mode is a no-op and beeps.
4683 - <Esc> in Normal mode makes Vim go to Insert mode.
4684 - CTRL-L in Insert mode is a command, it is not inserted.
4685 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4686 However, when <Esc> is used inside a mapping, it behaves like
4687 'insertmode' was not set. This was done to be able to use the same
4688 mappings with 'insertmode' set or not set.
4689 When executing commands with |:normal| 'insertmode' is not used.
4690
4691 NOTE: This option is reset when 'compatible' is set.
4692
4693 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004694'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4696 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4697 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4698 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4699 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 The characters specified by this option are included in file names and
4702 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004703 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 Multi-byte characters 256 and above are always included, only the
4705 characters up to 255 are specified with this option.
4706 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004707 Think twice before adding white space to this option. Although a
4708 space may appear inside a file name, the effect will be that Vim
4709 doesn't know where a file name starts or ends when doing completion.
4710 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711
4712 Note that on systems using a backslash as path separator, Vim tries to
4713 do its best to make it work as you would expect. That is a bit
4714 tricky, since Vi originally used the backslash to escape special
4715 characters. Vim will not remove a backslash in front of a normal file
4716 name character on these systems, but it will on Unix and alikes. The
4717 '&' and '^' are not included by default, because these are special for
4718 cmd.exe.
4719
4720 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004721 Each part can be a single character number or a range. A range is two
4722 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 decimal number between 0 and 255 or the ASCII character itself (does
4724 not work for digits). Example:
4725 "_,-,128-140,#-43" (include '_' and '-' and the range
4726 128 to 140 and '#' to 43)
4727 If a part starts with '^', the following character number or range
4728 will be excluded from the option. The option is interpreted from left
4729 to right. Put the excluded character after the range where it is
4730 included. To include '^' itself use it as the last character of the
4731 option or the end of a range. Example:
4732 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4733 If the character is '@', all characters where isalpha() returns TRUE
4734 are included. Normally these are the characters a to z and A to Z,
4735 plus accented characters. To include '@' itself use "@-@". Examples:
4736 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004737 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 "a-z,A-Z,@-@" All letters plus the '@' character.
4739 A comma can be included by using it where a character number is
4740 expected. Example:
4741 "48-57,,,_" Digits, comma and underscore.
4742 A comma can be excluded by prepending a '^'. Example:
4743 " -~,^,,9" All characters from space to '~', excluding
4744 comma, plus <Tab>.
4745 See |option-backslash| about including spaces and backslashes.
4746
4747 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004748'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004749 "@,48-57,_,128-167,224-235"
4750 otherwise: "@,48-57,_,192-255")
4751 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752 The characters given by this option are included in identifiers.
4753 Identifiers are used in recognizing environment variables and after a
4754 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004755 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004756 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004758 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4760
4761 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004762'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 "@,48-57,_,128-167,224-235"
4764 otherwise: "@,48-57,_,192-255"
4765 Vi default: "@,48-57,_")
4766 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004768 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004769 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004770 characters above 255 check the "word" character class (any character
4771 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004772 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 For a help file it is set to all non-blank printable characters except
4774 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4775 command).
4776 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004777 This option also influences syntax highlighting, unless the syntax
4778 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004779 NOTE: This option is set to the Vi default value when 'compatible' is
4780 set and to the Vim default value when 'compatible' is reset.
4781
4782 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004783'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784 "@,~-255"; otherwise: "@,161-255")
4785 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786 The characters given by this option are displayed directly on the
4787 screen. It is also used for "\p" in a |pattern|. The characters from
4788 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4789 even when they are not included in 'isprint' or excluded. See
4790 'isfname' for a description of the format of this option.
4791
4792 Non-printable characters are displayed with two characters:
4793 0 - 31 "^@" - "^_"
4794 32 - 126 always single characters
4795 127 "^?"
4796 128 - 159 "~@" - "~_"
4797 160 - 254 "| " - "|~"
4798 255 "~?"
4799 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4800 displayed as <xx>, with the hexadecimal value of the byte.
4801 When 'display' contains "uhex" all unprintable characters are
4802 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004803 The SpecialKey highlighting will be used for unprintable characters.
4804 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805
4806 Multi-byte characters 256 and above are always included, only the
4807 characters up to 255 are specified with this option. When a character
4808 is printable but it is not available in the current font, a
4809 replacement character will be shown.
4810 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4811 There is no option to specify these characters.
4812
4813 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4814'joinspaces' 'js' boolean (default on)
4815 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816 Insert two spaces after a '.', '?' and '!' with a join command.
4817 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4818 Otherwise only one space is inserted.
4819 NOTE: This option is set when 'compatible' is set.
4820
4821 *'key'*
4822'key' string (default "")
4823 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004824 {only available when compiled with the |+cryptv|
4825 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004827 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828 Careful: Do not set the key value by hand, someone might see the typed
4829 key. Use the |:X| command. But you can make 'key' empty: >
4830 :set key=
4831< It is not possible to get the value of this option with ":set key" or
4832 "echo &key". This is to avoid showing it to someone who shouldn't
4833 know. It also means you cannot see it yourself once you have set it,
4834 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004835 You can use "&key" in an expression to detect whether encryption is
4836 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837
4838 *'keymap'* *'kmp'* *E544*
4839'keymap' 'kmp' string (default "")
4840 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 {only available when compiled with the |+keymap|
4842 feature}
4843 Name of a keyboard mapping. See |mbyte-keymap|.
4844 Setting this option to a valid keymap name has the side effect of
4845 setting 'iminsert' to one, so that the keymap becomes effective.
4846 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004847 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848
4849 *'keymodel'* *'km'*
4850'keymodel' 'km' string (default "")
4851 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004852 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 can do. These values can be used:
4854 startsel Using a shifted special key starts selection (either
4855 Select mode or Visual mode, depending on "key" being
4856 present in 'selectmode').
4857 stopsel Using a not-shifted special key stops selection.
4858 Special keys in this context are the cursor keys, <End>, <Home>,
4859 <PageUp> and <PageDown>.
4860 The 'keymodel' option is set by the |:behave| command.
4861
4862 *'keywordprg'* *'kp'*
4863'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004864 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 Program to use for the |K| command. Environment variables are
4867 expanded |:set_env|. ":help" may be used to access the Vim internal
4868 help. (Note that previously setting the global option to the empty
4869 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004870 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01004871 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004872 When "man", "man -s" or an Ex command is used, Vim will automatically
4873 translate a count for the "K" command and pass it as the first
4874 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 See |option-backslash| about including spaces and backslashes.
4876 Example: >
4877 :set keywordprg=man\ -s
4878< This option cannot be set from a |modeline| or in the |sandbox|, for
4879 security reasons.
4880
4881 *'langmap'* *'lmap'* *E357* *E358*
4882'langmap' 'lmap' string (default "")
4883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884 {only available when compiled with the |+langmap|
4885 feature}
4886 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004887 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004888 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889 care of translating these special characters to the original meaning
4890 of the key. This means you don't have to change the keyboard mode to
4891 be able to execute Normal mode commands.
4892 This is the opposite of the 'keymap' option, where characters are
4893 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004894 Also consider setting 'langremap' to off, to prevent 'langmap' from
4895 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004896 This option cannot be set from a |modeline| or in the |sandbox|, for
4897 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004899 Example (for Greek, in UTF-8): *greek* >
4900 :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 +00004901< Example (exchanges meaning of z and y for commands): >
4902 :set langmap=zy,yz,ZY,YZ
4903<
4904 The 'langmap' option is a list of parts, separated with commas. Each
4905 part can be in one of two forms:
4906 1. A list of pairs. Each pair is a "from" character immediately
4907 followed by the "to" character. Examples: "aA", "aAbBcC".
4908 2. A list of "from" characters, a semi-colon and a list of "to"
4909 characters. Example: "abc;ABC"
4910 Example: "aA,fgh;FGH,cCdDeE"
4911 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004912 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913
4914 This will allow you to activate vim actions without having to switch
4915 back and forth between the languages. Your language characters will
4916 be understood as normal vim English characters (according to the
4917 langmap mappings) in the following cases:
4918 o Normal/Visual mode (commands, buffer/register names, user mappings)
4919 o Insert/Replace Mode: Register names after CTRL-R
4920 o Insert/Replace Mode: Mappings
4921 Characters entered in Command-line mode will NOT be affected by
4922 this option. Note that this option can be changed at any time
4923 allowing to switch between mappings for different languages/encodings.
4924 Use a mapping to avoid having to type it each time!
4925
4926 *'langmenu'* *'lm'*
4927'langmenu' 'lm' string (default "")
4928 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004929 {only available when compiled with the |+menu| and
4930 |+multi_lang| features}
4931 Language to use for menu translation. Tells which file is loaded
4932 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004933 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934< (without the spaces). For example, to always use the Dutch menus, no
4935 matter what $LANG is set to: >
4936 :set langmenu=nl_NL.ISO_8859-1
4937< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004938 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 If your $LANG is set to a non-English language but you do want to use
4940 the English menus: >
4941 :set langmenu=none
4942< This option must be set before loading menus, switching on filetype
4943 detection or syntax highlighting. Once the menus are defined setting
4944 this option has no effect. But you could do this: >
4945 :source $VIMRUNTIME/delmenu.vim
4946 :set langmenu=de_DE.ISO_8859-1
4947 :source $VIMRUNTIME/menu.vim
4948< Warning: This deletes all menus that you defined yourself!
4949
Bram Moolenaard94464e2015-11-02 15:28:18 +01004950 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004951'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004952 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004953 {only available when compiled with the |+langmap|
4954 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004955 This is just like 'langremap' but with the value inverted. It only
4956 exists for backwards compatibility. When setting 'langremap' then
4957 'langnoremap' is set to the inverted value, and the other way around.
4958
4959 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004960'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004961 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004962 {only available when compiled with the |+langmap|
4963 feature}
4964 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004965 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004966 'langmap' disables some of your mappings, try resetting this option.
4967 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004968 that works for you to avoid mappings to break.
4969
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 *'laststatus'* *'ls'*
4971'laststatus' 'ls' number (default 1)
4972 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 The value of this option influences when the last window will have a
4974 status line:
4975 0: never
4976 1: only if there are at least two windows
4977 2: always
4978 The screen looks nicer with a status line if you have several
4979 windows, but it takes another screen line. |status-line|
4980
4981 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4982'lazyredraw' 'lz' boolean (default off)
4983 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 When this option is set, the screen will not be redrawn while
4985 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004986 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004987 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01004988 This may occasionally cause display errors. It is only meant to be set
4989 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01004990 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991
4992 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4993'linebreak' 'lbr' boolean (default off)
4994 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004995 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004997 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998 than at the last character that fits on the screen. Unlike
4999 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005000 it only affects the way the file is displayed, not its contents.
5001 If 'breakindent' is set, line is visually indented. Then, the value
5002 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005003 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 Note that <Tab> characters after an <EOL> are mostly not displayed
5005 with the right amount of white space.
5006
5007 *'lines'* *E593*
5008'lines' number (default 24 or terminal height)
5009 global
5010 Number of lines of the Vim window.
5011 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005012 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013 When Vim is running in the GUI or in a resizable window, setting this
5014 option will cause the window size to be changed. When you only want
5015 to use the size for the GUI, put the command in your |gvimrc| file.
5016 Vim limits the number of lines to what fits on the screen. You can
5017 use this command to get the tallest window possible: >
5018 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005019< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005020 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005021 When you set this option and Vim is unable to change the physical
5022 number of lines of the display, the display may be messed up.
5023
5024 *'linespace'* *'lsp'*
5025'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5026 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027 {only in the GUI}
5028 Number of pixel lines inserted between characters. Useful if the font
5029 uses the full character cell height, making lines touch each other.
5030 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005031 With some fonts there can be too much room between lines (to have
5032 space for ascents and descents). Then it makes sense to set
5033 'linespace' to a negative value. This may cause display problems
5034 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035
5036 *'lisp'* *'nolisp'*
5037'lisp' boolean (default off)
5038 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 Lisp mode: When <Enter> is typed in insert mode set the indent for
5040 the next line to Lisp standards (well, sort of). Also happens with
5041 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5042 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5043 better. Also see 'lispwords'.
5044 The '-' character is included in keyword characters. Redefines the
5045 "=" operator to use this same indentation algorithm rather than
5046 calling an external program if 'equalprg' is empty.
5047 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048
5049 *'lispwords'* *'lw'*
5050'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005051 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005052 Comma-separated list of words that influence the Lisp indenting when
5053 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054
5055 *'list'* *'nolist'*
5056'list' boolean (default off)
5057 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005058 List mode: By default show tabs as CTRL-I is displayed, display $
5059 after end of line. Useful to see the difference between tabs and
5060 spaces and for trailing blanks. Further changed by the 'listchars'
5061 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005062
5063 The cursor is displayed at the start of the space a Tab character
5064 occupies, not at the end as usual in Normal mode. To get this cursor
5065 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005066 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005067<
5068 Note that list mode will also affect formatting (set with 'textwidth'
5069 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070 changing the way tabs are displayed.
5071
5072 *'listchars'* *'lcs'*
5073'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005074 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005075 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005076 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005077 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005078 eol:c Character to show at the end of each line. When
5079 omitted, there is no extra character at the end of the
5080 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005081 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005082 tab:xy[z] Two or three characters to be used to show a tab.
5083 The third character is optional.
5084
5085 tab:xy The 'x' is always used, then 'y' as many times as will
5086 fit. Thus "tab:>-" displays:
5087 >
5088 >-
5089 >--
5090 etc.
5091
5092 tab:xyz The 'z' is always used, then 'x' is prepended, and
5093 then 'y' is used as many times as will fit. Thus
5094 "tab:<->" displays:
5095 >
5096 <>
5097 <->
5098 <-->
5099 etc.
5100
5101 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005102 *lcs-space*
5103 space:c Character to show for a space. When omitted, spaces
5104 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005105 *lcs-multispace*
5106 multispace:c...
5107 One or more characters to use cyclically to show for
5108 multiple consecutive spaces. Overrides the "space"
5109 setting, except for single spaces. When omitted, the
5110 "space" setting is used. For example,
5111 `:set listchars=multispace:---+` shows ten consecutive
5112 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005113 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005114 *lcs-lead*
5115 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005116 leading spaces are blank. Overrides the "space" and
5117 "multispace" settings for leading spaces. You can
5118 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005119 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005120< *lcs-leadmultispace*
5121 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005122 Like the |lcs-multispace| value, but for leading
5123 spaces only. Also overrides |lcs-lead| for leading
5124 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005125 `:set listchars=leadmultispace:---+` shows ten
5126 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005127 ---+---+--XXX ~
5128 Where "XXX" denotes the first non-blank characters in
5129 the line.
5130 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005131 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005132 trailing spaces are blank. Overrides the "space" and
5133 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005134 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005135 extends:c Character to show in the last column, when 'wrap' is
5136 off and the line continues beyond the right of the
5137 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005138 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005139 precedes:c Character to show in the first visible column of the
5140 physical line, when there is text preceding the
5141 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005142 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005143 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005144 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005145 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005146 nbsp:c Character to show for a non-breakable space character
5147 (0xA0 (160 decimal) and U+202F). Left blank when
5148 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005149
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005150 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005152 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005154 Each character can be specified as hex: >
5155 set listchars=eol:\\x24
5156 set listchars=eol:\\u21b5
5157 set listchars=eol:\\U000021b5
5158< Note that a double backslash is used. The number of hex characters
5159 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5160
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161 Examples: >
5162 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005163 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 :set lcs=extends:>,precedes:<
5165< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005166 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5167 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005168 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169
5170 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5171'loadplugins' 'lpl' boolean (default on)
5172 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173 When on the plugin scripts are loaded when starting up |load-plugins|.
5174 This option can be reset in your |vimrc| file to disable the loading
5175 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005176 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5177 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178
Bram Moolenaard94464e2015-11-02 15:28:18 +01005179 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005180'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005181 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005182 {only available when compiled with the |+lua/dyn|
5183 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005184 Specifies the name of the Lua shared library. The default is
5185 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005186 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005187 This option cannot be set from a |modeline| or in the |sandbox|, for
5188 security reasons.
5189
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005190 *'macatsui'* *'nomacatsui'*
5191'macatsui' boolean (default on)
5192 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005193 {not supported}
5194 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005195
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196 *'magic'* *'nomagic'*
5197'magic' boolean (default on)
5198 global
5199 Changes the special characters that can be used in search patterns.
5200 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005201 WARNING: Switching this option off most likely breaks plugins! That
5202 is because many patterns assume it's on and will fail when it's off.
5203 Only switch it off when working with old Vi scripts. In any other
5204 situation write patterns that work when 'magic' is on. Include "\M"
5205 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005206 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5207 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005208
5209 *'makeef'* *'mef'*
5210'makeef' 'mef' string (default: "")
5211 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212 {not available when compiled without the |+quickfix|
5213 feature}
5214 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5215 and the |:grep| command.
5216 When it is empty, an internally generated temp file will be used.
5217 When "##" is included, it is replaced by a number to make the name
5218 unique. This makes sure that the ":make" command doesn't overwrite an
5219 existing file.
5220 NOT used for the ":cf" command. See 'errorfile' for that.
5221 Environment variables are expanded |:set_env|.
5222 See |option-backslash| about including spaces and backslashes.
5223 This option cannot be set from a |modeline| or in the |sandbox|, for
5224 security reasons.
5225
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005226 *'makeencoding'* *'menc'*
5227'makeencoding' 'menc' string (default "")
5228 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005229 Encoding used for reading the output of external commands. When empty,
5230 encoding is not converted.
5231 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5232 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5233 and `:laddfile`.
5234
5235 This would be mostly useful when you use MS-Windows and set 'encoding'
5236 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5237 'makeencoding' to "char" has the same effect as setting to the system
5238 locale encoding. Example: >
5239 :set encoding=utf-8
5240 :set makeencoding=char " system locale is used
5241<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242 *'makeprg'* *'mp'*
5243'makeprg' 'mp' string (default "make", VMS: "MMS")
5244 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005245 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005246 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5247 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005248 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005249 Environment variables are expanded |:set_env|. See |option-backslash|
5250 about including spaces and backslashes.
5251 Note that a '|' must be escaped twice: once for ":set" and once for
5252 the interpretation of a command. When you use a filter called
5253 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 :set makeprg=gmake\ \\\|\ myfilter
5255< The placeholder "$*" can be given (even multiple times) to specify
5256 where the arguments will be included, for example: >
5257 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5258< This option cannot be set from a |modeline| or in the |sandbox|, for
5259 security reasons.
5260
5261 *'matchpairs'* *'mps'*
5262'matchpairs' 'mps' string (default "(:),{:},[:]")
5263 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005265 other.
5266 Only character pairs are allowed that are different, thus you cannot
5267 jump between two double quotes.
5268 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005269 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005270 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271 :set mps+=<:>
5272
5273< A more exotic example, to jump between the '=' and ';' in an
5274 assignment, useful for languages like C and Java: >
5275 :au FileType c,cpp,java set mps+==:;
5276
5277< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005278 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005279
5280 *'matchtime'* *'mat'*
5281'matchtime' 'mat' number (default 5)
5282 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283 Tenths of a second to show the matching paren, when 'showmatch' is
5284 set. Note that this is not in milliseconds, like other options that
5285 set a time. This is to be compatible with Nvi.
5286
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005287 *'maxcombine'* *'mco'*
5288'maxcombine' 'mco' number (default 2)
5289 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005290 The maximum number of combining characters supported for displaying.
5291 Only used when 'encoding' is "utf-8".
5292 The default is OK for most languages. Hebrew may require 4.
5293 Maximum value is 6.
5294 Even when this option is set to 2 you can still edit text with more
5295 combining characters, you just can't see them. Use |g8| or |ga|.
5296 See |mbyte-combining|.
5297
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298 *'maxfuncdepth'* *'mfd'*
5299'maxfuncdepth' 'mfd' number (default 100)
5300 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005301 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005302 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303 Maximum depth of function calls for user functions. This normally
5304 catches endless recursion. When using a recursive function with
5305 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5306 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005307 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005308 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309 See also |:function|.
5310
5311 *'maxmapdepth'* *'mmd'* *E223*
5312'maxmapdepth' 'mmd' number (default 1000)
5313 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314 Maximum number of times a mapping is done without resulting in a
5315 character to be used. This normally catches endless mappings, like
5316 ":map x y" with ":map y x". It still does not catch ":map g wg",
5317 because the 'w' is used before the next mapping is done. See also
5318 |key-mapping|.
5319
5320 *'maxmem'* *'mm'*
5321'maxmem' 'mm' number (default between 256 to 5120 (system
5322 dependent) or half the amount of memory
5323 available)
5324 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5326 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005327 other memory to be freed.
5328 The maximum usable value is about 2000000. Use this to work without a
5329 limit.
5330 The value is ignored when 'swapfile' is off.
5331 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005332
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005333 *'maxmempattern'* *'mmp'*
5334'maxmempattern' 'mmp' number (default 1000)
5335 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005336 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005337 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005338 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005339 When Vim runs into the limit it gives an error message and mostly
5340 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005341 Running into the limit often means that the pattern is very
5342 inefficient or too complex. This may already happen with the pattern
5343 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005344 Might also happen on redraw, when syntax rules try to match a complex
5345 text structure.
5346 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5347 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005348
Bram Moolenaar071d4272004-06-13 20:20:40 +00005349 *'maxmemtot'* *'mmt'*
5350'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5351 dependent) or half the amount of memory
5352 available)
5353 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005354 Maximum amount of memory in Kbyte to use for all buffers together.
5355 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005356 without a limit.
5357 On 64 bit machines higher values might work. But hey, do you really
5358 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005359 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005360 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005361 Buffers with 'swapfile' off still count to the total amount of memory
5362 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005363 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005364
5365 *'menuitems'* *'mis'*
5366'menuitems' 'mis' number (default 25)
5367 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005368 {not available when compiled without the |+menu|
5369 feature}
5370 Maximum number of items to use in a menu. Used for menus that are
5371 generated from a list of items, e.g., the Buffers menu. Changing this
5372 option has no direct effect, the menu must be refreshed first.
5373
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005374 *'mkspellmem'* *'msm'*
5375'mkspellmem' 'msm' string (default "460000,2000,500")
5376 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005377 {not available when compiled without the |+syntax|
5378 feature}
5379 Parameters for |:mkspell|. This tunes when to start compressing the
5380 word tree. Compression can be slow when there are many words, but
5381 it's needed to avoid running out of memory. The amount of memory used
5382 per word depends very much on how similar the words are, that's why
5383 this tuning is complicated.
5384
5385 There are three numbers, separated by commas:
5386 {start},{inc},{added}
5387
5388 For most languages the uncompressed word tree fits in memory. {start}
5389 gives the amount of memory in Kbyte that can be used before any
5390 compression is done. It should be a bit smaller than the amount of
5391 memory that is available to Vim.
5392
5393 When going over the {start} limit the {inc} number specifies the
5394 amount of memory in Kbyte that can be allocated before another
5395 compression is done. A low number means compression is done after
5396 less words are added, which is slow. A high number means more memory
5397 will be allocated.
5398
5399 After doing compression, {added} times 1024 words can be added before
5400 the {inc} limit is ignored and compression is done when any extra
5401 amount of memory is needed. A low number means there is a smaller
5402 chance of hitting the {inc} limit, less memory is used but it's
5403 slower.
5404
5405 The languages for which these numbers are important are Italian and
5406 Hungarian. The default works for when you have about 512 Mbyte. If
5407 you have 1 Gbyte you could use: >
5408 :set mkspellmem=900000,3000,800
5409< If you have less than 512 Mbyte |:mkspell| may fail for some
5410 languages, no matter what you set 'mkspellmem' to.
5411
Bram Moolenaar07607392019-05-26 19:20:43 +02005412 This option cannot be set from a |modeline| or in the |sandbox|.
5413
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005415'modeline' 'ml' boolean (Vim default: on (off for root),
5416 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005417 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005418 If 'modeline' is on 'modelines' gives the number of lines that is
5419 checked for set commands. If 'modeline' is off or 'modelines' is zero
5420 no lines are checked. See |modeline|.
5421
5422 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5423'modelineexpr' 'mle' boolean (default: off)
5424 global
5425 When on allow some options that are an expression to be set in the
5426 modeline. Check the option for whether it is affected by
5427 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005428 This option cannot be set from a |modeline| or in the |sandbox|, for
5429 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005430
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431 *'modelines'* *'mls'*
5432'modelines' 'mls' number (default 5)
5433 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 If 'modeline' is on 'modelines' gives the number of lines that is
5435 checked for set commands. If 'modeline' is off or 'modelines' is zero
5436 no lines are checked. See |modeline|.
5437 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5438 set and to the Vim default value when 'compatible' is reset.
5439
5440 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005441 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442'modifiable' 'ma' boolean (default on)
5443 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 When off the buffer contents cannot be changed. The 'fileformat' and
5445 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005446 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447
5448 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5449'modified' 'mod' boolean (default off)
5450 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451 When on, the buffer is considered to be modified. This option is set
5452 when:
5453 1. A change was made to the text since it was last written. Using the
5454 |undo| command to go back to the original text will reset the
5455 option. But undoing changes that were made before writing the
5456 buffer will set the option again, since the text is different from
5457 when it was written.
5458 2. 'fileformat' or 'fileencoding' is different from its original
5459 value. The original value is set when the buffer is read or
5460 written. A ":set nomodified" command also resets the original
5461 values to the current values and the 'modified' option will be
5462 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005463 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005464 This option is not set when a change is made to the buffer as the
5465 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5466 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5467 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5469 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005470 Note that the text may actually be the same, e.g. 'modified' is set
5471 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005472
5473 *'more'* *'nomore'*
5474'more' boolean (Vim default: on, Vi default: off)
5475 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 When on, listings pause when the whole screen is filled. You will get
5477 the |more-prompt|. When this option is off there are no pauses, the
5478 listing continues until finished.
5479 NOTE: This option is set to the Vi default value when 'compatible' is
5480 set and to the Vim default value when 'compatible' is reset.
5481
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005482 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005483'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005484 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005485 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005486 Enable the use of the mouse. Works for most terminals (xterm, Win32
5487 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5488 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5489 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005490 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 v Visual mode
5492 i Insert mode
5493 c Command-line mode
5494 h all previous modes when editing a help file
5495 a all previous modes
5496 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005497 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005498 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005499< If your terminal can't overrule the mouse events going to the
5500 application, use: >
5501 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005502< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005503 back to Vim using the mouse events.
5504 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5505 "xterm".
5506
5507 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 modeless selection. This doesn't move the text cursor.
5509
5510 See |mouse-using|. Also see |'clipboard'|.
5511
5512 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005513 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514 the mouse buttons can still be used by keeping the shift key pressed.
5515 Also see the 'clipboard' option.
5516
5517 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5518'mousefocus' 'mousef' boolean (default off)
5519 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005520 {only works in the GUI}
5521 The window that the mouse pointer is on is automatically activated.
5522 When changing the window layout or window focus in another way, the
5523 mouse pointer is moved to the window with keyboard focus. Off is the
5524 default because it makes using the pull down menus a little goofy, as
5525 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005526 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005527 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005528
5529 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5530'mousehide' 'mh' boolean (default on)
5531 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 {only works in the GUI}
5533 When on, the mouse pointer is hidden when characters are typed.
5534 The mouse pointer is restored when the mouse is moved.
5535
5536 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005537'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005538 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005539 Sets the model to use for the mouse. The name mostly specifies what
5540 the right mouse button is used for:
5541 extend Right mouse button extends a selection. This works
5542 like in an xterm.
5543 popup Right mouse button pops up a menu. The shifted left
5544 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005545 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005546 popup_setpos Like "popup", but the cursor will be moved to the
5547 position where the mouse was clicked, and thus the
5548 selected operation will act upon the clicked object.
5549 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005550 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 course, that right clicking outside a selection will
5552 end Visual mode.
5553 Overview of what button does what for each model:
5554 mouse extend popup(_setpos) ~
5555 left click place cursor place cursor
5556 left drag start selection start selection
5557 shift-left search word extend selection
5558 right click extend selection popup menu (place cursor)
5559 right drag extend selection -
5560 middle click paste paste
5561
5562 In the "popup" model the right mouse button produces a pop-up menu.
5563 You need to define this first, see |popup-menu|.
5564
5565 Note that you can further refine the meaning of buttons with mappings.
5566 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5567 selection (because that's handled in the GUI code directly).
5568
5569 The 'mousemodel' option is set by the |:behave| command.
5570
Ernie Raelc4cb5442022-04-03 15:47:28 +01005571 *'mousemoveevent'* *'mousemev'*
5572'mousemoveevent' 'mousemev' boolean (default off)
5573 global
5574 {only works in the GUI}
5575 When on, mouse move events are delivered to the input queue and are
5576 available for mapping. The default, off, avoids the mouse movement
5577 overhead except when needed. See |gui-mouse-mapping|.
5578 Warning: Setting this option can make pending mappings to be aborted
5579 when the mouse is moved.
5580 Currently only works in the GUI, may be made to work in a terminal
5581 later.
5582
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005584'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5585 vs:leftright,vd:lrsizing,m:no,
5586 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005588 {only available when compiled with the |+mouseshape|
5589 feature}
5590 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005591 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005592 like used for 'guicursor'. Each part consist of a mode/location-list
5593 and an argument-list:
5594 mode-list:shape,mode-list:shape,..
5595 The mode-list is a dash separated list of these modes/locations:
5596 In a normal window: ~
5597 n Normal mode
5598 v Visual mode
5599 ve Visual mode with 'selection' "exclusive" (same as 'v',
5600 if not specified)
5601 o Operator-pending mode
5602 i Insert mode
5603 r Replace mode
5604
5605 Others: ~
5606 c appending to the command-line
5607 ci inserting in the command-line
5608 cr replacing in the command-line
5609 m at the 'Hit ENTER' or 'More' prompts
5610 ml idem, but cursor in the last line
5611 e any mode, pointer below last window
5612 s any mode, pointer on a status line
5613 sd any mode, while dragging a status line
5614 vs any mode, pointer on a vertical separator line
5615 vd any mode, while dragging a vertical separator line
5616 a everywhere
5617
5618 The shape is one of the following:
5619 avail name looks like ~
5620 w x arrow Normal mouse pointer
5621 w x blank no pointer at all (use with care!)
5622 w x beam I-beam
5623 w x updown up-down sizing arrows
5624 w x leftright left-right sizing arrows
5625 w x busy The system's usual busy pointer
5626 w x no The system's usual 'no input' pointer
5627 x udsizing indicates up-down resizing
5628 x lrsizing indicates left-right resizing
5629 x crosshair like a big thin +
5630 x hand1 black hand
5631 x hand2 white hand
5632 x pencil what you write with
5633 x question big ?
5634 x rightup-arrow arrow pointing right-up
5635 w x up-arrow arrow pointing up
5636 x <number> any X11 pointer number (see X11/cursorfont.h)
5637
5638 The "avail" column contains a 'w' if the shape is available for Win32,
5639 x for X11.
5640 Any modes not specified or shapes not available use the normal mouse
5641 pointer.
5642
5643 Example: >
5644 :set mouseshape=s:udsizing,m:no
5645< will make the mouse turn to a sizing arrow over the status lines and
5646 indicate no input when the hit-enter prompt is displayed (since
5647 clicking the mouse has no effect in this state.)
5648
5649 *'mousetime'* *'mouset'*
5650'mousetime' 'mouset' number (default 500)
5651 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005652 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653 time in msec between two mouse clicks for the second click to be
5654 recognized as a multi click.
5655
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005656 *'mzschemedll'*
5657'mzschemedll' string (default depends on the build)
5658 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005659 {only available when compiled with the |+mzscheme/dyn|
5660 feature}
5661 Specifies the name of the MzScheme shared library. The default is
5662 DYNAMIC_MZSCH_DLL which was specified at compile time.
5663 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005664 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005665 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005666 This option cannot be set from a |modeline| or in the |sandbox|, for
5667 security reasons.
5668
5669 *'mzschemegcdll'*
5670'mzschemegcdll' string (default depends on the build)
5671 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005672 {only available when compiled with the |+mzscheme/dyn|
5673 feature}
5674 Specifies the name of the MzScheme GC shared library. The default is
5675 DYNAMIC_MZGC_DLL which was specified at compile time.
5676 The value can be equal to 'mzschemedll' if it includes the GC code.
5677 Environment variables are expanded |:set_env|.
5678 This option cannot be set from a |modeline| or in the |sandbox|, for
5679 security reasons.
5680
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005681 *'mzquantum'* *'mzq'*
5682'mzquantum' 'mzq' number (default 100)
5683 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005684 {not available when compiled without the |+mzscheme|
5685 feature}
5686 The number of milliseconds between polls for MzScheme threads.
5687 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005688 NOTE: This option is set to the Vim default value when 'compatible'
5689 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005690
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005692'nrformats' 'nf' string (default "bin,octal,hex",
5693 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005694 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 This defines what bases Vim will consider for numbers when using the
5696 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5697 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005698 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005700 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005701 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005702 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005703 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 considered to be hexadecimal. Example: Using CTRL-X on
5705 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005706 bin If included, numbers starting with "0b" or "0B" will be
5707 considered to be binary. Example: Using CTRL-X on
5708 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005709 unsigned If included, numbers are recognized as unsigned. Thus a
5710 leading dash or negative sign won't be considered as part of
5711 the number. Examples:
5712 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5713 (without "unsigned" it would become "9-2021").
5714 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5715 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005716 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5717 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005718 Numbers which simply begin with a digit in the range 1-9 are always
5719 considered decimal. This also happens for numbers that are not
5720 recognized as octal or hex.
5721
5722 *'number'* *'nu'* *'nonumber'* *'nonu'*
5723'number' 'nu' boolean (default off)
5724 local to window
5725 Print the line number in front of each line. When the 'n' option is
5726 excluded from 'cpoptions' a wrapped line will not use the column of
5727 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005728 The 'numberwidth' option can be used to set the room used for the line
5729 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730 When a long, wrapped line doesn't start with the first character, '-'
5731 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005732 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5733 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005734 *number_relativenumber*
5735 The 'relativenumber' option changes the displayed number to be
5736 relative to the cursor. Together with 'number' there are these
5737 four combinations (cursor in line 3):
5738
Bram Moolenaar3848e002016-03-19 18:42:29 +01005739 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005740 'nornu' 'nornu' 'rnu' 'rnu'
5741
5742 |apple | 1 apple | 2 apple | 2 apple
5743 |pear | 2 pear | 1 pear | 1 pear
5744 |nobody | 3 nobody | 0 nobody |3 nobody
5745 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005747 *'numberwidth'* *'nuw'*
5748'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5749 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005750 {only available when compiled with the |+linebreak|
5751 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005752 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005753 when the 'number' or 'relativenumber' option is set or printing lines
5754 with a line number. Since one space is always between the number and
5755 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005756 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005757 fit the highest line number in the buffer respectively the number of
5758 rows in the window, depending on whether 'number' or 'relativenumber'
5759 is set. Thus with the Vim default of 4 there is room for a line number
5760 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005761 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005762 NOTE: This option is set to the Vi default value when 'compatible' is
5763 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005764
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005765 *'omnifunc'* *'ofu'*
5766'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005767 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005768 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005769 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005770 This option specifies a function to be used for Insert mode omni
5771 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005772 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005773 invoked and what it should return. The value can be the name of a
5774 function, a |lambda| or a |Funcref|. See |option-value-function| for
5775 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005776 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005777 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005778 This option cannot be set from a |modeline| or in the |sandbox|, for
5779 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005780
5781
Bram Moolenaar02467872007-05-06 13:22:01 +00005782 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005783'opendevice' 'odev' boolean (default off)
5784 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005785 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005786 Enable reading and writing from devices. This may get Vim stuck on a
5787 device that can be opened but doesn't actually do the I/O. Therefore
5788 it is off by default.
5789 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5790 result in editing a device.
5791
5792
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005793 *'operatorfunc'* *'opfunc'*
5794'operatorfunc' 'opfunc' string (default: empty)
5795 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005796 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005797 See |:map-operator| for more info and an example. The value can be
5798 the name of a function, a |lambda| or a |Funcref|. See
5799 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005800
5801 This option cannot be set from a |modeline| or in the |sandbox|, for
5802 security reasons.
5803
5804
Bram Moolenaar251e1912011-06-19 05:09:16 +02005805 *'osfiletype'* *'oft'*
5806'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005808 This option was supported on RISC OS, which has been removed.
5809
Bram Moolenaar071d4272004-06-13 20:20:40 +00005810
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005811 *'packpath'* *'pp'*
5812'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005813 Directories used to find packages. See |packages|.
5814
5815
Bram Moolenaar071d4272004-06-13 20:20:40 +00005816 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005817'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005818 global
5819 Specifies the nroff macros that separate paragraphs. These are pairs
5820 of two letters (see |object-motions|).
5821
5822 *'paste'* *'nopaste'*
5823'paste' boolean (default off)
5824 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005825 Put Vim in Paste mode. This is useful if you want to cut or copy
5826 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005827 unexpected effects.
5828 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005829 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005830 knows about pasting and will mostly do the right thing without 'paste'
5831 being set. The same is true for a terminal where Vim handles the
5832 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005833 This option is reset when starting the GUI. Thus if you set it in
5834 your .vimrc it will work in a terminal, but not in the GUI. Setting
5835 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5836 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837 When the 'paste' option is switched on (also when it was already on):
5838 - mapping in Insert mode and Command-line mode is disabled
5839 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005840 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005841 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005842 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843 - 'revins' is reset
5844 - 'ruler' is reset
5845 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005846 - 'smarttab' is reset
5847 - 'softtabstop' is set to 0
5848 - 'textwidth' is set to 0
5849 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005850 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005852 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005853 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005854 - 'indentexpr'
5855 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005856 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005857 NOTE: When you start editing another file while the 'paste' option is
5858 on, settings from the modelines or autocommands may change the
5859 settings again, causing trouble when pasting text. You might want to
5860 set the 'paste' option again.
5861 When the 'paste' option is reset the mentioned options are restored to
5862 the value before the moment 'paste' was switched from off to on.
5863 Resetting 'paste' before ever setting it does not have any effect.
5864 Since mapping doesn't work while 'paste' is active, you need to use
5865 the 'pastetoggle' option to toggle the 'paste' option with some key.
5866
5867 *'pastetoggle'* *'pt'*
5868'pastetoggle' 'pt' string (default "")
5869 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005870 When non-empty, specifies the key sequence that toggles the 'paste'
5871 option. This is like specifying a mapping: >
5872 :map {keys} :set invpaste<CR>
5873< Where {keys} is the value of 'pastetoggle'.
5874 The difference is that it will work even when 'paste' is set.
5875 'pastetoggle' works in Insert mode and Normal mode, but not in
5876 Command-line mode.
5877 Mappings are checked first, thus overrule 'pastetoggle'. However,
5878 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5879 this: >
5880 :map <F10> :set paste<CR>
5881 :map <F11> :set nopaste<CR>
5882 :imap <F10> <C-O>:set paste<CR>
5883 :imap <F11> <nop>
5884 :set pastetoggle=<F11>
5885< This will make <F10> start paste mode and <F11> stop paste mode.
5886 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5887 mode everything is inserted literally, except the 'pastetoggle' key
5888 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005889 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890
5891 *'pex'* *'patchexpr'*
5892'patchexpr' 'pex' string (default "")
5893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894 {not available when compiled without the |+diff|
5895 feature}
5896 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005897 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005898
Bram Moolenaardbc28022014-07-26 13:40:44 +02005899 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900'patchmode' 'pm' string (default "")
5901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902 When non-empty the oldest version of a file is kept. This can be used
5903 to keep the original version of a file if you are changing files in a
5904 source distribution. Only the first time that a file is written a
5905 copy of the original file will be kept. The name of the copy is the
5906 name of the original file with the string in the 'patchmode' option
5907 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005908 ".orig" or ".org". 'backupdir' must not be empty for this to work
5909 (Detail: The backup file is renamed to the patchmode file after the
5910 new file has been successfully written, that's why it must be possible
5911 to write a backup file). If there was no file to be backed up, an
5912 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005913 When the 'backupskip' pattern matches, a patchmode file is not made.
5914 Using 'patchmode' for compressed files appends the extension at the
5915 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5916 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005917 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005919 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921 other systems: ".,,")
5922 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005923 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005924 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5925 provided that the file being searched for has a relative path (not
5926 starting with "/", "./" or "../"). The directories in the 'path'
5927 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005928 - Use commas to separate directory names: >
5929 :set path=.,/usr/local/include,/usr/include
5930< - Spaces can also be used to separate directory names (for backwards
5931 compatibility with version 3.0). To have a space in a directory
5932 name, precede it with an extra backslash, and escape the space: >
5933 :set path=.,/dir/with\\\ space
5934< - To include a comma in a directory name precede it with an extra
5935 backslash: >
5936 :set path=.,/dir/with\\,comma
5937< - To search relative to the directory of the current file, use: >
5938 :set path=.
5939< - To search in the current directory use an empty string between two
5940 commas: >
5941 :set path=,,
5942< - A directory name may end in a ':' or '/'.
5943 - Environment variables are expanded |:set_env|.
5944 - When using |netrw.vim| URLs can be used. For example, adding
5945 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005946 - Search upwards and downwards in a directory tree using "*", "**" and
5947 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005948 - Careful with '\' characters, type two to get one in the option: >
5949 :set path=.,c:\\include
5950< Or just use '/' instead: >
5951 :set path=.,c:/include
5952< Don't forget "." or files won't even be found in the same directory as
5953 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005954 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005955 it is something like 256 or 1024 characters.
5956 You can check if all the include files are found, using the value of
5957 'path', see |:checkpath|.
5958 The use of |:set+=| and |:set-=| is preferred when adding or removing
5959 directories from the list. This avoids problems when a future version
5960 uses another default. To remove the current directory use: >
5961 :set path-=
5962< To add the current directory use: >
5963 :set path+=
5964< To use an environment variable, you probably need to replace the
5965 separator. Here is an example to append $INCL, in which directory
5966 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005967 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005968< Replace the ';' with a ':' or whatever separator is used. Note that
5969 this doesn't work when $INCL contains a comma or white space.
5970
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005971 *'perldll'*
5972'perldll' string (default depends on the build)
5973 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005974 {only available when compiled with the |+perl/dyn|
5975 feature}
5976 Specifies the name of the Perl shared library. The default is
5977 DYNAMIC_PERL_DLL, which was specified at compile time.
5978 Environment variables are expanded |:set_env|.
5979 This option cannot be set from a |modeline| or in the |sandbox|, for
5980 security reasons.
5981
Bram Moolenaar071d4272004-06-13 20:20:40 +00005982 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5983'preserveindent' 'pi' boolean (default off)
5984 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005985 When changing the indent of the current line, preserve as much of the
5986 indent structure as possible. Normally the indent is replaced by a
5987 series of tabs followed by spaces as required (unless |'expandtab'| is
5988 enabled, in which case only spaces are used). Enabling this option
5989 means the indent will preserve as many existing characters as possible
5990 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005991 'expandtab' does not apply to the preserved white space, a Tab remains
5992 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005993 NOTE: When using ">>" multiple times the resulting indent is a mix of
5994 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005995 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005996 Also see 'copyindent'.
5997 Use |:retab| to clean up white space.
5998
5999 *'previewheight'* *'pvh'*
6000'previewheight' 'pvh' number (default 12)
6001 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006002 {not available when compiled without the |+quickfix|
6003 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006005 commands. Used for |CTRL-W_}| when no count is given. Not used when
6006 'previewpopup' is set.
6007
6008 *'previewpopup'* *'pvp'*
6009'previewpopup' 'pvp' string (default empty)
6010 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006011 {not available when compiled without the |+textprop|
6012 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006013 When not empty a popup window is used for commands that would open a
6014 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006015 Not used for the insert completion info, add "popup" to
6016 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006017
6018 *'previewwindow'* *'nopreviewwindow'*
6019 *'pvw'* *'nopvw'* *E590*
6020'previewwindow' 'pvw' boolean (default off)
6021 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006022 {not available when compiled without the |+quickfix|
6023 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006024 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006025 set. It's normally not set directly, but by using one of the commands
6026 |:ptag|, |:pedit|, etc.
6027
6028 *'printdevice'* *'pdev'*
6029'printdevice' 'pdev' string (default empty)
6030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 {only available when compiled with the |+printer|
6032 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006033 The name of the printer to be used for |:hardcopy|.
6034 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006035 This option cannot be set from a |modeline| or in the |sandbox|, for
6036 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006037
Bram Moolenaar8299df92004-07-10 09:47:34 +00006038 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006039'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006040 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006041 {only available when compiled with the |+printer|
6042 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006043 Sets the character encoding used when printing.
6044 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045
6046 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006047'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006048 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006049 {only available when compiled with the |+printer|
6050 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006051 Expression used to print the PostScript produced with |:hardcopy|.
6052 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006053 This option cannot be set from a |modeline| or in the |sandbox|, for
6054 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055
Bram Moolenaar8299df92004-07-10 09:47:34 +00006056 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006057'printfont' 'pfn' string (default "courier")
6058 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059 {only available when compiled with the |+printer|
6060 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006061 The name of the font that will be used for |:hardcopy|.
6062 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063
6064 *'printheader'* *'pheader'*
6065'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6066 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006067 {only available when compiled with the |+printer|
6068 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006069 The format of the header produced in |:hardcopy| output.
6070 See |pheader-option|.
6071
6072 *'printmbcharset'* *'pmbcs'*
6073'printmbcharset' 'pmbcs' string (default "")
6074 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006075 {only available when compiled with the |+printer|
6076 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006077 The CJK character set to be used for CJK output from |:hardcopy|.
6078 See |pmbcs-option|.
6079
6080 *'printmbfont'* *'pmbfn'*
6081'printmbfont' 'pmbfn' string (default "")
6082 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006083 {only available when compiled with the |+printer|
6084 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006085 List of font names to be used for CJK output from |:hardcopy|.
6086 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006087
6088 *'printoptions'* *'popt'*
6089'printoptions' 'popt' string (default "")
6090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006092 List of items that control the format of the output of |:hardcopy|.
6093 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006095 *'prompt'* *'noprompt'*
6096'prompt' boolean (default on)
6097 global
6098 When on a ":" prompt is used in Ex mode.
6099
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006100 *'pumheight'* *'ph'*
6101'pumheight' 'ph' number (default 0)
6102 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006103 Determines the maximum number of items to show in the popup menu for
6104 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006105 |ins-completion-menu|.
6106
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006107 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006108'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006109 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006110 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006111 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006112
Bram Moolenaard94464e2015-11-02 15:28:18 +01006113 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006114'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006115 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006116 {only available when compiled with the |+python/dyn|
6117 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006118 Specifies the name of the Python 2.x shared library. The default is
6119 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006120 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006121 This option cannot be set from a |modeline| or in the |sandbox|, for
6122 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006123
Bram Moolenaar94073162018-01-31 21:49:05 +01006124 *'pythonhome'*
6125'pythonhome' string (default "")
6126 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006127 {only available when compiled with the |+python/dyn|
6128 feature}
6129 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6130 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6131 which was specified at compile time, will be used for the Python 2.x
6132 home directory.
6133 Environment variables are expanded |:set_env|.
6134 This option cannot be set from a |modeline| or in the |sandbox|, for
6135 security reasons.
6136
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006137 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006138'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006139 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006140 {only available when compiled with the |+python3/dyn|
6141 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006142 Specifies the name of the Python 3 shared library. The default is
6143 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006144 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006145 This option cannot be set from a |modeline| or in the |sandbox|, for
6146 security reasons.
6147
Bram Moolenaar94073162018-01-31 21:49:05 +01006148 *'pythonthreehome'*
6149'pythonthreehome' string (default "")
6150 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006151 {only available when compiled with the |+python3/dyn|
6152 feature}
6153 Specifies the name of the Python 3 home directory. When
6154 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6155 PYTHON3_HOME, which was specified at compile time, will be used for
6156 the Python 3 home directory.
6157 Environment variables are expanded |:set_env|.
6158 This option cannot be set from a |modeline| or in the |sandbox|, for
6159 security reasons.
6160
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006161 *'pyxversion'* *'pyx'*
6162'pyxversion' 'pyx' number (default depends on the build)
6163 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006164 {only available when compiled with the |+python| or
6165 the |+python3| feature}
6166 Specifies the python version used for pyx* functions and commands
6167 |python_x|. The default value is as follows:
6168
6169 Compiled with Default ~
6170 |+python| and |+python3| 0
6171 only |+python| 2
6172 only |+python3| 3
6173
6174 Available values are 0, 2 and 3.
6175 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6176 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6177 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6178 to 2 if Python 2 is available.
6179 See also: |has-pythonx|
6180
6181 If Vim is compiled with only |+python| or |+python3| setting
6182 'pyxversion' has no effect. The pyx* functions and commands are
6183 always the same as the compiled version.
6184
6185 This option cannot be set from a |modeline| or in the |sandbox|, for
6186 security reasons.
6187
Bram Moolenaar858ba062020-05-31 23:11:59 +02006188 *'quickfixtextfunc'* *'qftf'*
6189'quickfixtextfunc' 'qftf' string (default "")
6190 global
6191 {only available when compiled with the |+quickfix|
6192 feature}
6193 This option specifies a function to be used to get the text to display
6194 in the quickfix and location list windows. This can be used to
6195 customize the information displayed in the quickfix or location window
6196 for each entry in the corresponding quickfix or location list. See
6197 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006198 function and an example. The value can be the name of a function, a
6199 |lambda| or a |Funcref|. See |option-value-function| for more
6200 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006201
6202 This option cannot be set from a |modeline| or in the |sandbox|, for
6203 security reasons.
6204
Bram Moolenaar677ee682005-01-27 14:41:15 +00006205 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006206'quoteescape' 'qe' string (default "\")
6207 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006208 The characters that are used to escape quotes in a string. Used for
6209 objects like a', a" and a` |a'|.
6210 When one of the characters in this option is found inside a string,
6211 the following character will be skipped. The default value makes the
6212 text "foo\"bar\\" considered to be one string.
6213
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6215'readonly' 'ro' boolean (default off)
6216 local to buffer
6217 If on, writes fail unless you use a '!'. Protects you from
6218 accidentally overwriting a file. Default on when Vim is started
6219 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006220 When using ":w!" the 'readonly' option is reset for the current
6221 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006222 When using the ":view" command the 'readonly' option is set for the
6223 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006224 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006226 *'redrawtime'* *'rdt'*
6227'redrawtime' 'rdt' number (default 2000)
6228 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006229 {only available when compiled with the |+reltime|
6230 feature}
6231 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006232 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006233 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006234 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006235 matches will be highlighted.
6236 For syntax highlighting the time applies per window. When over the
6237 limit syntax highlighting is disabled until |CTRL-L| is used.
6238 This is used to avoid that Vim hangs when using a very complicated
6239 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006240
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006241 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006242'regexpengine' 're' number (default 0)
6243 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006244 This selects the default regexp engine. |two-engines|
6245 The possible values are:
6246 0 automatic selection
6247 1 old engine
6248 2 NFA engine
6249 Note that when using the NFA engine and the pattern contains something
6250 that is not supported the pattern will not match. This is only useful
6251 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006252 Using automatic selection enables Vim to switch the engine, if the
6253 default engine becomes too costly. E.g., when the NFA engine uses too
6254 many states. This should prevent Vim from hanging on a combination of
6255 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006256
Bram Moolenaar64486672010-05-16 15:46:46 +02006257 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6258'relativenumber' 'rnu' boolean (default off)
6259 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006260 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006261 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006262 precede some vertical motion commands (e.g. j k + -) with, without
6263 having to calculate it yourself. Especially useful in combination with
6264 other commands (e.g. y d c < > gq gw =).
6265 When the 'n' option is excluded from 'cpoptions' a wrapped
6266 line will not use the column of line numbers (this is the default when
6267 'compatible' isn't set).
6268 The 'numberwidth' option can be used to set the room used for the line
6269 number.
6270 When a long, wrapped line doesn't start with the first character, '-'
6271 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006272 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6273 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006274
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006275 The number in front of the cursor line also depends on the value of
6276 'number', see |number_relativenumber| for all combinations of the two
6277 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006278
Bram Moolenaar071d4272004-06-13 20:20:40 +00006279 *'remap'* *'noremap'*
6280'remap' boolean (default on)
6281 global
6282 Allows for mappings to work recursively. If you do not want this for
6283 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006284 NOTE: To avoid portability problems with Vim scripts, always keep
6285 this option at the default "on". Only switch it off when working with
6286 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006287
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006288 *'renderoptions'* *'rop'*
6289'renderoptions' 'rop' string (default: empty)
6290 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006291 {only available when compiled with GUI and DIRECTX on
6292 MS-Windows}
6293 Select a text renderer and set its options. The options depend on the
6294 renderer.
6295
6296 Syntax: >
6297 set rop=type:{renderer}(,{name}:{value})*
6298<
6299 Currently, only one optional renderer is available.
6300
6301 render behavior ~
6302 directx Vim will draw text using DirectX (DirectWrite). It makes
6303 drawn glyphs more beautiful than default GDI.
6304 It requires 'encoding' is "utf-8", and only works on
6305 MS-Windows Vista or newer version.
6306
6307 Options:
6308 name meaning type value ~
6309 gamma gamma float 1.0 - 2.2 (maybe)
6310 contrast enhancedContrast float (unknown)
6311 level clearTypeLevel float (unknown)
6312 geom pixelGeometry int 0 - 2 (see below)
6313 renmode renderingMode int 0 - 6 (see below)
6314 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006315 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006316
Bram Moolenaar92467d32017-12-05 13:22:16 +01006317 See this URL for detail (except for scrlines):
6318 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006319
6320 For geom: structure of a device pixel.
6321 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6322 1 - DWRITE_PIXEL_GEOMETRY_RGB
6323 2 - DWRITE_PIXEL_GEOMETRY_BGR
6324
6325 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006326 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006327
6328 For renmode: method of rendering glyphs.
6329 0 - DWRITE_RENDERING_MODE_DEFAULT
6330 1 - DWRITE_RENDERING_MODE_ALIASED
6331 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6332 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6333 4 - DWRITE_RENDERING_MODE_NATURAL
6334 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6335 6 - DWRITE_RENDERING_MODE_OUTLINE
6336
6337 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006338 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006339
6340 For taamode: antialiasing mode used for drawing text.
6341 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6342 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6343 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6344 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6345
6346 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006347 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6348
Bram Moolenaara338adc2018-01-31 20:51:47 +01006349 For scrlines:
6350 This was used for optimizing scrolling behavior, however this
6351 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006352
6353 Example: >
6354 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006355 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006356 set rop=type:directx
6357<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006358 If select a raster font (Courier, Terminal or FixedSys which
6359 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006360 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006361
6362 NOTE: It is known that some fonts and options combination
6363 causes trouble on drawing glyphs.
6364
Bram Moolenaar92467d32017-12-05 13:22:16 +01006365 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006366 special made fonts (True-Type fonts which includes only
6367 bitmap glyphs).
6368 - 'taamode:3' will not work with some vector fonts.
6369
6370 NOTE: With this option, you can display colored emoji
6371 (emoticon) in Windows 8.1 or later. To display colored emoji,
6372 there are some conditions which you should notice.
6373
6374 - If your font includes non-colored emoji already, it will
6375 be used.
6376 - If your font doesn't have emoji, the system chooses an
6377 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6378 will be used.
6379 - When this alternative font didn't have fixed width glyph,
6380 emoji might be rendered beyond the bounding box of drawing
6381 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006382
6383 Other render types are currently not supported.
6384
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385 *'report'*
6386'report' number (default 2)
6387 global
6388 Threshold for reporting number of lines changed. When the number of
6389 changed lines is more than 'report' a message will be given for most
6390 ":" commands. If you want it always, set 'report' to 0.
6391 For the ":substitute" command the number of substitutions is used
6392 instead of the number of lines.
6393
6394 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6395'restorescreen' 'rs' boolean (default on)
6396 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006397 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006398 When set, the screen contents is restored when exiting Vim. This also
6399 happens when executing external commands.
6400
6401 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6402 options in your .vimrc. To disable restoring:
6403 set t_ti= t_te=
6404 To enable restoring (for an xterm):
6405 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6406 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6407
6408 *'revins'* *'ri'* *'norevins'* *'nori'*
6409'revins' 'ri' boolean (default off)
6410 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 {only available when compiled with the |+rightleft|
6412 feature}
6413 Inserting characters in Insert mode will work backwards. See "typing
6414 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6415 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006416 NOTE: This option is reset when 'compatible' is set.
6417 This option is reset when 'paste' is set and restored when 'paste' is
6418 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006419
6420 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6421'rightleft' 'rl' boolean (default off)
6422 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006423 {only available when compiled with the |+rightleft|
6424 feature}
6425 When on, display orientation becomes right-to-left, i.e., characters
6426 that are stored in the file appear from the right to the left.
6427 Using this option, it is possible to edit files for languages that
6428 are written from the right to the left such as Hebrew and Arabic.
6429 This option is per window, so it is possible to edit mixed files
6430 simultaneously, or to view the same file in both ways (this is
6431 useful whenever you have a mixed text file with both right-to-left
6432 and left-to-right strings so that both sets are displayed properly
6433 in different windows). Also see |rileft.txt|.
6434
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006435 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436'rightleftcmd' 'rlc' string (default "search")
6437 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006438 {only available when compiled with the |+rightleft|
6439 feature}
6440 Each word in this option enables the command line editing to work in
6441 right-to-left mode for a group of commands:
6442
6443 search "/" and "?" commands
6444
6445 This is useful for languages such as Hebrew, Arabic and Farsi.
6446 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6447
Bram Moolenaard94464e2015-11-02 15:28:18 +01006448 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006449'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006450 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006451 {only available when compiled with the |+ruby/dyn|
6452 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006453 Specifies the name of the Ruby shared library. The default is
6454 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006455 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006456 This option cannot be set from a |modeline| or in the |sandbox|, for
6457 security reasons.
6458
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006460'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006462 {not available when compiled without the
6463 |+cmdline_info| feature}
6464 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006465 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006466 text in the file is shown on the far right:
6467 Top first line is visible
6468 Bot last line is visible
6469 All first and last line are visible
6470 45% relative position in the file
6471 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006472 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006473 ruler is shown there. Otherwise it is shown in the last line of the
6474 screen. If the statusline is given by 'statusline' (i.e. not empty),
6475 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006477 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 the text column (byte number) and the screen column are shown,
6479 separated with a dash.
6480 For an empty line "0-1" is shown.
6481 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006482 This option is reset when 'paste' is set and restored when 'paste' is
6483 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 If you don't want to see the ruler all the time but want to know where
6485 you are, use "g CTRL-G" |g_CTRL-G|.
6486 NOTE: This option is reset when 'compatible' is set.
6487
6488 *'rulerformat'* *'ruf'*
6489'rulerformat' 'ruf' string (default empty)
6490 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491 {not available when compiled without the |+statusline|
6492 feature}
6493 When this option is not empty, it determines the content of the ruler
6494 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006495 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006496 This option cannot be set in a modeline when 'modelineexpr' is off.
6497
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 The default ruler width is 17 characters. To make the ruler 15
6499 characters wide, put "%15(" at the start and "%)" at the end.
6500 Example: >
6501 :set rulerformat=%15(%c%V\ %p%%%)
6502<
6503 *'runtimepath'* *'rtp'* *vimfiles*
6504'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006505 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 $VIM/vimfiles,
6507 $VIMRUNTIME,
6508 $VIM/vimfiles/after,
6509 $HOME/.vim/after"
6510 Amiga: "home:vimfiles,
6511 $VIM/vimfiles,
6512 $VIMRUNTIME,
6513 $VIM/vimfiles/after,
6514 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006515 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 $VIM/vimfiles,
6517 $VIMRUNTIME,
6518 $VIM/vimfiles/after,
6519 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006520 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 $VIMRUNTIME,
6522 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006523 Haiku: "$BE_USER_SETTINGS/vim,
6524 $VIM/vimfiles,
6525 $VIMRUNTIME,
6526 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006527 $BE_USER_SETTINGS/vim/after"
6528 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529 $VIM/vimfiles,
6530 $VIMRUNTIME,
6531 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006532 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006534 This is a list of directories which will be searched for runtime
6535 files:
6536 filetype.vim filetypes by file name |new-filetype|
6537 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006538 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006539 colors/ color scheme files |:colorscheme|
6540 compiler/ compiler files |:compiler|
6541 doc/ documentation |write-local-help|
6542 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006543 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544 indent/ indent scripts |indent-expression|
6545 keymap/ key mapping files |mbyte-keymap|
6546 lang/ menu translations |:menutrans|
6547 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006548 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 plugin/ plugin scripts |write-plugin|
6550 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006551 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006552 syntax/ syntax files |mysyntaxfile|
6553 tutor/ files for vimtutor |tutor|
6554
6555 And any other file searched for with the |:runtime| command.
6556
6557 The defaults for most systems are setup to search five locations:
6558 1. In your home directory, for your personal preferences.
6559 2. In a system-wide Vim directory, for preferences from the system
6560 administrator.
6561 3. In $VIMRUNTIME, for files distributed with Vim.
6562 *after-directory*
6563 4. In the "after" directory in the system-wide Vim directory. This is
6564 for the system administrator to overrule or add to the distributed
6565 defaults (rarely needed)
6566 5. In the "after" directory in your home directory. This is for
6567 personal preferences to overrule or add to the distributed defaults
6568 or system-wide settings (rarely needed).
6569
Bram Moolenaard0796902016-09-16 20:02:31 +02006570 More entries are added when using |packages|. If it gets very long
6571 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6572 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006573
Bram Moolenaar071d4272004-06-13 20:20:40 +00006574 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6575 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006576 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 wildcards.
6578 See |:runtime|.
6579 Example: >
6580 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6581< This will use the directory "~/vimruntime" first (containing your
6582 personal Vim runtime files), then "/mygroup/vim" (shared between a
6583 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6584 files).
6585 You probably should always include $VIMRUNTIME somewhere, to use the
6586 distributed runtime files. You can put a directory before $VIMRUNTIME
6587 to find files which replace a distributed runtime files. You can put
6588 a directory after $VIMRUNTIME to find files which add to distributed
6589 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006590 When Vim is started with |--clean| the home directory entries are not
6591 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592 This option cannot be set from a |modeline| or in the |sandbox|, for
6593 security reasons.
6594
6595 *'scroll'* *'scr'*
6596'scroll' 'scr' number (default: half the window height)
6597 local to window
6598 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6599 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006600 changes. This may happen when enabling the |status-line| or
6601 'tabline' option after setting the 'scroll' option.
6602 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006603 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006604 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605
6606 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6607'scrollbind' 'scb' boolean (default off)
6608 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006609 See also |scroll-binding|. When this option is set, the current
6610 window scrolls as other scrollbind windows (windows that also have
6611 this option set) scroll. This option is useful for viewing the
6612 differences between two versions of a file, see 'diff'.
6613 See |'scrollopt'| for options that determine how this option should be
6614 interpreted.
6615 This option is mostly reset when splitting a window to edit another
6616 file. This means that ":split | edit file" results in two windows
6617 with scroll-binding, but ":split file" does not.
6618
Bram Moolenaarae20f342019-11-05 21:09:23 +01006619 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6620'scrollfocus' 'scf' boolean (default off)
6621 global
6622 {only for MS-Windows GUI}
6623 When using the scroll wheel and this option is set, the window under
6624 the mouse pointer is scrolled. With this option off the current
6625 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006626 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006627
Bram Moolenaar071d4272004-06-13 20:20:40 +00006628 *'scrolljump'* *'sj'*
6629'scrolljump' 'sj' number (default 1)
6630 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 Minimal number of lines to scroll when the cursor gets off the
6632 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6633 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006634 When set to a negative number from -1 to -100 this is used as the
6635 percentage of the window height. Thus -50 scrolls half the window
6636 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 NOTE: This option is set to 1 when 'compatible' is set.
6638
6639 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006640'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006641 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006642 Minimal number of screen lines to keep above and below the cursor.
6643 This will make some context visible around where you are working. If
6644 you set it to a very large value (999) the cursor line will always be
6645 in the middle of the window (except at the start or end of the file or
6646 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006647 After using the local value, go back the global value with one of
6648 these two: >
6649 setlocal scrolloff<
6650 setlocal scrolloff=-1
6651< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 NOTE: This option is set to 0 when 'compatible' is set.
6653
6654 *'scrollopt'* *'sbo'*
6655'scrollopt' 'sbo' string (default "ver,jump")
6656 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006658 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6659 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660 The following words are available:
6661 ver Bind vertical scrolling for 'scrollbind' windows
6662 hor Bind horizontal scrolling for 'scrollbind' windows
6663 jump Applies to the offset between two windows for vertical
6664 scrolling. This offset is the difference in the first
6665 displayed line of the bound windows. When moving
6666 around in a window, another 'scrollbind' window may
6667 reach a position before the start or after the end of
6668 the buffer. The offset is not changed though, when
6669 moving back the 'scrollbind' window will try to scroll
6670 to the desired position when possible.
6671 When now making that window the current one, two
6672 things can be done with the relative offset:
6673 1. When "jump" is not included, the relative offset is
6674 adjusted for the scroll position in the new current
6675 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006676 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 2. When "jump" is included, the other windows are
6678 scrolled to keep the same relative offset. When
6679 going back to the other window, it still uses the
6680 same relative offset.
6681 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006682 When 'diff' mode is active there always is vertical scroll binding,
6683 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684
6685 *'sections'* *'sect'*
6686'sections' 'sect' string (default "SHNHH HUnhsh")
6687 global
6688 Specifies the nroff macros that separate sections. These are pairs of
6689 two letters (See |object-motions|). The default makes a section start
6690 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6691
6692 *'secure'* *'nosecure'* *E523*
6693'secure' boolean (default off)
6694 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006695 When on, ":autocmd", shell and write commands are not allowed in
6696 ".vimrc" and ".exrc" in the current directory and map commands are
6697 displayed. Switch it off only if you know that you will not run into
6698 problems, or when the 'exrc' option is off. On Unix this option is
6699 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006700 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 'secure' at the end of your ~/.vimrc then.
6702 This option cannot be set from a |modeline| or in the |sandbox|, for
6703 security reasons.
6704
6705 *'selection'* *'sel'*
6706'selection' 'sel' string (default "inclusive")
6707 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 This option defines the behavior of the selection. It is only used
6709 in Visual and Select mode.
6710 Possible values:
6711 value past line inclusive ~
6712 old no yes
6713 inclusive yes yes
6714 exclusive yes no
6715 "past line" means that the cursor is allowed to be positioned one
6716 character past the line.
6717 "inclusive" means that the last character of the selection is included
6718 in an operation. For example, when "x" is used to delete the
6719 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006720 When "old" is used and 'virtualedit' allows the cursor to move past
6721 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 Note that when "exclusive" is used and selecting from the end
6723 backwards, you cannot include the last character of a line, when
6724 starting in Normal mode and 'virtualedit' empty.
6725
6726 The 'selection' option is set by the |:behave| command.
6727
6728 *'selectmode'* *'slm'*
6729'selectmode' 'slm' string (default "")
6730 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006731 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 Select mode instead of Visual mode, when a selection is started.
6733 Possible values:
6734 mouse when using the mouse
6735 key when using shifted special keys
6736 cmd when using "v", "V" or CTRL-V
6737 See |Select-mode|.
6738 The 'selectmode' option is set by the |:behave| command.
6739
6740 *'sessionoptions'* *'ssop'*
6741'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006742 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006744 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006745 feature}
6746 Changes the effect of the |:mksession| command. It is a comma
6747 separated list of words. Each word enables saving and restoring
6748 something:
6749 word save and restore ~
6750 blank empty windows
6751 buffers hidden and unloaded buffers, not just those in windows
6752 curdir the current directory
6753 folds manually created folds, opened/closed folds and local
6754 fold options
6755 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006756 and contain at least one lowercase letter. Only
6757 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 help the help window
6759 localoptions options and mappings local to a window or buffer (not
6760 global values for local options)
6761 options all options and mappings (also global values for local
6762 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006763 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 resize size of the Vim window: 'lines' and 'columns'
6765 sesdir the directory in which the session file is located
6766 will become the current directory (useful with
6767 projects accessed over a network from different
6768 systems)
6769 slash backslashes in file names replaced with forward
6770 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006771 tabpages all tab pages; without this only the current tab page
6772 is restored, so that you can make a session for each
6773 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006774 terminal include terminal windows where the command can be
6775 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776 unix with Unix end-of-line format (single <NL>), even when
6777 on Windows or DOS
6778 winpos position of the whole Vim window
6779 winsize window sizes
6780
6781 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006782 When neither "curdir" nor "sesdir" is included, file names are stored
6783 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006784 If you leave out "options" many things won't work well after restoring
6785 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786 "slash" and "unix" are useful on Windows when sharing session files
6787 with Unix. The Unix version of Vim cannot source dos format scripts,
6788 but the Windows version of Vim can source unix format scripts.
6789
6790 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006791'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792 global
6793 Name of the shell to use for ! and :! commands. When changing the
6794 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6795 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006796 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797 See |option-backslash| about including spaces and backslashes.
6798 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006799
Bram Moolenaara2baa732022-02-04 16:09:54 +00006800 In |restricted-mode| shell commands will not be possible. This mode
6801 is used if the value of $SHELL ends in "false" or "nologin".
6802
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006803 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006804 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6806< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006807 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006809 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006810 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006811 Example with escaped space (Vim will do this when initializing the
6812 option from $SHELL): >
6813 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006814< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006815 backslashes are consumed by `:set`.
6816
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 Under MS-Windows, when the executable ends in ".com" it must be
6818 included. Thus setting the shell to "command.com" or "4dos.com"
6819 works, but "command" and "4dos" do not work for all commands (e.g.,
6820 filtering).
6821 For unknown reasons, when using "4dos.com" the current directory is
6822 changed to "C:\". To avoid this set 'shell' like this: >
6823 :set shell=command.com\ /c\ 4dos
6824< This option cannot be set from a |modeline| or in the |sandbox|, for
6825 security reasons.
6826
6827 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006828'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006829 Win32, when 'shell' contains "powershell":
6830 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006831 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006834 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6835 For MS-Windows, the default is set according to the value of 'shell',
6836 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006837 On Unix it can have more than one flag. Each white space separated
6838 part is passed as an argument to the shell command.
6839 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006840 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841 This option cannot be set from a |modeline| or in the |sandbox|, for
6842 security reasons.
6843
6844 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006845'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6846 "2>&1| tee", or
6847 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006849 {not available when compiled without the |+quickfix|
6850 feature}
6851 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006852 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853 including spaces and backslashes.
6854 The name of the temporary file can be represented by "%s" if necessary
6855 (the file name is appended automatically if no %s appears in the value
6856 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006857 For the Amiga the default is ">". For MS-Windows using powershell the
6858 default is "2>&1 | Out-File -Encoding default", otherwise the default
6859 is ">%s 2>&1". The output is directly saved in a file and not echoed
6860 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006861 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006862 in a file and echoed to the screen. If the 'shell' option is "csh" or
6863 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006864 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006865 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6866 means that stderr is also included. Before using the 'shell' option a
6867 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006868 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6869 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006870 The initialization of this option is done after reading the ".vimrc"
6871 and the other initializations, so that when the 'shell' option is set
6872 there, the 'shellpipe' option changes automatically, unless it was
6873 explicitly set before.
6874 When 'shellpipe' is set to an empty string, no redirection of the
6875 ":make" output will be done. This is useful if you use a 'makeprg'
6876 that writes to 'makeef' by itself. If you want no piping, but do
6877 want to include the 'makeef', set 'shellpipe' to a single space.
6878 Don't forget to precede the space with a backslash: ":set sp=\ ".
6879 In the future pipes may be used for filtering and this option will
6880 become obsolete (at least for Unix).
6881 This option cannot be set from a |modeline| or in the |sandbox|, for
6882 security reasons.
6883
6884 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006885'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006886 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887 Quoting character(s), put around the command passed to the shell, for
6888 the "!" and ":!" commands. The redirection is kept outside of the
6889 quoting. See 'shellxquote' to include the redirection. It's
6890 probably not useful to set both options.
6891 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006892 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006893 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 This option cannot be set from a |modeline| or in the |sandbox|, for
6895 security reasons.
6896
6897 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006898'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6899 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006900 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901 String to be used to put the output of a filter command in a temporary
6902 file. See also |:!|. See |option-backslash| about including spaces
6903 and backslashes.
6904 The name of the temporary file can be represented by "%s" if necessary
6905 (the file name is appended automatically if no %s appears in the value
6906 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006907 The default is ">". For Unix, if the 'shell' option is "csh" or
6908 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006909 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006910 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6911 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006912 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6913 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006914 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6915 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006916 The initialization of this option is done after reading the ".vimrc"
6917 and the other initializations, so that when the 'shell' option is set
6918 there, the 'shellredir' option changes automatically unless it was
6919 explicitly set before.
6920 In the future pipes may be used for filtering and this option will
6921 become obsolete (at least for Unix).
6922 This option cannot be set from a |modeline| or in the |sandbox|, for
6923 security reasons.
6924
6925 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6926'shellslash' 'ssl' boolean (default off)
6927 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006928 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006930 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006931 powershell.exe. Backward slashes can still be typed, but they are
6932 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933 Note that setting or resetting this option has no effect for some
6934 existing file names, thus this option needs to be set before opening
6935 any file for best results. This might change in the future.
6936 'shellslash' only works when a backslash can be used as a path
6937 separator. To test if this is so use: >
6938 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006939< Also see 'completeslash'.
6940
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006941 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6942'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6943 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006944 When on, use temp files for shell commands. When off use a pipe.
6945 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006946 Currently a pipe is only supported on Unix and MS-Windows 2K and
6947 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006948 :if has("filterpipe")
6949< The advantage of using a pipe is that nobody can read the temp file
6950 and the 'shell' command does not need to support redirection.
6951 The advantage of using a temp file is that the file type and encoding
6952 can be detected.
6953 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6954 |FilterWritePost| autocommands event are not triggered when
6955 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006956 The `system()` function does not respect this option and always uses
6957 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006958 NOTE: This option is set to the Vim default value when 'compatible'
6959 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006960
Bram Moolenaar071d4272004-06-13 20:20:40 +00006961 *'shelltype'* *'st'*
6962'shelltype' 'st' number (default 0)
6963 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006964 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965 On the Amiga this option influences the way how the commands work
6966 which use a shell.
6967 0 and 1: always use the shell
6968 2 and 3: use the shell only to filter lines
6969 4 and 5: use shell only for ':sh' command
6970 When not using the shell, the command is executed directly.
6971
6972 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6973 1 and 3: use "shell cmd" to start external commands
6974
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006975 *'shellxescape'* *'sxe'*
6976'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006977 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006978 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006979 When 'shellxquote' is set to "(" then the characters listed in this
6980 option will be escaped with a '^' character. This makes it possible
6981 to execute most external commands with cmd.exe.
6982
Bram Moolenaar071d4272004-06-13 20:20:40 +00006983 *'shellxquote'* *'sxq'*
6984'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006985 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006986 for Win32, when 'shell' is
6987 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006988 for Win32, when 'shell' contains "sh"
6989 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006990 for Unix, when using system(): "\"")
6991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 Quoting character(s), put around the command passed to the shell, for
6993 the "!" and ":!" commands. Includes the redirection. See
6994 'shellquote' to exclude the redirection. It's probably not useful
6995 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006996 When the value is '(' then ')' is appended. When the value is '"('
6997 then ')"' is appended.
6998 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006999 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007000 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7001 pwsh.exe which automatically strips off the first and last quote on a
7002 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7003 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007004 'shell', to reduce the need to set this option by the user. See
7005 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007006 This option cannot be set from a |modeline| or in the |sandbox|, for
7007 security reasons.
7008
7009 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7010'shiftround' 'sr' boolean (default off)
7011 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007012 Round indent to multiple of 'shiftwidth'. Applies to > and <
7013 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7014 a multiple of 'shiftwidth' (this is Vi compatible).
7015 NOTE: This option is reset when 'compatible' is set.
7016
7017 *'shiftwidth'* *'sw'*
7018'shiftwidth' 'sw' number (default 8)
7019 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007020 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007022 When zero the 'ts' value will be used. Use the |shiftwidth()|
7023 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024
7025 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007026'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7027 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 This option helps to avoid all the |hit-enter| prompts caused by file
7030 messages, for example with CTRL-G, and to avoid some other messages.
7031 It is a list of flags:
7032 flag meaning when present ~
7033 f use "(3 of 5)" instead of "(file 3 of 5)"
7034 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02007035 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007036 m use "[+]" instead of "[Modified]"
7037 n use "[New]" instead of "[New File]"
7038 r use "[RO]" instead of "[readonly]"
7039 w use "[w]" instead of "written" for file write message
7040 and "[a]" instead of "appended" for ':w >> file' command
7041 x use "[dos]" instead of "[dos format]", "[unix]" instead of
7042 "[unix format]" and "[mac]" instead of "[mac format]".
7043 a all of the above abbreviations
7044
7045 o overwrite message for writing a file with subsequent message
7046 for reading a file (useful for ":wn" or when 'autowrite' on)
7047 O message for reading a file overwrites any previous message.
7048 Also for quickfix message (e.g., ":cn").
7049 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02007050 hit TOP, continuing at BOTTOM" messages; when using the search
7051 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052 t truncate file message at the start if it is too long to fit
7053 on the command-line, "<" will appear in the left most column.
7054 Ignored in Ex mode.
7055 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00007056 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007057 Ignored in Ex mode.
7058 W don't give "written" or "[w]" when writing a file
7059 A don't give the "ATTENTION" message when an existing swap file
7060 is found.
7061 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02007062 c don't give |ins-completion-menu| messages. For example,
7063 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
7064 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01007065 q use "recording" instead of "recording @a"
7066 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02007067 was used for the command; note that this also affects messages
7068 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007069 S do not show search count message when searching, e.g.
7070 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007071
7072 This gives you the opportunity to avoid that a change between buffers
7073 requires you to hit <Enter>, but still gives as useful a message as
7074 possible for the space available. To get the whole message that you
7075 would have got with 'shm' empty, use ":file!"
7076 Useful values:
7077 shm= No abbreviation of message.
7078 shm=a Abbreviation, but no loss of information.
7079 shm=at Abbreviation, and truncate message when necessary.
7080
7081 NOTE: This option is set to the Vi default value when 'compatible' is
7082 set and to the Vim default value when 'compatible' is reset.
7083
7084 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7085'shortname' 'sn' boolean (default off)
7086 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007087 Filenames are assumed to be 8 characters plus one extension of 3
7088 characters. Multiple dots in file names are not allowed. When this
7089 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007090 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007091 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007092 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093
7094 *'showbreak'* *'sbr'* *E595*
7095'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007096 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007097 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007098 feature}
7099 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007100 values are "> " or "+++ ": >
7101 :set showbreak=>\
7102< Note the backslash to escape the trailing space. It's easier like
7103 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007104 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007105< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106 comma (in a future version the comma might be used to separate the
7107 part that is shown at the end and at the start of a line).
7108 The characters are highlighted according to the '@' flag in
7109 'highlight'.
7110 Note that tabs after the showbreak will be displayed differently.
7111 If you want the 'showbreak' to appear in between line numbers, add the
7112 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007113 A window-local value overrules a global value. If the global value is
7114 set and you want no value in the current window use NONE: >
7115 :setlocal showbreak=NONE
7116<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007117 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007118'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7119 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121 {not available when compiled without the
7122 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007123 Show (partial) command in the last line of the screen. Set this
7124 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 In Visual mode the size of the selected area is shown:
7126 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007127 If the number of bytes is different it is also displayed: "2-6"
7128 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007130 - When selecting a block, the size in screen characters:
7131 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007132 NOTE: This option is set to the Vi default value when 'compatible' is
7133 set and to the Vim default value when 'compatible' is reset.
7134
7135 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7136'showfulltag' 'sft' boolean (default off)
7137 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 When completing a word in insert mode (see |ins-completion|) from the
7139 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007140 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 matched a C function, you can see a template for what arguments are
7142 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007143 Note that this doesn't work well together with having "longest" in
7144 'completeopt', because the completion from the search pattern may not
7145 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146
7147 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7148'showmatch' 'sm' boolean (default off)
7149 global
7150 When a bracket is inserted, briefly jump to the matching one. The
7151 jump is only done if the match can be seen on the screen. The time to
7152 show the match can be set with 'matchtime'.
7153 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007154 seen or not).
7155 This option is reset when 'paste' is set and restored when 'paste' is
7156 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 When the 'm' flag is not included in 'cpoptions', typing a character
7158 will immediately move the cursor back to where it belongs.
7159 See the "sm" field in 'guicursor' for setting the cursor shape and
7160 blinking when showing the match.
7161 The 'matchpairs' option can be used to specify the characters to show
7162 matches for. 'rightleft' and 'revins' are used to look for opposite
7163 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007164 Also see the matchparen plugin for highlighting the match when moving
7165 around |pi_paren.txt|.
7166 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007167
7168 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7169'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7170 global
7171 If in Insert, Replace or Visual mode put a message on the last line.
7172 Use the 'M' flag in 'highlight' to set the type of highlighting for
7173 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007174 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175 doesn't mean XIM is really active, especially when 'imactivatekey' is
7176 not set.
7177 NOTE: This option is set to the Vi default value when 'compatible' is
7178 set and to the Vim default value when 'compatible' is reset.
7179
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007180 *'showtabline'* *'stal'*
7181'showtabline' 'stal' number (default 1)
7182 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007183 The value of this option specifies when the line with tab page labels
7184 will be displayed:
7185 0: never
7186 1: only if there are at least two tab pages
7187 2: always
7188 This is both for the GUI and non-GUI implementation of the tab pages
7189 line.
7190 See |tab-page| for more information about tab pages.
7191
Bram Moolenaar071d4272004-06-13 20:20:40 +00007192 *'sidescroll'* *'ss'*
7193'sidescroll' 'ss' number (default 0)
7194 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007195 The minimal number of columns to scroll horizontally. Used only when
7196 the 'wrap' option is off and the cursor is moved off of the screen.
7197 When it is zero the cursor will be put in the middle of the screen.
7198 When using a slow terminal set it to a large number or 0. When using
7199 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7200 commands.
7201
7202 *'sidescrolloff'* *'siso'*
7203'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007204 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007205 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007206 right of the cursor if 'nowrap' is set. Setting this option to a
7207 value greater than 0 while having |'sidescroll'| also at a non-zero
7208 value makes some context visible in the line you are scrolling in
7209 horizontally (except at beginning of the line). Setting this option
7210 to a large value (like 999) has the effect of keeping the cursor
7211 horizontally centered in the window, as long as one does not come too
7212 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007213 After using the local value, go back the global value with one of
7214 these two: >
7215 setlocal sidescrolloff<
7216 setlocal sidescrolloff=-1
7217< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007218
7219 Example: Try this together with 'sidescroll' and 'listchars' as
7220 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007221 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222
7223 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7224 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007225<
7226 *'signcolumn'* *'scl'*
7227'signcolumn' 'scl' string (default "auto")
7228 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007229 {not available when compiled without the |+signs|
7230 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007231 Whether or not to draw the signcolumn. Valid values are:
7232 "auto" only when there is a sign to display
7233 "no" never
7234 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007235 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007236 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237
7238
7239 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7240'smartcase' 'scs' boolean (default off)
7241 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242 Override the 'ignorecase' option if the search pattern contains upper
7243 case characters. Only used when the search pattern is typed and
7244 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007245 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7247 recalling the search pattern from history and hitting <Enter>.
7248 NOTE: This option is reset when 'compatible' is set.
7249
7250 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7251'smartindent' 'si' boolean (default off)
7252 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 Do smart autoindenting when starting a new line. Works for C-like
7254 programs, but can also be used for other languages. 'cindent' does
7255 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007256 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007257 setting 'si' has no effect. 'indentexpr' is a more advanced
7258 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007259 Normally 'autoindent' should also be on when using 'smartindent'.
7260 An indent is automatically inserted:
7261 - After a line ending in '{'.
7262 - After a line starting with a keyword from 'cinwords'.
7263 - Before a line starting with '}' (only with the "O" command).
7264 When typing '}' as the first character in a new line, that line is
7265 given the same indent as the matching '{'.
7266 When typing '#' as the first character in a new line, the indent for
7267 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007268 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7270 When using the ">>" command, lines starting with '#' are not shifted
7271 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007272 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007273 This option is reset when 'paste' is set and restored when 'paste' is
7274 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275
7276 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7277'smarttab' 'sta' boolean (default off)
7278 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007280 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7281 <BS> will delete a 'shiftwidth' worth of space at the start of the
7282 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007283 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007284 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7285 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007286 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007287 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007288 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007289 This option is reset when 'paste' is set and restored when 'paste' is
7290 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007291 NOTE: This option is reset when 'compatible' is set.
7292
7293 *'softtabstop'* *'sts'*
7294'softtabstop' 'sts' number (default 0)
7295 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 Number of spaces that a <Tab> counts for while performing editing
7297 operations, like inserting a <Tab> or using <BS>. It "feels" like
7298 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7299 used. This is useful to keep the 'ts' setting at its standard value
7300 of 8, while being able to edit like it is set to 'sts'. However,
7301 commands like "x" still work on the actual characters.
7302 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007303 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007304 'softtabstop' is set to 0 when the 'paste' option is set and restored
7305 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7307 spaces is minimized by using <Tab>s.
7308 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7309 set.
7310 NOTE: This option is set to 0 when 'compatible' is set.
7311
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007312 If Vim is compiled with the |+vartabs| feature then the value of
7313 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7314 anything other than an empty string.
7315
Bram Moolenaar217ad922005-03-20 22:37:15 +00007316 *'spell'* *'nospell'*
7317'spell' boolean (default off)
7318 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007319 {not available when compiled without the |+syntax|
7320 feature}
7321 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007322 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007323
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007324 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007325'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007326 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007327 {not available when compiled without the |+syntax|
7328 feature}
7329 Pattern to locate the end of a sentence. The following word will be
7330 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007331 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007332 When this check is not wanted make this option empty.
7333 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007334 Be careful with special characters, see |option-backslash| about
7335 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007336 To set this option automatically depending on the language, see
7337 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007338
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007339 *'spellfile'* *'spf'*
7340'spellfile' 'spf' string (default empty)
7341 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007342 {not available when compiled without the |+syntax|
7343 feature}
7344 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007345 commands. It must end in ".{encoding}.add". You need to include the
7346 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007347 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007348 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007349 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007350 |zg| and |zw| commands can be used to access each. This allows using
7351 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007352 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007353 you: Using the first directory in 'runtimepath' that is writable. If
7354 there is no "spell" directory yet it will be created. For the file
7355 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007356 ignoring the region.
7357 The resulting ".spl" file will be used for spell checking, it does not
7358 have to appear in 'spelllang'.
7359 Normally one file is used for all regions, but you can add the region
7360 name if you want to. However, it will then only be used when
7361 'spellfile' is set to it, for entries in 'spelllang' only files
7362 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007363 This option cannot be set from a |modeline| or in the |sandbox|, for
7364 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007365
Bram Moolenaar217ad922005-03-20 22:37:15 +00007366 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007367'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007368 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007369 {not available when compiled without the |+syntax|
7370 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007371 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007372 on spellchecking will be done for these languages. Example: >
7373 set spelllang=en_us,nl,medical
7374< This means US English, Dutch and medical words are recognized. Words
7375 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007376 The word list name must consist of alphanumeric characters, a dash or
7377 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007378 recommended to separate the two letter language name from a
7379 specification. Thus "en-rare" is used for rare English words.
7380 A region name must come last and have the form "_xx", where "xx" is
7381 the two-letter, lower case region name. You can use more than one
7382 region by listing them: "en_us,en_ca" supports both US and Canadian
7383 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007384 Britain. (Note: currently en_au and en_nz dictionaries are older than
7385 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007386 If the name "cjk" is included East Asian characters are excluded from
7387 spell checking. This is useful when editing text that also has Asian
7388 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007389 Note that the "medical" dictionary does not exist, it is just an
7390 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007391 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007392 As a special case the name of a .spl file can be given as-is. The
7393 first "_xx" in the name is removed and used as the region name
7394 (_xx is an underscore, two letters and followed by a non-letter).
7395 This is mainly for testing purposes. You must make sure the correct
7396 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007397 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007398 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7399 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007400 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007401
Bram Moolenaar98692072006-02-04 00:57:42 +00007402 If the |spellfile.vim| plugin is active and you use a language name
7403 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7404 will ask you if you want to download the file.
7405
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007406 After this option has been set successfully, Vim will source the files
7407 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007408 up to the first character that is not an ASCII letter or number and
7409 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007410
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007411 *'spelloptions'* *'spo'*
7412'spelloptions' 'spo' string (default "")
7413 local to buffer
7414 {not available when compiled without the |+syntax|
7415 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007416 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007417 camel When a word is CamelCased, assume "Cased" is a
7418 separate word: every upper-case character in a word
7419 that comes after a lower case character indicates the
7420 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007421
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007422 *'spellsuggest'* *'sps'*
7423'spellsuggest' 'sps' string (default "best")
7424 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007425 {not available when compiled without the |+syntax|
7426 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007427 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007428 the |spellsuggest()| function. This is a comma-separated list of
7429 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007430
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007431 best Internal method that works best for English. Finds
7432 changes like "fast" and uses a bit of sound-a-like
7433 scoring to improve the ordering.
7434
7435 double Internal method that uses two methods and mixes the
7436 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007437 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007438 word. That only works when the language specifies
7439 sound folding. Can be slow and doesn't always give
7440 better results.
7441
7442 fast Internal method that only checks for simple changes:
7443 character inserts/deletes/swaps. Works well for
7444 simple typing mistakes.
7445
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007446 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007447 Not used for |spellsuggest()|. The number of
7448 suggestions is never more than the value of 'lines'
7449 minus two.
7450
Bram Moolenaar585ee072022-01-29 11:22:17 +00007451 timeout:{millisec} Limit the time searching for suggestions to
7452 {millisec} milli seconds. Applies to the following
7453 methods. When omitted the limit is 5000. When
7454 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007455 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007456
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007457 file:{filename} Read file {filename}, which must have two columns,
7458 separated by a slash. The first column contains the
7459 bad word, the second column the suggested good word.
7460 Example:
7461 theribal/terrible ~
7462 Use this for common mistakes that do not appear at the
7463 top of the suggestion list with the internal methods.
7464 Lines without a slash are ignored, use this for
7465 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007466 The word in the second column must be correct,
7467 otherwise it will not be used. Add the word to an
7468 ".add" file if it is currently flagged as a spelling
7469 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007470 The file is used for all languages.
7471
7472 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7473 trouble with spaces. |v:val| holds the badly spelled
7474 word. The expression must evaluate to a List of
7475 Lists, each with a suggestion and a score.
7476 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007477 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007478 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007479 internal methods use. A lower score is better.
7480 This may invoke |spellsuggest()| if you temporarily
7481 set 'spellsuggest' to exclude the "expr:" part.
7482 Errors are silently ignored, unless you set the
7483 'verbose' option to a non-zero value.
7484
7485 Only one of "best", "double" or "fast" may be used. The others may
7486 appear several times in any order. Example: >
7487 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7488<
7489 This option cannot be set from a |modeline| or in the |sandbox|, for
7490 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007491
7492
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7494'splitbelow' 'sb' boolean (default off)
7495 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 When on, splitting a window will put the new window below the current
7497 one. |:split|
7498
7499 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7500'splitright' 'spr' boolean (default off)
7501 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007502 When on, splitting a window will put the new window right of the
7503 current one. |:vsplit|
7504
Luuk van Baal29ab5242022-09-11 16:59:53 +01007505 *'splitscroll'* *'spsc'* *'nosplitscroll'* *'nospsc'*
7506'splitscroll' 'spsc' boolean (default on)
7507 global
7508 The value of this option determines the scroll behavior when opening,
7509 closing or resizing horizontal splits. When "on", splitting a window
7510 horizontally will keep the same relative cursor position in the old and
7511 new window, as well windows that are resized. When "off", scrolling
7512 will be avoided to stabilize the window content. Instead, the cursor
7513 position will be changed when necessary. In this case, the jumplist
7514 will be populated with the previous cursor position. Scrolling cannot
7515 be guaranteed to be avoided when 'wrap' is enabled.
7516
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7518'startofline' 'sol' boolean (default on)
7519 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007521 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007522 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007523 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007524 with a linewise operator, with "%" with a count and to buffer changing
7525 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7526 only has a line number, e.g., ":25" or ":+".
7527 In case of buffer changing commands the cursor is placed at the column
7528 where it was the last time the buffer was edited.
7529 NOTE: This option is set when 'compatible' is set.
7530
Bram Moolenaar00654022011-02-25 14:42:19 +01007531 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007533 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007534 {not available when compiled without the |+statusline|
7535 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007536 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007537 Also see |status-line|.
7538
7539 The option consists of printf style '%' items interspersed with
7540 normal text. Each status line item is of the form:
7541 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007542 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007543 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544
Bram Moolenaar238a5642006-02-21 22:12:05 +00007545 When the option starts with "%!" then it is used as an expression,
7546 evaluated and the result is used as the option value. Example: >
7547 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007548< The *g:statusline_winid* variable will be set to the |window-ID| of the
7549 window that the status line belongs to.
7550 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007551 Note that the "%!" expression is evaluated in the context of the
7552 current window and buffer, while %{} items are evaluated in the
7553 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007554
7555 When there is error while evaluating the option then it will be made
7556 empty to avoid further errors. Otherwise screen updating would loop.
7557
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 Note that the only effect of 'ruler' when this option is set (and
7559 'laststatus' is 2) is controlling the output of |CTRL-G|.
7560
7561 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007562 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007563 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007564 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007565 minwid Minimum width of the item, padding as set by '-' & '0'.
7566 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007567 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 on the left for text items. Numeric items will be
7569 shifted down to maxwid-2 digits followed by '>'number
7570 where number is the amount of missing digits, much like
7571 an exponential notation.
7572 item A one letter code as described below.
7573
7574 Following is a description of the possible statusline items. The
7575 second character in "item" is the type:
7576 N for number
7577 S for string
7578 F for flags as described below
7579 - not applicable
7580
7581 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007582 f S Path to the file in the buffer, as typed or relative to current
7583 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584 F S Full path to the file in the buffer.
7585 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007586 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007588 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007590 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007592 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007593 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007594 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007596 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7598 being used: "<keymap>"
7599 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007600 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007601 B N As above, in hexadecimal.
7602 o N Byte number in file of byte under cursor, first byte is 1.
7603 Mnemonic: Offset from start of file (with one added)
7604 {not available when compiled without |+byte_offset| feature}
7605 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007606 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007607 l N Line number.
7608 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007609 c N Column number (byte index).
7610 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007611 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612 p N Percentage through file in lines as in |CTRL-G|.
7613 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007614 percentage described for 'ruler'. Always 3 in length, unless
7615 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007616 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007617 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007618 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007619 Note that there is no '%' before the closing '}'. The
7620 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007621 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007622 {% - This is almost same as { except the result of the expression is
7623 re-evaluated as a statusline format string. Thus if the
7624 return value of expr contains % items they will get expanded.
7625 The expression can contain the } character, the end of
7626 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007627 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007628 func! Stl_filename() abort
7629 return "%t"
7630 endfunc
7631< `stl=%{Stl_filename()}` results in `"%t"`
7632 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007633 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007634 ( - Start of item group. Can be used for setting the width and
7635 alignment of a section. Must be followed by %) somewhere.
7636 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007637 T N For 'tabline': start of tab page N label. Use %T after the last
7638 label. This information is used for mouse clicks.
7639 X N For 'tabline': start of close tab N label. Use %X after the
7640 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7641 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642 < - Where to truncate line if too long. Default is at the start.
7643 No width fields allowed.
7644 = - Separation point between left and right aligned items.
7645 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007646 # - Set highlight group. The name must follow and then a # again.
7647 Thus use %#HLname# for highlight group HLname. The same
7648 highlighting is used, also for the statusline of non-current
7649 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007651 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652 The difference between User{N} and StatusLine will be applied
7653 to StatusLineNC for the statusline of non-current windows.
7654 The number N must be between 1 and 9. See |hl-User1..9|
7655
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007656 When displaying a flag, Vim removes the leading comma, if any, when
7657 that flag comes right after plaintext. This will make a nice display
7658 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007659
Bram Moolenaar582fd852005-03-28 20:58:01 +00007660 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007661 not set) and a minwid is not set for the group, the whole group will
7662 become empty. This will make a group like the following disappear
7663 completely from the statusline when none of the flags are set. >
7664 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007665< Beware that an expression is evaluated each and every time the status
7666 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007667 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007668 While evaluating %{} the current buffer and current window will be set
7669 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007670 currently being drawn. The expression will evaluate in this context.
7671 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7672 real current buffer and "g:actual_curwin" to the |window-ID| of the
7673 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007674
Bram Moolenaar30b65812012-07-12 22:01:11 +02007675 The 'statusline' option will be evaluated in the |sandbox| if set from
7676 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007677 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007678
7679 It is not allowed to change text or jump to another window while
7680 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007681
7682 If the statusline is not updated when you want it (e.g., after setting
7683 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007684 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007685
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007686 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007687 Otherwise the result is taken as flag text and applied to the rules
7688 described above.
7689
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007690 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007691 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007692 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693
7694 Examples:
7695 Emulate standard status line with 'ruler' set >
7696 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7697< Similar, but add ASCII value of char under the cursor (like "ga") >
7698 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7699< Display byte count and byte value, modified flag in red. >
7700 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7701 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7702< Display a ,GZ flag if a compressed file is loaded >
7703 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7704< In the |:autocmd|'s: >
7705 :let b:gzflag = 1
7706< And: >
7707 :unlet b:gzflag
7708< And define this function: >
7709 :function VarExists(var, val)
7710 : if exists(a:var) | return a:val | else | return '' | endif
7711 :endfunction
7712<
7713 *'suffixes'* *'su'*
7714'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7715 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007716 Files with these suffixes get a lower priority when multiple files
7717 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007718 suffixes. Spaces after the comma are ignored. A dot is also seen as
7719 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007720 separator, precede it with a backslash (see |option-backslash| about
7721 including spaces and backslashes).
7722 See 'wildignore' for completely ignoring files.
7723 The use of |:set+=| and |:set-=| is preferred when adding or removing
7724 suffixes from the list. This avoids problems when a future version
7725 uses another default.
7726
7727 *'suffixesadd'* *'sua'*
7728'suffixesadd' 'sua' string (default "")
7729 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007730 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007731 file for the "gf", "[I", etc. commands. Example: >
7732 :set suffixesadd=.java
7733<
7734 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7735'swapfile' 'swf' boolean (default on)
7736 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007737 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007738 swapfile is not wanted for a specific buffer. For example, with
7739 confidential information that even root must not be able to access.
7740 Careful: All text will be in memory:
7741 - Don't use this for big files.
7742 - Recovery will be impossible!
7743 A swapfile will only be present when |'updatecount'| is non-zero and
7744 'swapfile' is set.
7745 When 'swapfile' is reset, the swap file for the current buffer is
7746 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7747 non-zero, a swap file is immediately created.
7748 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007749 If you want to open a new buffer without creating a swap file for it,
7750 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007751 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752
7753 This option is used together with 'bufhidden' and 'buftype' to
7754 specify special kinds of buffers. See |special-buffers|.
7755
7756 *'swapsync'* *'sws'*
7757'swapsync' 'sws' string (default "fsync")
7758 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007759 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007760 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007761 When this option is empty parts of the swap file may be in memory and
7762 not written to disk. When the system crashes you may lose more work.
7763 On Unix the system does a sync now and then without Vim asking for it,
7764 so the disadvantage of setting this option off is small. On some
7765 systems the swap file will not be written at all. For a unix system
7766 setting it to "sync" will use the sync() call instead of the default
7767 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007768 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007769
7770 *'switchbuf'* *'swb'*
7771'switchbuf' 'swb' string (default "")
7772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007773 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007774 Mostly for |quickfix| commands some values are also used for other
7775 commands, as mentioned below.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007776 Possible values (comma-separated list):
Bram Moolenaar071d4272004-06-13 20:20:40 +00007777 useopen If included, jump to the first open window that
7778 contains the specified buffer (if there is one).
7779 Otherwise: Do not examine other windows.
7780 This setting is checked with |quickfix| commands, when
7781 jumping to errors (":cc", ":cn", "cp", etc.). It is
7782 also used in all buffer related split commands, for
7783 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007784 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007785 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007786 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007787 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007788 Otherwise: do not split, use current window (when used
7789 in the quickfix window: the previously used window or
7790 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007791 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007792 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007793 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007794 uselast If included, jump to the previously used window when
7795 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007796
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007797 *'synmaxcol'* *'smc'*
7798'synmaxcol' 'smc' number (default 3000)
7799 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007800 {not available when compiled without the |+syntax|
7801 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007802 Maximum column in which to search for syntax items. In long lines the
7803 text after this column is not highlighted and following lines may not
7804 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007805 This helps to avoid very slow redrawing for an XML file that is one
7806 long line.
7807 Set to zero to remove the limit.
7808
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809 *'syntax'* *'syn'*
7810'syntax' 'syn' string (default empty)
7811 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812 {not available when compiled without the |+syntax|
7813 feature}
7814 When this option is set, the syntax with this name is loaded, unless
7815 syntax highlighting has been switched off with ":syntax off".
7816 Otherwise this option does not always reflect the current syntax (the
7817 b:current_syntax variable does).
7818 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007819 not automatically recognized. Example, in an IDL file:
7820 /* vim: set syntax=idl : */ ~
7821 When a dot appears in the value then this separates two filetype
7822 names. Example:
7823 /* vim: set syntax=c.doxygen : */ ~
7824 This will use the "c" syntax first, then the "doxygen" syntax.
7825 Note that the second one must be prepared to be loaded as an addition,
7826 otherwise it will be skipped. More than one dot may appear.
7827 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007828 :set syntax=OFF
7829< To switch syntax highlighting on according to the current value of the
7830 'filetype' option: >
7831 :set syntax=ON
7832< What actually happens when setting the 'syntax' option is that the
7833 Syntax autocommand event is triggered with the value as argument.
7834 This option is not copied to another buffer, independent of the 's' or
7835 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007836 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007838 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007839'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007840 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00007841 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007842 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007843 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007844
7845 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007846 option and only when there is no GUI tab line. When 'e' is in
7847 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007848 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007849
7850 The value is evaluated like with 'statusline'. You can use
7851 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007852 the text to be displayed. Use "%1T" for the first label, "%2T" for
7853 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007854
Bram Moolenaare12bab32019-01-08 22:02:56 +01007855 When changing something that is used in 'tabline' that does not
7856 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007857 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007858
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007859 Keep in mind that only one of the tab pages is the current one, others
7860 are invisible and you can't jump to their windows.
7861
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007862
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007863 *'tabpagemax'* *'tpm'*
7864'tabpagemax' 'tpm' number (default 10)
7865 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007866 Maximum number of tab pages to be opened by the |-p| command line
7867 argument or the ":tab all" command. |tabpage|
7868
7869
7870 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007871'tabstop' 'ts' number (default 8)
7872 local to buffer
7873 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007874 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875
7876 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007877 appear wrong in many places, e.g., when printing it.
7878 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879
7880 There are four main ways to use tabs in Vim:
7881 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7882 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007883 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 behave like a tab appears every 4 (or 3) characters.
7885 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7886 'expandtab'. This way you will always insert spaces. The
7887 formatting will never be messed up when 'tabstop' is changed.
7888 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007889 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007890 works when using Vim to edit the file.
7891 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7892 'noexpandtab'. This should then work (for initial indents only)
7893 for any tabstop setting that people use. It might be nice to have
7894 tabs after the first non-blank inserted as spaces if you do this
7895 though. Otherwise aligned comments will be wrong when 'tabstop' is
7896 changed.
7897
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007898 If Vim is compiled with the |+vartabs| feature then the value of
7899 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7900 than an empty string.
7901
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7903'tagbsearch' 'tbs' boolean (default on)
7904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007905 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007906 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907 searching makes searching for a tag a LOT faster, but a linear search
7908 will find more tags if the tags file wasn't properly sorted.
7909 Vim normally assumes that your tags files are sorted, or indicate that
7910 they are not sorted. Only when this is not the case does the
7911 'tagbsearch' option need to be switched off.
7912
7913 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007914 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915 certain files, or retry all files with a linear search. When
7916 'tagbsearch' is off, only a linear search is done.
7917
7918 Linear searching is done anyway, for one file, when Vim finds a line
7919 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007920 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007921< [The whitespace before and after the '0' must be a single <Tab>]
7922
7923 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007924 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925 instead of a normal tag name, a retry is done with a linear search.
7926 Tags in unsorted tags files, and matches with different case will only
7927 be found in the retry.
7928
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007929 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007930 linear search can be avoided when case is ignored. Use a value of '2'
7931 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7932 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00007933 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
7934 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
7935 used for this as well. Note that case must be folded to uppercase for
7936 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007937
7938 By default, tag searches are case-sensitive. Case is ignored when
7939 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7940 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007941 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7942 'tagcase' is "smart", and the pattern contains only lowercase
7943 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007944
7945 When 'tagbsearch' is off, tags searching is slower when a full match
7946 exists, but faster when no full match exists. Tags in unsorted tags
7947 files may only be found with 'tagbsearch' off.
7948 When the tags file is not sorted, or sorted in a wrong way (not on
7949 ASCII byte value), 'tagbsearch' should be off, or the line given above
7950 must be included in the tags file.
7951 This option doesn't affect commands that find all matching tags (e.g.,
7952 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007954 *'tagcase'* *'tc'*
7955'tagcase' 'tc' string (default "followic")
7956 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007957 This option specifies how case is handled when searching the tags
7958 file:
7959 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007960 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007961 ignore Ignore case
7962 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007963 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007964 NOTE: This option is set to the Vi default value when 'compatible' is
7965 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007966
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007967 *'tagfunc'* *'tfu'*
7968'tagfunc' 'tfu' string (default: empty)
7969 local to buffer
7970 {not available when compiled without the |+eval|
7971 feature}
7972 This option specifies a function to be used to perform tag searches.
7973 The function gets the tag pattern and should return a List of matching
7974 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007975 function and an example. The value can be the name of a function, a
7976 |lambda| or a |Funcref|. See |option-value-function| for more
7977 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007978
Bram Moolenaar071d4272004-06-13 20:20:40 +00007979 *'taglength'* *'tl'*
7980'taglength' 'tl' number (default 0)
7981 global
7982 If non-zero, tags are significant up to this number of characters.
7983
7984 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7985'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7986 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007987 If on and using a tags file in another directory, file names in that
7988 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007989 NOTE: This option is set to the Vi default value when 'compatible' is
7990 set and to the Vim default value when 'compatible' is reset.
7991
7992 *'tags'* *'tag'* *E433*
7993'tags' 'tag' string (default "./tags,tags", when compiled with
7994 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7995 global or local to buffer |global-local|
7996 Filenames for the tag command, separated by spaces or commas. To
7997 include a space or comma in a file name, precede it with a backslash
7998 (see |option-backslash| about including spaces and backslashes).
7999 When a file name starts with "./", the '.' is replaced with the path
8000 of the current file. But only when the 'd' flag is not included in
8001 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8002 |tags-option|.
8003 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008004 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8005 find all files named "tags" below "/lib". The filename itself cannot
8006 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008007 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008008 The |tagfiles()| function can be used to get a list of the file names
8009 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008010 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8011 files are also supported. They are automatically recognized. The
8012 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8013 differences are ignored (MS-Windows). |emacs-tags|
8014 The use of |:set+=| and |:set-=| is preferred when adding or removing
8015 file names from the list. This avoids problems when a future version
8016 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017
8018 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8019'tagstack' 'tgst' boolean (default on)
8020 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008021 When on, the |tagstack| is used normally. When off, a ":tag" or
8022 ":tselect" command with an argument will not push the tag onto the
8023 tagstack. A following ":tag" without an argument, a ":pop" command or
8024 any other command that uses the tagstack will use the unmodified
8025 tagstack, but does change the pointer to the active entry.
8026 Resetting this option is useful when using a ":tag" command in a
8027 mapping which should not change the tagstack.
8028
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008029 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008030'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008031 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008032 {only available when compiled with the |+tcl/dyn|
8033 feature}
8034 Specifies the name of the Tcl shared library. The default is
8035 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008036 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008037 This option cannot be set from a |modeline| or in the |sandbox|, for
8038 security reasons.
8039
Bram Moolenaar071d4272004-06-13 20:20:40 +00008040 *'term'* *E529* *E530* *E531*
8041'term' string (default is $TERM, if that fails:
8042 in the GUI: "builtin_gui"
8043 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008044 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008045 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008046 on Unix: "ansi"
8047 on VMS: "ansi"
8048 on Win 32: "win32")
8049 global
8050 Name of the terminal. Used for choosing the terminal control
8051 characters. Environment variables are expanded |:set_env|.
8052 For example: >
8053 :set term=$TERM
8054< See |termcap|.
8055
8056 *'termbidi'* *'tbidi'*
8057 *'notermbidi'* *'notbidi'*
8058'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8059 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060 {only available when compiled with the |+arabic|
8061 feature}
8062 The terminal is in charge of Bi-directionality of text (as specified
8063 by Unicode). The terminal is also expected to do the required shaping
8064 that some languages (such as Arabic) require.
8065 Setting this option implies that 'rightleft' will not be set when
8066 'arabic' is set and the value of 'arabicshape' will be ignored.
8067 Note that setting 'termbidi' has the immediate effect that
8068 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8069 This option is reset when the GUI is started.
8070 For further details see |arabic.txt|.
8071
8072 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008073'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008075 Encoding used for the terminal. This specifies what character
8076 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008077 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008078 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008079 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008080 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008081 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8082 Any attempts to set a different value will be rejected, and an error
8083 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008084 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085 because the Win32 system always passes Unicode characters.
8086 When empty, the same encoding is used as for the 'encoding' option.
8087 This is the normal value.
8088 Not all combinations for 'termencoding' and 'encoding' are valid. See
8089 |encoding-table|.
8090 The value for this option must be supported by internal conversions or
8091 iconv(). When this is not possible no conversion will be done and you
8092 will probably experience problems with non-ASCII characters.
8093 Example: You are working with the locale set to euc-jp (Japanese) and
8094 want to edit a UTF-8 file: >
8095 :let &termencoding = &encoding
8096 :set encoding=utf-8
8097< You need to do this when your system has no locale support for UTF-8.
8098
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008099 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008100'termguicolors' 'tgc' boolean (default off)
8101 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008102 {not available when compiled without the
8103 |+termguicolors| feature}
8104 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008105 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008106
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008107 Requires a ISO-8613-3 compatible terminal. If setting this option
8108 does not work (produces a colorless UI) reading |xterm-true-color|
8109 might help.
8110
8111 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8112 is required. Use this check to find out: >
8113 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008114< This requires Vim to be built with the |+vtp| feature.
8115
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008116 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008117
8118 When using Vim with Windows Terminal, the background of Windows
8119 Terminal is normally filled with the Vim background color. Setting
8120 'termguicolors' and the guibg of the Normal highlight group to NONE
8121 will make the background transparent: >
8122 :hi Normal guibg=NONE
8123<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008124 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008125
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008126 *'termwinkey'* *'twk'*
8127'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008128 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008129 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008130 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008131 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008132 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008133< The string must be one key stroke but can be multiple bytes.
8134 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008135 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008136 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008137
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008138 *'termwinscroll'* *'twsl'*
8139'termwinscroll' 'twsl' number (default 10000)
8140 local to buffer
8141 {not available when compiled without the
8142 |+terminal| feature}
8143 Number of scrollback lines to keep. When going over this limit the
8144 first 10% of the scrollback lines are deleted. This is just to reduce
8145 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008146 Also used as a limit for text sent to the terminal in one write,
8147 multiplied by the number of columns times 3 (average number of bytes
8148 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008149
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008150 *'termwinsize'* *'tws'*
8151'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008152 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008153 Size used when opening the |terminal| window. Format:
8154 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008155 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008156 - When set with a "x" (e.g., "24x80") the terminal size is not
8157 adjusted to the window size. If the window is smaller only the
8158 top-left part is displayed.
8159 - When set with a "*" (e.g., "10*50") the terminal size follows the
8160 window size, but will not be smaller than the specified rows and/or
8161 columns.
8162 - When rows is zero then use the height of the window.
8163 - When columns is zero then use the width of the window.
8164 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008165 - Can be overruled in the |term_start()| options with "term_rows" and
8166 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008167
8168 Examples:
8169 "30x0" uses 30 rows and the current window width.
8170 "20*0" uses at least 20 rows and the current window width.
8171 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008172 Note that the command running in the terminal window may still change
8173 the size of the terminal. In that case the Vim window will be
8174 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008175
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008176 *'termwintype'* *'twt'*
8177'termwintype' 'twt' string (default "")
8178 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008179 {only available when compiled with the |terminal|
8180 feature on MS-Windows}
8181 Specify the virtual console (pty) used when opening the terminal
8182 window.
8183
8184 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008185 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008186 "winpty" use winpty, fail if not supported
8187 "conpty" use |ConPTY|, fail if not supported
8188
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008189 |ConPTY| support depends on the platform. Windows 10 October 2018
8190 Update is the first version that supports ConPTY, however it is still
8191 considered unstable. ConPTY might become stable in the next release
8192 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008193 supported then you cannot open a terminal window.
8194
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195 *'terse'* *'noterse'*
8196'terse' boolean (default off)
8197 global
8198 When set: Add 's' flag to 'shortmess' option (this makes the message
8199 for a search that hits the start or end of the file not being
8200 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8201 shortens a lot of messages}
8202
8203 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8204'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8205 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008206 This option is obsolete. Use 'fileformats'.
8207 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8208 set to the default value for the current system. When 'textauto' is
8209 reset, 'fileformats' is made empty.
8210 NOTE: This option is set to the Vi default value when 'compatible' is
8211 set and to the Vim default value when 'compatible' is reset.
8212
8213 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008214'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008215 others: default off)
8216 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 This option is obsolete. Use 'fileformat'.
8218 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8219 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8220 "unix".
8221
8222 *'textwidth'* *'tw'*
8223'textwidth' 'tw' number (default 0)
8224 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008225 Maximum width of text that is being inserted. A longer line will be
8226 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008227 this.
8228 'textwidth' is set to 0 when the 'paste' option is set and restored
8229 when 'paste' is reset.
8230 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008231 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008232 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008233 NOTE: This option is set to 0 when 'compatible' is set.
8234
8235 *'thesaurus'* *'tsr'*
8236'thesaurus' 'tsr' string (default "")
8237 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008238 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008239 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8240 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008241
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008242 This option is not used if 'thesaurusfunc' is set, either for the
8243 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008244
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008245 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008246 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008247 name. See |option-backslash| about using backslashes. The use of
8248 |:set+=| and |:set-=| is preferred when adding or removing directories
8249 from the list. This avoids problems when a future version uses
8250 another default. Backticks cannot be used in this option for security
8251 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008252
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008253 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008254'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008255 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008256 {not available when compiled without the |+eval|
8257 feature}
8258 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008259 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008260 The value can be the name of a function, a |lambda| or a |Funcref|.
8261 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008262
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008263 This option cannot be set from a |modeline| or in the |sandbox|, for
8264 security reasons.
8265
Bram Moolenaar071d4272004-06-13 20:20:40 +00008266 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8267'tildeop' 'top' boolean (default off)
8268 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008269 When on: The tilde command "~" behaves like an operator.
8270 NOTE: This option is reset when 'compatible' is set.
8271
8272 *'timeout'* *'to'* *'notimeout'* *'noto'*
8273'timeout' 'to' boolean (default on)
8274 global
8275 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008276'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008277 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008278 These two options together determine the behavior when part of a
8279 mapped key sequence or keyboard code has been received:
8280
8281 'timeout' 'ttimeout' action ~
8282 off off do not time out
8283 on on or off time out on :mappings and key codes
8284 off on time out on key codes
8285
8286 If both options are off, Vim will wait until either the complete
8287 mapping or key sequence has been received, or it is clear that there
8288 is no mapping or key sequence for the received characters. For
8289 example: if you have mapped "vl" and Vim has received 'v', the next
8290 character is needed to see if the 'v' is followed by an 'l'.
8291 When one of the options is on, Vim will wait for about 1 second for
8292 the next character to arrive. After that the already received
8293 characters are interpreted as single characters. The waiting time can
8294 be changed with the 'timeoutlen' option.
8295 On slow terminals or very busy systems timing out may cause
8296 malfunctioning cursor keys. If both options are off, Vim waits
8297 forever after an entered <Esc> if there are key codes that start
8298 with <Esc>. You will have to type <Esc> twice. If you do not have
8299 problems with key codes, but would like to have :mapped key
8300 sequences not timing out in 1 second, set the 'ttimeout' option and
8301 reset the 'timeout' option.
8302
8303 NOTE: 'ttimeout' is reset when 'compatible' is set.
8304
8305 *'timeoutlen'* *'tm'*
8306'timeoutlen' 'tm' number (default 1000)
8307 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008308
Bram Moolenaar071d4272004-06-13 20:20:40 +00008309 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008310'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312 The time in milliseconds that is waited for a key code or mapped key
8313 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8314 when part of a command has been typed.
8315 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8316 different timeout value for key codes is desired set 'ttimeoutlen' to
8317 a non-negative number.
8318
8319 ttimeoutlen mapping delay key code delay ~
8320 < 0 'timeoutlen' 'timeoutlen'
8321 >= 0 'timeoutlen' 'ttimeoutlen'
8322
8323 The timeout only happens when the 'timeout' and 'ttimeout' options
8324 tell so. A useful setting would be >
8325 :set timeout timeoutlen=3000 ttimeoutlen=100
8326< (time out on mapping after three seconds, time out on key codes after
8327 a tenth of a second).
8328
8329 *'title'* *'notitle'*
8330'title' boolean (default off, on when title can be restored)
8331 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008332 When on, the title of the window will be set to the value of
8333 'titlestring' (if it is not empty), or to:
8334 filename [+=-] (path) - VIM
8335 Where:
8336 filename the name of the file being edited
8337 - indicates the file cannot be modified, 'ma' off
8338 + indicates the file was modified
8339 = indicates the file is read-only
8340 =+ indicates the file is read-only and modified
8341 (path) is the path of the file being edited
8342 - VIM the server name |v:servername| or "VIM"
8343 Only works if the terminal supports setting window titles
8344 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008345 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008346 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8347 *X11*
8348 When Vim was compiled with HAVE_X11 defined, the original title will
8349 be restored if possible. The output of ":version" will include "+X11"
8350 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8351 works for the icon name |'icon'|.
8352 But: When Vim was started with the |-X| argument, restoring the title
8353 will not work (except in the GUI).
8354 If the title cannot be restored, it is set to the value of 'titleold'.
8355 You might want to restore the title outside of Vim then.
8356 When using an xterm from a remote machine you can use this command:
8357 rsh machine_name xterm -display $DISPLAY &
8358 then the WINDOWID environment variable should be inherited and the
8359 title of the window should change back to what it should be after
8360 exiting Vim.
8361
8362 *'titlelen'*
8363'titlelen' number (default 85)
8364 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008366 title. When the title is longer, only the end of the path name is
8367 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368 Using a percentage makes this adapt to the width of the window. But
8369 it won't work perfectly, because the actual number of characters
8370 available also depends on the font used and other things in the title
8371 bar. When 'titlelen' is zero the full path is used. Otherwise,
8372 values from 1 to 30000 percent can be used.
8373 'titlelen' is also used for the 'titlestring' option.
8374
8375 *'titleold'*
8376'titleold' string (default "Thanks for flying Vim")
8377 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378 This option will be used for the window title when exiting Vim if the
8379 original title cannot be restored. Only happens if 'title' is on or
8380 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008381 This option cannot be set from a |modeline| or in the |sandbox|, for
8382 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008383 *'titlestring'*
8384'titlestring' string (default "")
8385 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 When this option is not empty, it will be used for the title of the
8387 window. This happens only when the 'title' option is on.
8388 Only works if the terminal supports setting window titles (currently
8389 Amiga console, Win32 console, all GUI versions and terminals with a
8390 non-empty 't_ts' option).
8391 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008392 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008393
Bram Moolenaar071d4272004-06-13 20:20:40 +00008394 When this option contains printf-style '%' items, they will be
8395 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008396 This option cannot be set in a modeline when 'modelineexpr' is off.
8397
Bram Moolenaar071d4272004-06-13 20:20:40 +00008398 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008399 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8401< The value of 'titlelen' is used to align items in the middle or right
8402 of the available space.
8403 Some people prefer to have the file name first: >
8404 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8405< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008406 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407 separating space only when needed.
8408 NOTE: Use of special characters in 'titlestring' may cause the display
8409 to be garbled (e.g., when it contains a CR or NL character).
8410 {not available when compiled without the |+statusline| feature}
8411
8412 *'toolbar'* *'tb'*
8413'toolbar' 'tb' string (default "icons,tooltips")
8414 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008415 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008416 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008417 possible values are:
8418 icons Toolbar buttons are shown with icons.
8419 text Toolbar buttons shown with text.
8420 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008421 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422 tooltips Tooltips are active for toolbar buttons.
8423 Tooltips refer to the popup help text which appears after the mouse
8424 cursor is placed over a toolbar button for a brief moment.
8425
8426 If you want the toolbar to be shown with icons as well as text, do the
8427 following: >
8428 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008429< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008430 will show icons if both are requested.
8431
8432 If none of the strings specified in 'toolbar' are valid or if
8433 'toolbar' is empty, this option is ignored. If you want to disable
8434 the toolbar, you need to set the 'guioptions' option. For example: >
8435 :set guioptions-=T
8436< Also see |gui-toolbar|.
8437
8438 *'toolbariconsize'* *'tbis'*
8439'toolbariconsize' 'tbis' string (default "small")
8440 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008441 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008443 tiny Use tiny icons.
8444 small Use small icons (default).
8445 medium Use medium-sized icons.
8446 large Use large icons.
8447 huge Use even larger icons.
8448 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008450 the current theme. Common dimensions are giant=48x48, huge=32x32,
8451 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452
8453 If 'toolbariconsize' is empty, the global default size as determined
8454 by user preferences or the current theme is used.
8455
8456 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8457'ttybuiltin' 'tbi' boolean (default on)
8458 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008459 When on, the builtin termcaps are searched before the external ones.
8460 When off the builtin termcaps are searched after the external ones.
8461 When this option is changed, you should set the 'term' option next for
8462 the change to take effect, for example: >
8463 :set notbi term=$TERM
8464< See also |termcap|.
8465 Rationale: The default for this option is "on", because the builtin
8466 termcap entries are generally better (many systems contain faulty
8467 xterm entries...).
8468
8469 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8470'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8471 sun-cmd, screen, rxvt, dtterm or
8472 iris-ansi; also on when running Vim in
8473 a DOS console)
8474 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008475 Indicates a fast terminal connection. More characters will be sent to
8476 the screen for redrawing, instead of using insert/delete line
8477 commands. Improves smoothness of redrawing when there are multiple
8478 windows and the terminal does not support a scrolling region.
8479 Also enables the extra writing of characters at the end of each screen
8480 line for lines that wrap. This helps when using copy/paste with the
8481 mouse in an xterm and other terminals.
8482
8483 *'ttymouse'* *'ttym'*
8484'ttymouse' 'ttym' string (default depends on 'term')
8485 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008486 {only in Unix and VMS, doesn't work in the GUI; not
8487 available when compiled without |+mouse|}
8488 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008489 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008490 *xterm-mouse*
8491 xterm xterm-like mouse handling. The mouse generates
8492 "<Esc>[Mscr", where "scr" is three bytes:
8493 "s" = button state
8494 "c" = column plus 33
8495 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008496 This only works up to 223 columns! See "dec",
8497 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008498 xterm2 Works like "xterm", but with the xterm reporting the
8499 mouse position while the mouse is dragged. This works
8500 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008501 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502 work. See below for how Vim detects this
8503 automatically.
8504 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008505 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008506 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008507 for the row and column. No other mouse events are
8508 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008509 *dec-mouse*
8510 dec DEC terminal mouse handling. The mouse generates a
8511 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008512 This is also available for an Xterm, if it was
8513 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008514 *jsbterm-mouse*
8515 jsbterm JSB term mouse handling.
8516 *pterm-mouse*
8517 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008518 *urxvt-mouse*
8519 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008520 The mouse works only if the terminal supports this
8521 encoding style, but it does not have 223 columns limit
8522 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008523 *sgr-mouse*
8524 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008525 mouse reporting. The mouse works even in columns
8526 beyond 223. This option is backward compatible with
8527 "xterm2" because it can also decode "xterm2" style
8528 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529
8530 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008531 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8532 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008533 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8534 recognized, if enabled at compile time. DEC terminal mouse codes
8535 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008536 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8537 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008538 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008539 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8540 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8541 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008542 Additionally, if vim is compiled with the |+termresponse| feature and
8543 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008544 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008546 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8547 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8548 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008549 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8550 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008551 :set t_RV=
8552<
8553 *'ttyscroll'* *'tsl'*
8554'ttyscroll' 'tsl' number (default 999)
8555 global
8556 Maximum number of lines to scroll the screen. If there are more lines
8557 to scroll the window is redrawn. For terminals where scrolling is
8558 very slow and redrawing is not slow this can be set to a small number,
8559 e.g., 3, to speed up displaying.
8560
8561 *'ttytype'* *'tty'*
8562'ttytype' 'tty' string (default from $TERM)
8563 global
8564 Alias for 'term', see above.
8565
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008566 *'undodir'* *'udir'*
8567'undodir' 'udir' string (default ".")
8568 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008569 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008570 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008571 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008572 "." means using the directory of the file. The undo file name for
8573 "file.txt" is ".file.txt.un~".
8574 For other directories the file name is the full path of the edited
8575 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008576 When writing: The first directory that exists is used. "." always
8577 works, no directories after "." will be used for writing.
8578 When reading all entries are tried to find an undo file. The first
8579 undo file that exists is used. When it cannot be read an error is
8580 given, no further entry is used.
8581 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008582 This option cannot be set from a |modeline| or in the |sandbox|, for
8583 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008584
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008585 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008586'undofile' 'udf' boolean (default off)
8587 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008588 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008589 When on, Vim automatically saves undo history to an undo file when
8590 writing a buffer to a file, and restores undo history from the same
8591 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008592 The directory where the undo file is stored is specified by 'undodir'.
8593 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008594 The undo file is not read when 'undoreload' causes the buffer from
8595 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008596 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008597 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008598
Bram Moolenaar071d4272004-06-13 20:20:40 +00008599 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008600'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008601 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008602 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008603 is kept in memory, higher numbers will cause more memory to be used.
8604 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008605 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8606 itself: >
8607 set ul=0
8608< But you can also get Vi compatibility by including the 'u' flag in
8609 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008610 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008611 Set to -1 for no undo at all. You might want to do this only for the
8612 current buffer: >
8613 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008614< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008615
8616 The local value is set to -123456 when the global value is to be used.
8617
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008618 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008620 *'undoreload'* *'ur'*
8621'undoreload' 'ur' number (default 10000)
8622 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008623 Save the whole buffer for undo when reloading it. This applies to the
8624 ":e!" command and reloading for when the buffer changed outside of
8625 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008626 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008627 of lines is smaller than the value of this option.
8628 Set this option to zero to disable undo for a reload.
8629
8630 When saving undo for a reload, any undo file is not read.
8631
8632 Note that this causes the whole buffer to be stored in memory. Set
8633 this option to a lower value if you run out of memory.
8634
Bram Moolenaar071d4272004-06-13 20:20:40 +00008635 *'updatecount'* *'uc'*
8636'updatecount' 'uc' number (default: 200)
8637 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008638 After typing this many characters the swap file will be written to
8639 disk. When zero, no swap file will be created at all (see chapter on
8640 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8641 Vim with the "-n" option, see |startup|. When editing in readonly
8642 mode this option will be initialized to 10000.
8643 The swapfile can be disabled per buffer with |'swapfile'|.
8644 When 'updatecount' is set from zero to non-zero, swap files are
8645 created for all buffers that have 'swapfile' set. When 'updatecount'
8646 is set to zero, existing swap files are not deleted.
8647 Also see |'swapsync'|.
8648 This option has no meaning in buffers where |'buftype'| is "nofile"
8649 or "nowrite".
8650
8651 *'updatetime'* *'ut'*
8652'updatetime' 'ut' number (default 4000)
8653 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654 If this many milliseconds nothing is typed the swap file will be
8655 written to disk (see |crash-recovery|). Also used for the
8656 |CursorHold| autocommand event.
8657
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008658 *'varsofttabstop'* *'vsts'*
8659'varsofttabstop' 'vsts' string (default "")
8660 local to buffer
8661 {only available when compiled with the |+vartabs|
8662 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008663 A list of the number of spaces that a <Tab> counts for while editing,
8664 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8665 width <Tab>s are being inserted, while in fact a mixture of spaces
8666 and <Tab>s is used. Tab widths are separated with commas, with the
8667 final value applying to all subsequent tabs.
8668
8669 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008670 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008671 to use the following: >
8672 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008673< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8674 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008675
8676 Note that the value of |'softtabstop'| will be ignored while
8677 'varsofttabstop' is set.
8678
8679 *'vartabstop'* *'vts'*
8680'vartabstop' 'vts' string (default "")
8681 local to buffer
8682 {only available when compiled with the |+vartabs|
8683 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008684 A list of the number of spaces that a <Tab> in the file counts for,
8685 separated by commas. Each value corresponds to one tab, with the
8686 final value applying to all subsequent tabs. For example: >
8687 :set vartabstop=4,20,10,8
8688< This will make the first tab 4 spaces wide, the second 20 spaces,
8689 the third 10 spaces, and all following tabs 8 spaces.
8690
8691 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8692 is set.
8693
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694 *'verbose'* *'vbs'*
8695'verbose' 'vbs' number (default 0)
8696 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697 When bigger than zero, Vim will give messages about what it is doing.
8698 Currently, these messages are given:
8699 >= 1 When the viminfo file is read or written.
8700 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008701 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008702 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008703 >= 8 Files for which a group of autocommands is executed.
8704 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008705 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008706 >= 12 Every executed function.
8707 >= 13 When an exception is thrown, caught, finished, or discarded.
8708 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008709 >= 15 Every executed Ex command from a script (truncated at 200
8710 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008711 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008712
8713 This option can also be set with the "-V" argument. See |-V|.
8714 This option is also set by the |:verbose| command.
8715
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008716 When the 'verbosefile' option is set then the verbose messages are not
8717 displayed.
8718
8719 *'verbosefile'* *'vfile'*
8720'verbosefile' 'vfile' string (default empty)
8721 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008722 When not empty all messages are written in a file with this name.
8723 When the file exists messages are appended.
8724 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008725 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008726 Setting 'verbosefile' to a new value is like making it empty first.
8727 The difference with |:redir| is that verbose messages are not
8728 displayed when 'verbosefile' is set.
8729
Bram Moolenaar071d4272004-06-13 20:20:40 +00008730 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008731'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 "$VIM/vimfiles/view",
8733 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008734 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008735 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008737 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 feature}
8739 Name of the directory where to store files for |:mkview|.
8740 This option cannot be set from a |modeline| or in the |sandbox|, for
8741 security reasons.
8742
8743 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008744'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008746 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008747 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008748 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008749 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008750 word save and restore ~
8751 cursor cursor position in file and in window
8752 folds manually created folds, opened/closed folds and local
8753 fold options
8754 options options and mappings local to a window or buffer (not
8755 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008756 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008757 slash backslashes in file names replaced with forward
8758 slashes
8759 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008760 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008761 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008762
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008763 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008765 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008766
8767 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008768'viminfo' 'vi' string (Vi default: "", Vim default for
8769 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008770 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8771 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008772 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008773 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 feature}
8775 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008776 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8777 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008778 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008779 consisting of a single character identifying the particular parameter,
8780 followed by a number or string which specifies the value of that
8781 parameter. If a particular character is left out, then the default
8782 value is used for that parameter. The following is a list of the
8783 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008785 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008786 ! When included, save and restore global variables that start
8787 with an uppercase letter, and don't contain a lowercase
8788 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008789 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008790 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008791 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008792 " Maximum number of lines saved for each register. Old name of
8793 the '<' item, with the disadvantage that you need to put a
8794 backslash before the ", otherwise it will be recognized as the
8795 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008796 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008797 % When included, save and restore the buffer list. If Vim is
8798 started with a file name argument, the buffer list is not
8799 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008800 buffer list is restored from the viminfo file. Quickfix
8801 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8802 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008803 When followed by a number, the number specifies the maximum
8804 number of buffers that are stored. Without a number all
8805 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008806 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008807 ' Maximum number of previously edited files for which the marks
8808 are remembered. This parameter must always be included when
8809 'viminfo' is non-empty.
8810 Including this item also means that the |jumplist| and the
8811 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008812 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008813 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008814 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008815 patterns are also saved. When not included, the value of
8816 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008817 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008819 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008820 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008821 < Maximum number of lines saved for each register. If zero then
8822 registers are not saved. When not included, all lines are
8823 saved. '"' is the old name for this item.
8824 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008825 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008827 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008828 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008829 c When included, convert the text in the viminfo file from the
8830 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008831 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008832 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008833 f Whether file marks need to be stored. If zero, file marks ('0
8834 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008835 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008836 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008837 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 h Disable the effect of 'hlsearch' when loading the viminfo
8839 file. When not included, it depends on whether ":nohlsearch"
8840 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008841 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008842 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008843 the 'n'. Must be at the end of the option! If the
8844 'viminfofile' option is set, that file name overrides the one
8845 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008846 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008847 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008848 r Removable media. The argument is a string (up to the next
8849 ','). This parameter can be given several times. Each
8850 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008851 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008852 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8853 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8854 ignored. Maximum length of each 'r' argument is 50
8855 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008856 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008857 s Maximum size of an item in Kbyte. If zero then registers are
8858 not saved. Currently only applies to registers. The default
8859 "s10" will exclude registers with more than 10 Kbyte of text.
8860 Also see the '<' item above: line count limit.
8861
8862 Example: >
8863 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8864<
8865 '50 Marks will be remembered for the last 50 files you
8866 edited.
8867 <1000 Contents of registers (up to 1000 lines each) will be
8868 remembered.
8869 s100 Registers with more than 100 Kbyte text are skipped.
8870 :0 Command-line history will not be saved.
8871 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8872 no / Since '/' is not specified, the default will be used,
8873 that is, save all of the search history, and also the
8874 previous search and substitute patterns.
8875 no % The buffer list will not be saved nor read back.
8876 no h 'hlsearch' highlighting will be restored.
8877
8878 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8879 load the contents of the file, this is not done automatically.
8880
8881 This option cannot be set from a |modeline| or in the |sandbox|, for
8882 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008883 NOTE: This option is set to the Vim default value when 'compatible'
8884 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008885
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008886 *'viminfofile'* *'vif'*
8887'viminfofile' 'vif' string (default: "")
8888 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008889 {not available when compiled without the |+viminfo|
8890 feature}
8891 When non-empty, overrides the file name used for viminfo.
8892 When equal to "NONE" no viminfo file will be read or written.
8893 This option can be set with the |-i| command line flag. The |--clean|
8894 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008895 This option cannot be set from a |modeline| or in the |sandbox|, for
8896 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008897
Bram Moolenaar071d4272004-06-13 20:20:40 +00008898 *'virtualedit'* *'ve'*
8899'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008900 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008901 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008902 block Allow virtual editing in Visual block mode.
8903 insert Allow virtual editing in Insert mode.
8904 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008905 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008906 none When used as the local value, do not allow virtual
8907 editing even when the global value is set. When used
8908 as the global value, "none" is the same as "".
8909 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008910
Bram Moolenaar071d4272004-06-13 20:20:40 +00008911 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008912 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008913 of the line. Useful for selecting a rectangle in Visual mode and
8914 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008915 "onemore" is not the same, it will only allow moving the cursor just
8916 after the last character of the line. This makes some commands more
8917 consistent. Previously the cursor was always past the end of the line
8918 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008919 break some plugins or Vim scripts. For example because |l| can move
8920 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008921 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008922 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008923 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008924 It doesn't make sense to combine "all" with "onemore", but you will
8925 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008926 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008927 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008928
8929 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8930'visualbell' 'vb' boolean (default off)
8931 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008932 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008933 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008934 use: >
8935 :set vb t_vb=
8936< If you want a short flash, you can use this on many terminals: >
8937 :set vb t_vb=[?5h$<100>[?5l
8938< Here $<100> specifies the time, you can use a smaller or bigger value
8939 to get a shorter or longer flash.
8940
8941 Note: Vim will limit the bell to once per half a second. This avoids
8942 having to wait for the flashing to finish when there are lots of
8943 bells, e.g. on key repeat. This also happens without 'visualbell'
8944 set.
8945
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8947 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8948 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008949
8950 Note: When the GUI starts, 't_vb' is reset to its default value. You
8951 might want to set it again in your |gvimrc|.
8952
Bram Moolenaar071d4272004-06-13 20:20:40 +00008953 Does not work on the Amiga, you always get a screen flash.
8954 Also see 'errorbells'.
8955
8956 *'warn'* *'nowarn'*
8957'warn' boolean (default on)
8958 global
8959 Give a warning message when a shell command is used while the buffer
8960 has been changed.
8961
8962 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8963'weirdinvert' 'wiv' boolean (default off)
8964 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008965 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008966 It is provided for backwards compatibility with version 4.x.
8967 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8968 vice versa. Has no effect when the GUI is running.
8969
8970 *'whichwrap'* *'ww'*
8971'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8972 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008973 Allow specified keys that move the cursor left/right to move to the
8974 previous/next line when the cursor is on the first/last character in
8975 the line. Concatenate characters to allow this for these keys:
8976 char key mode ~
8977 b <BS> Normal and Visual
8978 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008979 h "h" Normal and Visual (not recommended)
8980 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008981 < <Left> Normal and Visual
8982 > <Right> Normal and Visual
8983 ~ "~" Normal
8984 [ <Left> Insert and Replace
8985 ] <Right> Insert and Replace
8986 For example: >
8987 :set ww=<,>,[,]
8988< allows wrap only when cursor keys are used.
8989 When the movement keys are used in combination with a delete or change
8990 operator, the <EOL> also counts for a character. This makes "3h"
8991 different from "3dh" when the cursor crosses the end of a line. This
8992 is also true for "x" and "X", because they do the same as "dl" and
8993 "dh". If you use this, you may also want to use the mapping
8994 ":map <BS> X" to make backspace delete the character in front of the
8995 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008996 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008997 line (not an empty line) then it will not move to the next line. This
8998 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008999 NOTE: This option is set to the Vi default value when 'compatible' is
9000 set and to the Vim default value when 'compatible' is reset.
9001
9002 *'wildchar'* *'wc'*
9003'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005 Character you have to type to start wildcard expansion in the
9006 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009007 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009008 The character is not recognized when used inside a macro. See
9009 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009010 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009011 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009012 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013< NOTE: This option is set to the Vi default value when 'compatible' is
9014 set and to the Vim default value when 'compatible' is reset.
9015
9016 *'wildcharm'* *'wcm'*
9017'wildcharm' 'wcm' number (default: none (0))
9018 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009020 recognized when used inside a macro. You can find "spare" command-line
9021 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009022 you'll never actually type 'wildcharm', just use it in mappings that
9023 automatically invoke completion mode, e.g.: >
9024 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009025 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009026< Then after typing :ss you can use CTRL-P & CTRL-N.
9027
9028 *'wildignore'* *'wig'*
9029'wildignore' 'wig' string (default "")
9030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009031 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009032 patterns is ignored when expanding |wildcards|, completing file or
9033 directory names, and influences the result of |expand()|, |glob()| and
9034 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009035 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9036 Also see 'suffixes'.
9037 Example: >
9038 :set wildignore=*.o,*.obj
9039< The use of |:set+=| and |:set-=| is preferred when adding or removing
9040 a pattern from the list. This avoids problems when a future version
9041 uses another default.
9042
Bram Moolenaar94950a92010-12-02 16:01:29 +01009043
Bram Moolenaar81af9252010-12-10 20:35:50 +01009044 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009045'wildignorecase' 'wic' boolean (default off)
9046 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009047 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009048 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009049 Does not apply when the shell is used to expand wildcards, which
9050 happens when there are special characters.
9051
9052
Bram Moolenaar071d4272004-06-13 20:20:40 +00009053 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009054'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009055 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009056 When 'wildmenu' is on, command-line completion operates in an enhanced
9057 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009058 the possible matches are shown.
9059 When 'wildoptions' contains "pum", then the completion matches are
9060 shown in a popup menu. Otherwise they are displayed just above the
9061 command line, with the first match highlighted (overwriting the status
9062 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009063 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009064 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9065 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9066 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009067 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009068 If there are more matches than can fit in the line, a ">" is shown on
9069 the right and/or a "<" is shown on the left. The status line scrolls
9070 as needed.
9071 The "wildmenu" mode is abandoned when a key is hit that is not used
9072 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009073 While the "wildmenu" is active, not using the popup menu, the
9074 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009075
9076 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9077 <Down> - in filename/menu name completion: move into a
9078 subdirectory or submenu.
9079 <CR> - in menu completion, when the cursor is just after a
9080 dot: move into a submenu.
9081 <Up> - in filename/menu name completion: move up into
9082 parent directory or parent menu.
9083
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009084 When using the popup menu for command line completion, the following
9085 keys have special meanings:
9086 <Down> - select next match (like CTRL-N)
9087 <Left> - in filename/menu name completion: move up into
9088 parent directory or parent menu.
9089 <Right> - in filename/menu name completion: move into a
9090 subdirectory or submenu.
9091 <Up> - select previous match (like CTRL-P)
9092 CTRL-E - end completion, go back to what was there before
9093 selecting a match.
9094 CTRL-N - go to the next entry
9095 CTRL-P - go to the previous entry
9096 CTRL-Y - accept the currently selected match and stop
9097 completion.
9098
Bram Moolenaar071d4272004-06-13 20:20:40 +00009099 This makes the menus accessible from the console |console-menus|.
9100
9101 If you prefer the <Left> and <Right> keys to move the cursor instead
9102 of selecting a different match, use this: >
9103 :cnoremap <Left> <Space><BS><Left>
9104 :cnoremap <Right> <Space><BS><Right>
9105<
9106 The "WildMenu" highlighting is used for displaying the current match
9107 |hl-WildMenu|.
9108
9109 *'wildmode'* *'wim'*
9110'wildmode' 'wim' string (Vim default: "full")
9111 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009112 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009113 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009114 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009115 first part specifies the behavior for the first use of 'wildchar',
9116 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009117
9118 Each part consists of a colon separated list consisting of the
9119 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009120 "" Complete only the first match.
9121 "full" Complete the next full match. After the last match,
9122 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009123 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009124 "longest" Complete till longest common string. If this doesn't
9125 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009126 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009127 "lastused" When completing buffer names and more than one buffer
9128 matches, sort buffers by time last used (other than
9129 the current buffer).
9130 When there is only a single match, it is fully completed in all cases.
9131
9132 Examples of useful colon-separated values:
9133 "longest:full" Like "longest", but also start 'wildmenu' if it is
9134 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009135 "list:full" When more than one match, list all matches and
9136 complete first match.
9137 "list:longest" When more than one match, list all matches and
9138 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009139 "list:lastused" When more than one buffer matches, list all matches
9140 and sort buffers by time last used (other than the
9141 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009142
9143 Examples: >
9144 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009145< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009146 :set wildmode=longest,full
9147< Complete longest common string, then each full match >
9148 :set wildmode=list:full
9149< List all matches and complete each full match >
9150 :set wildmode=list,full
9151< List all matches without completing, then each full match >
9152 :set wildmode=longest,list
9153< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009154 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009155
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009156 *'wildoptions'* *'wop'*
9157'wildoptions' 'wop' string (default "")
9158 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009159 A list of words that change how |cmdline-completion| is done.
9160 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009161 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009162 this value is specified, wildcard expansion will not
9163 be used for completion. The matches will be sorted by
9164 the "best match" rather than alphabetically sorted.
9165 This will find more matches than the wildcard
9166 expansion. Currently fuzzy matching based completion
9167 is not supported for file and directory names and
9168 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009169 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009170 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009171 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009172 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009173 is displayed per line. Often used tag kinds are:
9174 d #define
9175 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009176
Bram Moolenaar071d4272004-06-13 20:20:40 +00009177 *'winaltkeys'* *'wak'*
9178'winaltkeys' 'wak' string (default "menu")
9179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009180 {only used in Win32, Motif, GTK and Photon GUI}
9181 Some GUI versions allow the access to menu entries by using the ALT
9182 key in combination with a character that appears underlined in the
9183 menu. This conflicts with the use of the ALT key for mappings and
9184 entering special characters. This option tells what to do:
9185 no Don't use ALT keys for menus. ALT key combinations can be
9186 mapped, but there is no automatic handling. This can then be
9187 done with the |:simalt| command.
9188 yes ALT key handling is done by the windowing system. ALT key
9189 combinations cannot be mapped.
9190 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009191 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009192 keys can be mapped.
9193 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9194 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009195 This option is not used for <F10>; on Win32 and with GTK <F10> will
9196 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009197
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009198 *'wincolor'* *'wcr'*
9199'wincolor' 'wcr' string (default empty)
9200 local to window
9201 Highlight group name to use for this window instead of the Normal
9202 color |hl-Normal|.
9203
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009204 *'window'* *'wi'*
9205'window' 'wi' number (default screen height - 1)
9206 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009207 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9208 window and the value is smaller than 'lines' minus one. The screen
9209 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009210 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9211 in a much smarter way, taking care of wrapping lines.
9212 When resizing the Vim window, the value is smaller than 1 or more than
9213 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009214 Note: Do not confuse this with the height of the Vim window, use
9215 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009216
Bram Moolenaar071d4272004-06-13 20:20:40 +00009217 *'winheight'* *'wh'* *E591*
9218'winheight' 'wh' number (default 1)
9219 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009220 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009221 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009222 focus goes to a window that is smaller, its size is increased, at the
9223 cost of the height of other windows.
9224 Set 'winheight' to a small number for normal editing.
9225 Set it to 999 to make the current window fill most of the screen.
9226 Other windows will be only 'winminheight' high. This has the drawback
9227 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9228 to create only two windows, set the option after startup is done,
9229 using the |VimEnter| event: >
9230 au VimEnter * set winheight=999
9231< Minimum value is 1.
9232 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009233 height of the current window.
9234 'winheight' applies to the current window. Use 'winminheight' to set
9235 the minimal height for other windows.
9236
9237 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9238'winfixheight' 'wfh' boolean (default off)
9239 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009240 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009241 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9242 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009243 The height may be changed anyway when running out of room.
9244
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009245 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9246'winfixwidth' 'wfw' boolean (default off)
9247 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009248 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009249 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009250 The width may be changed anyway when running out of room.
9251
Bram Moolenaar071d4272004-06-13 20:20:40 +00009252 *'winminheight'* *'wmh'*
9253'winminheight' 'wmh' number (default 1)
9254 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009255 The minimal height of a window, when it's not the current window.
9256 This is a hard minimum, windows will never become smaller.
9257 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9258 status bar) if necessary. They will return to at least one line when
9259 they become active (since the cursor has to have somewhere to go.)
9260 Use 'winheight' to set the minimal height of the current window.
9261 This option is only checked when making a window smaller. Don't use a
9262 large number, it will cause errors when opening more than a few
9263 windows. A value of 0 to 3 is reasonable.
9264
9265 *'winminwidth'* *'wmw'*
9266'winminwidth' 'wmw' number (default 1)
9267 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009268 The minimal width of a window, when it's not the current window.
9269 This is a hard minimum, windows will never become smaller.
9270 When set to zero, windows may be "squashed" to zero columns (i.e. just
9271 a vertical separator) if necessary. They will return to at least one
9272 line when they become active (since the cursor has to have somewhere
9273 to go.)
9274 Use 'winwidth' to set the minimal width of the current window.
9275 This option is only checked when making a window smaller. Don't use a
9276 large number, it will cause errors when opening more than a few
9277 windows. A value of 0 to 12 is reasonable.
9278
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009279 *'winptydll'*
9280'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9281 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009282 {only available when compiled with the |terminal|
9283 feature on MS-Windows}
9284 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009285 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009286 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009287 a fallback.
9288 Environment variables are expanded |:set_env|.
9289 This option cannot be set from a |modeline| or in the |sandbox|, for
9290 security reasons.
9291
Bram Moolenaar071d4272004-06-13 20:20:40 +00009292 *'winwidth'* *'wiw'* *E592*
9293'winwidth' 'wiw' number (default 20)
9294 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009295 Minimal number of columns for the current window. This is not a hard
9296 minimum, Vim will use fewer columns if there is not enough room. If
9297 the current window is smaller, its size is increased, at the cost of
9298 the width of other windows. Set it to 999 to make the current window
9299 always fill the screen. Set it to a small number for normal editing.
9300 The width is not adjusted after one of the commands to change the
9301 width of the current window.
9302 'winwidth' applies to the current window. Use 'winminwidth' to set
9303 the minimal width for other windows.
9304
9305 *'wrap'* *'nowrap'*
9306'wrap' boolean (default on)
9307 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009308 This option changes how text is displayed. It doesn't change the text
9309 in the buffer, see 'textwidth' for that.
9310 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009311 displaying continues on the next line. When off lines will not wrap
9312 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009313 moved to a part that is not shown, the screen will scroll
9314 horizontally.
9315 The line will be broken in the middle of a word if necessary. See
9316 'linebreak' to get the break at a word boundary.
9317 To make scrolling horizontally a bit more useful, try this: >
9318 :set sidescroll=5
9319 :set listchars+=precedes:<,extends:>
9320< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009321 This option can't be set from a |modeline| when the 'diff' option is
9322 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009323
9324 *'wrapmargin'* *'wm'*
9325'wrapmargin' 'wm' number (default 0)
9326 local to buffer
9327 Number of characters from the right window border where wrapping
9328 starts. When typing text beyond this limit, an <EOL> will be inserted
9329 and inserting continues on the next line.
9330 Options that add a margin, such as 'number' and 'foldcolumn', cause
9331 the text width to be further reduced. This is Vi compatible.
9332 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009333 This option is set to 0 when 'paste' is set and restored when 'paste'
9334 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009335 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009336
9337 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9338'wrapscan' 'ws' boolean (default on) *E384* *E385*
9339 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009340 Searches wrap around the end of the file. Also applies to |]s| and
9341 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009342
9343 *'write'* *'nowrite'*
9344'write' boolean (default on)
9345 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009346 Allows writing files. When not set, writing a file is not allowed.
9347 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009348 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009349 argument. Filtering text is still possible, even though this requires
9350 writing a temporary file.
9351
9352 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9353'writeany' 'wa' boolean (default off)
9354 global
9355 Allows writing to any file with no need for "!" override.
9356
9357 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9358'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9359 otherwise)
9360 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009361 Make a backup before overwriting a file. The backup is removed after
9362 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009363 also on.
9364 WARNING: Switching this option off means that when Vim fails to write
9365 your buffer correctly and then, for whatever reason, Vim exits, you
9366 lose both the original file and what you were writing. Only reset
9367 this option if your file system is almost full and it makes the write
9368 fail (and make sure not to exit Vim until the write was successful).
9369 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009370 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009371 Depending on 'backupcopy' the backup is a new file or the original
9372 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009373 NOTE: This option is set to the default value when 'compatible' is
9374 set.
9375
9376 *'writedelay'* *'wd'*
9377'writedelay' 'wd' number (default 0)
9378 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009379 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009380 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009381 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009382
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009383 *'xtermcodes'* *'noxtermcodes'*
9384'xtermcodes' boolean (default on)
9385 global
9386 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009387 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009388 key codes and number of colors from the terminal. This takes care of
9389 various configuration options of the terminal that cannot be obtained
9390 from the termlib/terminfo entry, see |xterm-codes|.
9391 A side effect may be that t_Co changes and Vim will redraw the
9392 display.
9393
9394
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009395 vim:tw=78:ts=8:noet:ft=help:norl: