blob: 689c9a28c1d0b179e4d4243b3165294d228e219d [file] [log] [blame]
Bram Moolenaar75ab5902022-04-18 15:36:40 +01001*options.txt* For Vim version 8.2. Last change: 2022 Apr 13
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
802 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000803 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200805 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
806'autoshelldir' 'asd' boolean (default off)
807 global
808 When on, Vim will change the current working directory whenever you
809 change the directory of the shell running in a terminal window. You
810 need proper setting-up, so whenever the shell's pwd changes an OSC 7
811 escape sequence will be emitted. For example, on Linux, you can source
812 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000813 When the parsing of the OSC sequence fails you get *E1179* .
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200814
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
816'arabic' 'arab' boolean (default off)
817 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 {only available when compiled with the |+arabic|
819 feature}
820 This option can be set to start editing Arabic text.
821 Setting this option will:
822 - Set the 'rightleft' option, unless 'termbidi' is set.
823 - Set the 'arabicshape' option, unless 'termbidi' is set.
824 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
825 between typing English and Arabic key mapping.
826 - Set the 'delcombine' option
827 Note that 'encoding' must be "utf-8" for working with Arabic text.
828
829 Resetting this option will:
830 - Reset the 'rightleft' option.
831 - Disable the use of 'keymap' (without changing its value).
832 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200833 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100834 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 Also see |arabic.txt|.
836
837 *'arabicshape'* *'arshape'*
838 *'noarabicshape'* *'noarshape'*
839'arabicshape' 'arshape' boolean (default on)
840 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 {only available when compiled with the |+arabic|
842 feature}
843 When on and 'termbidi' is off, the required visual character
844 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200845 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 one which encompasses:
847 a) the changing/morphing of characters based on their location
848 within a word (initial, medial, final and stand-alone).
849 b) the enabling of the ability to compose characters
850 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100851 When disabled the display shows each character's true stand-alone
852 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 Arabic is a complex language which requires other settings, for
854 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100855 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856
857 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
858'autoindent' 'ai' boolean (default off)
859 local to buffer
860 Copy indent from current line when starting a new line (typing <CR>
861 in Insert mode or when using the "o" or "O" command). If you do not
862 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000863 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
864 to another line has the same effect, unless the 'I' flag is included
865 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000866 When autoindent is on, formatting (with the "gq" command or when you
867 reach 'textwidth' in Insert mode) uses the indentation of the first
868 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 When 'smartindent' or 'cindent' is on the indent is changed in
870 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200871 The 'autoindent' option is reset when the 'paste' option is set and
872 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873
874 *'autoread'* *'ar'* *'noautoread'* *'noar'*
875'autoread' 'ar' boolean (default off)
876 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877 When a file has been detected to have been changed outside of Vim and
878 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200879 When the file has been deleted this is not done, so you have the text
880 from before it was deleted. When it appears again then it is read.
881 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882 If this option has a local value, use this command to switch back to
883 using the global value: >
884 :set autoread<
885<
886 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
887'autowrite' 'aw' boolean (default off)
888 global
889 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000890 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000891 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
892 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000893 to another file.
894 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000895 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896 Note that for some commands the 'autowrite' option is not used, see
897 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200898 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200899 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900
901 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
902'autowriteall' 'awa' boolean (default off)
903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
905 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
906 Setting this option also implies that Vim behaves like 'autowrite' has
907 been set.
908
909 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200910'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912 When set to "dark", Vim will try to use colors that look good on a
913 dark background. When set to "light", Vim will try to use colors that
914 look good on a light background. Any other value is illegal.
915 Vim tries to set the default value according to the terminal used.
916 This will not always be correct.
917 Setting this option does not change the background color, it tells Vim
918 what the background color looks like. For changing the background
919 color, see |:hi-normal|.
920
921 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000922 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000923 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100924 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 setting 'background' will cause the color scheme to be reloaded. If
926 the color scheme adjusts to the value of 'background' this will work.
927 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100928 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929
930 When setting 'background' to the default value with: >
931 :set background&
932< Vim will guess the value. In the GUI this should work correctly,
933 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200934 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200935 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200937 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200938 color from the terminal. If the returned RGB value is dark/light and
939 'background' is not dark/light, 'background' will be set and the
940 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200941 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100942 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200943
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944 When starting the GUI, the default value for 'background' will be
945 "light". When the value is not set in the .gvimrc, and Vim detects
946 that the background is actually quite dark, 'background' is set to
947 "dark". But this happens only AFTER the .gvimrc file has been read
948 (because the window needs to be opened to find the actual background
949 color). To get around this, force the GUI window to be opened by
950 putting a ":gui" command in the .gvimrc file, before where the value
951 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200952
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100953 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200954 For other systems "dark" is used when 'term' is "linux",
955 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
956 background. Otherwise the default is "light".
957
Bram Moolenaarc572da52017-08-27 16:52:01 +0200958 The |:terminal| command and the |term_start()| function use the
959 'background' value to decide whether the terminal window will start
960 with a white or black background.
961
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962 Normally this option would be set in the .vimrc file. Possibly
963 depending on the terminal name. Example: >
964 :if &term == "pcterm"
965 : set background=dark
966 :endif
967< When this option is set, the default settings for the highlight groups
968 will change. To use other settings, place ":highlight" commands AFTER
969 the setting of the 'background' option.
970 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
971 to select the colors for syntax highlighting. After changing this
972 option, you must load syntax.vim again to see the result. This can be
973 done with ":syntax on".
974
975 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200976'backspace' 'bs' string (default "", set to "indent,eol,start"
977 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
980 mode. This is a list of items, separated by commas. Each item allows
981 a way to backspace over something:
982 value effect ~
983 indent allow backspacing over autoindent
984 eol allow backspacing over line breaks (join lines)
985 start allow backspacing over the start of insert; CTRL-W and CTRL-U
986 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200987 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
988 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989
Bram Moolenaar46eea442022-03-30 10:51:39 +0100990 When the value is empty, Vi compatible backspacing is used, none of
991 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992
993 For backwards compatibility with version 5.4 and earlier:
994 value effect ~
995 0 same as ":set backspace=" (Vi compatible)
996 1 same as ":set backspace=indent,eol"
997 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200998 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999
1000 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1001 NOTE: This option is set to "" when 'compatible' is set.
1002
1003 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1004'backup' 'bk' boolean (default off)
1005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006 Make a backup before overwriting a file. Leave it around after the
1007 file has been successfully written. If you do not want to keep the
1008 backup file, but you do want a backup while the file is being
1009 written, reset this option and set the 'writebackup' option (this is
1010 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001011 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 |backup-table| for more explanations.
1013 When the 'backupskip' pattern matches, a backup is not made anyway.
1014 When 'patchmode' is set, the backup may be renamed to become the
1015 oldest version of a file.
1016 NOTE: This option is reset when 'compatible' is set.
1017
1018 *'backupcopy'* *'bkc'*
1019'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001020 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001022 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023
1024 The main values are:
1025 "yes" make a copy of the file and overwrite the original one
1026 "no" rename the file and write a new one
1027 "auto" one of the previous, what works best
1028
1029 Extra values that can be combined with the ones above are:
1030 "breaksymlink" always break symlinks when writing
1031 "breakhardlink" always break hardlinks when writing
1032
1033 Making a copy and overwriting the original file:
1034 - Takes extra time to copy the file.
1035 + When the file has special attributes, is a (hard/symbolic) link or
1036 has a resource fork, all this is preserved.
1037 - When the file is a link the backup will have the name of the link,
1038 not of the real file.
1039
1040 Renaming the file and writing a new one:
1041 + It's fast.
1042 - Sometimes not all attributes of the file can be copied to the new
1043 file.
1044 - When the file is a link the new file will not be a link.
1045
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001046 The "auto" value is the middle way: When Vim sees that renaming the
1047 file is possible without side effects (the attributes can be passed on
1048 and the file is not a link) that is used. When problems are expected,
1049 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050
1051 The "breaksymlink" and "breakhardlink" values can be used in
1052 combination with any of "yes", "no" and "auto". When included, they
1053 force Vim to always break either symbolic or hard links by doing
1054 exactly what the "no" option does, renaming the original file to
1055 become the backup and writing a new file in its place. This can be
1056 useful for example in source trees where all the files are symbolic or
1057 hard links and any changes should stay in the local source tree, not
1058 be propagated back to the original source.
1059 *crontab*
1060 One situation where "no" and "auto" will cause problems: A program
1061 that opens a file, invokes Vim to edit that file, and then tests if
1062 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001063 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001064 example.
1065
1066 When a copy is made, the original file is truncated and then filled
1067 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001068 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001069 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 group of the backup is set to the group of the original file. If this
1071 fails, the protection bits for the group are made the same as for
1072 others.
1073
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001074 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 the same attributes of the original file, and the newly written file
1076 is owned by the current user. When the file was a (hard/symbolic)
1077 link, the new file will not! That's why the "auto" value doesn't
1078 rename when the file is a link. The owner and group of the newly
1079 written file will be set to the same ones as the original file, but
1080 the system may refuse to do this. In that case the "auto" value will
1081 again not rename the file.
1082
Bram Moolenaar036986f2017-03-16 17:41:02 +01001083 NOTE: This option is set to the Vi default value when 'compatible' is
1084 set and to the Vim default value when 'compatible' is reset.
1085
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 *'backupdir'* *'bdir'*
1087'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001088 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089 for Unix: ".,~/tmp,~/")
1090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091 List of directories for the backup file, separated with commas.
1092 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001093 where this is possible. The directory must exist, Vim will not
1094 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001095 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 impossible!). Writing may fail because of this.
1097 - A directory "." means to put the backup file in the same directory
1098 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001099 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1100 the backup file relative to where the edited file is. The leading
1101 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 ("." inside a directory name has no special meaning).
1103 - Spaces after the comma are ignored, other spaces are considered part
1104 of the directory name. To have a space at the start of a directory
1105 name, precede it with a backslash.
1106 - To include a comma in a directory name precede it with a backslash.
1107 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001108 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001109 the backup file name will be built from the complete path to the
1110 file with all path separators changed to percent '%' signs. This
1111 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001112 On Win32, it is also possible to end with "\\". However, When a
1113 separating comma is following, you must use "//", since "\\" will
1114 include the comma in the file name. Therefore it is recommended to
1115 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 - Environment variables are expanded |:set_env|.
1117 - Careful with '\' characters, type one before a space, type two to
1118 get one in the option (see |option-backslash|), for example: >
1119 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1120< - For backwards compatibility with Vim version 3.0 a '>' at the start
1121 of the option is removed.
1122 See also 'backup' and 'writebackup' options.
1123 If you want to hide your backup files on Unix, consider this value: >
1124 :set backupdir=./.backup,~/.backup,.,/tmp
1125< You must create a ".backup" directory in each directory and in your
1126 home directory for this to work properly.
1127 The use of |:set+=| and |:set-=| is preferred when adding or removing
1128 directories from the list. This avoids problems when a future version
1129 uses another default.
1130 This option cannot be set from a |modeline| or in the |sandbox|, for
1131 security reasons.
1132
1133 *'backupext'* *'bex'* *E589*
1134'backupext' 'bex' string (default "~", for VMS: "_")
1135 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136 String which is appended to a file name to make the name of the
1137 backup file. The default is quite unusual, because this avoids
1138 accidentally overwriting existing files with a backup file. You might
1139 prefer using ".bak", but make sure that you don't have files with
1140 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001141 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001143 If you like to keep a lot of backups, you could use a BufWritePre
1144 autocommand to change 'backupext' just before writing the file to
1145 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001146 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001147< Use 'backupdir' to put the backup in a different directory.
1148
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001150'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1151 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1152 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154 {not available when compiled without the |+wildignore|
1155 feature}
1156 A list of file patterns. When one of the patterns matches with the
1157 name of the file which is written, no backup file is created. Both
1158 the specified file name and the full path name of the file are used.
1159 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1160 Watch out for special characters, see |option-backslash|.
1161 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001162 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001163
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001164 WARNING: Not having a backup file means that when Vim fails to write
1165 your buffer correctly and then, for whatever reason, Vim exits, you
1166 lose both the original file and what you were writing. Only disable
1167 backups if you don't care about losing the file.
1168
Bram Moolenaar02467872007-05-06 13:22:01 +00001169 Note that environment variables are not expanded. If you want to use
1170 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001171 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001172
1173< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001174 backup would be made by renaming the original file crontab won't see
1175 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176
1177 *'balloondelay'* *'bdlay'*
1178'balloondelay' 'bdlay' number (default: 600)
1179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 {only available when compiled with the |+balloon_eval|
1181 feature}
1182 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1183
1184 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1185'ballooneval' 'beval' boolean (default off)
1186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001188 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001189 Switch on the |balloon-eval| functionality for the GUI.
1190
1191 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1192 *'nobevalterm'*
1193'balloonevalterm' 'bevalterm' boolean (default off)
1194 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001195 {only available when compiled with the
1196 |+balloon_eval_term| feature}
1197 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001199 *'balloonexpr'* *'bexpr'*
1200'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001201 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001202 {only available when compiled with the |+balloon_eval|
1203 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001204 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001205 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1206 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001207
1208 v:beval_bufnr number of the buffer in which balloon is going to show
1209 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001210 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001211 v:beval_lnum line number
1212 v:beval_col column number (byte index)
1213 v:beval_text word under or after the mouse pointer
1214
Bram Moolenaar54775062019-07-31 21:07:14 +02001215 Instead of showing a balloon, which is limited to plain text, consider
1216 using a popup window, see |popup_beval_example|. A popup window can
1217 use highlighting and show a border.
1218
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001219 The evaluation of the expression must not have side effects!
1220 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001221 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001222 return 'Cursor is at line ' .. v:beval_lnum ..
1223 \ ', column ' .. v:beval_col ..
1224 \ ' of file ' .. bufname(v:beval_bufnr) ..
1225 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001226 endfunction
1227 set bexpr=MyBalloonExpr()
1228 set ballooneval
1229<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001230 Also see |balloon_show()|, it can be used if the content of the balloon
1231 is to be fetched asynchronously. In that case evaluating
1232 'balloonexpr' should result in an empty string. If you get a balloon
1233 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001234
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001235 NOTE: The balloon is displayed only if the cursor is on a text
1236 character. If the result of evaluating 'balloonexpr' is not empty,
1237 Vim does not try to send a message to an external debugger (Netbeans
1238 or Sun Workshop).
1239
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001240 If the expression starts with s: or |<SID>|, then it is replaced with
1241 the script ID (|local-function|). Example: >
1242 set bexpr=s:MyBalloonExpr()
1243 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001244< Otherwise, the expression is evaluated in the context of the script
1245 where the option was set, thus script-local items are available.
1246
Bram Moolenaar30b65812012-07-12 22:01:11 +02001247 The expression will be evaluated in the |sandbox| when set from a
1248 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001249 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001250
1251 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001252 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001253
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001254 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001255 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001256< When they are supported "\n" characters will start a new line. If the
1257 expression evaluates to a |List| this is equal to using each List item
1258 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001259 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001260
Bram Moolenaar165bc692015-07-21 17:53:25 +02001261 *'belloff'* *'bo'*
1262'belloff' 'bo' string (default "")
1263 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001264 Specifies for which events the bell will not be rung. It is a comma
1265 separated list of items. For each item that is present, the bell
1266 will be silenced. This is most useful to specify specific events in
1267 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001268 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001269
1270 item meaning when present ~
1271 all All events.
1272 backspace When hitting <BS> or <Del> and deleting results in an
1273 error.
1274 cursor Fail to move around using the cursor keys or
1275 <PageUp>/<PageDown> in |Insert-mode|.
1276 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1277 |i_CTRL-X_CTRL-T|.
1278 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1279 |i_CTRL-E|.
1280 ctrlg Unknown Char after <C-G> in Insert mode.
1281 error Other Error occurred (e.g. try to join last line)
1282 (mostly used in |Normal-mode| or |Cmdline-mode|).
1283 esc hitting <Esc> in |Normal-mode|.
1284 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001285 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001286 insertmode Pressing <Esc> in 'insertmode'.
1287 lang Calling the beep module for Lua/Mzscheme/TCL.
1288 mess No output available for |g<|.
1289 showmatch Error occurred for 'showmatch' function.
1290 operator Empty region error |cpo-E|.
1291 register Unknown register after <C-R> in |Insert-mode|.
1292 shell Bell from shell output |:!|.
1293 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001294 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001295 wildmode More matches in |cmdline-completion| available
1296 (depends on the 'wildmode' setting).
1297
Bram Moolenaar036986f2017-03-16 17:41:02 +01001298 This is most useful to fine tune when in Insert mode the bell should
1299 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001300 indicate that an error occurred. It can be silenced by adding the
1301 "error" keyword.
1302
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1304'binary' 'bin' boolean (default off)
1305 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306 This option should be set before editing a binary file. You can also
1307 use the |-b| Vim argument. When this option is switched on a few
1308 options will be changed (also when it already was on):
1309 'textwidth' will be set to 0
1310 'wrapmargin' will be set to 0
1311 'modeline' will be off
1312 'expandtab' will be off
1313 Also, 'fileformat' and 'fileformats' options will not be used, the
1314 file is read and written like 'fileformat' was "unix" (a single <NL>
1315 separates lines).
1316 The 'fileencoding' and 'fileencodings' options will not be used, the
1317 file is read without conversion.
1318 NOTE: When you start editing a(nother) file while the 'bin' option is
1319 on, settings from autocommands may change the settings again (e.g.,
1320 'textwidth'), causing trouble when editing. You might want to set
1321 'bin' again when the file has been loaded.
1322 The previous values of these options are remembered and restored when
1323 'bin' is switched from on to off. Each buffer has its own set of
1324 saved option values.
1325 To edit a file with 'binary' set you can use the |++bin| argument.
1326 This avoids you have to do ":set bin", which would have effect for all
1327 files you edit.
1328 When writing a file the <EOL> for the last line is only written if
1329 there was one in the original file (normally Vim appends an <EOL> to
1330 the last line if there is none; this would make the file longer). See
1331 the 'endofline' option.
1332
1333 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1334'bioskey' 'biosk' boolean (default on)
1335 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001336 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001337 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001338
1339 *'bomb'* *'nobomb'*
1340'bomb' boolean (default off)
1341 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 When writing a file and the following conditions are met, a BOM (Byte
1343 Order Mark) is prepended to the file:
1344 - this option is on
1345 - the 'binary' option is off
1346 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1347 endian variants.
1348 Some applications use the BOM to recognize the encoding of the file.
1349 Often used for UCS-2 files on MS-Windows. For other applications it
1350 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001351 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1353 check for the presence of the BOM is done and 'bomb' set accordingly.
1354 Unless 'binary' is set, it is removed from the first line, so that you
1355 don't see it when editing. When you don't change the options, the BOM
1356 will be restored when writing the file.
1357
1358 *'breakat'* *'brk'*
1359'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1360 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001361 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362 feature}
1363 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001364 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1365 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001367 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001368'breakindent' 'bri' boolean (default off)
1369 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001370 {not available when compiled without the |+linebreak|
1371 feature}
1372 Every wrapped line will continue visually indented (same amount of
1373 space as the beginning of that line), thus preserving horizontal blocks
1374 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001375 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001376
1377 *'breakindentopt'* *'briopt'*
1378'breakindentopt' 'briopt' string (default empty)
1379 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001380 {not available when compiled without the |+linebreak|
1381 feature}
1382 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001383 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001384 min:{n} Minimum text width that will be kept after
1385 applying 'breakindent', even if the resulting
1386 text should normally be narrower. This prevents
1387 text indented almost to the right window border
1388 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001389 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001390 shift:{n} After applying 'breakindent', the wrapped line's
1391 beginning will be shifted by the given number of
1392 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001393 indentation (negative) or emphasizing the line
1394 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001395 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001396 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001397 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001398 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001399 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001400 numbered or bulleted list (using the
1401 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001402 list:-1 Uses the length of a match with 'formatlistpat'
1403 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001404 (default: 0)
1405 column:{n} Indent at column {n}. Will overrule the other
1406 sub-options. Note: an additional indent may be
1407 added for the 'showbreak' setting.
1408 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001409
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001411'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001413 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001414 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001415 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001416 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417 buffer Use the directory of the related buffer.
1418 current Use the current directory.
1419 {path} Use the specified directory
1420
1421 *'bufhidden'* *'bh'*
1422'bufhidden' 'bh' string (default: "")
1423 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 This option specifies what happens when a buffer is no longer
1425 displayed in a window:
1426 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001427 hide hide the buffer (don't unload it), even if 'hidden' is
1428 not set
1429 unload unload the buffer, even if 'hidden' is set; the
1430 |:hide| command will also unlod the buffer
1431 delete delete the buffer from the buffer list, even if
1432 'hidden' is set; the |:hide| command will also delete
1433 the buffer, making it behave like |:bdelete|
1434 wipe wipe the buffer from the buffer list, even if
1435 'hidden' is set; the |:hide| command will also wipe
1436 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001438 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001439 are lost without a warning. Also, these values may break autocommands
1440 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441 This option is used together with 'buftype' and 'swapfile' to specify
1442 special kinds of buffers. See |special-buffers|.
1443
1444 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1445'buflisted' 'bl' boolean (default: on)
1446 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 When this option is set, the buffer shows up in the buffer list. If
1448 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1449 This option is reset by Vim for buffers that are only used to remember
1450 a file name or marks. Vim sets it when starting to edit a buffer.
1451 But not when moving to a buffer with ":buffer".
1452
1453 *'buftype'* *'bt'* *E382*
1454'buftype' 'bt' string (default: "")
1455 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456 The value of this option specifies the type of a buffer:
1457 <empty> normal buffer
1458 nofile buffer which is not related to a file and will not be
1459 written
1460 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001461 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001462 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001464 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 help help buffer (you are not supposed to set this
1466 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001467 terminal buffer for a |terminal| (you are not supposed to set
1468 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001469 prompt buffer where only the last line can be edited, meant
1470 to be used by a plugin, see |prompt-buffer|
1471 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001472 popup buffer used in a popup window, see |popup|.
1473 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474
1475 This option is used together with 'bufhidden' and 'swapfile' to
1476 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001477 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001478
1479 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001480 One such effect is that Vim will not check the timestamp of the file,
1481 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001482
Bram Moolenaar280f1262006-01-30 00:14:18 +00001483 A "quickfix" buffer is only used for the error list and the location
1484 list. This value is set by the |:cwindow| and |:lwindow| commands and
1485 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486
1487 "nofile" and "nowrite" buffers are similar:
1488 both: The buffer is not to be written to disk, ":w" doesn't
1489 work (":w filename" does work though).
1490 both: The buffer is never considered to be |'modified'|.
1491 There is no warning when the changes will be lost, for
1492 example when you quit Vim.
1493 both: A swap file is only created when using too much memory
1494 (when 'swapfile' has been reset there is never a swap
1495 file).
1496 nofile only: The buffer name is fixed, it is not handled like a
1497 file name. It is not modified in response to a |:cd|
1498 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001499 both: When using ":e bufname" and already editing "bufname"
1500 the buffer is made empty and autocommands are
1501 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001502 *E676*
1503 "acwrite" implies that the buffer name is not related to a file, like
1504 "nofile", but it will be written. Thus, in contrast to "nofile" and
1505 "nowrite", ":w" does work and a modified buffer can't be abandoned
1506 without saving. For writing there must be matching |BufWriteCmd|,
1507 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508
1509 *'casemap'* *'cmp'*
1510'casemap' 'cmp' string (default: "internal,keepascii")
1511 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512 Specifies details about changing the case of letters. It may contain
1513 these words, separated by a comma:
1514 internal Use internal case mapping functions, the current
1515 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001516 matters when 'encoding' is a Unicode encoding,
1517 "latin1" or "iso-8859-15". When "internal" is
1518 omitted, the towupper() and towlower() system library
1519 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1521 case mapping, the current locale is not effective.
1522 This probably only matters for Turkish.
1523
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001524 *'cdhome'* *'cdh'*
1525'cdhome' 'cdh' boolean (default: off)
1526 global
1527 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1528 current working directory to the |$HOME| directory like in Unix.
1529 When off, those commands just print the current directory name.
1530 On Unix this option has no effect.
1531 NOTE: This option is reset when 'compatible' is set.
1532
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533 *'cdpath'* *'cd'* *E344* *E346*
1534'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1535 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 {not available when compiled without the
1537 |+file_in_path| feature}
1538 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001539 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1540 searched for has a relative path, not an absolute part starting with
1541 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 The 'cdpath' option's value has the same form and semantics as
1543 |'path'|. Also see |file-searching|.
1544 The default value is taken from $CDPATH, with a "," prepended to look
1545 in the current directory first.
1546 If the default value taken from $CDPATH is not what you want, include
1547 a modified version of the following command in your vimrc file to
1548 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001549 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550< This option cannot be set from a |modeline| or in the |sandbox|, for
1551 security reasons.
1552 (parts of 'cdpath' can be passed to the shell to expand file names).
1553
1554 *'cedit'*
1555'cedit' string (Vi default: "", Vim default: CTRL-F)
1556 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 The key used in Command-line Mode to open the command-line window.
1558 The default is CTRL-F when 'compatible' is off.
1559 Only non-printable keys are allowed.
1560 The key can be specified as a single character, but it is difficult to
1561 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001562 :exe "set cedit=\<C-Y>"
1563 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001564< |Nvi| also has this option, but it only uses the first character.
1565 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001566 NOTE: This option is set to the Vim default value when 'compatible'
1567 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568
1569 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1570'charconvert' 'ccv' string (default "")
1571 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001572 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573 An expression that is used for character encoding conversion. It is
1574 evaluated when a file that is to be read or has been written has a
1575 different encoding from what is desired.
1576 'charconvert' is not used when the internal iconv() function is
1577 supported and is able to do the conversion. Using iconv() is
1578 preferred, because it is much faster.
1579 'charconvert' is not used when reading stdin |--|, because there is no
1580 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001581 The expression must return zero, false or an empty string for success,
1582 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583 The possible encoding names encountered are in 'encoding'.
1584 Additionally, names given in 'fileencodings' and 'fileencoding' are
1585 used.
1586 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1587 is done internally by Vim, 'charconvert' is not used for this.
1588 'charconvert' is also used to convert the viminfo file, if the 'c'
1589 flag is present in 'viminfo'. Also used for Unicode conversion.
1590 Example: >
1591 set charconvert=CharConvert()
1592 fun CharConvert()
1593 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001594 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1595 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001596 return v:shell_error
1597 endfun
1598< The related Vim variables are:
1599 v:charconvert_from name of the current encoding
1600 v:charconvert_to name of the desired encoding
1601 v:fname_in name of the input file
1602 v:fname_out name of the output file
1603 Note that v:fname_in and v:fname_out will never be the same.
1604 Note that v:charconvert_from and v:charconvert_to may be different
1605 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001606
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 Encryption is not done by Vim when using 'charconvert'. If you want
1608 to encrypt the file after conversion, 'charconvert' should take care
1609 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001610
1611 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1612 replaced with the script ID (|local-function|). Example: >
1613 set charconvert=s:MyConvert()
1614 set charconvert=<SID>SomeConvert()
1615< Otherwise the expression is evaluated in the context of the script
1616 where the option was set, thus script-local items are available.
1617
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618 This option cannot be set from a |modeline| or in the |sandbox|, for
1619 security reasons.
1620
1621 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1622'cindent' 'cin' boolean (default off)
1623 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 {not available when compiled without the |+cindent|
1625 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001626 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627 that trigger reindenting in insert mode and 'cinoptions' to set your
1628 preferred indent style.
1629 If 'indentexpr' is not empty, it overrules 'cindent'.
1630 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1631 the "=" operator indents using this algorithm rather than calling an
1632 external program.
1633 See |C-indenting|.
1634 When you don't like the way 'cindent' works, try the 'smartindent'
1635 option or 'indentexpr'.
1636 This option is not used when 'paste' is set.
1637 NOTE: This option is reset when 'compatible' is set.
1638
1639 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001640'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001642 {not available when compiled without the |+cindent|
1643 feature}
1644 A list of keys that, when typed in Insert mode, cause reindenting of
1645 the current line. Only used if 'cindent' is on and 'indentexpr' is
1646 empty.
1647 For the format of this option see |cinkeys-format|.
1648 See |C-indenting|.
1649
1650 *'cinoptions'* *'cino'*
1651'cinoptions' 'cino' string (default "")
1652 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653 {not available when compiled without the |+cindent|
1654 feature}
1655 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1656 program. See |cinoptions-values| for the values of this option, and
1657 |C-indenting| for info on C indenting in general.
1658
1659
1660 *'cinwords'* *'cinw'*
1661'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1662 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 {not available when compiled without both the
1664 |+cindent| and the |+smartindent| features}
1665 These keywords start an extra indent in the next line when
1666 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1667 an appropriate place (inside {}).
1668 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1669 matter, include the keyword both the uppercase and lowercase:
1670 "if,If,IF".
1671
Tom Praschan3506cf32022-04-07 12:39:08 +01001672 *'cinscopedecls'* *'cinsd'*
1673'cinscopedecls' 'cinsd' string (default "public,protected,private")
1674 local to buffer
1675 {not available when compiled without the |+cindent|
1676 feature}
1677 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1678 Useful e.g. for working with the Qt framework that defines additional
1679 scope declarations "signals", "public slots" and "private slots": >
1680 set cinscopedecls+=signals,public\ slots,private\ slots
1681
1682< *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001683'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1684 for X-windows, "" otherwise)
1685 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 {only in GUI versions or when the |+xterm_clipboard|
1687 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001688 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001689 Note: if one of the items is "exclude:", then you can't add an item
1690 after that. Therefore do append an item with += but use ^= to
1691 prepend, e.g.: >
1692 set clipboard^=unnamed
1693< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001695 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001696 unnamed When included, Vim will use the clipboard register '*'
1697 for all yank, delete, change and put operations which
1698 would normally go to the unnamed register. When a
1699 register is explicitly specified, it will always be
1700 used regardless of whether "unnamed" is in 'clipboard'
1701 or not. The clipboard register can always be
1702 explicitly accessed using the "* notation. Also see
1703 |gui-clipboard|.
1704
Bram Moolenaar30b65812012-07-12 22:01:11 +02001705 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001706 unnamedplus A variant of the "unnamed" flag which uses the
1707 clipboard register '+' (|quoteplus|) instead of
1708 register '*' for all yank, delete, change and put
1709 operations which would normally go to the unnamed
1710 register. When "unnamed" is also included to the
1711 option, yank operations (but not delete, change or
1712 put) will additionally copy the text into register
1713 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001714 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001715 Availability can be checked with: >
1716 if has('unnamedplus')
1717<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001718 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 autoselect Works like the 'a' flag in 'guioptions': If present,
1720 then whenever Visual mode is started, or the Visual
1721 area extended, Vim tries to become the owner of the
1722 windowing system's global selection or put the
1723 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001724 register "*. See |'go-a'| and |quotestar| for details.
1725 When the GUI is active, the 'a' flag in 'guioptions'
1726 is used, when the GUI is not active, this "autoselect"
1727 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728 Also applies to the modeless selection.
1729
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001730 *clipboard-autoselectplus*
1731 autoselectplus Like "autoselect" but using the + register instead of
1732 the * register. Compare to the 'P' flag in
1733 'guioptions'.
1734
1735 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001736 autoselectml Like "autoselect", but for the modeless selection
1737 only. Compare to the 'A' flag in 'guioptions'.
1738
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001739 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001740 html When the clipboard contains HTML, use this when
1741 pasting. When putting text on the clipboard, mark it
1742 as HTML. This works to copy rendered HTML from
1743 Firefox, paste it as raw HTML in Vim, select the HTML
1744 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001745 You probably want to add this only temporarily,
1746 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001747 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001748
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001749 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001750 exclude:{pattern}
1751 Defines a pattern that is matched against the name of
1752 the terminal 'term'. If there is a match, no
1753 connection will be made to the X server. This is
1754 useful in this situation:
1755 - Running Vim in a console.
1756 - $DISPLAY is set to start applications on another
1757 display.
1758 - You do not want to connect to the X server in the
1759 console, but do want this in a terminal emulator.
1760 To never connect to the X server use: >
1761 exclude:.*
1762< This has the same effect as using the |-X| argument.
1763 Note that when there is no connection to the X server
1764 the window title won't be restored and the clipboard
1765 cannot be accessed.
1766 The value of 'magic' is ignored, {pattern} is
1767 interpreted as if 'magic' was on.
1768 The rest of the option value will be used for
1769 {pattern}, this must be the last entry.
1770
1771 *'cmdheight'* *'ch'*
1772'cmdheight' 'ch' number (default 1)
1773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 Number of screen lines to use for the command-line. Helps avoiding
1775 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001776 The value of this option is stored with the tab page, so that each tab
1777 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778
1779 *'cmdwinheight'* *'cwh'*
1780'cmdwinheight' 'cwh' number (default 7)
1781 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782 Number of screen lines to use for the command-line window. |cmdwin|
1783
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001784 *'colorcolumn'* *'cc'*
1785'colorcolumn' 'cc' string (default "")
1786 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001787 {not available when compiled without the |+syntax|
1788 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001789 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001790 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1791 text. Will make screen redrawing slower.
1792 The screen column can be an absolute number, or a number preceded with
1793 '+' or '-', which is added to or subtracted from 'textwidth'. >
1794
1795 :set cc=+1 " highlight column after 'textwidth'
1796 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1797 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1798<
1799 When 'textwidth' is zero then the items with '-' and '+' are not used.
1800 A maximum of 256 columns are highlighted.
1801
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 *'columns'* *'co'* *E594*
1803'columns' 'co' number (default 80 or terminal width)
1804 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001806 initialization and does not have to be set by hand. Also see
1807 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808 When Vim is running in the GUI or in a resizable window, setting this
1809 option will cause the window size to be changed. When you only want
1810 to use the size for the GUI, put the command in your |gvimrc| file.
1811 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001812 number of columns of the display, the display may be messed up. For
1813 the GUI it is always possible and Vim limits the number of columns to
1814 what fits on the screen. You can use this command to get the widest
1815 window possible: >
1816 :set columns=9999
1817< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818
1819 *'comments'* *'com'* *E524* *E525*
1820'comments' 'com' string (default
1821 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1822 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001823 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824 |format-comments|. See |option-backslash| about using backslashes to
1825 insert a space.
1826
1827 *'commentstring'* *'cms'* *E537*
1828'commentstring' 'cms' string (default "/*%s*/")
1829 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 {not available when compiled without the |+folding|
1831 feature}
1832 A template for a comment. The "%s" in the value is replaced with the
1833 comment text. Currently only used to add markers for folding, see
1834 |fold-marker|.
1835
1836 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001837'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001838 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 This option has the effect of making Vim either more Vi-compatible, or
1841 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001842
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001844 other options are also changed as a side effect.
1845 NOTE: Setting or resetting this option can have a lot of unexpected
1846 effects: Mappings are interpreted in another way, undo behaves
1847 differently, etc. If you set this option in your vimrc file, you
1848 should probably put it at the very start.
1849
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 By default this option is on and the Vi defaults are used for the
1851 options. This default was chosen for those people who want to use Vim
1852 just like Vi, and don't even (want to) know about the 'compatible'
1853 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001854 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001855 this option is switched off, and all options that have not been
1856 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001857 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001858 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001859 happen for the system-wide vimrc or gvimrc file, nor for a file given
1860 with the |-u| argument). Also see |compatible-default| and
1861 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862 You can also set this option with the "-C" argument, and reset it with
1863 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001864 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865
Bram Moolenaar214641f2017-03-05 17:04:09 +01001866 When this option is set, numerous other options are set to make Vim as
1867 Vi-compatible as possible. When this option is unset, various options
1868 are set to make Vim more useful. The table below lists all the
1869 options affected.
1870 The {?} column indicates when the options are affected:
1871 + Means that the option is set to the value given in {set value} when
1872 'compatible' is set.
1873 & Means that the option is set to the value given in {set value} when
1874 'compatible' is set AND is set to its Vim default value when
1875 'compatible' is unset.
1876 - Means the option is NOT changed when setting 'compatible' but IS
1877 set to its Vim default when 'compatible' is unset.
1878 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001879
Bram Moolenaar036986f2017-03-16 17:41:02 +01001880 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001881
1882 'allowrevins' + off no CTRL-_ command
1883 'antialias' + off don't use antialiased fonts
1884 'arabic' + off reset arabic-related options
1885 'arabicshape' + on correct character shapes
1886 'backspace' + "" normal backspace
1887 'backup' + off no backup file
1888 'backupcopy' & Unix: "yes" backup file is a copy
1889 else: "auto" copy or rename backup file
1890 'balloonexpr' + "" text to show in evaluation balloon
1891 'breakindent' + off don't indent when wrapping lines
1892 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001893 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001894 'cindent' + off no C code indentation
1895 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1896 'copyindent' + off don't copy indent structure
1897 'cpoptions' & (all flags) Vi-compatible flags
1898 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001899 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001900 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001901 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001902 'cscopeverbose' + off see |cscopeverbose|
1903 'delcombine' + off unicode: delete whole char combination
1904 'digraph' + off no digraphs
1905 'esckeys' & off no <Esc>-keys in Insert mode
1906 'expandtab' + off tabs not expanded to spaces
1907 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001908 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001909 'formatexpr' + "" use 'formatprg' for auto-formatting
1910 'formatoptions' & "vt" Vi compatible formatting
1911 'gdefault' + off no default 'g' flag for ":s"
1912 'history' & 0 no commandline history
1913 'hkmap' + off no Hebrew keyboard mapping
1914 'hkmapp' + off no phonetic Hebrew keyboard mapping
1915 'hlsearch' + off no highlighting of search matches
1916 'incsearch' + off no incremental searching
1917 'indentexpr' + "" no indenting by expression
1918 'insertmode' + off do not start in Insert mode
1919 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001921 'joinspaces' + on insert 2 spaces after period
1922 'modeline' & off no modelines
1923 'more' & off no pauses in listings
1924 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1925 'numberwidth' & 8 min number of columns for line number
1926 'preserveindent'+ off don't preserve current indent structure
1927 when changing it
1928 'revins' + off no reverse insert
1929 'ruler' + off no ruler
1930 'scrolljump' + 1 no jump scroll
1931 'scrolloff' + 0 no scroll offset
1932 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1933 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001934 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001935 'showcmd' & off command characters not shown
1936 'showmode' & off current mode not shown
1937 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1938 'smartcase' + off no automatic ignore case switch
1939 'smartindent' + off no smart indentation
1940 'smarttab' + off no smart tab size
1941 'softtabstop' + 0 tabs are always 'tabstop' positions
1942 'startofline' + on goto startofline with some commands
1943 'tagcase' & "followic" 'ignorecase' when searching tags file
1944 'tagrelative' & off tag file names are not relative
1945 'termguicolors' + off don't use highlight-(guifg|guibg)
1946 'textauto' & off no automatic textmode detection
1947 'textwidth' + 0 no automatic line wrap
1948 'tildeop' + off tilde is not an operator
1949 'ttimeout' + off no terminal timeout
1950 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001951 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001952 'virtualedit' + "" cursor can only be placed on characters
1953 'whichwrap' & "" left-right movements don't wrap
1954 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001956 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957
1958 *'complete'* *'cpt'* *E535*
1959'complete' 'cpt' string (default: ".,w,b,u,t,i")
1960 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961 This option specifies how keyword completion |ins-completion| works
1962 when CTRL-P or CTRL-N are used. It is also used for whole-line
1963 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001964 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001965 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001966 w scan buffers from other windows
1967 b scan other loaded buffers that are in the buffer list
1968 u scan the unloaded buffers that are in the buffer list
1969 U scan the buffers that are not in the buffer list
1970 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001971 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001972 k{dict} scan the file {dict}. Several "k" flags can be given,
1973 patterns are valid too. For example: >
1974 :set cpt=k/usr/dict/*,k~/spanish
1975< s scan the files given with the 'thesaurus' option
1976 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1977 are valid too.
1978 i scan current and included files
1979 d scan current and included files for defined name or macro
1980 |i_CTRL-X_CTRL-D|
1981 ] tag completion
1982 t same as "]"
1983
1984 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1985 not executed, this may lead to unexpected completions from some files
1986 (gzipped files for example). Unloaded buffers are not scanned for
1987 whole-line completion.
1988
1989 The default is ".,w,b,u,t,i", which means to scan:
1990 1. the current buffer
1991 2. buffers in other windows
1992 3. other loaded buffers
1993 4. unloaded buffers
1994 5. tags
1995 6. included files
1996
1997 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001998 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1999 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002001 *'completefunc'* *'cfu'*
2002'completefunc' 'cfu' string (default: empty)
2003 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002004 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002005 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002006 This option specifies a function to be used for Insert mode completion
2007 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002008 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002009 invoked and what it should return. The value can be the name of a
2010 function, a |lambda| or a |Funcref|. See |option-value-function| for
2011 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002012 This option cannot be set from a |modeline| or in the |sandbox|, for
2013 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002014
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002015 *'completeslash'* *'csl'*
2016'completeslash' 'csl' string (default: "")
2017 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002018 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002019 When this option is set it overrules 'shellslash' for completion:
2020 - When this option is set to "slash", a forward slash is used for path
2021 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002022 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002023 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002024 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002025 - When this option is empty, same character is used as for
2026 'shellslash'.
2027 For Insert mode completion the buffer-local value is used. For
2028 command line completion the global value is used.
2029
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002030 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002031'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002032 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002033 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002034 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002035
2036 menu Use a popup menu to show the possible completions. The
2037 menu is only shown when there is more than one match and
2038 sufficient colors are available. |ins-completion-menu|
2039
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002040 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002041 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002042 match, e.g., what file it comes from.
2043
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002044 longest Only insert the longest common text of the matches. If
2045 the menu is displayed you can use CTRL-L to add more
2046 characters. Whether case is ignored depends on the kind
2047 of completion. For buffer text the 'ignorecase' option is
2048 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002049
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002050 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002051 completion in the preview window. Only works in
2052 combination with "menu" or "menuone".
2053
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002054 popup Show extra information about the currently selected
2055 completion in a popup window. Only works in combination
2056 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002057 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002058 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002059
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002060 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002061 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002062 |CompleteChanged| autocommand to fetch the info and call
2063 |popup_show()| once the popup has been filled.
2064 See the example at |complete-popuphidden|.
2065 {only works when compiled with the |+textprop| feature}
2066
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002067 noinsert Do not insert any text for a match until the user selects
2068 a match from the menu. Only works in combination with
2069 "menu" or "menuone". No effect if "longest" is present.
2070
2071 noselect Do not select a match in the menu, force the user to
2072 select one from the menu. Only works in combination with
2073 "menu" or "menuone".
2074
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002075
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002076 *'completepopup'* *'cpp'*
2077'completepopup' 'cpp' string (default empty)
2078 global
2079 {not available when compiled without the |+textprop|
2080 or |+quickfix| feature}
2081 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002082 properties of the info popup when it is created. If an info popup
2083 window already exists it is closed, so that the option value is
2084 applied when it is created again.
2085 You can also use |popup_findinfo()| and then set properties for an
2086 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002087
2088
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002089 *'concealcursor'* *'cocu'*
2090'concealcursor' 'cocu' string (default: "")
2091 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002092 {not available when compiled without the |+conceal|
2093 feature}
2094 Sets the modes in which text in the cursor line can also be concealed.
2095 When the current mode is listed then concealing happens just like in
2096 other lines.
2097 n Normal mode
2098 v Visual mode
2099 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002100 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002101
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002102 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002103 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002104 are moving around text is concealed, but when starting to insert text
2105 or selecting a Visual area the concealed text is displayed, so that
2106 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002107 Keep in mind that the cursor position is not always where it's
2108 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002109
2110
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002111 *'conceallevel'* *'cole'*
2112'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002113 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002114 {not available when compiled without the |+conceal|
2115 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002116 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2117 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002118
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002119 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002120 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002121 1 Each block of concealed text is replaced with one
2122 character. If the syntax item does not have a custom
2123 replacement character defined (see |:syn-cchar|) the
2124 character defined in 'listchars' is used (default is a
2125 space).
2126 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002127 2 Concealed text is completely hidden unless it has a
2128 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002129 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002130 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002131
Bram Moolenaara7781e02010-07-19 20:13:22 +02002132 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002133 edit and copy the text. This can be changed with the 'concealcursor'
2134 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002135
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2137'confirm' 'cf' boolean (default off)
2138 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002139 When 'confirm' is on, certain operations that would normally
2140 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2141 instead raise a |dialog| asking if you wish to save the current
2142 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2143 If 'confirm' is off you can still activate confirmation for one
2144 command only (this is most useful in mappings) with the |:confirm|
2145 command.
2146 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2147
2148 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2149'conskey' 'consk' boolean (default off)
2150 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002151 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152
2153 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2154'copyindent' 'ci' boolean (default off)
2155 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 Copy the structure of the existing lines indent when autoindenting a
2157 new line. Normally the new indent is reconstructed by a series of
2158 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2159 in which case only spaces are used). Enabling this option makes the
2160 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002161 existing line. 'expandtab' has no effect on these characters, a Tab
2162 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002164 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165 Also see 'preserveindent'.
2166
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002167 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168'cpoptions' 'cpo' string (Vim default: "aABceFs",
2169 Vi default: all flags)
2170 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002172 this indicates Vi-compatible behavior. This is used for things where
2173 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174 'cpoptions' stands for "compatible-options".
2175 Commas can be added for readability.
2176 To avoid problems with flags that are added in the future, use the
2177 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002178
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 NOTE: This option is set to the Vi default value when 'compatible' is
2180 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002181
2182 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2183 is saved, 'cpoptions' is set to the Vim default, and the saved value
2184 is restored at the end of the script. Changes to the value of
2185 'cpoptions' will be applied to the saved value, but keep in mind that
2186 removing a flag that is not present when 'cpoptions' is changed has no
2187 effect. In the |.vimrc| file the value is not restored, thus using
2188 `vim9script` in the |.vimrc| file results in using the Vim default.
2189
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002190 NOTE: This option is set to the POSIX default value at startup when
2191 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002192 variable exists |posix|. This means Vim tries to behave like the
2193 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002194
2195 contains behavior ~
2196 *cpo-a*
2197 a When included, a ":read" command with a file name
2198 argument will set the alternate file name for the
2199 current window.
2200 *cpo-A*
2201 A When included, a ":write" command with a file name
2202 argument will set the alternate file name for the
2203 current window.
2204 *cpo-b*
2205 b "\|" in a ":map" command is recognized as the end of
2206 the map command. The '\' is included in the mapping,
2207 the text after the '|' is interpreted as the next
2208 command. Use a CTRL-V instead of a backslash to
2209 include the '|' in the mapping. Applies to all
2210 mapping, abbreviation, menu and autocmd commands.
2211 See also |map_bar|.
2212 *cpo-B*
2213 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002214 abbreviations, user commands and the "to" part of the
2215 menu commands. Remove this flag to be able to use a
2216 backslash like a CTRL-V. For example, the command
2217 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 'B' included: "\^[" (^[ is a real <Esc>)
2219 'B' excluded: "<Esc>" (5 characters)
2220 ('<' excluded in both cases)
2221 *cpo-c*
2222 c Searching continues at the end of any match at the
2223 cursor position, but not further than the start of the
2224 next line. When not present searching continues
2225 one character from the cursor position. With 'c'
2226 "abababababab" only gets three matches when repeating
2227 "/abab", without 'c' there are five matches.
2228 *cpo-C*
2229 C Do not concatenate sourced lines that start with a
2230 backslash. See |line-continuation|.
2231 *cpo-d*
2232 d Using "./" in the 'tags' option doesn't mean to use
2233 the tags file relative to the current file, but the
2234 tags file in the current directory.
2235 *cpo-D*
2236 D Can't use CTRL-K to enter a digraph after Normal mode
2237 commands with a character argument, like |r|, |f| and
2238 |t|.
2239 *cpo-e*
2240 e When executing a register with ":@r", always add a
2241 <CR> to the last line, also when the register is not
2242 linewise. If this flag is not present, the register
2243 is not linewise and the last line does not end in a
2244 <CR>, then the last line is put on the command-line
2245 and can be edited before hitting <CR>.
2246 *cpo-E*
2247 E It is an error when using "y", "d", "c", "g~", "gu" or
2248 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002249 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250 This makes "y0" fail in the first column.
2251 *cpo-f*
2252 f When included, a ":read" command with a file name
2253 argument will set the file name for the current buffer,
2254 if the current buffer doesn't have a file name yet.
2255 *cpo-F*
2256 F When included, a ":write" command with a file name
2257 argument will set the file name for the current
2258 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002259 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260 *cpo-g*
2261 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002262 *cpo-H*
2263 H When using "I" on a line with only blanks, insert
2264 before the last blank. Without this flag insert after
2265 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 *cpo-i*
2267 i When included, interrupting the reading of a file will
2268 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002269 *cpo-I*
2270 I When moving the cursor up or down just after inserting
2271 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002272 *cpo-j*
2273 j When joining lines, only add two spaces after a '.',
2274 not after '!' or '?'. Also see 'joinspaces'.
2275 *cpo-J*
2276 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002277 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278 white space.
2279 *cpo-k*
2280 k Disable the recognition of raw key codes in
2281 mappings, abbreviations, and the "to" part of menu
2282 commands. For example, if <Key> sends ^[OA (where ^[
2283 is <Esc>), the command ":map X ^[OA" results in X
2284 being mapped to:
2285 'k' included: "^[OA" (3 characters)
2286 'k' excluded: "<Key>" (one key code)
2287 Also see the '<' flag below.
2288 *cpo-K*
2289 K Don't wait for a key code to complete when it is
2290 halfway a mapping. This breaks mapping <F1><F1> when
2291 only part of the second <F1> has been read. It
2292 enables cancelling the mapping by typing <F1><Esc>.
2293 *cpo-l*
2294 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002295 literally, only "\]", "\^", "\-" and "\\" are special.
2296 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2298 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002299 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300 *cpo-L*
2301 L When the 'list' option is set, 'wrapmargin',
2302 'textwidth', 'softtabstop' and Virtual Replace mode
2303 (see |gR|) count a <Tab> as two characters, instead of
2304 the normal behavior of a <Tab>.
2305 *cpo-m*
2306 m When included, a showmatch will always wait half a
2307 second. When not included, a showmatch will wait half
2308 a second or until a character is typed. |'showmatch'|
2309 *cpo-M*
2310 M When excluded, "%" matching will take backslashes into
2311 account. Thus in "( \( )" and "\( ( \)" the outer
2312 parenthesis match. When included "%" ignores
2313 backslashes, which is Vi compatible.
2314 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002315 n When included, the column used for 'number' and
2316 'relativenumber' will also be used for text of wrapped
2317 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318 *cpo-o*
2319 o Line offset to search command is not remembered for
2320 next search.
2321 *cpo-O*
2322 O Don't complain if a file is being overwritten, even
2323 when it didn't exist when editing it. This is a
2324 protection against a file unexpectedly created by
2325 someone else. Vi didn't complain about this.
2326 *cpo-p*
2327 p Vi compatible Lisp indenting. When not present, a
2328 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002329 *cpo-P*
2330 P When included, a ":write" command that appends to a
2331 file will set the file name for the current buffer, if
2332 the current buffer doesn't have a file name yet and
2333 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002334 *cpo-q*
2335 q When joining multiple lines leave the cursor at the
2336 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337 *cpo-r*
2338 r Redo ("." command) uses "/" to repeat a search
2339 command, instead of the actually used search string.
2340 *cpo-R*
2341 R Remove marks from filtered lines. Without this flag
2342 marks are kept like |:keepmarks| was used.
2343 *cpo-s*
2344 s Set buffer options when entering the buffer for the
2345 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002346 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002347 set when the buffer is created.
2348 *cpo-S*
2349 S Set buffer options always when entering a buffer
2350 (except 'readonly', 'fileformat', 'filetype' and
2351 'syntax'). This is the (most) Vi compatible setting.
2352 The options are set to the values in the current
2353 buffer. When you change an option and go to another
2354 buffer, the value is copied. Effectively makes the
2355 buffer options global to all buffers.
2356
2357 's' 'S' copy buffer options
2358 no no when buffer created
2359 yes no when buffer first entered (default)
2360 X yes each time when buffer entered (vi comp.)
2361 *cpo-t*
2362 t Search pattern for the tag command is remembered for
2363 "n" command. Otherwise Vim only puts the pattern in
2364 the history for search pattern, but doesn't change the
2365 last used search pattern.
2366 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002367 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368 *cpo-v*
2369 v Backspaced characters remain visible on the screen in
2370 Insert mode. Without this flag the characters are
2371 erased from the screen right away. With this flag the
2372 screen newly typed text overwrites backspaced
2373 characters.
2374 *cpo-w*
2375 w When using "cw" on a blank character, only change one
2376 character and not all blanks until the start of the
2377 next word.
2378 *cpo-W*
2379 W Don't overwrite a readonly file. When omitted, ":w!"
2380 overwrites a readonly file, if possible.
2381 *cpo-x*
2382 x <Esc> on the command-line executes the command-line.
2383 The default in Vim is to abandon the command-line,
2384 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002385 *cpo-X*
2386 X When using a count with "R" the replaced text is
2387 deleted only once. Also when repeating "R" with "."
2388 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002390 y A yank command can be redone with ".". Think twice if
2391 you really want to use this, it may break some
2392 plugins, since most people expect "." to only repeat a
2393 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002394 *cpo-Z*
2395 Z When using "w!" while the 'readonly' option is set,
2396 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 *cpo-!*
2398 ! When redoing a filter command, use the last used
2399 external command, whatever it was. Otherwise the last
2400 used -filter- command is used.
2401 *cpo-$*
2402 $ When making a change to one line, don't redisplay the
2403 line, but put a '$' at the end of the changed text.
2404 The changed text will be overwritten when you type the
2405 new text. The line is redisplayed if you type any
2406 command that moves the cursor from the insertion
2407 point.
2408 *cpo-%*
2409 % Vi-compatible matching is done for the "%" command.
2410 Does not recognize "#if", "#endif", etc.
2411 Does not recognize "/*" and "*/".
2412 Parens inside single and double quotes are also
2413 counted, causing a string that contains a paren to
2414 disturb the matching. For example, in a line like
2415 "if (strcmp("foo(", s))" the first paren does not
2416 match the last one. When this flag is not included,
2417 parens inside single and double quotes are treated
2418 specially. When matching a paren outside of quotes,
2419 everything inside quotes is ignored. When matching a
2420 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002421 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002422 This flag is also used for other features, such as
2423 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002424 *cpo--*
2425 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002426 it would go above the first line or below the last
2427 line. Without it the cursor moves to the first or
2428 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002429 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002430 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002431 *cpo-+*
2432 + When included, a ":write file" command will reset the
2433 'modified' flag of the buffer, even though the buffer
2434 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002435 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002436 * Use ":*" in the same way as ":@". When not included,
2437 ":*" is an alias for ":'<,'>", select the Visual area.
2438 *cpo-<*
2439 < Disable the recognition of special key codes in |<>|
2440 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002441 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002442 ":map X <Tab>" results in X being mapped to:
2443 '<' included: "<Tab>" (5 characters)
2444 '<' excluded: "^I" (^I is a real <Tab>)
2445 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002446 *cpo->*
2447 > When appending to a register, put a line break before
2448 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002449 *cpo-;*
2450 ; When using |,| or |;| to repeat the last |t| search
2451 and the cursor is right in front of the searched
2452 character, the cursor won't move. When not included,
2453 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002454 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002455
2456 POSIX flags. These are not included in the Vi default value, except
2457 when $VIM_POSIX was set on startup. |posix|
2458
2459 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002460 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002461 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002462 *cpo-&*
2463 & When ":preserve" was used keep the swap file when
2464 exiting normally while this buffer is still loaded.
2465 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002466 *cpo-\*
2467 \ Backslash in a [] range in a search pattern is taken
2468 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002469 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2470 '\' excluded: "/[ \-]" finds <Space> and '-'
2471 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002472 *cpo-/*
2473 / When "%" is used as the replacement string in a |:s|
2474 command, use the previous replacement string. |:s%|
2475 *cpo-{*
2476 { The |{| and |}| commands also stop at a "{" character
2477 at the start of a line.
2478 *cpo-.*
2479 . The ":chdir" and ":cd" commands fail if the current
2480 buffer is modified, unless ! is used. Vim doesn't
2481 need this, since it remembers the full path of an
2482 opened file.
2483 *cpo-bar*
2484 | The value of the $LINES and $COLUMNS environment
2485 variables overrule the terminal size values obtained
2486 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002487
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002489 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002490'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002491 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002492 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002493 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002494 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002495 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002496 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002497 blowfish Blowfish method. Medium strong encryption but it has
2498 an implementation flaw. Requires Vim 7.3 or later,
2499 files can NOT be read by Vim 7.2 and older. This adds
2500 a "seed" to the file, every time you write the file
2501 the encrypted bytes will be different.
2502 *blowfish2*
2503 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002504 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002505 and older. This adds a "seed" to the file, every time
2506 you write the file the encrypted bytes will be
2507 different. The whole undo file is encrypted, not just
2508 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002509 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002510 *E1197* *E1198* *E1199* *E1200* *E1201*
2511 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2512 Code. Medium strong till strong encryption.
2513 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002514 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002515 It adds a seed and a message authentication code (MAC)
2516 to the file. This needs at least a Vim 8.2.3022 to
2517 read the encrypted file.
2518 Encryption of swap files is not supported, therefore
2519 no swap file will be used when xchacha20 encryption is
2520 enabled.
2521 Encryption of undo files is not yet supported,
2522 therefore no undo file will currently be written.
2523 CURRENTLY EXPERIMENTAL: Files written with this method
2524 might have to be read back with the same version of
2525 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002526
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002527 You should use "blowfish2", also to re-encrypt older files.
2528
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002529 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002530 to the detected method of the file being read. Thus if you write it
2531 without changing 'cryptmethod' the same method will be used.
2532 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002533 explicitly write it, you don't get a warning unless there are other
2534 modifications. Also see |:X|.
2535
2536 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002537 the value "blowfish2". When setting the local value to an empty
2538 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002539
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002540 When a new encryption method is added in a later version of Vim, and
2541 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002542 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002543
2544
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545 *'cscopepathcomp'* *'cspc'*
2546'cscopepathcomp' 'cspc' number (default 0)
2547 global
2548 {not available when compiled without the |+cscope|
2549 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 Determines how many components of the path to show in a list of tags.
2551 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002552 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553
2554 *'cscopeprg'* *'csprg'*
2555'cscopeprg' 'csprg' string (default "cscope")
2556 global
2557 {not available when compiled without the |+cscope|
2558 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002559 Specifies the command to execute cscope. See |cscopeprg|.
2560 This option cannot be set from a |modeline| or in the |sandbox|, for
2561 security reasons.
2562
2563 *'cscopequickfix'* *'csqf'*
2564'cscopequickfix' 'csqf' string (default "")
2565 global
2566 {not available when compiled without the |+cscope|
2567 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002568 Specifies whether to use quickfix window to show cscope results.
2569 See |cscopequickfix|.
2570
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002571 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002572'cscoperelative' 'csre' boolean (default off)
2573 global
2574 {not available when compiled without the |+cscope|
2575 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002576 In the absence of a prefix (-P) for cscope. setting this option enables
2577 to use the basename of cscope.out path as the prefix.
2578 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002579 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002580
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2582'cscopetag' 'cst' boolean (default off)
2583 global
2584 {not available when compiled without the |+cscope|
2585 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586 Use cscope for tag commands. See |cscope-options|.
2587 NOTE: This option is reset when 'compatible' is set.
2588
2589 *'cscopetagorder'* *'csto'*
2590'cscopetagorder' 'csto' number (default 0)
2591 global
2592 {not available when compiled without the |+cscope|
2593 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 Determines the order in which ":cstag" performs a search. See
2595 |cscopetagorder|.
2596 NOTE: This option is set to 0 when 'compatible' is set.
2597
2598 *'cscopeverbose'* *'csverb'*
2599 *'nocscopeverbose'* *'nocsverb'*
2600'cscopeverbose' 'csverb' boolean (default off)
2601 global
2602 {not available when compiled without the |+cscope|
2603 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002604 Give messages when adding a cscope database. See |cscopeverbose|.
2605 NOTE: This option is reset when 'compatible' is set.
2606
Bram Moolenaar860cae12010-06-05 23:22:07 +02002607 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2608'cursorbind' 'crb' boolean (default off)
2609 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002610 When this option is set, as the cursor in the current
2611 window moves other cursorbound windows (windows that also have
2612 this option set) move their cursors to the corresponding line and
2613 column. This option is useful for viewing the
2614 differences between two versions of a file (see 'diff'); in diff mode,
2615 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002616 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002617
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002618
2619 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2620'cursorcolumn' 'cuc' boolean (default off)
2621 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002622 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002623 feature}
2624 Highlight the screen column of the cursor with CursorColumn
2625 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2626 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002627 If you only want the highlighting in the current window you can use
2628 these autocommands: >
2629 au WinLeave * set nocursorline nocursorcolumn
2630 au WinEnter * set cursorline cursorcolumn
2631<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002632
2633 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2634'cursorline' 'cul' boolean (default off)
2635 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002636 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002637 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002638 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2639 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002640 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002641 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002642
2643
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002644 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002645'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002646 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002647 {not available when compiled without the |+syntax|
2648 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002649 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002650 Valid values:
2651 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002652 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002653 "screenline" Highlight only the screen line of the cursor with
2654 CursorLine |hl-CursorLine|.
2655 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002656 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002657
2658 Special value:
2659 "both" Alias for the values "line,number".
2660
2661 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002662
2663
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664 *'debug'*
2665'debug' string (default "")
2666 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002667 These values can be used:
2668 msg Error messages that would otherwise be omitted will be given
2669 anyway.
2670 throw Error messages that would otherwise be omitted will be given
2671 anyway and also throw an exception and set |v:errmsg|.
2672 beep A message will be given when otherwise only a beep would be
2673 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002674 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002675 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2676 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002677
2678 *'define'* *'def'*
2679'define' 'def' string (default "^\s*#\s*define")
2680 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002681 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682 pattern, just like for the "/" command. This option is used for the
2683 commands like "[i" and "[d" |include-search|. The 'isident' option is
2684 used to recognize the defined name after the match:
2685 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2686 See |option-backslash| about inserting backslashes to include a space
2687 or backslash.
2688 The default value is for C programs. For C++ this value would be
2689 useful, to include const type declarations: >
2690 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002691< You can also use "\ze" just before the name and continue the pattern
2692 to check what is following. E.g. for Javascript, if a function is
2693 defined with "func_name = function(args)": >
2694 ^\s*\ze\i\+\s*=\s*function(
2695< If the function is defined with "func_name : function() {...": >
2696 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002698 To avoid that use `:let` with a single quote string: >
2699 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002700<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701
2702 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2703'delcombine' 'deco' boolean (default off)
2704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705 If editing Unicode and this option is set, backspace and Normal mode
2706 "x" delete each combining character on its own. When it is off (the
2707 default) the character along with its combining characters are
2708 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002709 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710
2711 This is useful for Arabic, Hebrew and many other languages where one
2712 may have combining characters overtop of base characters, and want
2713 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002714 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715
2716 *'dictionary'* *'dict'*
2717'dictionary' 'dict' string (default "")
2718 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002719 List of file names, separated by commas, that are used to lookup words
2720 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2721 contain a list of words. This can be one word per line, or several
2722 words per line, separated by non-keyword characters (white space is
2723 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002724
2725 When this option is empty or an entry "spell" is present, and spell
2726 checking is enabled, words in the word lists for the currently active
2727 'spelllang' are used. See |spell|.
2728
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002729 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730 after a comma are ignored, otherwise spaces are included in the file
2731 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002732 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 Where to find a list of words?
2734 - On FreeBSD, there is the file "/usr/share/dict/words".
2735 - In the Simtel archive, look in the "msdos/linguist" directory.
2736 - In "miscfiles" of the GNU collection.
2737 The use of |:set+=| and |:set-=| is preferred when adding or removing
2738 directories from the list. This avoids problems when a future version
2739 uses another default.
2740 Backticks cannot be used in this option for security reasons.
2741
2742 *'diff'* *'nodiff'*
2743'diff' boolean (default off)
2744 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745 {not available when compiled without the |+diff|
2746 feature}
2747 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002748 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749
2750 *'dex'* *'diffexpr'*
2751'diffexpr' 'dex' string (default "")
2752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 {not available when compiled without the |+diff|
2754 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002755 Expression which is evaluated to obtain a diff file (either ed-style
2756 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 This option cannot be set from a |modeline| or in the |sandbox|, for
2758 security reasons.
2759
2760 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002761'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 {not available when compiled without the |+diff|
2764 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002765 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 All are optional. Items must be separated by a comma.
2767
2768 filler Show filler lines, to keep the text
2769 synchronized with a window that has inserted
2770 lines at the same position. Mostly useful
2771 when windows are side-by-side and 'scrollbind'
2772 is set.
2773
2774 context:{n} Use a context of {n} lines between a change
2775 and a fold that contains unchanged lines.
2776 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002777 When using zero the context is actually one,
2778 since folds require a line in between, also
2779 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 See |fold-diff|.
2781
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002782 iblank Ignore changes where lines are all blank. Adds
2783 the "-B" flag to the "diff" command if
2784 'diffexpr' is empty. Check the documentation
2785 of the "diff" command for what this does
2786 exactly.
2787 NOTE: the diff windows will get out of sync,
2788 because no differences between blank lines are
2789 taken into account.
2790
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791 icase Ignore changes in case of text. "a" and "A"
2792 are considered the same. Adds the "-i" flag
2793 to the "diff" command if 'diffexpr' is empty.
2794
2795 iwhite Ignore changes in amount of white space. 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. It should ignore adding trailing
2800 white space, but not leading white space.
2801
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002802 iwhiteall Ignore all white space changes. Adds
2803 the "-w" flag to the "diff" command if
2804 'diffexpr' is empty. Check the documentation
2805 of the "diff" command for what this does
2806 exactly.
2807
2808 iwhiteeol Ignore white space changes at end of line.
2809 Adds the "-Z" flag to the "diff" command if
2810 'diffexpr' is empty. Check the documentation
2811 of the "diff" command for what this does
2812 exactly.
2813
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002814 horizontal Start diff mode with horizontal splits (unless
2815 explicitly specified otherwise).
2816
2817 vertical Start diff mode with vertical splits (unless
2818 explicitly specified otherwise).
2819
Bram Moolenaarc8234772019-11-10 21:00:27 +01002820 closeoff When a window is closed where 'diff' is set
2821 and there is only one window remaining in the
2822 same tab page with 'diff' set, execute
2823 `:diffoff` in that window. This undoes a
2824 `:diffsplit` command.
2825
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002826 hiddenoff Do not use diff mode for a buffer when it
2827 becomes hidden.
2828
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002829 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2830 starting diff mode. Without this 2 is used.
2831
Bram Moolenaar4223d432021-02-10 13:18:17 +01002832 followwrap Follow the 'wrap' option and leave as it is.
2833
Bram Moolenaare828b762018-09-10 17:51:58 +02002834 internal Use the internal diff library. This is
2835 ignored when 'diffexpr' is set. *E960*
2836 When running out of memory when writing a
2837 buffer this item will be ignored for diffs
2838 involving that buffer. Set the 'verbose'
2839 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840
Bram Moolenaare828b762018-09-10 17:51:58 +02002841 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002842 Use the indent heuristic for the internal
2843 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002844
2845 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002846 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002847 algorithms are:
2848 myers the default algorithm
2849 minimal spend extra time to generate the
2850 smallest possible diff
2851 patience patience diff algorithm
2852 histogram histogram diff algorithm
2853
2854 Examples: >
2855 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002857 :set diffopt=internal,filler,foldcolumn:3
2858 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859<
2860 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2861'digraph' 'dg' boolean (default off)
2862 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002863 {not available when compiled without the |+digraphs|
2864 feature}
2865 Enable the entering of digraphs in Insert mode with {char1} <BS>
2866 {char2}. See |digraphs|.
2867 NOTE: This option is reset when 'compatible' is set.
2868
2869 *'directory'* *'dir'*
2870'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002871 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 for Unix: ".,~/tmp,/var/tmp,/tmp")
2873 global
2874 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002875 Recommended value: ".,~/vimswap//" - this will put the swap file next
2876 to the edited file if possible, and in your personal swap directory
2877 otherwise. Make sure "~/vimswap//" is only readable for you.
2878
2879 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 - The swap file will be created in the first directory where this is
2881 possible.
2882 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002883 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002884 - A directory "." means to put the swap file in the same directory as
2885 the edited file. On Unix, a dot is prepended to the file name, so
2886 it doesn't show in a directory listing. On MS-Windows the "hidden"
2887 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002888 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2889 the swap file relative to where the edited file is. The leading "."
2890 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002891 - For Unix and Win32, if a directory ends in two path separators "//",
2892 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002893 with all path separators replaced by percent '%' signs (including
2894 the colon following the drive letter on Win32). This will ensure
2895 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002896 On Win32, it is also possible to end with "\\". However, When a
2897 separating comma is following, you must use "//", since "\\" will
2898 include the comma in the file name. Therefore it is recommended to
2899 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 - Spaces after the comma are ignored, other spaces are considered part
2901 of the directory name. To have a space at the start of a directory
2902 name, precede it with a backslash.
2903 - To include a comma in a directory name precede it with a backslash.
2904 - A directory name may end in an ':' or '/'.
2905 - Environment variables are expanded |:set_env|.
2906 - Careful with '\' characters, type one before a space, type two to
2907 get one in the option (see |option-backslash|), for example: >
2908 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2909< - For backwards compatibility with Vim version 3.0 a '>' at the start
2910 of the option is removed.
2911 Using "." first in the list is recommended. This means that editing
2912 the same file twice will result in a warning. Using "/tmp" on Unix is
2913 discouraged: When the system crashes you lose the swap file.
2914 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002915 choice than "/tmp". But others on the computer may be able to see the
2916 files, and it can contain a lot of files, your swap files get lost in
2917 the crowd. That is why a "tmp" directory in your home directory is
2918 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 The use of |:set+=| and |:set-=| is preferred when adding or removing
2920 directories from the list. This avoids problems when a future version
2921 uses another default.
2922 This option cannot be set from a |modeline| or in the |sandbox|, for
2923 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924
2925 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002926'display' 'dy' string (default "", set to "truncate" in
2927 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002929 Change the way text is displayed. This is comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 flags:
2931 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002932 in a window will be displayed. "@@@" is put in the
2933 last columns of the last screen line to indicate the
2934 rest of the line is not displayed.
2935 truncate Like "lastline", but "@@@" is displayed in the first
2936 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937 uhex Show unprintable characters hexadecimal as <xx>
2938 instead of using ^C and ~C.
2939
Bram Moolenaard0796902016-09-16 20:02:31 +02002940 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002941 doesn't fit is replaced with "@" lines.
2942
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 *'eadirection'* *'ead'*
2944'eadirection' 'ead' string (default "both")
2945 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946 Tells when the 'equalalways' option applies:
2947 ver vertically, width of windows is not affected
2948 hor horizontally, height of windows is not affected
2949 both width and height of windows is affected
2950
2951 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2952'edcompatible' 'ed' boolean (default off)
2953 global
2954 Makes the 'g' and 'c' flags of the ":substitute" command to be
2955 toggled each time the flag is given. See |complex-change|. See
2956 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002957 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002958 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959
Bram Moolenaar03413f42016-04-12 21:07:15 +02002960 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002961'emoji' 'emo' boolean (default: on)
2962 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002963 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002964 This excludes "text emoji" characters, which are normally displayed as
2965 single width. Unfortunately there is no good specification for this
2966 and it has been determined on trial-and-error basis. Use the
2967 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002968
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002970'encoding' 'enc' string (default for MS-Windows: "utf-8",
2971 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 Sets the character encoding used inside Vim. It applies to text in
2974 the buffers, registers, Strings in expressions, text stored in the
2975 viminfo file, etc. It sets the kind of characters which Vim can work
2976 with. See |encoding-names| for the possible values.
2977
2978 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002979 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002981 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982
Bram Moolenaar865242e2010-07-14 21:12:05 +02002983 This option cannot be set from a |modeline|. It would most likely
2984 corrupt the text.
2985
Bram Moolenaar3df01732017-02-17 22:47:16 +01002986 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2987 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 'encoding', "utf-8" is the natural choice for the environment and
2989 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002990 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 versions, and to avoid changing the encoding of newly created files
2992 without your knowledge (in case 'fileencodings' is empty).
2993
2994 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002995 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 iconv() or as specified with 'charconvert'.
2997
Bram Moolenaar207f0092020-08-30 17:20:20 +02002998 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002999 can use: >
3000 if has("multi_byte_encoding")
3001<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 Normally 'encoding' will be equal to your current locale. This will
3003 be the default if Vim recognizes your environment settings. If
3004 'encoding' is not set to the current locale, 'termencoding' must be
3005 set to convert typed and displayed text. See |encoding-table|.
3006
3007 When you set this option, it fires the |EncodingChanged| autocommand
3008 event so that you can set up fonts if necessary.
3009
3010 When the option is set, the value is converted to lowercase. Thus
3011 you can set it with uppercase values too. Underscores are translated
3012 to '-' signs.
3013 When the encoding is recognized, it is changed to the standard name.
3014 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3015 "iso-8859-2" and "utf8" becomes "utf-8".
3016
3017 Note: "latin1" is also used when the encoding could not be detected.
3018 This only works when editing files in the same encoding! When the
3019 actual character set is not latin1, make sure 'fileencoding' and
3020 'fileencodings' are empty. When conversion is needed, switch to using
3021 utf-8.
3022
3023 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3024 You don't notice this while editing, but it does matter for the
3025 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3026 setting 'encoding' to one of these values instead of utf-8 only has
3027 effect for encoding used for files when 'fileencoding' is empty.
3028
Bram Moolenaar661b1822005-07-28 22:36:45 +00003029 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3030 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031
3032 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3033'endofline' 'eol' boolean (default on)
3034 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003036 is on, or 'fixeol' option is off, no <EOL> will be written for the
3037 last line in the file. This option is automatically set or reset when
3038 starting to edit a new file, depending on whether file has an <EOL>
3039 for the last line in the file. Normally you don't have to set or
3040 reset this option.
3041 When 'binary' is off and 'fixeol' is on the value is not used when
3042 writing the file. When 'binary' is on or 'fixeol' is off it is used
3043 to remember the presence of a <EOL> for the last line in the file, so
3044 that when you write the file the situation from the original file can
3045 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046
3047 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3048'equalalways' 'ea' boolean (default on)
3049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003051 splitting or closing a window. This also happens the moment the
3052 option is switched on. When off, splitting a window will reduce the
3053 size of the current window and leave the other windows the same. When
3054 closing a window the extra lines are given to the window next to it
3055 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 When mixing vertically and horizontally split windows, a minimal size
3057 is computed and some windows may be larger if there is room. The
3058 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003059 Changing the height and width of a window can be avoided by setting
3060 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003061 If a window size is specified when creating a new window sizes are
3062 currently not equalized (it's complicated, but may be implemented in
3063 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064
3065 *'equalprg'* *'ep'*
3066'equalprg' 'ep' string (default "")
3067 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003069 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003070 or 'indentexpr'. When Vim was compiled without internal formatting,
3071 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003072 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 about including spaces and backslashes.
3074 This option cannot be set from a |modeline| or in the |sandbox|, for
3075 security reasons.
3076
3077 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3078'errorbells' 'eb' boolean (default off)
3079 global
3080 Ring the bell (beep or screen flash) for error messages. This only
3081 makes a difference for error messages, the bell will be used always
3082 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003083 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003084 screen flash or do nothing. See 'belloff' to finetune when to ring the
3085 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086
3087 *'errorfile'* *'ef'*
3088'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3089 others: "errors.err")
3090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 {not available when compiled without the |+quickfix|
3092 feature}
3093 Name of the errorfile for the QuickFix mode (see |:cf|).
3094 When the "-q" command-line argument is used, 'errorfile' is set to the
3095 following argument. See |-q|.
3096 NOT used for the ":make" command. See 'makeef' for that.
3097 Environment variables are expanded |:set_env|.
3098 See |option-backslash| about including spaces and backslashes.
3099 This option cannot be set from a |modeline| or in the |sandbox|, for
3100 security reasons.
3101
3102 *'errorformat'* *'efm'*
3103'errorformat' 'efm' string (default is very long)
3104 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 {not available when compiled without the |+quickfix|
3106 feature}
3107 Scanf-like description of the format for the lines in the error file
3108 (see |errorformat|).
3109
3110 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3111'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3112 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 Function keys that start with an <Esc> are recognized in Insert
3114 mode. When this option is off, the cursor and function keys cannot be
3115 used in Insert mode if they start with an <Esc>. The advantage of
3116 this is that the single <Esc> is recognized immediately, instead of
3117 after one second. Instead of resetting this option, you might want to
3118 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3119 when 'esckeys' is off, you can still map anything, but the cursor keys
3120 won't work by default.
3121 NOTE: This option is set to the Vi default value when 'compatible' is
3122 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003123 NOTE: when this option is off then the |modifyOtherKeys| functionality
3124 is disabled while in Insert mode to avoid ending Insert mode with any
3125 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126
3127 *'eventignore'* *'ei'*
3128'eventignore' 'ei' string (default "")
3129 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003131 When set to "all" or when "all" is one of the items, all autocommand
3132 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003133 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 :set ei=WinEnter,WinLeave
3135<
3136 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3137'expandtab' 'et' boolean (default off)
3138 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003140 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3142 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003143 This option is reset when the 'paste' option is set and restored when
3144 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 NOTE: This option is reset when 'compatible' is set.
3146
3147 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3148'exrc' 'ex' boolean (default off)
3149 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003151 directory.
3152
3153 Setting this option is a potential security leak. E.g., consider
3154 unpacking a package or fetching files from github, a .vimrc in there
3155 might be a trojan horse. BETTER NOT SET THIS OPTION!
3156 Instead, define an autocommand in your .vimrc to set options for a
3157 matching directory.
3158
3159 If you do switch this option on you should also consider setting the
3160 'secure' option (see |initialization|).
3161 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 This option cannot be set from a |modeline| or in the |sandbox|, for
3163 security reasons.
3164
3165 *'fileencoding'* *'fenc'* *E213*
3166'fileencoding' 'fenc' string (default: "")
3167 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003168 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003169
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003171 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 When 'fileencoding' is empty, the same value as 'encoding' will be
3173 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003174 No error will be given when the value is set, only when it is used,
3175 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003176 Conversion will also be done when 'encoding' and 'fileencoding' are
3177 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3178 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003180 'encoding' is "utf-8" or another Unicode encoding, conversion
3181 is most likely done in a way that the reverse conversion
3182 results in the same text. When 'encoding' is not "utf-8" some
3183 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003184
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 See 'encoding' for the possible values. Additionally, values may be
3186 specified that can be handled by the converter, see
3187 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003188
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 When reading a file 'fileencoding' will be set from 'fileencodings'.
3190 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003191 'fileencoding', use the |++enc| argument. One exception: when
3192 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003193 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003194
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3196 When the option is set, the value is converted to lowercase. Thus
3197 you can set it with uppercase values too. '_' characters are
3198 replaced with '-'. If a name is recognized from the list for
3199 'encoding', it is replaced by the standard name. For example
3200 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003201
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 When this option is set, after starting to edit a file, the 'modified'
3203 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003204
3205 Keep in mind that changing 'fenc' from a modeline happens
3206 AFTER the text has been read, thus it applies to when the file will be
3207 written. If you do set 'fenc' in a modeline, you might want to set
3208 'nomodified' to avoid not being able to ":q".
3209
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 This option can not be changed when 'modifiable' is off.
3211
3212 *'fe'*
3213 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003214 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 old short name was 'fe', which is no longer used.
3216
3217 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003218'fileencodings' 'fencs' string (default: "ucs-bom",
3219 "ucs-bom,utf-8,default,latin1" when
3220 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222 This is a list of character encodings considered when starting to edit
3223 an existing file. When a file is read, Vim tries to use the first
3224 mentioned character encoding. If an error is detected, the next one
3225 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003226 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 an empty string, which means the value of 'encoding' is used.
3228 WARNING: Conversion can cause loss of information! When
3229 'encoding' is "utf-8" (or one of the other Unicode variants)
3230 conversion is most likely done in a way that the reverse
3231 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003232 "utf-8" some non-ASCII characters may be lost! You can use
3233 the |++bad| argument to specify what is done with characters
3234 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 For an empty file or a file with only ASCII characters most encodings
3236 will work and the first entry of 'fileencodings' will be used (except
3237 "ucs-bom", which requires the BOM to be present). If you prefer
3238 another encoding use an BufReadPost autocommand event to test if your
3239 preferred encoding is to be used. Example: >
3240 au BufReadPost * if search('\S', 'w') == 0 |
3241 \ set fenc=iso-2022-jp | endif
3242< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3243 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003244 When the |++enc| argument is used then the value of 'fileencodings' is
3245 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003246 Note that 'fileencodings' is not used for a new file, the global value
3247 of 'fileencoding' is used instead. You can set it with: >
3248 :setglobal fenc=iso-8859-2
3249< This means that a non-existing file may get a different encoding than
3250 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003251 The special value "ucs-bom" can be used to check for a Unicode BOM
3252 (Byte Order Mark) at the start of the file. It must not be preceded
3253 by "utf-8" or another Unicode encoding for this to work properly.
3254 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3255 because Vim cannot detect an error, thus the encoding is always
3256 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003257 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003258 environment. On MS-Windows this is the system encoding. Otherwise
3259 this is the default value for 'encoding'. It is useful when
3260 'encoding' is set to "utf-8" and your environment uses a non-latin1
3261 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003262 When 'encoding' is "utf-8" and a file contains an illegal byte
3263 sequence it won't be recognized as UTF-8. You can use the |8g8|
3264 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 WRONG VALUES: WHAT'S WRONG:
3266 latin1,utf-8 "latin1" will always be used
3267 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3268 file
3269 cp1250,latin1 "cp1250" will always be used
3270 If 'fileencodings' is empty, 'fileencoding' is not modified.
3271 See 'fileencoding' for the possible values.
3272 Setting this option does not have an effect until the next time a file
3273 is read.
3274
3275 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003276'fileformat' 'ff' string (MS-Windows default: "dos",
3277 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 This gives the <EOL> of the current buffer, which is used for
3280 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003281 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 unix <NL>
3283 mac <CR>
3284 When "dos" is used, CTRL-Z at the end of a file is ignored.
3285 See |file-formats| and |file-read|.
3286 For the character encoding of the file see 'fileencoding'.
3287 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003288 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 This option is set automatically when starting to edit a file and
3290 'fileformats' is not empty and 'binary' is off.
3291 When this option is set, after starting to edit a file, the 'modified'
3292 option is set, because the file would be different when written.
3293 This option can not be changed when 'modifiable' is off.
3294 For backwards compatibility: When this option is set to "dos",
3295 'textmode' is set, otherwise 'textmode' is reset.
3296
3297 *'fileformats'* *'ffs'*
3298'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003299 Vim+Vi MS-Windows: "dos,unix",
3300 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 Vi Cygwin: "unix,dos",
3302 Vi others: "")
3303 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304 This gives the end-of-line (<EOL>) formats that will be tried when
3305 starting to edit a new buffer and when reading a file into an existing
3306 buffer:
3307 - When empty, the format defined with 'fileformat' will be used
3308 always. It is not set automatically.
3309 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003310 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311 'fileformats' name will be used when a file is read into an existing
3312 buffer, no matter what 'fileformat' for that buffer is set to.
3313 - When more than one name is present, separated by commas, automatic
3314 <EOL> detection will be done when reading a file. When starting to
3315 edit a file, a check is done for the <EOL>:
3316 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3317 'fileformat' is set to "dos".
3318 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003319 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003321 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3322 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003323 This means that "mac" is only chosen when:
3324 "unix" is not present or no <NL> is found in the file, and
3325 "dos" is not present or no <CR><NL> is found in the file.
3326 Except: if "unix" was chosen, but there is a <CR> before
3327 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003328 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 4. If 'fileformat' is still not set, the first name from
3330 'fileformats' is used.
3331 When reading a file into an existing buffer, the same is done, but
3332 this happens like 'fileformat' has been set appropriately for that
3333 file only, the option is not changed.
3334 When 'binary' is set, the value of 'fileformats' is not used.
3335
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003336 When Vim starts up with an empty buffer the first item is used. You
3337 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003338
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3340 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3341 done:
3342 - When 'fileformats' is empty, there is no automatic detection. Dos
3343 format will be used.
3344 - When 'fileformats' is set to one or more names, automatic detection
3345 is done. This is based on the first <NL> in the file: If there is a
3346 <CR> in front of it, Dos format is used, otherwise Unix format is
3347 used.
3348 Also see |file-formats|.
3349 For backwards compatibility: When this option is set to an empty
3350 string or one format (no comma is included), 'textauto' is reset,
3351 otherwise 'textauto' is set.
3352 NOTE: This option is set to the Vi default value when 'compatible' is
3353 set and to the Vim default value when 'compatible' is reset.
3354
Bram Moolenaarbf884932013-04-05 22:26:15 +02003355 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3356'fileignorecase' 'fic' boolean (default on for systems where case in file
3357 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003358 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003359 When set case is ignored when using file names and directories.
3360 See 'wildignorecase' for only ignoring case when doing completion.
3361
Bram Moolenaar071d4272004-06-13 20:20:40 +00003362 *'filetype'* *'ft'*
3363'filetype' 'ft' string (default: "")
3364 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 When this option is set, the FileType autocommand event is triggered.
3366 All autocommands that match with the value of this option will be
3367 executed. Thus the value of 'filetype' is used in place of the file
3368 name.
3369 Otherwise this option does not always reflect the current file type.
3370 This option is normally set when the file type is detected. To enable
3371 this use the ":filetype on" command. |:filetype|
3372 Setting this option to a different value is most useful in a modeline,
3373 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003374 Example, for in an IDL file:
3375 /* vim: set filetype=idl : */ ~
3376 |FileType| |filetypes|
3377 When a dot appears in the value then this separates two filetype
3378 names. Example:
3379 /* vim: set filetype=c.doxygen : */ ~
3380 This will use the "c" filetype first, then the "doxygen" filetype.
3381 This works both for filetype plugins and for syntax files. More than
3382 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 This option is not copied to another buffer, independent of the 's' or
3384 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003385 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386
3387 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003388'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003390 {not available when compiled without the |+folding|
3391 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392 Characters to fill the statuslines and vertical separators.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003393 It is a comma-separated list of items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394
3395 item default Used for ~
3396 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003397 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 vert:c '|' vertical separators |:vsplit|
3399 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003400 foldopen:c '-' mark the beginning of a fold
3401 foldclose:c '+' show a closed fold
3402 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003404 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003406 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003407 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 otherwise.
3409
3410 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003411 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003412< This is similar to the default, except that these characters will also
3413 be used when there is highlighting.
3414
Bram Moolenaar008bff92021-03-04 21:55:58 +01003415 For "stl" and "stlnc" single-byte and multibyte characters are
3416 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003417
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 The highlighting used for these items:
3419 item highlight group ~
3420 stl:c StatusLine |hl-StatusLine|
3421 stlnc:c StatusLineNC |hl-StatusLineNC|
3422 vert:c VertSplit |hl-VertSplit|
3423 fold:c Folded |hl-Folded|
3424 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003425 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003427 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3428'fixendofline' 'fixeol' boolean (default on)
3429 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003430 When writing a file and this option is on, <EOL> at the end of file
3431 will be restored if missing. Turn this option off if you want to
3432 preserve the situation from the original file.
3433 When the 'binary' option is set the value of this option doesn't
3434 matter.
3435 See the 'endofline' option.
3436
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003438'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 {only available when compiled with the |+rightleft|
3441 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003442 This option was for using Farsi, which has been removed. See
3443 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444
3445 *'foldclose'* *'fcl'*
3446'foldclose' 'fcl' string (default "")
3447 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448 {not available when compiled without the |+folding|
3449 feature}
3450 When set to "all", a fold is closed when the cursor isn't in it and
3451 its level is higher than 'foldlevel'. Useful if you want folds to
3452 automatically close when moving out of them.
3453
3454 *'foldcolumn'* *'fdc'*
3455'foldcolumn' 'fdc' number (default 0)
3456 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457 {not available when compiled without the |+folding|
3458 feature}
3459 When non-zero, a column with the specified width is shown at the side
3460 of the window which indicates open and closed folds. The maximum
3461 value is 12.
3462 See |folding|.
3463
3464 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3465'foldenable' 'fen' boolean (default on)
3466 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467 {not available when compiled without the |+folding|
3468 feature}
3469 When off, all folds are open. This option can be used to quickly
3470 switch between showing all text unfolded and viewing the text with
3471 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003472 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 'foldenable' is off.
3474 This option is set by commands that create a new fold or close a fold.
3475 See |folding|.
3476
3477 *'foldexpr'* *'fde'*
3478'foldexpr' 'fde' string (default: "0")
3479 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003481 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003483 for each line to obtain its fold level. The context is set to the
3484 script where 'foldexpr' was set, script-local items can be accessed.
3485 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003486
Bram Moolenaar30b65812012-07-12 22:01:11 +02003487 The expression will be evaluated in the |sandbox| if set from a
3488 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003489 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003490 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003491
3492 It is not allowed to change text or jump to another window while
3493 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494
3495 *'foldignore'* *'fdi'*
3496'foldignore' 'fdi' string (default: "#")
3497 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 {not available when compiled without the |+folding|
3499 feature}
3500 Used only when 'foldmethod' is "indent". Lines starting with
3501 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003502 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 The default "#" works well for C programs. See |fold-indent|.
3504
3505 *'foldlevel'* *'fdl'*
3506'foldlevel' 'fdl' number (default: 0)
3507 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003508 {not available when compiled without the |+folding|
3509 feature}
3510 Sets the fold level: Folds with a higher level will be closed.
3511 Setting this option to zero will close all folds. Higher numbers will
3512 close fewer folds.
3513 This option is set by commands like |zm|, |zM| and |zR|.
3514 See |fold-foldlevel|.
3515
3516 *'foldlevelstart'* *'fdls'*
3517'foldlevelstart' 'fdls' number (default: -1)
3518 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519 {not available when compiled without the |+folding|
3520 feature}
3521 Sets 'foldlevel' when starting to edit another buffer in a window.
3522 Useful to always start editing with all folds closed (value zero),
3523 some folds closed (one) or no folds closed (99).
3524 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003525 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 ignores this option and closes all folds.
3527 It is also done before BufReadPre autocommands, to allow an autocmd to
3528 overrule the 'foldlevel' value for specific files.
3529 When the value is negative, it is not used.
3530
3531 *'foldmarker'* *'fmr'* *E536*
3532'foldmarker' 'fmr' string (default: "{{{,}}}")
3533 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 {not available when compiled without the |+folding|
3535 feature}
3536 The start and end marker used when 'foldmethod' is "marker". There
3537 must be one comma, which separates the start and end marker. The
3538 marker is a literal string (a regular expression would be too slow).
3539 See |fold-marker|.
3540
3541 *'foldmethod'* *'fdm'*
3542'foldmethod' 'fdm' string (default: "manual")
3543 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 {not available when compiled without the |+folding|
3545 feature}
3546 The kind of folding used for the current window. Possible values:
3547 |fold-manual| manual Folds are created manually.
3548 |fold-indent| indent Lines with equal indent form a fold.
3549 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3550 |fold-marker| marker Markers are used to specify folds.
3551 |fold-syntax| syntax Syntax highlighting items specify folds.
3552 |fold-diff| diff Fold text that is not changed.
3553
3554 *'foldminlines'* *'fml'*
3555'foldminlines' 'fml' number (default: 1)
3556 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 {not available when compiled without the |+folding|
3558 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003559 Sets the number of screen lines above which a fold can be displayed
3560 closed. Also for manually closed folds. With the default value of
3561 one a fold can only be closed if it takes up two or more screen lines.
3562 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003563 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564 "zc" to close a fold, which is displayed open because it's smaller
3565 than 'foldminlines', a following "zc" may close a containing fold.
3566
3567 *'foldnestmax'* *'fdn'*
3568'foldnestmax' 'fdn' number (default: 20)
3569 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 {not available when compiled without the |+folding|
3571 feature}
3572 Sets the maximum nesting of folds for the "indent" and "syntax"
3573 methods. This avoids that too many folds will be created. Using more
3574 than 20 doesn't work, because the internal limit is 20.
3575
3576 *'foldopen'* *'fdo'*
3577'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3578 search,tag,undo")
3579 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 {not available when compiled without the |+folding|
3581 feature}
3582 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003583 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003585 NOTE: When the command is part of a mapping this option is not used.
3586 Add the |zv| command to the mapping to get the same effect.
3587 (rationale: the mapping may want to control opening folds itself)
3588
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 item commands ~
3590 all any
3591 block "(", "{", "[[", "[{", etc.
3592 hor horizontal movements: "l", "w", "fx", etc.
3593 insert any command in Insert mode
3594 jump far jumps: "G", "gg", etc.
3595 mark jumping to a mark: "'m", CTRL-O, etc.
3596 percent "%"
3597 quickfix ":cn", ":crew", ":make", etc.
3598 search search for a pattern: "/", "n", "*", "gd", etc.
3599 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003600 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 tag jumping to a tag: ":ta", CTRL-T, etc.
3602 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 When a movement command is used for an operator (e.g., "dl" or "y%")
3604 this option is not used. This means the operator will include the
3605 whole closed fold.
3606 Note that vertical movements are not here, because it would make it
3607 very difficult to move onto a closed fold.
3608 In insert mode the folds containing the cursor will always be open
3609 when text is inserted.
3610 To close folds you can re-apply 'foldlevel' with the |zx| command or
3611 set the 'foldclose' option to "all".
3612
3613 *'foldtext'* *'fdt'*
3614'foldtext' 'fdt' string (default: "foldtext()")
3615 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 {not available when compiled without the |+folding|
3617 feature}
3618 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003619 fold. The context is set to the script where 'foldexpr' was set,
3620 script-local items can be accessed. See |fold-foldtext| for the
3621 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622
Bram Moolenaar30b65812012-07-12 22:01:11 +02003623 The expression will be evaluated in the |sandbox| if set from a
3624 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003625 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003626
3627 It is not allowed to change text or jump to another window while
3628 evaluating 'foldtext' |textlock|.
3629
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003630 *'formatexpr'* *'fex'*
3631'formatexpr' 'fex' string (default "")
3632 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003633 {not available when compiled without the |+eval|
3634 feature}
3635 Expression which is evaluated to format a range of lines for the |gq|
3636 operator or automatic formatting (see 'formatoptions'). When this
3637 option is empty 'formatprg' is used.
3638
3639 The |v:lnum| variable holds the first line to be formatted.
3640 The |v:count| variable holds the number of lines to be formatted.
3641 The |v:char| variable holds the character that is going to be
3642 inserted if the expression is being evaluated due to
3643 automatic formatting. This can be empty. Don't insert
3644 it yet!
3645
3646 Example: >
3647 :set formatexpr=mylang#Format()
3648< This will invoke the mylang#Format() function in the
3649 autoload/mylang.vim file in 'runtimepath'. |autoload|
3650
3651 The expression is also evaluated when 'textwidth' is set and adding
3652 text beyond that limit. This happens under the same conditions as
3653 when internal formatting is used. Make sure the cursor is kept in the
3654 same spot relative to the text then! The |mode()| function will
3655 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003656
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003657 When the expression evaluates to non-zero Vim will fall back to using
3658 the internal format mechanism.
3659
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003660 If the expression starts with s: or |<SID>|, then it is replaced with
3661 the script ID (|local-function|). Example: >
3662 set formatexpr=s:MyFormatExpr()
3663 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003664< Otherwise, the expression is evaluated in the context of the script
3665 where the option was set, thus script-local items are available.
3666
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003667 The expression will be evaluated in the |sandbox| when set from a
3668 modeline, see |sandbox-option|. That stops the option from working,
3669 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003670 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003671 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003672
Bram Moolenaar86b68352004-12-27 21:59:20 +00003673 *'formatlistpat'* *'flp'*
3674'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3675 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003676 A pattern that is used to recognize a list header. This is used for
3677 the "n" flag in 'formatoptions'.
3678 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003679 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003680 while still checking more characters. There must be a character
3681 following the pattern, when it matches the whole line it is handled
3682 like there is no match.
3683 The default recognizes a number, followed by an optional punctuation
3684 character and white space.
3685
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003686 *'formatoptions'* *'fo'*
3687'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3688 local to buffer
3689 This is a sequence of letters which describes how automatic
3690 formatting is to be done. See |fo-table|. When the 'paste' option is
3691 on, no formatting is done (like 'formatoptions' is empty). Commas can
3692 be inserted for readability.
3693 To avoid problems with flags that are added in the future, use the
3694 "+=" and "-=" feature of ":set" |add-option-flags|.
3695 NOTE: This option is set to the Vi default value when 'compatible' is
3696 set and to the Vim default value when 'compatible' is reset.
3697
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 *'formatprg'* *'fp'*
3699'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003700 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003702 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003704 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003705 If the 'formatexpr' option is not empty it will be used instead.
3706 Otherwise, if 'formatprg' option is an empty string, the internal
3707 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003708 Environment variables are expanded |:set_env|. See |option-backslash|
3709 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003710 This option cannot be set from a |modeline| or in the |sandbox|, for
3711 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712
Bram Moolenaard94464e2015-11-02 15:28:18 +01003713 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003714'fsync' 'fs' boolean (default on)
3715 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003716 When on, the library function fsync() will be called after writing a
3717 file. This will flush a file to disk, ensuring that it is safely
3718 written even on filesystems which do metadata-only journaling. This
3719 will force the harddrive to spin up on Linux systems running in laptop
3720 mode, so it may be undesirable in some situations. Be warned that
3721 turning this off increases the chances of data loss after a crash. On
3722 systems without an fsync() implementation, this variable is always
3723 off.
3724 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003725 'fsync' also applies to |writefile()| (unless a flag is used to
3726 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003727 This option cannot be set from a |modeline| or in the |sandbox|, for
3728 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003729
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3731'gdefault' 'gd' boolean (default off)
3732 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 When on, the ":substitute" flag 'g' is default on. This means that
3734 all matches in a line are substituted instead of one. When a 'g' flag
3735 is given to a ":substitute" command, this will toggle the substitution
3736 of all or one match. See |complex-change|.
3737
3738 command 'gdefault' on 'gdefault' off ~
3739 :s/// subst. all subst. one
3740 :s///g subst. one subst. all
3741 :s///gg subst. all subst. one
3742
3743 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003744 DEPRECATED: Setting this option may break plugins that are not aware
3745 of this option. Also, many users get confused that adding the /g flag
3746 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003747 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748
3749 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003750'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 Format to recognize for the ":grep" command output.
3753 This is a scanf-like string that uses the same format as the
3754 'errorformat' option: see |errorformat|.
3755
3756 *'grepprg'* *'gp'*
3757'grepprg' 'gp' string (default "grep -n ",
3758 Unix: "grep -n $* /dev/null",
3759 Win32: "findstr /n" or "grep -n",
3760 VMS: "SEARCH/NUMBERS ")
3761 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003762 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 and '#' characters, which are expanded like when used in a command-
3764 line. The placeholder "$*" is allowed to specify where the arguments
3765 will be included. Environment variables are expanded |:set_env|. See
3766 |option-backslash| about including spaces and backslashes.
3767 When your "grep" accepts the "-H" argument, use this to make ":grep"
3768 also work well with a single file: >
3769 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003770< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003771 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3772 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003773 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 apply equally to 'grepprg'.
3775 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3776 otherwise it's "grep -n".
3777 This option cannot be set from a |modeline| or in the |sandbox|, for
3778 security reasons.
3779
3780 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3781'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3782 ve:ver35-Cursor,
3783 o:hor50-Cursor,
3784 i-ci:ver25-Cursor/lCursor,
3785 r-cr:hor20-Cursor/lCursor,
3786 sm:block-Cursor
3787 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003788 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 "n-v-c:block,o:hor50,i-ci:hor15,
3790 r-cr:hor30,sm:block")
3791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003793 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003795 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003796 height of the cursor can be changed. This can be done by specifying a
3797 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003798 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3799 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003801 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 mode-list and an argument-list:
3803 mode-list:argument-list,mode-list:argument-list,..
3804 The mode-list is a dash separated list of these modes:
3805 n Normal mode
3806 v Visual mode
3807 ve Visual mode with 'selection' "exclusive" (same as 'v',
3808 if not specified)
3809 o Operator-pending mode
3810 i Insert mode
3811 r Replace mode
3812 c Command-line Normal (append) mode
3813 ci Command-line Insert mode
3814 cr Command-line Replace mode
3815 sm showmatch in Insert mode
3816 a all modes
3817 The argument-list is a dash separated list of these arguments:
3818 hor{N} horizontal bar, {N} percent of the character height
3819 ver{N} vertical bar, {N} percent of the character width
3820 block block cursor, fills the whole character
3821 [only one of the above three should be present]
3822 blinkwait{N} *cursor-blinking*
3823 blinkon{N}
3824 blinkoff{N}
3825 blink times for cursor: blinkwait is the delay before
3826 the cursor starts blinking, blinkon is the time that
3827 the cursor is shown and blinkoff is the time that the
3828 cursor is not shown. The times are in msec. When one
3829 of the numbers is zero, there is no blinking. The
3830 default is: "blinkwait700-blinkon400-blinkoff250".
3831 These numbers are used for a missing entry. This
3832 means that blinking is enabled by default. To switch
3833 blinking off you can use "blinkon0". The cursor only
3834 blinks when Vim is waiting for input, not while
3835 executing a command.
3836 To make the cursor blink in an xterm, see
3837 |xterm-blink|.
3838 {group-name}
3839 a highlight group name, that sets the color and font
3840 for the cursor
3841 {group-name}/{group-name}
3842 Two highlight group names, the first is used when
3843 no language mappings are used, the other when they
3844 are. |language-mapping|
3845
3846 Examples of parts:
3847 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3848 block cursor with colors from the "nCursor"
3849 highlight group
3850 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3851 In Insert and Command-line Insert mode, use a
3852 30% vertical bar cursor with colors from the
3853 "iCursor" highlight group. Blink a bit
3854 faster.
3855
3856 The 'a' mode is different. It will set the given argument-list for
3857 all modes. It does not reset anything to defaults. This can be used
3858 to do a common setting for all modes. For example, to switch off
3859 blinking: "a:blinkon0"
3860
3861 Examples of cursor highlighting: >
3862 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3863 :highlight Cursor gui=NONE guifg=bg guibg=fg
3864<
3865 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003866 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867'guifont' 'gfn' string (default "")
3868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 {only available when compiled with GUI enabled}
3870 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003871 In its simplest form the value is just one font name.
3872 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873
3874 *'guifontset'* *'gfs'*
3875 *E250* *E252* *E234* *E597* *E598*
3876'guifontset' 'gfs' string (default "")
3877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 {only available when compiled with GUI enabled and
3879 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003880 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 When not empty, specifies two (or more) fonts to be used. The first
3882 one for normal English, the second one for your special language. See
3883 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003884
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3886'guifontwide' 'gfw' string (default "")
3887 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 {only available when compiled with GUI enabled}
3889 When not empty, specifies a comma-separated list of fonts to be used
3890 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003891 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003892
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 *'guiheadroom'* *'ghr'*
3894'guiheadroom' 'ghr' number (default 50)
3895 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003896 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 The number of pixels subtracted from the screen height when fitting
3898 the GUI window on the screen. Set this before the GUI is started,
3899 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003900 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 lines will be left for window decorations and other items on the
3902 screen. Set it to a negative value to allow windows taller than the
3903 screen.
3904
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003905 *'guiligatures'* *'gli'* *E1243*
3906'guiligatures' 'gli' string (default "")
3907 global
3908 {only for GTK GUI}
3909 List of ASCII characters that, when combined together, can create more
3910 complex shapes. Each character must be a printable ASCII character
3911 with a value in the 32-127 range.
3912 Example: >
3913 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3914< Changing this option updates screen output immediately. Set it to an
3915 empty string to disable ligatures.
3916
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003918'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3919 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003920 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003921 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003924 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 sequence of letters which describes what components and options of the
3926 GUI should be used.
3927 To avoid problems with flags that are added in the future, use the
3928 "+=" and "-=" feature of ":set" |add-option-flags|.
3929
Bram Moolenaar13568252018-03-16 20:46:58 +01003930 Valid characters are as follows:
3931 *'go-!'*
3932 '!' External commands are executed in a terminal window. Without
3933 this flag the MS-Windows GUI will open a console window to
3934 execute the command. The Unix GUI will simulate a dumb
3935 terminal to list the command output.
3936 The terminal window will be positioned at the bottom, and grow
3937 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003938 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 'a' Autoselect: If present, then whenever VISUAL mode is started,
3940 or the Visual area extended, Vim tries to become the owner of
3941 the windowing system's global selection. This means that the
3942 Visually highlighted text is available for pasting into other
3943 applications as well as into Vim itself. When the Visual mode
3944 ends, possibly due to an operation on the text, or when an
3945 application wants to paste the selection, the highlighted text
3946 is automatically yanked into the "* selection register.
3947 Thus the selection is still available for pasting into other
3948 applications after the VISUAL mode has ended.
3949 If not present, then Vim won't become the owner of the
3950 windowing system's global selection unless explicitly told to
3951 by a yank or delete operation for the "* register.
3952 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003953 *'go-P'*
3954 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003955 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003956 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003957 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 applies to the modeless selection.
3959
3960 'guioptions' autoselect Visual autoselect modeless ~
3961 "" - -
3962 "a" yes yes
3963 "A" - yes
3964 "aA" yes yes
3965
Bram Moolenaar02467872007-05-06 13:22:01 +00003966 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 'c' Use console dialogs instead of popup dialogs for simple
3968 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003969 *'go-d'*
3970 'd' Use dark theme variant if available. Currently only works for
3971 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003972 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003973 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003974 'guitablabel' can be used to change the text in the labels.
3975 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003976 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003977 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003978 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 'f' Foreground: Don't use fork() to detach the GUI from the shell
3980 where it was started. Use this for programs that wait for the
3981 editor to finish (e.g., an e-mail program). Alternatively you
3982 can use "gvim -f" or ":gui -f" to start the GUI in the
3983 foreground. |gui-fork|
3984 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003985 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003986 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3988 corner of the window. It's black&white on non-GTK, because of
3989 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003990 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003992 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003993 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003995 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003997 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003998 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 'g' Grey menu items: Make menu items that are not active grey. If
4000 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004001 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 't' Include tearoff menu items. Currently only works for Win32,
4003 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004004 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004005 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4006 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004007 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004009 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 'R' Right-hand scrollbar is present when there is a vertically
4011 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004012 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004014 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 'L' Left-hand scrollbar is present when there is a vertically
4016 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004017 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4019 the longest visible line, or on the cursor line if the 'h'
4020 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004021 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 'h' Limit horizontal scrollbar size to the length of the cursor
4023 line. Reduces computations. |gui-horiz-scroll|
4024
4025 And yes, you may even have scrollbars on the left AND the right if
4026 you really want to :-). See |gui-scrollbars| for more information.
4027
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004028 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 'v' Use a vertical button layout for dialogs. When not included,
4030 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004031 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004032 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 'p' Use Pointer callbacks for X11 GUI. This is required for some
4034 window managers. If the cursor is not blinking or hollow at
4035 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004036 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004038 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004039 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004040 *'go-k'*
4041 'k' Keep the GUI window size when adding/removing a scrollbar, or
4042 toolbar, tabline, etc. Instead, the behavior is similar to
4043 when the window is maximized and will adjust 'lines' and
4044 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004045 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004046 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004047
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 *'guipty'* *'noguipty'*
4049'guipty' boolean (default on)
4050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051 {only available when compiled with GUI enabled}
4052 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4053 I/O to/from shell commands. See |gui-pty|.
4054
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004055 *'guitablabel'* *'gtl'*
4056'guitablabel' 'gtl' string (default empty)
4057 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004058 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004059 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004060 pages line. When empty and when the result is empty Vim will use a
4061 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004062
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004063 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004064 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004065 The expression will be evaluated in the |sandbox| when set from a
4066 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004067 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004068
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004069 Only used when the GUI tab pages line is displayed. 'e' must be
4070 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4071 used.
4072
Bram Moolenaar57657d82006-04-21 22:12:41 +00004073 *'guitabtooltip'* *'gtt'*
4074'guitabtooltip' 'gtt' 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 tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004078 pages line. When empty Vim will use a default tooltip.
4079 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004080 You can include a line break. Simplest method is to use |:let|: >
4081 :let &guitabtooltip = "line one\nline two"
4082<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004083
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004085'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004086 (others) "$VIMRUNTIME/doc/help.txt")
4087 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088 Name of the main help file. All distributed help files should be
4089 placed together in one directory. Additionally, all "doc" directories
4090 in 'runtimepath' will be used.
4091 Environment variables are expanded |:set_env|. For example:
4092 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004093 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094 spaces and backslashes.
4095 This option cannot be set from a |modeline| or in the |sandbox|, for
4096 security reasons.
4097
4098 *'helpheight'* *'hh'*
4099'helpheight' 'hh' number (default 20)
4100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 Minimal initial height of the help window when it is opened with the
4102 ":help" command. The initial height of the help window is half of the
4103 current window, or (when the 'ea' option is on) the same as other
4104 windows. When the height is less than 'helpheight', the height is
4105 set to 'helpheight'. Set to zero to disable.
4106
4107 *'helplang'* *'hlg'*
4108'helplang' 'hlg' string (default: messages language or empty)
4109 global
4110 {only available when compiled with the |+multi_lang|
4111 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004112 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 for which the desired help can be found. The English help will always
4114 be used as a last resort. You can add "en" to prefer English over
4115 another language, but that will only find tags that exist in that
4116 language and not in the English help.
4117 Example: >
4118 :set helplang=de,it
4119< This will first search German, then Italian and finally English help
4120 files.
4121 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4122 try to find the tag in the current language before using this option.
4123 See |help-translated|.
4124
4125 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4126'hidden' 'hid' boolean (default off)
4127 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 When off a buffer is unloaded when it is |abandon|ed. When on a
4129 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4130 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004131
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004133 hidden even if the 'hidden' option is off when these three are true:
4134 - the buffer is modified
4135 - 'autowrite' is off or writing is not possible
4136 - the '!' flag was used
4137 Also see |windows.txt|.
4138
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004139 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140 This option is set for one command with ":hide {command}" |:hide|.
4141 WARNING: It's easy to forget that you have changes in hidden buffers.
4142 Think twice when using ":q!" or ":qa!".
4143
4144 *'highlight'* *'hl'*
4145'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004146 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4147 d:Directory,e:ErrorMsg,i:IncSearch,
4148 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004149 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004150 N:CursorLineNr,r:Question,s:StatusLine,
4151 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004152 v:Visual,V:VisualNOS,w:WarningMsg,
4153 W:WildMenu,f:Folded,F:FoldColumn,
4154 A:DiffAdd,C:DiffChange,D:DiffDelete,
4155 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004156 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004157 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004158 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4159 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004160 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004161 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004164 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004165 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004166 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004168 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4169 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170 characters from 'showbreak'
4171 |hl-Directory| d directories in CTRL-D listing and other special
4172 things in listings
4173 |hl-ErrorMsg| e error messages
4174 h (obsolete, ignored)
4175 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004176 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4178 |hl-MoreMsg| m |more-prompt|
4179 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004180 |hl-LineNr| n line number for ":number" and ":#" commands, and
4181 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004182 |hl-LineNrAbove| a line number above the cursor for when the
4183 'relativenumber' option is set.
4184 |hl-LineNrBelow| b line number below the cursor for when the
4185 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004186 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4187 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188 |hl-Question| r |hit-enter| prompt and yes/no questions
4189 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004190 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4192 |hl-VertSplit| c column used to separate vertically split windows
4193 |hl-Visual| v Visual mode
4194 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4195 Selection" Only X11 Gui's |gui-x11| and
4196 |xterm-clipboard|.
4197 |hl-WarningMsg| w warning messages
4198 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4199 |hl-Folded| f line used for closed folds
4200 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004201 |hl-DiffAdd| A added line in diff mode
4202 |hl-DiffChange| C changed line in diff mode
4203 |hl-DiffDelete| D deleted line in diff mode
4204 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004206 |hl-Conceal| - the placeholders used for concealed characters
4207 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004208 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004209 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004210 |hl-SpellRare| R rare word |spell|
4211 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004212 |hl-Pmenu| + popup menu normal line
4213 |hl-PmenuSel| = popup menu selected line
4214 |hl-PmenuSbar| x popup menu scrollbar
4215 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216
4217 The display modes are:
4218 r reverse (termcap entry "mr" and "me")
4219 i italic (termcap entry "ZH" and "ZR")
4220 b bold (termcap entry "md" and "me")
4221 s standout (termcap entry "so" and "se")
4222 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004223 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004224 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 n no highlighting
4226 - no highlighting
4227 : use a highlight group
4228 The default is used for occasions that are not included.
4229 If you want to change what the display modes do, see |dos-colors|
4230 for an example.
4231 When using the ':' display mode, this must be followed by the name of
4232 a highlight group. A highlight group can be used to define any type
4233 of highlighting, including using color. See |:highlight| on how to
4234 define one. The default uses a different group for each occasion.
4235 See |highlight-default| for the default highlight groups.
4236
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004238'history' 'hi' number (Vim default: 50, Vi default: 0,
4239 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004241 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004242 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004244 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245 NOTE: This option is set to the Vi default value when 'compatible' is
4246 set and to the Vim default value when 'compatible' is reset.
4247
4248 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4249'hkmap' 'hk' boolean (default off)
4250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251 {only available when compiled with the |+rightleft|
4252 feature}
4253 When on, the keyboard is mapped for the Hebrew character set.
4254 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4255 toggle this option. See |rileft.txt|.
4256 NOTE: This option is reset when 'compatible' is set.
4257
4258 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4259'hkmapp' 'hkp' boolean (default off)
4260 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 {only available when compiled with the |+rightleft|
4262 feature}
4263 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4264 This is useful if you have a non-Hebrew keyboard.
4265 See |rileft.txt|.
4266 NOTE: This option is reset when 'compatible' is set.
4267
Bram Moolenaar036986f2017-03-16 17:41:02 +01004268 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4269'hlsearch' 'hls' boolean (default off)
4270 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004271 {not available when compiled without the
4272 |+extra_search| feature}
4273 When there is a previous search pattern, highlight all its matches.
4274 The type of highlighting used can be set with the 'l' occasion in the
4275 'highlight' option. This uses the "Search" highlight group by
4276 default. Note that only the matching text is highlighted, any offsets
4277 are not applied.
4278 See also: 'incsearch' and |:match|.
4279 When you get bored looking at the highlighted matches, you can turn it
4280 off with |:nohlsearch|. This does not change the option value, as
4281 soon as you use a search command, the highlighting comes back.
4282 'redrawtime' specifies the maximum time spent on finding matches.
4283 When the search pattern can match an end-of-line, Vim will try to
4284 highlight all of the matched text. However, this depends on where the
4285 search starts. This will be the first line in the window or the first
4286 line below a closed fold. A match in a previous line which is not
4287 drawn may not continue in a newly drawn line.
4288 You can specify whether the highlight status is restored on startup
4289 with the 'h' flag in 'viminfo' |viminfo-h|.
4290 NOTE: This option is reset when 'compatible' is set.
4291
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 *'icon'* *'noicon'*
4293'icon' boolean (default off, on when title can be restored)
4294 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 When on, the icon text of the window will be set to the value of
4296 'iconstring' (if it is not empty), or to the name of the file
4297 currently being edited. Only the last part of the name is used.
4298 Overridden by the 'iconstring' option.
4299 Only works if the terminal supports setting window icons (currently
4300 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4301 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4302 builtin termcap).
4303 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004304 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004306 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307
4308 *'iconstring'*
4309'iconstring' string (default "")
4310 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 When this option is not empty, it will be used for the icon text of
4312 the window. This happens only when the 'icon' option is on.
4313 Only works if the terminal supports setting window icon text
4314 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004315 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 When Vim was compiled with HAVE_X11 defined, the original icon will be
4317 restored if possible |X11|.
4318 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004319 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004321 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 {not available when compiled without the |+statusline| feature}
4323
4324 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4325'ignorecase' 'ic' boolean (default off)
4326 global
4327 Ignore case in search patterns. Also used when searching in the tags
4328 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004329 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330 Can be overruled by using "\c" or "\C" in the pattern, see
4331 |/ignorecase|.
4332
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004333 *'imactivatefunc'* *'imaf'*
4334'imactivatefunc' 'imaf' string (default "")
4335 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004336 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004337 activate or deactivate the Input Method. The value can be the name of
4338 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4339 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004340 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004341 The expression will be evaluated in the |sandbox| when set from a
4342 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004343
4344 Example: >
4345 function ImActivateFunc(active)
4346 if a:active
4347 ... do something
4348 else
4349 ... do something
4350 endif
4351 " return value is not used
4352 endfunction
4353 set imactivatefunc=ImActivateFunc
4354<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 *'imactivatekey'* *'imak'*
4356'imactivatekey' 'imak' string (default "")
4357 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004359 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 Specifies the key that your Input Method in X-Windows uses for
4361 activation. When this is specified correctly, vim can fully control
4362 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4363 You can't use this option to change the activation key, the option
4364 tells Vim what the key is.
4365 Format:
4366 [MODIFIER_FLAG-]KEY_STRING
4367
4368 These characters can be used for MODIFIER_FLAG (case is ignored):
4369 S Shift key
4370 L Lock key
4371 C Control key
4372 1 Mod1 key
4373 2 Mod2 key
4374 3 Mod3 key
4375 4 Mod4 key
4376 5 Mod5 key
4377 Combinations are allowed, for example "S-C-space" or "SC-space" are
4378 both shift+ctrl+space.
4379 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4380
4381 Example: >
4382 :set imactivatekey=S-space
4383< "S-space" means shift+space. This is the activation key for kinput2 +
4384 canna (Japanese), and ami (Korean).
4385
4386 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4387'imcmdline' 'imc' boolean (default off)
4388 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 When set the Input Method is always on when starting to edit a command
4390 line, unless entering a search pattern (see 'imsearch' for that).
4391 Setting this option is useful when your input method allows entering
4392 English characters directly, e.g., when it's used to type accented
4393 characters with dead keys.
4394
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004395 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4397 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398 When set the Input Method is never used. This is useful to disable
4399 the IM when it doesn't work properly.
4400 Currently this option is on by default for SGI/IRIX machines. This
4401 may change in later releases.
4402
4403 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004404'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 Specifies whether :lmap or an Input Method (IM) is to be used in
4407 Insert mode. Valid values:
4408 0 :lmap is off and IM is off
4409 1 :lmap is ON and IM is off
4410 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 To always reset the option to zero when leaving Insert mode with <Esc>
4412 this can be used: >
4413 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4414< This makes :lmap and IM turn off automatically when leaving Insert
4415 mode.
4416 Note that this option changes when using CTRL-^ in Insert mode
4417 |i_CTRL-^|.
4418 The value is set to 1 when setting 'keymap' to a valid keymap name.
4419 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004420 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 methods. Use 'imdisable' to disable XIM then.
4422
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004423 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004424 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004425 |+multi_byte_ime| or |global-ime|.
4426
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004428'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004429 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430 Specifies whether :lmap or an Input Method (IM) is to be used when
4431 entering a search pattern. Valid values:
4432 -1 the value of 'iminsert' is used, makes it look like
4433 'iminsert' is also used when typing a search pattern
4434 0 :lmap is off and IM is off
4435 1 :lmap is ON and IM is off
4436 2 :lmap is off and IM is ON
4437 Note that this option changes when using CTRL-^ in Command-line mode
4438 |c_CTRL-^|.
4439 The value is set to 1 when it is not -1 and setting the 'keymap'
4440 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004441 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442 methods. Use 'imdisable' to disable XIM then.
4443
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004444 *'imstatusfunc'* *'imsf'*
4445'imstatusfunc' 'imsf' string (default "")
4446 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004447 This option specifies a function that is called to obtain the status
4448 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004449 The value can be the name of a function, a |lambda| or a |Funcref|.
4450 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004451 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004452
4453 Example: >
4454 function ImStatusFunc()
4455 let is_active = ...do something
4456 return is_active ? 1 : 0
4457 endfunction
4458 set imstatusfunc=ImStatusFunc
4459<
4460 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004461 The expression will be evaluated in the |sandbox| when set from a
4462 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004463
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004464 *'imstyle'* *'imst'*
4465'imstyle' 'imst' number (default 1)
4466 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004467 {only available when compiled with |+xim| and
4468 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004469 This option specifies the input style of Input Method:
4470 0 use on-the-spot style
4471 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004472 See: |xim-input-style|
4473
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004474 For a long time on-the-spot style had been used in the GTK version of
4475 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004476 |single-repeat|, etc. Therefore over-the-spot style becomes the
4477 default now. This should work fine for most people, however if you
4478 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004479 The expression will be evaluated in the |sandbox| when set from a
4480 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004481
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482 *'include'* *'inc'*
4483'include' 'inc' string (default "^\s*#\s*include")
4484 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 {not available when compiled without the
4486 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004487 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 pattern, just like for the "/" command (See |pattern|). The default
4489 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004490 "]I", "[d", etc.
4491 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004492 comes after the matched pattern. But if "\zs" appears in the pattern
4493 then the text matched from "\zs" to the end, or until "\ze" if it
4494 appears, is used as the file name. Use this to include characters
4495 that are not in 'isfname', such as a space. You can then use
4496 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004497 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498
4499 *'includeexpr'* *'inex'*
4500'includeexpr' 'inex' string (default "")
4501 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004502 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004503 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004505 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 :set includeexpr=substitute(v:fname,'\\.','/','g')
4507< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004508
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004510 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511 Also used for |<cfile>|.
4512
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004513 If the expression starts with s: or |<SID>|, then it is replaced with
4514 the script ID (|local-function|). Example: >
4515 set includeexpr=s:MyIncludeExpr(v:fname)
4516 set includeexpr=<SID>SomeIncludeExpr(v:fname)
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004517< Otherwise, the expression is evaluated in the context of the script
4518 where the option was set, thus script-local items are available.
4519
Bram Moolenaar30b65812012-07-12 22:01:11 +02004520 The expression will be evaluated in the |sandbox| when set from a
4521 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004522 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004523
4524 It is not allowed to change text or jump to another window while
4525 evaluating 'includeexpr' |textlock|.
4526
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004528'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4529 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004532 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004533 While typing a search command, show where the pattern, as it was typed
4534 so far, matches. The matched string is highlighted. If the pattern
4535 is invalid or not found, nothing is shown. The screen will be updated
4536 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004537 Also applies to the pattern in commands: >
4538 :global
4539 :lvimgrep
4540 :lvimgrepadd
4541 :smagic
4542 :snomagic
4543 :sort
4544 :substitute
4545 :vglobal
4546 :vimgrep
4547 :vimgrepadd
4548< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004549 original position when no match is found and when pressing <Esc>. You
4550 still need to finish the search command with <Enter> to move the
4551 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004552 You can use the CTRL-G and CTRL-T keys to move to the next and
4553 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004554 When compiled with the |+reltime| feature Vim only searches for about
4555 half a second. With a complicated pattern and/or a lot of text the
4556 match may not be found. This is to avoid that Vim hangs while you
4557 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004558 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004559 When 'hlsearch' is on, all matched strings are highlighted too while
4560 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004561 If you don't want to turn 'hlsearch' on, but want to highlight all
4562 matches while searching, you can turn on and off 'hlsearch' with
4563 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004564 augroup vimrc-incsearch-highlight
4565 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004566 autocmd CmdlineEnter /,\? :set hlsearch
4567 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004568 augroup END
4569<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004570 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004571 to the command line. If 'ignorecase' and 'smartcase' are set and the
4572 command line has no uppercase characters, the added character is
4573 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004574 CTRL-R CTRL-W can be used to add the word at the end of the current
4575 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 NOTE: This option is reset when 'compatible' is set.
4577
4578 *'indentexpr'* *'inde'*
4579'indentexpr' 'inde' string (default "")
4580 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 {not available when compiled without the |+cindent|
4582 or |+eval| features}
4583 Expression which is evaluated to obtain the proper indent for a line.
4584 It is used when a new line is created, for the |=| operator and
4585 in Insert mode as specified with the 'indentkeys' option.
4586 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004587 'smartindent' indenting. When 'lisp' is set, this option is
4588 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 When 'paste' is set this option is not used for indenting.
4590 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004591 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004593
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004594 If the expression starts with s: or |<SID>|, then it is replaced with
4595 the script ID (|local-function|). Example: >
4596 set indentexpr=s:MyIndentExpr()
4597 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004598< Otherwise, the expression is evaluated in the context of the script
4599 where the option was set, thus script-local items are available.
4600
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 The expression must return the number of spaces worth of indent. It
4602 can return "-1" to keep the current indent (this means 'autoindent' is
4603 used for the indent).
4604 Functions useful for computing the indent are |indent()|, |cindent()|
4605 and |lispindent()|.
4606 The evaluation of the expression must not have side effects! It must
4607 not change the text, jump to another window, etc. Afterwards the
4608 cursor position is always restored, thus the cursor may be moved.
4609 Normally this option would be set to call a function: >
4610 :set indentexpr=GetMyIndent()
4611< Error messages will be suppressed, unless the 'debug' option contains
4612 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004613 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004614 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615
Bram Moolenaar30b65812012-07-12 22:01:11 +02004616 The expression will be evaluated in the |sandbox| when set from a
4617 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004618 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004619
4620 It is not allowed to change text or jump to another window while
4621 evaluating 'indentexpr' |textlock|.
4622
4623
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004625'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 {not available when compiled without the |+cindent|
4628 feature}
4629 A list of keys that, when typed in Insert mode, cause reindenting of
4630 the current line. Only happens if 'indentexpr' isn't empty.
4631 The format is identical to 'cinkeys', see |indentkeys-format|.
4632 See |C-indenting| and |indent-expression|.
4633
4634 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4635'infercase' 'inf' boolean (default off)
4636 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004638 'ignorecase' is also on, the case of the match is adjusted depending
4639 on the typed text. If the typed text contains a lowercase letter
4640 where the match has an upper case letter, the completed part is made
4641 lowercase. If the typed text has no lowercase letters and the match
4642 has a lowercase letter where the typed text has an uppercase letter,
4643 and there is a letter before it, the completed part is made uppercase.
4644 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645
4646 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4647'insertmode' 'im' boolean (default off)
4648 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649 Makes Vim work in a way that Insert mode is the default mode. Useful
4650 if you want to use Vim as a modeless editor. Used for |evim|.
4651 These Insert mode commands will be useful:
4652 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004653 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 this is a mapping, it is executed as if 'insertmode' was off.
4655 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004657 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4658 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659
4660 These items change when 'insertmode' is set:
4661 - when starting to edit of a file, Vim goes to Insert mode.
4662 - <Esc> in Insert mode is a no-op and beeps.
4663 - <Esc> in Normal mode makes Vim go to Insert mode.
4664 - CTRL-L in Insert mode is a command, it is not inserted.
4665 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4666 However, when <Esc> is used inside a mapping, it behaves like
4667 'insertmode' was not set. This was done to be able to use the same
4668 mappings with 'insertmode' set or not set.
4669 When executing commands with |:normal| 'insertmode' is not used.
4670
4671 NOTE: This option is reset when 'compatible' is set.
4672
4673 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004674'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4676 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4677 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4678 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4679 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4680 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 The characters specified by this option are included in file names and
4682 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004683 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 Multi-byte characters 256 and above are always included, only the
4685 characters up to 255 are specified with this option.
4686 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004687 Think twice before adding white space to this option. Although a
4688 space may appear inside a file name, the effect will be that Vim
4689 doesn't know where a file name starts or ends when doing completion.
4690 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004691
4692 Note that on systems using a backslash as path separator, Vim tries to
4693 do its best to make it work as you would expect. That is a bit
4694 tricky, since Vi originally used the backslash to escape special
4695 characters. Vim will not remove a backslash in front of a normal file
4696 name character on these systems, but it will on Unix and alikes. The
4697 '&' and '^' are not included by default, because these are special for
4698 cmd.exe.
4699
4700 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004701 Each part can be a single character number or a range. A range is two
4702 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 decimal number between 0 and 255 or the ASCII character itself (does
4704 not work for digits). Example:
4705 "_,-,128-140,#-43" (include '_' and '-' and the range
4706 128 to 140 and '#' to 43)
4707 If a part starts with '^', the following character number or range
4708 will be excluded from the option. The option is interpreted from left
4709 to right. Put the excluded character after the range where it is
4710 included. To include '^' itself use it as the last character of the
4711 option or the end of a range. Example:
4712 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4713 If the character is '@', all characters where isalpha() returns TRUE
4714 are included. Normally these are the characters a to z and A to Z,
4715 plus accented characters. To include '@' itself use "@-@". Examples:
4716 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004717 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718 "a-z,A-Z,@-@" All letters plus the '@' character.
4719 A comma can be included by using it where a character number is
4720 expected. Example:
4721 "48-57,,,_" Digits, comma and underscore.
4722 A comma can be excluded by prepending a '^'. Example:
4723 " -~,^,,9" All characters from space to '~', excluding
4724 comma, plus <Tab>.
4725 See |option-backslash| about including spaces and backslashes.
4726
4727 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004728'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 "@,48-57,_,128-167,224-235"
4730 otherwise: "@,48-57,_,192-255")
4731 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 The characters given by this option are included in identifiers.
4733 Identifiers are used in recognizing environment variables and after a
4734 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004735 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004736 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004738 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4740
4741 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004742'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743 "@,48-57,_,128-167,224-235"
4744 otherwise: "@,48-57,_,192-255"
4745 Vi default: "@,48-57,_")
4746 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004748 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004749 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004750 characters above 255 check the "word" character class (any character
4751 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004752 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 For a help file it is set to all non-blank printable characters except
4754 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4755 command).
4756 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004757 This option also influences syntax highlighting, unless the syntax
4758 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 NOTE: This option is set to the Vi default value when 'compatible' is
4760 set and to the Vim default value when 'compatible' is reset.
4761
4762 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004763'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 "@,~-255"; otherwise: "@,161-255")
4765 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004766 The characters given by this option are displayed directly on the
4767 screen. It is also used for "\p" in a |pattern|. The characters from
4768 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4769 even when they are not included in 'isprint' or excluded. See
4770 'isfname' for a description of the format of this option.
4771
4772 Non-printable characters are displayed with two characters:
4773 0 - 31 "^@" - "^_"
4774 32 - 126 always single characters
4775 127 "^?"
4776 128 - 159 "~@" - "~_"
4777 160 - 254 "| " - "|~"
4778 255 "~?"
4779 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4780 displayed as <xx>, with the hexadecimal value of the byte.
4781 When 'display' contains "uhex" all unprintable characters are
4782 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004783 The SpecialKey highlighting will be used for unprintable characters.
4784 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004785
4786 Multi-byte characters 256 and above are always included, only the
4787 characters up to 255 are specified with this option. When a character
4788 is printable but it is not available in the current font, a
4789 replacement character will be shown.
4790 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4791 There is no option to specify these characters.
4792
4793 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4794'joinspaces' 'js' boolean (default on)
4795 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796 Insert two spaces after a '.', '?' and '!' with a join command.
4797 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4798 Otherwise only one space is inserted.
4799 NOTE: This option is set when 'compatible' is set.
4800
4801 *'key'*
4802'key' string (default "")
4803 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004804 {only available when compiled with the |+cryptv|
4805 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004807 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808 Careful: Do not set the key value by hand, someone might see the typed
4809 key. Use the |:X| command. But you can make 'key' empty: >
4810 :set key=
4811< It is not possible to get the value of this option with ":set key" or
4812 "echo &key". This is to avoid showing it to someone who shouldn't
4813 know. It also means you cannot see it yourself once you have set it,
4814 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004815 You can use "&key" in an expression to detect whether encryption is
4816 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817
4818 *'keymap'* *'kmp'* *E544*
4819'keymap' 'kmp' string (default "")
4820 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004821 {only available when compiled with the |+keymap|
4822 feature}
4823 Name of a keyboard mapping. See |mbyte-keymap|.
4824 Setting this option to a valid keymap name has the side effect of
4825 setting 'iminsert' to one, so that the keymap becomes effective.
4826 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004827 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828
4829 *'keymodel'* *'km'*
4830'keymodel' 'km' string (default "")
4831 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004832 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833 can do. These values can be used:
4834 startsel Using a shifted special key starts selection (either
4835 Select mode or Visual mode, depending on "key" being
4836 present in 'selectmode').
4837 stopsel Using a not-shifted special key stops selection.
4838 Special keys in this context are the cursor keys, <End>, <Home>,
4839 <PageUp> and <PageDown>.
4840 The 'keymodel' option is set by the |:behave| command.
4841
4842 *'keywordprg'* *'kp'*
4843'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004844 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 Program to use for the |K| command. Environment variables are
4847 expanded |:set_env|. ":help" may be used to access the Vim internal
4848 help. (Note that previously setting the global option to the empty
4849 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004850 When the first character is ":", the command is invoked as a Vim
4851 Ex command prefixed with [count].
4852 When "man", "man -s" or an Ex command is used, Vim will automatically
4853 translate a count for the "K" command and pass it as the first
4854 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855 See |option-backslash| about including spaces and backslashes.
4856 Example: >
4857 :set keywordprg=man\ -s
4858< This option cannot be set from a |modeline| or in the |sandbox|, for
4859 security reasons.
4860
4861 *'langmap'* *'lmap'* *E357* *E358*
4862'langmap' 'lmap' string (default "")
4863 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864 {only available when compiled with the |+langmap|
4865 feature}
4866 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004867 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004868 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 care of translating these special characters to the original meaning
4870 of the key. This means you don't have to change the keyboard mode to
4871 be able to execute Normal mode commands.
4872 This is the opposite of the 'keymap' option, where characters are
4873 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004874 Also consider setting 'langremap' to off, to prevent 'langmap' from
4875 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004876 This option cannot be set from a |modeline| or in the |sandbox|, for
4877 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004879 Example (for Greek, in UTF-8): *greek* >
4880 :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 +00004881< Example (exchanges meaning of z and y for commands): >
4882 :set langmap=zy,yz,ZY,YZ
4883<
4884 The 'langmap' option is a list of parts, separated with commas. Each
4885 part can be in one of two forms:
4886 1. A list of pairs. Each pair is a "from" character immediately
4887 followed by the "to" character. Examples: "aA", "aAbBcC".
4888 2. A list of "from" characters, a semi-colon and a list of "to"
4889 characters. Example: "abc;ABC"
4890 Example: "aA,fgh;FGH,cCdDeE"
4891 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004892 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893
4894 This will allow you to activate vim actions without having to switch
4895 back and forth between the languages. Your language characters will
4896 be understood as normal vim English characters (according to the
4897 langmap mappings) in the following cases:
4898 o Normal/Visual mode (commands, buffer/register names, user mappings)
4899 o Insert/Replace Mode: Register names after CTRL-R
4900 o Insert/Replace Mode: Mappings
4901 Characters entered in Command-line mode will NOT be affected by
4902 this option. Note that this option can be changed at any time
4903 allowing to switch between mappings for different languages/encodings.
4904 Use a mapping to avoid having to type it each time!
4905
4906 *'langmenu'* *'lm'*
4907'langmenu' 'lm' string (default "")
4908 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909 {only available when compiled with the |+menu| and
4910 |+multi_lang| features}
4911 Language to use for menu translation. Tells which file is loaded
4912 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004913 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004914< (without the spaces). For example, to always use the Dutch menus, no
4915 matter what $LANG is set to: >
4916 :set langmenu=nl_NL.ISO_8859-1
4917< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004918 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919 If your $LANG is set to a non-English language but you do want to use
4920 the English menus: >
4921 :set langmenu=none
4922< This option must be set before loading menus, switching on filetype
4923 detection or syntax highlighting. Once the menus are defined setting
4924 this option has no effect. But you could do this: >
4925 :source $VIMRUNTIME/delmenu.vim
4926 :set langmenu=de_DE.ISO_8859-1
4927 :source $VIMRUNTIME/menu.vim
4928< Warning: This deletes all menus that you defined yourself!
4929
Bram Moolenaard94464e2015-11-02 15:28:18 +01004930 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004931'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004932 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004933 {only available when compiled with the |+langmap|
4934 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004935 This is just like 'langremap' but with the value inverted. It only
4936 exists for backwards compatibility. When setting 'langremap' then
4937 'langnoremap' is set to the inverted value, and the other way around.
4938
4939 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004940'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004941 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004942 {only available when compiled with the |+langmap|
4943 feature}
4944 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004945 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004946 'langmap' disables some of your mappings, try resetting this option.
4947 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004948 that works for you to avoid mappings to break.
4949
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 *'laststatus'* *'ls'*
4951'laststatus' 'ls' number (default 1)
4952 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953 The value of this option influences when the last window will have a
4954 status line:
4955 0: never
4956 1: only if there are at least two windows
4957 2: always
4958 The screen looks nicer with a status line if you have several
4959 windows, but it takes another screen line. |status-line|
4960
4961 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4962'lazyredraw' 'lz' boolean (default off)
4963 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964 When this option is set, the screen will not be redrawn while
4965 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004966 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967 update use |:redraw|.
4968
4969 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4970'linebreak' 'lbr' boolean (default off)
4971 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004972 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004974 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 than at the last character that fits on the screen. Unlike
4976 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004977 it only affects the way the file is displayed, not its contents.
4978 If 'breakindent' is set, line is visually indented. Then, the value
4979 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004980 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 Note that <Tab> characters after an <EOL> are mostly not displayed
4982 with the right amount of white space.
4983
4984 *'lines'* *E593*
4985'lines' number (default 24 or terminal height)
4986 global
4987 Number of lines of the Vim window.
4988 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004989 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 When Vim is running in the GUI or in a resizable window, setting this
4991 option will cause the window size to be changed. When you only want
4992 to use the size for the GUI, put the command in your |gvimrc| file.
4993 Vim limits the number of lines to what fits on the screen. You can
4994 use this command to get the tallest window possible: >
4995 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004996< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004997 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998 When you set this option and Vim is unable to change the physical
4999 number of lines of the display, the display may be messed up.
5000
5001 *'linespace'* *'lsp'*
5002'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 {only in the GUI}
5005 Number of pixel lines inserted between characters. Useful if the font
5006 uses the full character cell height, making lines touch each other.
5007 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005008 With some fonts there can be too much room between lines (to have
5009 space for ascents and descents). Then it makes sense to set
5010 'linespace' to a negative value. This may cause display problems
5011 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012
5013 *'lisp'* *'nolisp'*
5014'lisp' boolean (default off)
5015 local to buffer
5016 {not available when compiled without the |+lispindent|
5017 feature}
5018 Lisp mode: When <Enter> is typed in insert mode set the indent for
5019 the next line to Lisp standards (well, sort of). Also happens with
5020 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5021 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5022 better. Also see 'lispwords'.
5023 The '-' character is included in keyword characters. Redefines the
5024 "=" operator to use this same indentation algorithm rather than
5025 calling an external program if 'equalprg' is empty.
5026 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027
5028 *'lispwords'* *'lw'*
5029'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005030 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031 {not available when compiled without the |+lispindent|
5032 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005033 Comma-separated list of words that influence the Lisp indenting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005034 |'lisp'|
5035
5036 *'list'* *'nolist'*
5037'list' boolean (default off)
5038 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005039 List mode: By default show tabs as CTRL-I is displayed, display $
5040 after end of line. Useful to see the difference between tabs and
5041 spaces and for trailing blanks. Further changed by the 'listchars'
5042 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005043
5044 The cursor is displayed at the start of the space a Tab character
5045 occupies, not at the end as usual in Normal mode. To get this cursor
5046 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005047 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005048<
5049 Note that list mode will also affect formatting (set with 'textwidth'
5050 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 changing the way tabs are displayed.
5052
5053 *'listchars'* *'lcs'*
5054'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005055 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005056 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005057 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005058 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005059 eol:c Character to show at the end of each line. When
5060 omitted, there is no extra character at the end of the
5061 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005062 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005063 tab:xy[z] Two or three characters to be used to show a tab.
5064 The third character is optional.
5065
5066 tab:xy The 'x' is always used, then 'y' as many times as will
5067 fit. Thus "tab:>-" displays:
5068 >
5069 >-
5070 >--
5071 etc.
5072
5073 tab:xyz The 'z' is always used, then 'x' is prepended, and
5074 then 'y' is used as many times as will fit. Thus
5075 "tab:<->" displays:
5076 >
5077 <>
5078 <->
5079 <-->
5080 etc.
5081
5082 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005083 *lcs-space*
5084 space:c Character to show for a space. When omitted, spaces
5085 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005086 *lcs-multispace*
5087 multispace:c...
5088 One or more characters to use cyclically to show for
5089 multiple consecutive spaces. Overrides the "space"
5090 setting, except for single spaces. When omitted, the
5091 "space" setting is used. For example,
5092 `:set listchars=multispace:---+` shows ten consecutive
5093 spaces as:
5094 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005095 *lcs-lead*
5096 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005097 leading spaces are blank. Overrides the "space" and
5098 "multispace" settings for leading spaces. You can
5099 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005100 :set listchars+=tab:>-,lead:.
5101< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005102 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005103 trailing spaces are blank. Overrides the "space" and
5104 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005105 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 extends:c Character to show in the last column, when 'wrap' is
5107 off and the line continues beyond the right of the
5108 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005109 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005110 precedes:c Character to show in the first visible column of the
5111 physical line, when there is text preceding the
5112 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005113 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005114 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005115 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005116 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005117 nbsp:c Character to show for a non-breakable space character
5118 (0xA0 (160 decimal) and U+202F). Left blank when
5119 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005121 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005122 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005123 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005125 Each character can be specified as hex: >
5126 set listchars=eol:\\x24
5127 set listchars=eol:\\u21b5
5128 set listchars=eol:\\U000021b5
5129< Note that a double backslash is used. The number of hex characters
5130 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5131
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132 Examples: >
5133 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005134 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005135 :set lcs=extends:>,precedes:<
5136< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005137 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5138 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005139 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005140
5141 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5142'loadplugins' 'lpl' boolean (default on)
5143 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005144 When on the plugin scripts are loaded when starting up |load-plugins|.
5145 This option can be reset in your |vimrc| file to disable the loading
5146 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005147 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5148 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005149
Bram Moolenaard94464e2015-11-02 15:28:18 +01005150 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005151'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005152 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005153 {only available when compiled with the |+lua/dyn|
5154 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005155 Specifies the name of the Lua shared library. The default is
5156 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005157 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005158 This option cannot be set from a |modeline| or in the |sandbox|, for
5159 security reasons.
5160
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005161 *'macatsui'* *'nomacatsui'*
5162'macatsui' boolean (default on)
5163 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005164 {not supported}
5165 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005166
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 *'magic'* *'nomagic'*
5168'magic' boolean (default on)
5169 global
5170 Changes the special characters that can be used in search patterns.
5171 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005172 WARNING: Switching this option off most likely breaks plugins! That
5173 is because many patterns assume it's on and will fail when it's off.
5174 Only switch it off when working with old Vi scripts. In any other
5175 situation write patterns that work when 'magic' is on. Include "\M"
5176 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005177 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5178 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179
5180 *'makeef'* *'mef'*
5181'makeef' 'mef' string (default: "")
5182 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 {not available when compiled without the |+quickfix|
5184 feature}
5185 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5186 and the |:grep| command.
5187 When it is empty, an internally generated temp file will be used.
5188 When "##" is included, it is replaced by a number to make the name
5189 unique. This makes sure that the ":make" command doesn't overwrite an
5190 existing file.
5191 NOT used for the ":cf" command. See 'errorfile' for that.
5192 Environment variables are expanded |:set_env|.
5193 See |option-backslash| about including spaces and backslashes.
5194 This option cannot be set from a |modeline| or in the |sandbox|, for
5195 security reasons.
5196
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005197 *'makeencoding'* *'menc'*
5198'makeencoding' 'menc' string (default "")
5199 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005200 Encoding used for reading the output of external commands. When empty,
5201 encoding is not converted.
5202 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5203 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5204 and `:laddfile`.
5205
5206 This would be mostly useful when you use MS-Windows and set 'encoding'
5207 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5208 'makeencoding' to "char" has the same effect as setting to the system
5209 locale encoding. Example: >
5210 :set encoding=utf-8
5211 :set makeencoding=char " system locale is used
5212<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213 *'makeprg'* *'mp'*
5214'makeprg' 'mp' string (default "make", VMS: "MMS")
5215 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005216 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005217 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5218 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005219 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005220 Environment variables are expanded |:set_env|. See |option-backslash|
5221 about including spaces and backslashes.
5222 Note that a '|' must be escaped twice: once for ":set" and once for
5223 the interpretation of a command. When you use a filter called
5224 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005225 :set makeprg=gmake\ \\\|\ myfilter
5226< The placeholder "$*" can be given (even multiple times) to specify
5227 where the arguments will be included, for example: >
5228 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5229< This option cannot be set from a |modeline| or in the |sandbox|, for
5230 security reasons.
5231
5232 *'matchpairs'* *'mps'*
5233'matchpairs' 'mps' string (default "(:),{:},[:]")
5234 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005235 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005236 other.
5237 Only character pairs are allowed that are different, thus you cannot
5238 jump between two double quotes.
5239 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005240 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005241 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242 :set mps+=<:>
5243
5244< A more exotic example, to jump between the '=' and ';' in an
5245 assignment, useful for languages like C and Java: >
5246 :au FileType c,cpp,java set mps+==:;
5247
5248< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005249 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005250
5251 *'matchtime'* *'mat'*
5252'matchtime' 'mat' number (default 5)
5253 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 Tenths of a second to show the matching paren, when 'showmatch' is
5255 set. Note that this is not in milliseconds, like other options that
5256 set a time. This is to be compatible with Nvi.
5257
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005258 *'maxcombine'* *'mco'*
5259'maxcombine' 'mco' number (default 2)
5260 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005261 The maximum number of combining characters supported for displaying.
5262 Only used when 'encoding' is "utf-8".
5263 The default is OK for most languages. Hebrew may require 4.
5264 Maximum value is 6.
5265 Even when this option is set to 2 you can still edit text with more
5266 combining characters, you just can't see them. Use |g8| or |ga|.
5267 See |mbyte-combining|.
5268
Bram Moolenaar071d4272004-06-13 20:20:40 +00005269 *'maxfuncdepth'* *'mfd'*
5270'maxfuncdepth' 'mfd' number (default 100)
5271 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005272 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005273 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 Maximum depth of function calls for user functions. This normally
5275 catches endless recursion. When using a recursive function with
5276 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5277 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005278 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005279 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 See also |:function|.
5281
5282 *'maxmapdepth'* *'mmd'* *E223*
5283'maxmapdepth' 'mmd' number (default 1000)
5284 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 Maximum number of times a mapping is done without resulting in a
5286 character to be used. This normally catches endless mappings, like
5287 ":map x y" with ":map y x". It still does not catch ":map g wg",
5288 because the 'w' is used before the next mapping is done. See also
5289 |key-mapping|.
5290
5291 *'maxmem'* *'mm'*
5292'maxmem' 'mm' number (default between 256 to 5120 (system
5293 dependent) or half the amount of memory
5294 available)
5295 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005296 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5297 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005298 other memory to be freed.
5299 The maximum usable value is about 2000000. Use this to work without a
5300 limit.
5301 The value is ignored when 'swapfile' is off.
5302 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005304 *'maxmempattern'* *'mmp'*
5305'maxmempattern' 'mmp' number (default 1000)
5306 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005307 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005308 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005309 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005310 When Vim runs into the limit it gives an error message and mostly
5311 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005312 Running into the limit often means that the pattern is very
5313 inefficient or too complex. This may already happen with the pattern
5314 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005315 Might also happen on redraw, when syntax rules try to match a complex
5316 text structure.
5317 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5318 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005319
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320 *'maxmemtot'* *'mmt'*
5321'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5322 dependent) or half the amount of memory
5323 available)
5324 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005325 Maximum amount of memory in Kbyte to use for all buffers together.
5326 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005327 without a limit.
5328 On 64 bit machines higher values might work. But hey, do you really
5329 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005330 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005331 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005332 Buffers with 'swapfile' off still count to the total amount of memory
5333 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005334 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335
5336 *'menuitems'* *'mis'*
5337'menuitems' 'mis' number (default 25)
5338 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005339 {not available when compiled without the |+menu|
5340 feature}
5341 Maximum number of items to use in a menu. Used for menus that are
5342 generated from a list of items, e.g., the Buffers menu. Changing this
5343 option has no direct effect, the menu must be refreshed first.
5344
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005345 *'mkspellmem'* *'msm'*
5346'mkspellmem' 'msm' string (default "460000,2000,500")
5347 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005348 {not available when compiled without the |+syntax|
5349 feature}
5350 Parameters for |:mkspell|. This tunes when to start compressing the
5351 word tree. Compression can be slow when there are many words, but
5352 it's needed to avoid running out of memory. The amount of memory used
5353 per word depends very much on how similar the words are, that's why
5354 this tuning is complicated.
5355
5356 There are three numbers, separated by commas:
5357 {start},{inc},{added}
5358
5359 For most languages the uncompressed word tree fits in memory. {start}
5360 gives the amount of memory in Kbyte that can be used before any
5361 compression is done. It should be a bit smaller than the amount of
5362 memory that is available to Vim.
5363
5364 When going over the {start} limit the {inc} number specifies the
5365 amount of memory in Kbyte that can be allocated before another
5366 compression is done. A low number means compression is done after
5367 less words are added, which is slow. A high number means more memory
5368 will be allocated.
5369
5370 After doing compression, {added} times 1024 words can be added before
5371 the {inc} limit is ignored and compression is done when any extra
5372 amount of memory is needed. A low number means there is a smaller
5373 chance of hitting the {inc} limit, less memory is used but it's
5374 slower.
5375
5376 The languages for which these numbers are important are Italian and
5377 Hungarian. The default works for when you have about 512 Mbyte. If
5378 you have 1 Gbyte you could use: >
5379 :set mkspellmem=900000,3000,800
5380< If you have less than 512 Mbyte |:mkspell| may fail for some
5381 languages, no matter what you set 'mkspellmem' to.
5382
Bram Moolenaar07607392019-05-26 19:20:43 +02005383 This option cannot be set from a |modeline| or in the |sandbox|.
5384
Bram Moolenaar071d4272004-06-13 20:20:40 +00005385 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005386'modeline' 'ml' boolean (Vim default: on (off for root),
5387 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005389 If 'modeline' is on 'modelines' gives the number of lines that is
5390 checked for set commands. If 'modeline' is off or 'modelines' is zero
5391 no lines are checked. See |modeline|.
5392
5393 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5394'modelineexpr' 'mle' boolean (default: off)
5395 global
5396 When on allow some options that are an expression to be set in the
5397 modeline. Check the option for whether it is affected by
5398 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005399 This option cannot be set from a |modeline| or in the |sandbox|, for
5400 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005401
Bram Moolenaar071d4272004-06-13 20:20:40 +00005402 *'modelines'* *'mls'*
5403'modelines' 'mls' number (default 5)
5404 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405 If 'modeline' is on 'modelines' gives the number of lines that is
5406 checked for set commands. If 'modeline' is off or 'modelines' is zero
5407 no lines are checked. See |modeline|.
5408 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5409 set and to the Vim default value when 'compatible' is reset.
5410
5411 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005412 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413'modifiable' 'ma' boolean (default on)
5414 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 When off the buffer contents cannot be changed. The 'fileformat' and
5416 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005417 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418
5419 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5420'modified' 'mod' boolean (default off)
5421 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422 When on, the buffer is considered to be modified. This option is set
5423 when:
5424 1. A change was made to the text since it was last written. Using the
5425 |undo| command to go back to the original text will reset the
5426 option. But undoing changes that were made before writing the
5427 buffer will set the option again, since the text is different from
5428 when it was written.
5429 2. 'fileformat' or 'fileencoding' is different from its original
5430 value. The original value is set when the buffer is read or
5431 written. A ":set nomodified" command also resets the original
5432 values to the current values and the 'modified' option will be
5433 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005434 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005435 This option is not set when a change is made to the buffer as the
5436 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5437 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5438 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5440 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005441 Note that the text may actually be the same, e.g. 'modified' is set
5442 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443
5444 *'more'* *'nomore'*
5445'more' boolean (Vim default: on, Vi default: off)
5446 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 When on, listings pause when the whole screen is filled. You will get
5448 the |more-prompt|. When this option is off there are no pauses, the
5449 listing continues until finished.
5450 NOTE: This option is set to the Vi default value when 'compatible' is
5451 set and to the Vim default value when 'compatible' is reset.
5452
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005453 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005454'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005455 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005457 Enable the use of the mouse. Works for most terminals (xterm, Win32
5458 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5459 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5460 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005461 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005462 v Visual mode
5463 i Insert mode
5464 c Command-line mode
5465 h all previous modes when editing a help file
5466 a all previous modes
5467 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005468 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005470< If your terminal can't overrule the mouse events going to the
5471 application, use: >
5472 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005473< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005474 back to Vim using the mouse events.
5475 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5476 "xterm".
5477
5478 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 modeless selection. This doesn't move the text cursor.
5480
5481 See |mouse-using|. Also see |'clipboard'|.
5482
5483 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005484 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005485 the mouse buttons can still be used by keeping the shift key pressed.
5486 Also see the 'clipboard' option.
5487
5488 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5489'mousefocus' 'mousef' boolean (default off)
5490 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 {only works in the GUI}
5492 The window that the mouse pointer is on is automatically activated.
5493 When changing the window layout or window focus in another way, the
5494 mouse pointer is moved to the window with keyboard focus. Off is the
5495 default because it makes using the pull down menus a little goofy, as
5496 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005497 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005498 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499
5500 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5501'mousehide' 'mh' boolean (default on)
5502 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503 {only works in the GUI}
5504 When on, the mouse pointer is hidden when characters are typed.
5505 The mouse pointer is restored when the mouse is moved.
5506
5507 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005508'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 Sets the model to use for the mouse. The name mostly specifies what
5511 the right mouse button is used for:
5512 extend Right mouse button extends a selection. This works
5513 like in an xterm.
5514 popup Right mouse button pops up a menu. The shifted left
5515 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005516 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005517 popup_setpos Like "popup", but the cursor will be moved to the
5518 position where the mouse was clicked, and thus the
5519 selected operation will act upon the clicked object.
5520 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005521 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522 course, that right clicking outside a selection will
5523 end Visual mode.
5524 Overview of what button does what for each model:
5525 mouse extend popup(_setpos) ~
5526 left click place cursor place cursor
5527 left drag start selection start selection
5528 shift-left search word extend selection
5529 right click extend selection popup menu (place cursor)
5530 right drag extend selection -
5531 middle click paste paste
5532
5533 In the "popup" model the right mouse button produces a pop-up menu.
5534 You need to define this first, see |popup-menu|.
5535
5536 Note that you can further refine the meaning of buttons with mappings.
5537 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5538 selection (because that's handled in the GUI code directly).
5539
5540 The 'mousemodel' option is set by the |:behave| command.
5541
Ernie Raelc4cb5442022-04-03 15:47:28 +01005542 *'mousemoveevent'* *'mousemev'*
5543'mousemoveevent' 'mousemev' boolean (default off)
5544 global
5545 {only works in the GUI}
5546 When on, mouse move events are delivered to the input queue and are
5547 available for mapping. The default, off, avoids the mouse movement
5548 overhead except when needed. See |gui-mouse-mapping|.
5549 Warning: Setting this option can make pending mappings to be aborted
5550 when the mouse is moved.
5551 Currently only works in the GUI, may be made to work in a terminal
5552 later.
5553
Bram Moolenaar071d4272004-06-13 20:20:40 +00005554 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005555'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5556 vs:leftright,vd:lrsizing,m:no,
5557 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559 {only available when compiled with the |+mouseshape|
5560 feature}
5561 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005562 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005563 like used for 'guicursor'. Each part consist of a mode/location-list
5564 and an argument-list:
5565 mode-list:shape,mode-list:shape,..
5566 The mode-list is a dash separated list of these modes/locations:
5567 In a normal window: ~
5568 n Normal mode
5569 v Visual mode
5570 ve Visual mode with 'selection' "exclusive" (same as 'v',
5571 if not specified)
5572 o Operator-pending mode
5573 i Insert mode
5574 r Replace mode
5575
5576 Others: ~
5577 c appending to the command-line
5578 ci inserting in the command-line
5579 cr replacing in the command-line
5580 m at the 'Hit ENTER' or 'More' prompts
5581 ml idem, but cursor in the last line
5582 e any mode, pointer below last window
5583 s any mode, pointer on a status line
5584 sd any mode, while dragging a status line
5585 vs any mode, pointer on a vertical separator line
5586 vd any mode, while dragging a vertical separator line
5587 a everywhere
5588
5589 The shape is one of the following:
5590 avail name looks like ~
5591 w x arrow Normal mouse pointer
5592 w x blank no pointer at all (use with care!)
5593 w x beam I-beam
5594 w x updown up-down sizing arrows
5595 w x leftright left-right sizing arrows
5596 w x busy The system's usual busy pointer
5597 w x no The system's usual 'no input' pointer
5598 x udsizing indicates up-down resizing
5599 x lrsizing indicates left-right resizing
5600 x crosshair like a big thin +
5601 x hand1 black hand
5602 x hand2 white hand
5603 x pencil what you write with
5604 x question big ?
5605 x rightup-arrow arrow pointing right-up
5606 w x up-arrow arrow pointing up
5607 x <number> any X11 pointer number (see X11/cursorfont.h)
5608
5609 The "avail" column contains a 'w' if the shape is available for Win32,
5610 x for X11.
5611 Any modes not specified or shapes not available use the normal mouse
5612 pointer.
5613
5614 Example: >
5615 :set mouseshape=s:udsizing,m:no
5616< will make the mouse turn to a sizing arrow over the status lines and
5617 indicate no input when the hit-enter prompt is displayed (since
5618 clicking the mouse has no effect in this state.)
5619
5620 *'mousetime'* *'mouset'*
5621'mousetime' 'mouset' number (default 500)
5622 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005623 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005624 time in msec between two mouse clicks for the second click to be
5625 recognized as a multi click.
5626
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005627 *'mzschemedll'*
5628'mzschemedll' string (default depends on the build)
5629 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005630 {only available when compiled with the |+mzscheme/dyn|
5631 feature}
5632 Specifies the name of the MzScheme shared library. The default is
5633 DYNAMIC_MZSCH_DLL which was specified at compile time.
5634 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005635 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005636 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005637 This option cannot be set from a |modeline| or in the |sandbox|, for
5638 security reasons.
5639
5640 *'mzschemegcdll'*
5641'mzschemegcdll' string (default depends on the build)
5642 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005643 {only available when compiled with the |+mzscheme/dyn|
5644 feature}
5645 Specifies the name of the MzScheme GC shared library. The default is
5646 DYNAMIC_MZGC_DLL which was specified at compile time.
5647 The value can be equal to 'mzschemedll' if it includes the GC code.
5648 Environment variables are expanded |:set_env|.
5649 This option cannot be set from a |modeline| or in the |sandbox|, for
5650 security reasons.
5651
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005652 *'mzquantum'* *'mzq'*
5653'mzquantum' 'mzq' number (default 100)
5654 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005655 {not available when compiled without the |+mzscheme|
5656 feature}
5657 The number of milliseconds between polls for MzScheme threads.
5658 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005659 NOTE: This option is set to the Vim default value when 'compatible'
5660 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005661
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005663'nrformats' 'nf' string (default "bin,octal,hex",
5664 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005666 This defines what bases Vim will consider for numbers when using the
5667 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5668 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005669 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005670 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005671 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005672 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005674 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 considered to be hexadecimal. Example: Using CTRL-X on
5676 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005677 bin If included, numbers starting with "0b" or "0B" will be
5678 considered to be binary. Example: Using CTRL-X on
5679 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005680 unsigned If included, numbers are recognized as unsigned. Thus a
5681 leading dash or negative sign won't be considered as part of
5682 the number. Examples:
5683 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5684 (without "unsigned" it would become "9-2021").
5685 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5686 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005687 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5688 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689 Numbers which simply begin with a digit in the range 1-9 are always
5690 considered decimal. This also happens for numbers that are not
5691 recognized as octal or hex.
5692
5693 *'number'* *'nu'* *'nonumber'* *'nonu'*
5694'number' 'nu' boolean (default off)
5695 local to window
5696 Print the line number in front of each line. When the 'n' option is
5697 excluded from 'cpoptions' a wrapped line will not use the column of
5698 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005699 The 'numberwidth' option can be used to set the room used for the line
5700 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 When a long, wrapped line doesn't start with the first character, '-'
5702 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005703 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5704 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005705 *number_relativenumber*
5706 The 'relativenumber' option changes the displayed number to be
5707 relative to the cursor. Together with 'number' there are these
5708 four combinations (cursor in line 3):
5709
Bram Moolenaar3848e002016-03-19 18:42:29 +01005710 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005711 'nornu' 'nornu' 'rnu' 'rnu'
5712
5713 |apple | 1 apple | 2 apple | 2 apple
5714 |pear | 2 pear | 1 pear | 1 pear
5715 |nobody | 3 nobody | 0 nobody |3 nobody
5716 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005718 *'numberwidth'* *'nuw'*
5719'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5720 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005721 {only available when compiled with the |+linebreak|
5722 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005723 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005724 when the 'number' or 'relativenumber' option is set or printing lines
5725 with a line number. Since one space is always between the number and
5726 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005727 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005728 fit the highest line number in the buffer respectively the number of
5729 rows in the window, depending on whether 'number' or 'relativenumber'
5730 is set. Thus with the Vim default of 4 there is room for a line number
5731 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005732 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005733 NOTE: This option is set to the Vi default value when 'compatible' is
5734 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005735
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005736 *'omnifunc'* *'ofu'*
5737'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005738 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005739 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005740 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005741 This option specifies a function to be used for Insert mode omni
5742 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005743 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005744 invoked and what it should return. The value can be the name of a
5745 function, a |lambda| or a |Funcref|. See |option-value-function| for
5746 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005747 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005748 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005749 This option cannot be set from a |modeline| or in the |sandbox|, for
5750 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005751
5752
Bram Moolenaar02467872007-05-06 13:22:01 +00005753 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005754'opendevice' 'odev' boolean (default off)
5755 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005756 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005757 Enable reading and writing from devices. This may get Vim stuck on a
5758 device that can be opened but doesn't actually do the I/O. Therefore
5759 it is off by default.
5760 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5761 result in editing a device.
5762
5763
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005764 *'operatorfunc'* *'opfunc'*
5765'operatorfunc' 'opfunc' string (default: empty)
5766 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005767 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005768 See |:map-operator| for more info and an example. The value can be
5769 the name of a function, a |lambda| or a |Funcref|. See
5770 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005771
5772 This option cannot be set from a |modeline| or in the |sandbox|, for
5773 security reasons.
5774
5775
Bram Moolenaar251e1912011-06-19 05:09:16 +02005776 *'osfiletype'* *'oft'*
5777'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005779 This option was supported on RISC OS, which has been removed.
5780
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005782 *'packpath'* *'pp'*
5783'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005784 Directories used to find packages. See |packages|.
5785
5786
Bram Moolenaar071d4272004-06-13 20:20:40 +00005787 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005788'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005789 global
5790 Specifies the nroff macros that separate paragraphs. These are pairs
5791 of two letters (see |object-motions|).
5792
5793 *'paste'* *'nopaste'*
5794'paste' boolean (default off)
5795 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005796 Put Vim in Paste mode. This is useful if you want to cut or copy
5797 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005798 unexpected effects.
5799 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005800 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005801 knows about pasting and will mostly do the right thing without 'paste'
5802 being set. The same is true for a terminal where Vim handles the
5803 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005804 This option is reset when starting the GUI. Thus if you set it in
5805 your .vimrc it will work in a terminal, but not in the GUI. Setting
5806 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5807 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005808 When the 'paste' option is switched on (also when it was already on):
5809 - mapping in Insert mode and Command-line mode is disabled
5810 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005811 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005812 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005813 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814 - 'revins' is reset
5815 - 'ruler' is reset
5816 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005817 - 'smarttab' is reset
5818 - 'softtabstop' is set to 0
5819 - 'textwidth' is set to 0
5820 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005821 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005822 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005823 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005824 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005825 - 'indentexpr'
5826 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005827 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828 NOTE: When you start editing another file while the 'paste' option is
5829 on, settings from the modelines or autocommands may change the
5830 settings again, causing trouble when pasting text. You might want to
5831 set the 'paste' option again.
5832 When the 'paste' option is reset the mentioned options are restored to
5833 the value before the moment 'paste' was switched from off to on.
5834 Resetting 'paste' before ever setting it does not have any effect.
5835 Since mapping doesn't work while 'paste' is active, you need to use
5836 the 'pastetoggle' option to toggle the 'paste' option with some key.
5837
5838 *'pastetoggle'* *'pt'*
5839'pastetoggle' 'pt' string (default "")
5840 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841 When non-empty, specifies the key sequence that toggles the 'paste'
5842 option. This is like specifying a mapping: >
5843 :map {keys} :set invpaste<CR>
5844< Where {keys} is the value of 'pastetoggle'.
5845 The difference is that it will work even when 'paste' is set.
5846 'pastetoggle' works in Insert mode and Normal mode, but not in
5847 Command-line mode.
5848 Mappings are checked first, thus overrule 'pastetoggle'. However,
5849 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5850 this: >
5851 :map <F10> :set paste<CR>
5852 :map <F11> :set nopaste<CR>
5853 :imap <F10> <C-O>:set paste<CR>
5854 :imap <F11> <nop>
5855 :set pastetoggle=<F11>
5856< This will make <F10> start paste mode and <F11> stop paste mode.
5857 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5858 mode everything is inserted literally, except the 'pastetoggle' key
5859 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005860 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861
5862 *'pex'* *'patchexpr'*
5863'patchexpr' 'pex' string (default "")
5864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 {not available when compiled without the |+diff|
5866 feature}
5867 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005868 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005869
Bram Moolenaardbc28022014-07-26 13:40:44 +02005870 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871'patchmode' 'pm' string (default "")
5872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873 When non-empty the oldest version of a file is kept. This can be used
5874 to keep the original version of a file if you are changing files in a
5875 source distribution. Only the first time that a file is written a
5876 copy of the original file will be kept. The name of the copy is the
5877 name of the original file with the string in the 'patchmode' option
5878 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005879 ".orig" or ".org". 'backupdir' must not be empty for this to work
5880 (Detail: The backup file is renamed to the patchmode file after the
5881 new file has been successfully written, that's why it must be possible
5882 to write a backup file). If there was no file to be backed up, an
5883 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884 When the 'backupskip' pattern matches, a patchmode file is not made.
5885 Using 'patchmode' for compressed files appends the extension at the
5886 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5887 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005888 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005889
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005890 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005892 other systems: ".,,")
5893 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005895 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5896 provided that the file being searched for has a relative path (not
5897 starting with "/", "./" or "../"). The directories in the 'path'
5898 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 - Use commas to separate directory names: >
5900 :set path=.,/usr/local/include,/usr/include
5901< - Spaces can also be used to separate directory names (for backwards
5902 compatibility with version 3.0). To have a space in a directory
5903 name, precede it with an extra backslash, and escape the space: >
5904 :set path=.,/dir/with\\\ space
5905< - To include a comma in a directory name precede it with an extra
5906 backslash: >
5907 :set path=.,/dir/with\\,comma
5908< - To search relative to the directory of the current file, use: >
5909 :set path=.
5910< - To search in the current directory use an empty string between two
5911 commas: >
5912 :set path=,,
5913< - A directory name may end in a ':' or '/'.
5914 - Environment variables are expanded |:set_env|.
5915 - When using |netrw.vim| URLs can be used. For example, adding
5916 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005917 - Search upwards and downwards in a directory tree using "*", "**" and
5918 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005919 {not available when compiled without the |+path_extra| feature}
5920 - Careful with '\' characters, type two to get one in the option: >
5921 :set path=.,c:\\include
5922< Or just use '/' instead: >
5923 :set path=.,c:/include
5924< Don't forget "." or files won't even be found in the same directory as
5925 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005926 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 it is something like 256 or 1024 characters.
5928 You can check if all the include files are found, using the value of
5929 'path', see |:checkpath|.
5930 The use of |:set+=| and |:set-=| is preferred when adding or removing
5931 directories from the list. This avoids problems when a future version
5932 uses another default. To remove the current directory use: >
5933 :set path-=
5934< To add the current directory use: >
5935 :set path+=
5936< To use an environment variable, you probably need to replace the
5937 separator. Here is an example to append $INCL, in which directory
5938 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005939 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005940< Replace the ';' with a ':' or whatever separator is used. Note that
5941 this doesn't work when $INCL contains a comma or white space.
5942
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005943 *'perldll'*
5944'perldll' string (default depends on the build)
5945 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005946 {only available when compiled with the |+perl/dyn|
5947 feature}
5948 Specifies the name of the Perl shared library. The default is
5949 DYNAMIC_PERL_DLL, which was specified at compile time.
5950 Environment variables are expanded |:set_env|.
5951 This option cannot be set from a |modeline| or in the |sandbox|, for
5952 security reasons.
5953
Bram Moolenaar071d4272004-06-13 20:20:40 +00005954 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5955'preserveindent' 'pi' boolean (default off)
5956 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957 When changing the indent of the current line, preserve as much of the
5958 indent structure as possible. Normally the indent is replaced by a
5959 series of tabs followed by spaces as required (unless |'expandtab'| is
5960 enabled, in which case only spaces are used). Enabling this option
5961 means the indent will preserve as many existing characters as possible
5962 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005963 'expandtab' does not apply to the preserved white space, a Tab remains
5964 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005965 NOTE: When using ">>" multiple times the resulting indent is a mix of
5966 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005967 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005968 Also see 'copyindent'.
5969 Use |:retab| to clean up white space.
5970
5971 *'previewheight'* *'pvh'*
5972'previewheight' 'pvh' number (default 12)
5973 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005974 {not available when compiled without the |+quickfix|
5975 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005977 commands. Used for |CTRL-W_}| when no count is given. Not used when
5978 'previewpopup' is set.
5979
5980 *'previewpopup'* *'pvp'*
5981'previewpopup' 'pvp' string (default empty)
5982 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005983 {not available when compiled without the |+textprop|
5984 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005985 When not empty a popup window is used for commands that would open a
5986 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005987 Not used for the insert completion info, add "popup" to
5988 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005989
5990 *'previewwindow'* *'nopreviewwindow'*
5991 *'pvw'* *'nopvw'* *E590*
5992'previewwindow' 'pvw' boolean (default off)
5993 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005994 {not available when compiled without the |+quickfix|
5995 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005996 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005997 set. It's normally not set directly, but by using one of the commands
5998 |:ptag|, |:pedit|, etc.
5999
6000 *'printdevice'* *'pdev'*
6001'printdevice' 'pdev' string (default empty)
6002 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006003 {only available when compiled with the |+printer|
6004 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006005 The name of the printer to be used for |:hardcopy|.
6006 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006007 This option cannot be set from a |modeline| or in the |sandbox|, for
6008 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009
Bram Moolenaar8299df92004-07-10 09:47:34 +00006010 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006011'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 {only available when compiled with the |+printer|
6014 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006015 Sets the character encoding used when printing.
6016 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006017
6018 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006019'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006021 {only available when compiled with the |+printer|
6022 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006023 Expression used to print the PostScript produced with |:hardcopy|.
6024 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006025 This option cannot be set from a |modeline| or in the |sandbox|, for
6026 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006027
Bram Moolenaar8299df92004-07-10 09:47:34 +00006028 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029'printfont' 'pfn' string (default "courier")
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 font that will be used for |:hardcopy|.
6034 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006035
6036 *'printheader'* *'pheader'*
6037'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 {only available when compiled with the |+printer|
6040 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006041 The format of the header produced in |:hardcopy| output.
6042 See |pheader-option|.
6043
6044 *'printmbcharset'* *'pmbcs'*
6045'printmbcharset' 'pmbcs' string (default "")
6046 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006047 {only available when compiled with the |+printer|
6048 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006049 The CJK character set to be used for CJK output from |:hardcopy|.
6050 See |pmbcs-option|.
6051
6052 *'printmbfont'* *'pmbfn'*
6053'printmbfont' 'pmbfn' string (default "")
6054 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006055 {only available when compiled with the |+printer|
6056 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006057 List of font names to be used for CJK output from |:hardcopy|.
6058 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059
6060 *'printoptions'* *'popt'*
6061'printoptions' 'popt' string (default "")
6062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006064 List of items that control the format of the output of |:hardcopy|.
6065 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006067 *'prompt'* *'noprompt'*
6068'prompt' boolean (default on)
6069 global
6070 When on a ":" prompt is used in Ex mode.
6071
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006072 *'pumheight'* *'ph'*
6073'pumheight' 'ph' number (default 0)
6074 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006075 Determines the maximum number of items to show in the popup menu for
6076 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006077 |ins-completion-menu|.
6078
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006079 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006080'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006081 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006082 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006083 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006084
Bram Moolenaard94464e2015-11-02 15:28:18 +01006085 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006086'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006087 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006088 {only available when compiled with the |+python/dyn|
6089 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006090 Specifies the name of the Python 2.x shared library. The default is
6091 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006092 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006093 This option cannot be set from a |modeline| or in the |sandbox|, for
6094 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006095
Bram Moolenaar94073162018-01-31 21:49:05 +01006096 *'pythonhome'*
6097'pythonhome' string (default "")
6098 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006099 {only available when compiled with the |+python/dyn|
6100 feature}
6101 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6102 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6103 which was specified at compile time, will be used for the Python 2.x
6104 home directory.
6105 Environment variables are expanded |:set_env|.
6106 This option cannot be set from a |modeline| or in the |sandbox|, for
6107 security reasons.
6108
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006109 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006110'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006111 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006112 {only available when compiled with the |+python3/dyn|
6113 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006114 Specifies the name of the Python 3 shared library. The default is
6115 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006116 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006117 This option cannot be set from a |modeline| or in the |sandbox|, for
6118 security reasons.
6119
Bram Moolenaar94073162018-01-31 21:49:05 +01006120 *'pythonthreehome'*
6121'pythonthreehome' string (default "")
6122 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006123 {only available when compiled with the |+python3/dyn|
6124 feature}
6125 Specifies the name of the Python 3 home directory. When
6126 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6127 PYTHON3_HOME, which was specified at compile time, will be used for
6128 the Python 3 home directory.
6129 Environment variables are expanded |:set_env|.
6130 This option cannot be set from a |modeline| or in the |sandbox|, for
6131 security reasons.
6132
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006133 *'pyxversion'* *'pyx'*
6134'pyxversion' 'pyx' number (default depends on the build)
6135 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006136 {only available when compiled with the |+python| or
6137 the |+python3| feature}
6138 Specifies the python version used for pyx* functions and commands
6139 |python_x|. The default value is as follows:
6140
6141 Compiled with Default ~
6142 |+python| and |+python3| 0
6143 only |+python| 2
6144 only |+python3| 3
6145
6146 Available values are 0, 2 and 3.
6147 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6148 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6149 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6150 to 2 if Python 2 is available.
6151 See also: |has-pythonx|
6152
6153 If Vim is compiled with only |+python| or |+python3| setting
6154 'pyxversion' has no effect. The pyx* functions and commands are
6155 always the same as the compiled version.
6156
6157 This option cannot be set from a |modeline| or in the |sandbox|, for
6158 security reasons.
6159
Bram Moolenaar858ba062020-05-31 23:11:59 +02006160 *'quickfixtextfunc'* *'qftf'*
6161'quickfixtextfunc' 'qftf' string (default "")
6162 global
6163 {only available when compiled with the |+quickfix|
6164 feature}
6165 This option specifies a function to be used to get the text to display
6166 in the quickfix and location list windows. This can be used to
6167 customize the information displayed in the quickfix or location window
6168 for each entry in the corresponding quickfix or location list. See
6169 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006170 function and an example. The value can be the name of a function, a
6171 |lambda| or a |Funcref|. See |option-value-function| for more
6172 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006173
6174 This option cannot be set from a |modeline| or in the |sandbox|, for
6175 security reasons.
6176
Bram Moolenaar677ee682005-01-27 14:41:15 +00006177 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006178'quoteescape' 'qe' string (default "\")
6179 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006180 The characters that are used to escape quotes in a string. Used for
6181 objects like a', a" and a` |a'|.
6182 When one of the characters in this option is found inside a string,
6183 the following character will be skipped. The default value makes the
6184 text "foo\"bar\\" considered to be one string.
6185
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6187'readonly' 'ro' boolean (default off)
6188 local to buffer
6189 If on, writes fail unless you use a '!'. Protects you from
6190 accidentally overwriting a file. Default on when Vim is started
6191 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006192 When using ":w!" the 'readonly' option is reset for the current
6193 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006194 When using the ":view" command the 'readonly' option is set for the
6195 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006196 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006198 *'redrawtime'* *'rdt'*
6199'redrawtime' 'rdt' number (default 2000)
6200 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006201 {only available when compiled with the |+reltime|
6202 feature}
6203 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006204 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006205 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006206 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006207 matches will be highlighted.
6208 For syntax highlighting the time applies per window. When over the
6209 limit syntax highlighting is disabled until |CTRL-L| is used.
6210 This is used to avoid that Vim hangs when using a very complicated
6211 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006212
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006213 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006214'regexpengine' 're' number (default 0)
6215 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006216 This selects the default regexp engine. |two-engines|
6217 The possible values are:
6218 0 automatic selection
6219 1 old engine
6220 2 NFA engine
6221 Note that when using the NFA engine and the pattern contains something
6222 that is not supported the pattern will not match. This is only useful
6223 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006224 Using automatic selection enables Vim to switch the engine, if the
6225 default engine becomes too costly. E.g., when the NFA engine uses too
6226 many states. This should prevent Vim from hanging on a combination of
6227 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006228
Bram Moolenaar64486672010-05-16 15:46:46 +02006229 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6230'relativenumber' 'rnu' boolean (default off)
6231 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006232 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006233 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006234 precede some vertical motion commands (e.g. j k + -) with, without
6235 having to calculate it yourself. Especially useful in combination with
6236 other commands (e.g. y d c < > gq gw =).
6237 When the 'n' option is excluded from 'cpoptions' a wrapped
6238 line will not use the column of line numbers (this is the default when
6239 'compatible' isn't set).
6240 The 'numberwidth' option can be used to set the room used for the line
6241 number.
6242 When a long, wrapped line doesn't start with the first character, '-'
6243 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006244 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6245 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006246
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006247 The number in front of the cursor line also depends on the value of
6248 'number', see |number_relativenumber| for all combinations of the two
6249 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006250
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 *'remap'* *'noremap'*
6252'remap' boolean (default on)
6253 global
6254 Allows for mappings to work recursively. If you do not want this for
6255 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006256 NOTE: To avoid portability problems with Vim scripts, always keep
6257 this option at the default "on". Only switch it off when working with
6258 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006260 *'renderoptions'* *'rop'*
6261'renderoptions' 'rop' string (default: empty)
6262 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006263 {only available when compiled with GUI and DIRECTX on
6264 MS-Windows}
6265 Select a text renderer and set its options. The options depend on the
6266 renderer.
6267
6268 Syntax: >
6269 set rop=type:{renderer}(,{name}:{value})*
6270<
6271 Currently, only one optional renderer is available.
6272
6273 render behavior ~
6274 directx Vim will draw text using DirectX (DirectWrite). It makes
6275 drawn glyphs more beautiful than default GDI.
6276 It requires 'encoding' is "utf-8", and only works on
6277 MS-Windows Vista or newer version.
6278
6279 Options:
6280 name meaning type value ~
6281 gamma gamma float 1.0 - 2.2 (maybe)
6282 contrast enhancedContrast float (unknown)
6283 level clearTypeLevel float (unknown)
6284 geom pixelGeometry int 0 - 2 (see below)
6285 renmode renderingMode int 0 - 6 (see below)
6286 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006287 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006288
Bram Moolenaar92467d32017-12-05 13:22:16 +01006289 See this URL for detail (except for scrlines):
6290 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006291
6292 For geom: structure of a device pixel.
6293 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6294 1 - DWRITE_PIXEL_GEOMETRY_RGB
6295 2 - DWRITE_PIXEL_GEOMETRY_BGR
6296
6297 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006298 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006299
6300 For renmode: method of rendering glyphs.
6301 0 - DWRITE_RENDERING_MODE_DEFAULT
6302 1 - DWRITE_RENDERING_MODE_ALIASED
6303 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6304 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6305 4 - DWRITE_RENDERING_MODE_NATURAL
6306 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6307 6 - DWRITE_RENDERING_MODE_OUTLINE
6308
6309 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006310 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006311
6312 For taamode: antialiasing mode used for drawing text.
6313 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6314 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6315 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6316 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6317
6318 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006319 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6320
Bram Moolenaara338adc2018-01-31 20:51:47 +01006321 For scrlines:
6322 This was used for optimizing scrolling behavior, however this
6323 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006324
6325 Example: >
6326 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006327 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006328 set rop=type:directx
6329<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006330 If select a raster font (Courier, Terminal or FixedSys which
6331 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006332 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006333
6334 NOTE: It is known that some fonts and options combination
6335 causes trouble on drawing glyphs.
6336
Bram Moolenaar92467d32017-12-05 13:22:16 +01006337 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006338 special made fonts (True-Type fonts which includes only
6339 bitmap glyphs).
6340 - 'taamode:3' will not work with some vector fonts.
6341
6342 NOTE: With this option, you can display colored emoji
6343 (emoticon) in Windows 8.1 or later. To display colored emoji,
6344 there are some conditions which you should notice.
6345
6346 - If your font includes non-colored emoji already, it will
6347 be used.
6348 - If your font doesn't have emoji, the system chooses an
6349 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6350 will be used.
6351 - When this alternative font didn't have fixed width glyph,
6352 emoji might be rendered beyond the bounding box of drawing
6353 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006354
6355 Other render types are currently not supported.
6356
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 *'report'*
6358'report' number (default 2)
6359 global
6360 Threshold for reporting number of lines changed. When the number of
6361 changed lines is more than 'report' a message will be given for most
6362 ":" commands. If you want it always, set 'report' to 0.
6363 For the ":substitute" command the number of substitutions is used
6364 instead of the number of lines.
6365
6366 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6367'restorescreen' 'rs' boolean (default on)
6368 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006369 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 When set, the screen contents is restored when exiting Vim. This also
6371 happens when executing external commands.
6372
6373 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6374 options in your .vimrc. To disable restoring:
6375 set t_ti= t_te=
6376 To enable restoring (for an xterm):
6377 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6378 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6379
6380 *'revins'* *'ri'* *'norevins'* *'nori'*
6381'revins' 'ri' boolean (default off)
6382 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383 {only available when compiled with the |+rightleft|
6384 feature}
6385 Inserting characters in Insert mode will work backwards. See "typing
6386 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6387 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006388 NOTE: This option is reset when 'compatible' is set.
6389 This option is reset when 'paste' is set and restored when 'paste' is
6390 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391
6392 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6393'rightleft' 'rl' boolean (default off)
6394 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395 {only available when compiled with the |+rightleft|
6396 feature}
6397 When on, display orientation becomes right-to-left, i.e., characters
6398 that are stored in the file appear from the right to the left.
6399 Using this option, it is possible to edit files for languages that
6400 are written from the right to the left such as Hebrew and Arabic.
6401 This option is per window, so it is possible to edit mixed files
6402 simultaneously, or to view the same file in both ways (this is
6403 useful whenever you have a mixed text file with both right-to-left
6404 and left-to-right strings so that both sets are displayed properly
6405 in different windows). Also see |rileft.txt|.
6406
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006407 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408'rightleftcmd' 'rlc' string (default "search")
6409 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 {only available when compiled with the |+rightleft|
6411 feature}
6412 Each word in this option enables the command line editing to work in
6413 right-to-left mode for a group of commands:
6414
6415 search "/" and "?" commands
6416
6417 This is useful for languages such as Hebrew, Arabic and Farsi.
6418 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6419
Bram Moolenaard94464e2015-11-02 15:28:18 +01006420 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006421'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006422 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006423 {only available when compiled with the |+ruby/dyn|
6424 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006425 Specifies the name of the Ruby shared library. The default is
6426 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006427 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006428 This option cannot be set from a |modeline| or in the |sandbox|, for
6429 security reasons.
6430
Bram Moolenaar071d4272004-06-13 20:20:40 +00006431 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006432'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006434 {not available when compiled without the
6435 |+cmdline_info| feature}
6436 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006437 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006438 text in the file is shown on the far right:
6439 Top first line is visible
6440 Bot last line is visible
6441 All first and last line are visible
6442 45% relative position in the file
6443 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006444 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006446 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 this option takes precedence over 'ruler' and 'rulerformat'
6448 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006449 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 the text column (byte number) and the screen column are shown,
6451 separated with a dash.
6452 For an empty line "0-1" is shown.
6453 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006454 This option is reset when 'paste' is set and restored when 'paste' is
6455 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456 If you don't want to see the ruler all the time but want to know where
6457 you are, use "g CTRL-G" |g_CTRL-G|.
6458 NOTE: This option is reset when 'compatible' is set.
6459
6460 *'rulerformat'* *'ruf'*
6461'rulerformat' 'ruf' string (default empty)
6462 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463 {not available when compiled without the |+statusline|
6464 feature}
6465 When this option is not empty, it determines the content of the ruler
6466 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006467 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006468 This option cannot be set in a modeline when 'modelineexpr' is off.
6469
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 The default ruler width is 17 characters. To make the ruler 15
6471 characters wide, put "%15(" at the start and "%)" at the end.
6472 Example: >
6473 :set rulerformat=%15(%c%V\ %p%%%)
6474<
6475 *'runtimepath'* *'rtp'* *vimfiles*
6476'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006477 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 $VIM/vimfiles,
6479 $VIMRUNTIME,
6480 $VIM/vimfiles/after,
6481 $HOME/.vim/after"
6482 Amiga: "home:vimfiles,
6483 $VIM/vimfiles,
6484 $VIMRUNTIME,
6485 $VIM/vimfiles/after,
6486 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006487 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 $VIM/vimfiles,
6489 $VIMRUNTIME,
6490 $VIM/vimfiles/after,
6491 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006492 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006493 $VIMRUNTIME,
6494 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006495 Haiku: "$BE_USER_SETTINGS/vim,
6496 $VIM/vimfiles,
6497 $VIMRUNTIME,
6498 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006499 $BE_USER_SETTINGS/vim/after"
6500 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501 $VIM/vimfiles,
6502 $VIMRUNTIME,
6503 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006504 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 This is a list of directories which will be searched for runtime
6507 files:
6508 filetype.vim filetypes by file name |new-filetype|
6509 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006510 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006511 colors/ color scheme files |:colorscheme|
6512 compiler/ compiler files |:compiler|
6513 doc/ documentation |write-local-help|
6514 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006515 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 indent/ indent scripts |indent-expression|
6517 keymap/ key mapping files |mbyte-keymap|
6518 lang/ menu translations |:menutrans|
6519 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006520 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 plugin/ plugin scripts |write-plugin|
6522 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006523 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 syntax/ syntax files |mysyntaxfile|
6525 tutor/ files for vimtutor |tutor|
6526
6527 And any other file searched for with the |:runtime| command.
6528
6529 The defaults for most systems are setup to search five locations:
6530 1. In your home directory, for your personal preferences.
6531 2. In a system-wide Vim directory, for preferences from the system
6532 administrator.
6533 3. In $VIMRUNTIME, for files distributed with Vim.
6534 *after-directory*
6535 4. In the "after" directory in the system-wide Vim directory. This is
6536 for the system administrator to overrule or add to the distributed
6537 defaults (rarely needed)
6538 5. In the "after" directory in your home directory. This is for
6539 personal preferences to overrule or add to the distributed defaults
6540 or system-wide settings (rarely needed).
6541
Bram Moolenaard0796902016-09-16 20:02:31 +02006542 More entries are added when using |packages|. If it gets very long
6543 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6544 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006545
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6547 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006548 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 wildcards.
6550 See |:runtime|.
6551 Example: >
6552 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6553< This will use the directory "~/vimruntime" first (containing your
6554 personal Vim runtime files), then "/mygroup/vim" (shared between a
6555 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6556 files).
6557 You probably should always include $VIMRUNTIME somewhere, to use the
6558 distributed runtime files. You can put a directory before $VIMRUNTIME
6559 to find files which replace a distributed runtime files. You can put
6560 a directory after $VIMRUNTIME to find files which add to distributed
6561 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006562 When Vim is started with |--clean| the home directory entries are not
6563 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006564 This option cannot be set from a |modeline| or in the |sandbox|, for
6565 security reasons.
6566
6567 *'scroll'* *'scr'*
6568'scroll' 'scr' number (default: half the window height)
6569 local to window
6570 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6571 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006572 changes. This may happen when enabling the |status-line| or
6573 'tabline' option after setting the 'scroll' option.
6574 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006575 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006576 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577
6578 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6579'scrollbind' 'scb' boolean (default off)
6580 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 See also |scroll-binding|. When this option is set, the current
6582 window scrolls as other scrollbind windows (windows that also have
6583 this option set) scroll. This option is useful for viewing the
6584 differences between two versions of a file, see 'diff'.
6585 See |'scrollopt'| for options that determine how this option should be
6586 interpreted.
6587 This option is mostly reset when splitting a window to edit another
6588 file. This means that ":split | edit file" results in two windows
6589 with scroll-binding, but ":split file" does not.
6590
Bram Moolenaarae20f342019-11-05 21:09:23 +01006591 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6592'scrollfocus' 'scf' boolean (default off)
6593 global
6594 {only for MS-Windows GUI}
6595 When using the scroll wheel and this option is set, the window under
6596 the mouse pointer is scrolled. With this option off the current
6597 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006598 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006599
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600 *'scrolljump'* *'sj'*
6601'scrolljump' 'sj' number (default 1)
6602 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 Minimal number of lines to scroll when the cursor gets off the
6604 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6605 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006606 When set to a negative number from -1 to -100 this is used as the
6607 percentage of the window height. Thus -50 scrolls half the window
6608 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006609 NOTE: This option is set to 1 when 'compatible' is set.
6610
6611 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006612'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006613 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 Minimal number of screen lines to keep above and below the cursor.
6615 This will make some context visible around where you are working. If
6616 you set it to a very large value (999) the cursor line will always be
6617 in the middle of the window (except at the start or end of the file or
6618 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006619 After using the local value, go back the global value with one of
6620 these two: >
6621 setlocal scrolloff<
6622 setlocal scrolloff=-1
6623< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006624 NOTE: This option is set to 0 when 'compatible' is set.
6625
6626 *'scrollopt'* *'sbo'*
6627'scrollopt' 'sbo' string (default "ver,jump")
6628 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006630 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6631 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 The following words are available:
6633 ver Bind vertical scrolling for 'scrollbind' windows
6634 hor Bind horizontal scrolling for 'scrollbind' windows
6635 jump Applies to the offset between two windows for vertical
6636 scrolling. This offset is the difference in the first
6637 displayed line of the bound windows. When moving
6638 around in a window, another 'scrollbind' window may
6639 reach a position before the start or after the end of
6640 the buffer. The offset is not changed though, when
6641 moving back the 'scrollbind' window will try to scroll
6642 to the desired position when possible.
6643 When now making that window the current one, two
6644 things can be done with the relative offset:
6645 1. When "jump" is not included, the relative offset is
6646 adjusted for the scroll position in the new current
6647 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006648 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 2. When "jump" is included, the other windows are
6650 scrolled to keep the same relative offset. When
6651 going back to the other window, it still uses the
6652 same relative offset.
6653 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006654 When 'diff' mode is active there always is vertical scroll binding,
6655 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656
6657 *'sections'* *'sect'*
6658'sections' 'sect' string (default "SHNHH HUnhsh")
6659 global
6660 Specifies the nroff macros that separate sections. These are pairs of
6661 two letters (See |object-motions|). The default makes a section start
6662 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6663
6664 *'secure'* *'nosecure'* *E523*
6665'secure' boolean (default off)
6666 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 When on, ":autocmd", shell and write commands are not allowed in
6668 ".vimrc" and ".exrc" in the current directory and map commands are
6669 displayed. Switch it off only if you know that you will not run into
6670 problems, or when the 'exrc' option is off. On Unix this option is
6671 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006672 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673 'secure' at the end of your ~/.vimrc then.
6674 This option cannot be set from a |modeline| or in the |sandbox|, for
6675 security reasons.
6676
6677 *'selection'* *'sel'*
6678'selection' 'sel' string (default "inclusive")
6679 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 This option defines the behavior of the selection. It is only used
6681 in Visual and Select mode.
6682 Possible values:
6683 value past line inclusive ~
6684 old no yes
6685 inclusive yes yes
6686 exclusive yes no
6687 "past line" means that the cursor is allowed to be positioned one
6688 character past the line.
6689 "inclusive" means that the last character of the selection is included
6690 in an operation. For example, when "x" is used to delete the
6691 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006692 When "old" is used and 'virtualedit' allows the cursor to move past
6693 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 Note that when "exclusive" is used and selecting from the end
6695 backwards, you cannot include the last character of a line, when
6696 starting in Normal mode and 'virtualedit' empty.
6697
6698 The 'selection' option is set by the |:behave| command.
6699
6700 *'selectmode'* *'slm'*
6701'selectmode' 'slm' string (default "")
6702 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006703 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006704 Select mode instead of Visual mode, when a selection is started.
6705 Possible values:
6706 mouse when using the mouse
6707 key when using shifted special keys
6708 cmd when using "v", "V" or CTRL-V
6709 See |Select-mode|.
6710 The 'selectmode' option is set by the |:behave| command.
6711
6712 *'sessionoptions'* *'ssop'*
6713'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006714 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006716 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 feature}
6718 Changes the effect of the |:mksession| command. It is a comma
6719 separated list of words. Each word enables saving and restoring
6720 something:
6721 word save and restore ~
6722 blank empty windows
6723 buffers hidden and unloaded buffers, not just those in windows
6724 curdir the current directory
6725 folds manually created folds, opened/closed folds and local
6726 fold options
6727 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006728 and contain at least one lowercase letter. Only
6729 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 help the help window
6731 localoptions options and mappings local to a window or buffer (not
6732 global values for local options)
6733 options all options and mappings (also global values for local
6734 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006735 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006736 resize size of the Vim window: 'lines' and 'columns'
6737 sesdir the directory in which the session file is located
6738 will become the current directory (useful with
6739 projects accessed over a network from different
6740 systems)
6741 slash backslashes in file names replaced with forward
6742 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006743 tabpages all tab pages; without this only the current tab page
6744 is restored, so that you can make a session for each
6745 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006746 terminal include terminal windows where the command can be
6747 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006748 unix with Unix end-of-line format (single <NL>), even when
6749 on Windows or DOS
6750 winpos position of the whole Vim window
6751 winsize window sizes
6752
6753 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006754 When neither "curdir" nor "sesdir" is included, file names are stored
6755 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006756 If you leave out "options" many things won't work well after restoring
6757 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 "slash" and "unix" are useful on Windows when sharing session files
6759 with Unix. The Unix version of Vim cannot source dos format scripts,
6760 but the Windows version of Vim can source unix format scripts.
6761
6762 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006763'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 global
6765 Name of the shell to use for ! and :! commands. When changing the
6766 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6767 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006768 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769 See |option-backslash| about including spaces and backslashes.
6770 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006771
Bram Moolenaara2baa732022-02-04 16:09:54 +00006772 In |restricted-mode| shell commands will not be possible. This mode
6773 is used if the value of $SHELL ends in "false" or "nologin".
6774
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006775 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006776 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6778< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006779 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006780 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006781 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006783 Example with escaped space (Vim will do this when initializing the
6784 option from $SHELL): >
6785 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006786< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006787 backslashes are consumed by `:set`.
6788
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 Under MS-Windows, when the executable ends in ".com" it must be
6790 included. Thus setting the shell to "command.com" or "4dos.com"
6791 works, but "command" and "4dos" do not work for all commands (e.g.,
6792 filtering).
6793 For unknown reasons, when using "4dos.com" the current directory is
6794 changed to "C:\". To avoid this set 'shell' like this: >
6795 :set shell=command.com\ /c\ 4dos
6796< This option cannot be set from a |modeline| or in the |sandbox|, for
6797 security reasons.
6798
6799 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006800'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006801 Win32, when 'shell' contains "powershell":
6802 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006803 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006804 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006806 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6807 For MS-Windows, the default is set according to the value of 'shell',
6808 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006809 On Unix it can have more than one flag. Each white space separated
6810 part is passed as an argument to the shell command.
6811 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006812 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 This option cannot be set from a |modeline| or in the |sandbox|, for
6814 security reasons.
6815
6816 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006817'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6818 "2>&1| tee", or
6819 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006820 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 {not available when compiled without the |+quickfix|
6822 feature}
6823 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006824 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825 including spaces and backslashes.
6826 The name of the temporary file can be represented by "%s" if necessary
6827 (the file name is appended automatically if no %s appears in the value
6828 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006829 For the Amiga the default is ">". For MS-Windows using powershell the
6830 default is "2>&1 | Out-File -Encoding default", otherwise the default
6831 is ">%s 2>&1". The output is directly saved in a file and not echoed
6832 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006833 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834 in a file and echoed to the screen. If the 'shell' option is "csh" or
6835 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006836 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006837 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6838 means that stderr is also included. Before using the 'shell' option a
6839 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006840 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6841 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842 The initialization of this option is done after reading the ".vimrc"
6843 and the other initializations, so that when the 'shell' option is set
6844 there, the 'shellpipe' option changes automatically, unless it was
6845 explicitly set before.
6846 When 'shellpipe' is set to an empty string, no redirection of the
6847 ":make" output will be done. This is useful if you use a 'makeprg'
6848 that writes to 'makeef' by itself. If you want no piping, but do
6849 want to include the 'makeef', set 'shellpipe' to a single space.
6850 Don't forget to precede the space with a backslash: ":set sp=\ ".
6851 In the future pipes may be used for filtering and this option will
6852 become obsolete (at least for Unix).
6853 This option cannot be set from a |modeline| or in the |sandbox|, for
6854 security reasons.
6855
6856 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006857'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 Quoting character(s), put around the command passed to the shell, for
6860 the "!" and ":!" commands. The redirection is kept outside of the
6861 quoting. See 'shellxquote' to include the redirection. It's
6862 probably not useful to set both options.
6863 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006864 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006865 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 This option cannot be set from a |modeline| or in the |sandbox|, for
6867 security reasons.
6868
6869 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006870'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6871 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006873 String to be used to put the output of a filter command in a temporary
6874 file. See also |:!|. See |option-backslash| about including spaces
6875 and backslashes.
6876 The name of the temporary file can be represented by "%s" if necessary
6877 (the file name is appended automatically if no %s appears in the value
6878 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006879 The default is ">". For Unix, if the 'shell' option is "csh" or
6880 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006881 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006882 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6883 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006884 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6885 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006886 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6887 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888 The initialization of this option is done after reading the ".vimrc"
6889 and the other initializations, so that when the 'shell' option is set
6890 there, the 'shellredir' option changes automatically unless it was
6891 explicitly set before.
6892 In the future pipes may be used for filtering and this option will
6893 become obsolete (at least for Unix).
6894 This option cannot be set from a |modeline| or in the |sandbox|, for
6895 security reasons.
6896
6897 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6898'shellslash' 'ssl' boolean (default off)
6899 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006900 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006902 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006903 powershell.exe. Backward slashes can still be typed, but they are
6904 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905 Note that setting or resetting this option has no effect for some
6906 existing file names, thus this option needs to be set before opening
6907 any file for best results. This might change in the future.
6908 'shellslash' only works when a backslash can be used as a path
6909 separator. To test if this is so use: >
6910 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006911< Also see 'completeslash'.
6912
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006913 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6914'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6915 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006916 When on, use temp files for shell commands. When off use a pipe.
6917 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006918 Currently a pipe is only supported on Unix and MS-Windows 2K and
6919 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006920 :if has("filterpipe")
6921< The advantage of using a pipe is that nobody can read the temp file
6922 and the 'shell' command does not need to support redirection.
6923 The advantage of using a temp file is that the file type and encoding
6924 can be detected.
6925 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6926 |FilterWritePost| autocommands event are not triggered when
6927 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006928 The `system()` function does not respect this option and always uses
6929 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006930 NOTE: This option is set to the Vim default value when 'compatible'
6931 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006932
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933 *'shelltype'* *'st'*
6934'shelltype' 'st' number (default 0)
6935 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006936 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937 On the Amiga this option influences the way how the commands work
6938 which use a shell.
6939 0 and 1: always use the shell
6940 2 and 3: use the shell only to filter lines
6941 4 and 5: use shell only for ':sh' command
6942 When not using the shell, the command is executed directly.
6943
6944 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6945 1 and 3: use "shell cmd" to start external commands
6946
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006947 *'shellxescape'* *'sxe'*
6948'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006949 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006950 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006951 When 'shellxquote' is set to "(" then the characters listed in this
6952 option will be escaped with a '^' character. This makes it possible
6953 to execute most external commands with cmd.exe.
6954
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 *'shellxquote'* *'sxq'*
6956'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006957 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006958 for Win32, when 'shell' is
6959 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006960 for Win32, when 'shell' contains "sh"
6961 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962 for Unix, when using system(): "\"")
6963 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964 Quoting character(s), put around the command passed to the shell, for
6965 the "!" and ":!" commands. Includes the redirection. See
6966 'shellquote' to exclude the redirection. It's probably not useful
6967 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006968 When the value is '(' then ')' is appended. When the value is '"('
6969 then ')"' is appended.
6970 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006971 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006972 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6973 pwsh.exe which automatically strips off the first and last quote on a
6974 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6975 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006976 'shell', to reduce the need to set this option by the user. See
6977 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978 This option cannot be set from a |modeline| or in the |sandbox|, for
6979 security reasons.
6980
6981 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6982'shiftround' 'sr' boolean (default off)
6983 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006984 Round indent to multiple of 'shiftwidth'. Applies to > and <
6985 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6986 a multiple of 'shiftwidth' (this is Vi compatible).
6987 NOTE: This option is reset when 'compatible' is set.
6988
6989 *'shiftwidth'* *'sw'*
6990'shiftwidth' 'sw' number (default 8)
6991 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006992 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006994 When zero the 'ts' value will be used. Use the |shiftwidth()|
6995 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006996
6997 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006998'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6999 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001 This option helps to avoid all the |hit-enter| prompts caused by file
7002 messages, for example with CTRL-G, and to avoid some other messages.
7003 It is a list of flags:
7004 flag meaning when present ~
7005 f use "(3 of 5)" instead of "(file 3 of 5)"
7006 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02007007 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 m use "[+]" instead of "[Modified]"
7009 n use "[New]" instead of "[New File]"
7010 r use "[RO]" instead of "[readonly]"
7011 w use "[w]" instead of "written" for file write message
7012 and "[a]" instead of "appended" for ':w >> file' command
7013 x use "[dos]" instead of "[dos format]", "[unix]" instead of
7014 "[unix format]" and "[mac]" instead of "[mac format]".
7015 a all of the above abbreviations
7016
7017 o overwrite message for writing a file with subsequent message
7018 for reading a file (useful for ":wn" or when 'autowrite' on)
7019 O message for reading a file overwrites any previous message.
7020 Also for quickfix message (e.g., ":cn").
7021 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02007022 hit TOP, continuing at BOTTOM" messages; when using the search
7023 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 t truncate file message at the start if it is too long to fit
7025 on the command-line, "<" will appear in the left most column.
7026 Ignored in Ex mode.
7027 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00007028 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 Ignored in Ex mode.
7030 W don't give "written" or "[w]" when writing a file
7031 A don't give the "ATTENTION" message when an existing swap file
7032 is found.
7033 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02007034 c don't give |ins-completion-menu| messages. For example,
7035 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
7036 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01007037 q use "recording" instead of "recording @a"
7038 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02007039 was used for the command; note that this also affects messages
7040 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007041 S do not show search count message when searching, e.g.
7042 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043
7044 This gives you the opportunity to avoid that a change between buffers
7045 requires you to hit <Enter>, but still gives as useful a message as
7046 possible for the space available. To get the whole message that you
7047 would have got with 'shm' empty, use ":file!"
7048 Useful values:
7049 shm= No abbreviation of message.
7050 shm=a Abbreviation, but no loss of information.
7051 shm=at Abbreviation, and truncate message when necessary.
7052
7053 NOTE: This option is set to the Vi default value when 'compatible' is
7054 set and to the Vim default value when 'compatible' is reset.
7055
7056 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7057'shortname' 'sn' boolean (default off)
7058 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059 Filenames are assumed to be 8 characters plus one extension of 3
7060 characters. Multiple dots in file names are not allowed. When this
7061 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007062 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007064 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007065
7066 *'showbreak'* *'sbr'* *E595*
7067'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007068 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007069 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 feature}
7071 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007072 values are "> " or "+++ ": >
7073 :set showbreak=>\
7074< Note the backslash to escape the trailing space. It's easier like
7075 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007076 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007077< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 comma (in a future version the comma might be used to separate the
7079 part that is shown at the end and at the start of a line).
7080 The characters are highlighted according to the '@' flag in
7081 'highlight'.
7082 Note that tabs after the showbreak will be displayed differently.
7083 If you want the 'showbreak' to appear in between line numbers, add the
7084 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007085 A window-local value overrules a global value. If the global value is
7086 set and you want no value in the current window use NONE: >
7087 :setlocal showbreak=NONE
7088<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007090'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7091 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 {not available when compiled without the
7094 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007095 Show (partial) command in the last line of the screen. Set this
7096 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097 In Visual mode the size of the selected area is shown:
7098 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007099 If the number of bytes is different it is also displayed: "2-6"
7100 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007101 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007102 - When selecting a block, the size in screen characters:
7103 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007104 NOTE: This option is set to the Vi default value when 'compatible' is
7105 set and to the Vim default value when 'compatible' is reset.
7106
7107 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7108'showfulltag' 'sft' boolean (default off)
7109 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 When completing a word in insert mode (see |ins-completion|) from the
7111 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007112 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 matched a C function, you can see a template for what arguments are
7114 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007115 Note that this doesn't work well together with having "longest" in
7116 'completeopt', because the completion from the search pattern may not
7117 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118
7119 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7120'showmatch' 'sm' boolean (default off)
7121 global
7122 When a bracket is inserted, briefly jump to the matching one. The
7123 jump is only done if the match can be seen on the screen. The time to
7124 show the match can be set with 'matchtime'.
7125 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007126 seen or not).
7127 This option is reset when 'paste' is set and restored when 'paste' is
7128 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 When the 'm' flag is not included in 'cpoptions', typing a character
7130 will immediately move the cursor back to where it belongs.
7131 See the "sm" field in 'guicursor' for setting the cursor shape and
7132 blinking when showing the match.
7133 The 'matchpairs' option can be used to specify the characters to show
7134 matches for. 'rightleft' and 'revins' are used to look for opposite
7135 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007136 Also see the matchparen plugin for highlighting the match when moving
7137 around |pi_paren.txt|.
7138 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139
7140 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7141'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7142 global
7143 If in Insert, Replace or Visual mode put a message on the last line.
7144 Use the 'M' flag in 'highlight' to set the type of highlighting for
7145 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007146 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 doesn't mean XIM is really active, especially when 'imactivatekey' is
7148 not set.
7149 NOTE: This option is set to the Vi default value when 'compatible' is
7150 set and to the Vim default value when 'compatible' is reset.
7151
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007152 *'showtabline'* *'stal'*
7153'showtabline' 'stal' number (default 1)
7154 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007155 The value of this option specifies when the line with tab page labels
7156 will be displayed:
7157 0: never
7158 1: only if there are at least two tab pages
7159 2: always
7160 This is both for the GUI and non-GUI implementation of the tab pages
7161 line.
7162 See |tab-page| for more information about tab pages.
7163
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 *'sidescroll'* *'ss'*
7165'sidescroll' 'ss' number (default 0)
7166 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007167 The minimal number of columns to scroll horizontally. Used only when
7168 the 'wrap' option is off and the cursor is moved off of the screen.
7169 When it is zero the cursor will be put in the middle of the screen.
7170 When using a slow terminal set it to a large number or 0. When using
7171 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7172 commands.
7173
7174 *'sidescrolloff'* *'siso'*
7175'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007176 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007178 right of the cursor if 'nowrap' is set. Setting this option to a
7179 value greater than 0 while having |'sidescroll'| also at a non-zero
7180 value makes some context visible in the line you are scrolling in
7181 horizontally (except at beginning of the line). Setting this option
7182 to a large value (like 999) has the effect of keeping the cursor
7183 horizontally centered in the window, as long as one does not come too
7184 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007185 After using the local value, go back the global value with one of
7186 these two: >
7187 setlocal sidescrolloff<
7188 setlocal sidescrolloff=-1
7189< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190
7191 Example: Try this together with 'sidescroll' and 'listchars' as
7192 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007193 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194
7195 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7196 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007197<
7198 *'signcolumn'* *'scl'*
7199'signcolumn' 'scl' string (default "auto")
7200 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007201 {not available when compiled without the |+signs|
7202 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007203 Whether or not to draw the signcolumn. Valid values are:
7204 "auto" only when there is a sign to display
7205 "no" never
7206 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007207 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007208 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007209
7210
7211 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7212'smartcase' 'scs' boolean (default off)
7213 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007214 Override the 'ignorecase' option if the search pattern contains upper
7215 case characters. Only used when the search pattern is typed and
7216 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007217 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007218 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7219 recalling the search pattern from history and hitting <Enter>.
7220 NOTE: This option is reset when 'compatible' is set.
7221
7222 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7223'smartindent' 'si' boolean (default off)
7224 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 {not available when compiled without the
7226 |+smartindent| feature}
7227 Do smart autoindenting when starting a new line. Works for C-like
7228 programs, but can also be used for other languages. 'cindent' does
7229 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007230 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007231 setting 'si' has no effect. 'indentexpr' is a more advanced
7232 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233 Normally 'autoindent' should also be on when using 'smartindent'.
7234 An indent is automatically inserted:
7235 - After a line ending in '{'.
7236 - After a line starting with a keyword from 'cinwords'.
7237 - Before a line starting with '}' (only with the "O" command).
7238 When typing '}' as the first character in a new line, that line is
7239 given the same indent as the matching '{'.
7240 When typing '#' as the first character in a new line, the indent for
7241 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007242 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7244 When using the ">>" command, lines starting with '#' are not shifted
7245 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007246 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007247 This option is reset when 'paste' is set and restored when 'paste' is
7248 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249
7250 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7251'smarttab' 'sta' boolean (default off)
7252 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007254 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7255 <BS> will delete a 'shiftwidth' worth of space at the start of the
7256 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007257 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007258 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7259 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007260 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007261 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007262 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007263 This option is reset when 'paste' is set and restored when 'paste' is
7264 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265 NOTE: This option is reset when 'compatible' is set.
7266
7267 *'softtabstop'* *'sts'*
7268'softtabstop' 'sts' number (default 0)
7269 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007270 Number of spaces that a <Tab> counts for while performing editing
7271 operations, like inserting a <Tab> or using <BS>. It "feels" like
7272 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7273 used. This is useful to keep the 'ts' setting at its standard value
7274 of 8, while being able to edit like it is set to 'sts'. However,
7275 commands like "x" still work on the actual characters.
7276 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007277 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007278 'softtabstop' is set to 0 when the 'paste' option is set and restored
7279 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007280 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7281 spaces is minimized by using <Tab>s.
7282 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7283 set.
7284 NOTE: This option is set to 0 when 'compatible' is set.
7285
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007286 If Vim is compiled with the |+vartabs| feature then the value of
7287 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7288 anything other than an empty string.
7289
Bram Moolenaar217ad922005-03-20 22:37:15 +00007290 *'spell'* *'nospell'*
7291'spell' boolean (default off)
7292 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007293 {not available when compiled without the |+syntax|
7294 feature}
7295 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007296 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007297
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007298 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007299'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007300 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007301 {not available when compiled without the |+syntax|
7302 feature}
7303 Pattern to locate the end of a sentence. The following word will be
7304 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007305 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007306 When this check is not wanted make this option empty.
7307 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007308 Be careful with special characters, see |option-backslash| about
7309 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007310 To set this option automatically depending on the language, see
7311 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007312
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007313 *'spellfile'* *'spf'*
7314'spellfile' 'spf' string (default empty)
7315 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007316 {not available when compiled without the |+syntax|
7317 feature}
7318 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007319 commands. It must end in ".{encoding}.add". You need to include the
7320 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007321 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007322 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007323 |zg| and |zw| commands can be used to access each. This allows using
7324 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007325 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007326 you: Using the first directory in 'runtimepath' that is writable. If
7327 there is no "spell" directory yet it will be created. For the file
7328 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007329 ignoring the region.
7330 The resulting ".spl" file will be used for spell checking, it does not
7331 have to appear in 'spelllang'.
7332 Normally one file is used for all regions, but you can add the region
7333 name if you want to. However, it will then only be used when
7334 'spellfile' is set to it, for entries in 'spelllang' only files
7335 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007336 This option cannot be set from a |modeline| or in the |sandbox|, for
7337 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007338
Bram Moolenaar217ad922005-03-20 22:37:15 +00007339 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007340'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007341 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007342 {not available when compiled without the |+syntax|
7343 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007344 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007345 on spellchecking will be done for these languages. Example: >
7346 set spelllang=en_us,nl,medical
7347< This means US English, Dutch and medical words are recognized. Words
7348 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007349 The word list name must consist of alphanumeric characters, a dash or
7350 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007351 recommended to separate the two letter language name from a
7352 specification. Thus "en-rare" is used for rare English words.
7353 A region name must come last and have the form "_xx", where "xx" is
7354 the two-letter, lower case region name. You can use more than one
7355 region by listing them: "en_us,en_ca" supports both US and Canadian
7356 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007357 Britain. (Note: currently en_au and en_nz dictionaries are older than
7358 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007359 If the name "cjk" is included East Asian characters are excluded from
7360 spell checking. This is useful when editing text that also has Asian
7361 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007362 Note that the "medical" dictionary does not exist, it is just an
7363 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007364 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007365 As a special case the name of a .spl file can be given as-is. The
7366 first "_xx" in the name is removed and used as the region name
7367 (_xx is an underscore, two letters and followed by a non-letter).
7368 This is mainly for testing purposes. You must make sure the correct
7369 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007370 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007371 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7372 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007373 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007374
Bram Moolenaar98692072006-02-04 00:57:42 +00007375 If the |spellfile.vim| plugin is active and you use a language name
7376 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7377 will ask you if you want to download the file.
7378
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007379 After this option has been set successfully, Vim will source the files
7380 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007381 up to the first character that is not an ASCII letter or number and
7382 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007383
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007384 *'spelloptions'* *'spo'*
7385'spelloptions' 'spo' string (default "")
7386 local to buffer
7387 {not available when compiled without the |+syntax|
7388 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007389 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007390 camel When a word is CamelCased, assume "Cased" is a
7391 separate word: every upper-case character in a word
7392 that comes after a lower case character indicates the
7393 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007394
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007395 *'spellsuggest'* *'sps'*
7396'spellsuggest' 'sps' string (default "best")
7397 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007398 {not available when compiled without the |+syntax|
7399 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007400 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007401 the |spellsuggest()| function. This is a comma-separated list of
7402 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007403
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007404 best Internal method that works best for English. Finds
7405 changes like "fast" and uses a bit of sound-a-like
7406 scoring to improve the ordering.
7407
7408 double Internal method that uses two methods and mixes the
7409 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007410 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007411 word. That only works when the language specifies
7412 sound folding. Can be slow and doesn't always give
7413 better results.
7414
7415 fast Internal method that only checks for simple changes:
7416 character inserts/deletes/swaps. Works well for
7417 simple typing mistakes.
7418
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007419 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007420 Not used for |spellsuggest()|. The number of
7421 suggestions is never more than the value of 'lines'
7422 minus two.
7423
Bram Moolenaar585ee072022-01-29 11:22:17 +00007424 timeout:{millisec} Limit the time searching for suggestions to
7425 {millisec} milli seconds. Applies to the following
7426 methods. When omitted the limit is 5000. When
7427 negative there is no limit. {only works when built
7428 with the +reltime feature}
7429
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007430 file:{filename} Read file {filename}, which must have two columns,
7431 separated by a slash. The first column contains the
7432 bad word, the second column the suggested good word.
7433 Example:
7434 theribal/terrible ~
7435 Use this for common mistakes that do not appear at the
7436 top of the suggestion list with the internal methods.
7437 Lines without a slash are ignored, use this for
7438 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007439 The word in the second column must be correct,
7440 otherwise it will not be used. Add the word to an
7441 ".add" file if it is currently flagged as a spelling
7442 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007443 The file is used for all languages.
7444
7445 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7446 trouble with spaces. |v:val| holds the badly spelled
7447 word. The expression must evaluate to a List of
7448 Lists, each with a suggestion and a score.
7449 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007450 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007451 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007452 internal methods use. A lower score is better.
7453 This may invoke |spellsuggest()| if you temporarily
7454 set 'spellsuggest' to exclude the "expr:" part.
7455 Errors are silently ignored, unless you set the
7456 'verbose' option to a non-zero value.
7457
7458 Only one of "best", "double" or "fast" may be used. The others may
7459 appear several times in any order. Example: >
7460 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7461<
7462 This option cannot be set from a |modeline| or in the |sandbox|, for
7463 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007464
7465
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7467'splitbelow' 'sb' boolean (default off)
7468 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469 When on, splitting a window will put the new window below the current
7470 one. |:split|
7471
7472 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7473'splitright' 'spr' boolean (default off)
7474 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007475 When on, splitting a window will put the new window right of the
7476 current one. |:vsplit|
7477
7478 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7479'startofline' 'sol' boolean (default on)
7480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007482 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007483 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007484 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 with a linewise operator, with "%" with a count and to buffer changing
7486 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7487 only has a line number, e.g., ":25" or ":+".
7488 In case of buffer changing commands the cursor is placed at the column
7489 where it was the last time the buffer was edited.
7490 NOTE: This option is set when 'compatible' is set.
7491
Bram Moolenaar00654022011-02-25 14:42:19 +01007492 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007494 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495 {not available when compiled without the |+statusline|
7496 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007497 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007498 Also see |status-line|.
7499
7500 The option consists of printf style '%' items interspersed with
7501 normal text. Each status line item is of the form:
7502 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007503 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007504 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505
Bram Moolenaar238a5642006-02-21 22:12:05 +00007506 When the option starts with "%!" then it is used as an expression,
7507 evaluated and the result is used as the option value. Example: >
7508 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007509< The *g:statusline_winid* variable will be set to the |window-ID| of the
7510 window that the status line belongs to.
7511 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007512 Note that the "%!" expression is evaluated in the context of the
7513 current window and buffer, while %{} items are evaluated in the
7514 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007515
7516 When there is error while evaluating the option then it will be made
7517 empty to avoid further errors. Otherwise screen updating would loop.
7518
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 Note that the only effect of 'ruler' when this option is set (and
7520 'laststatus' is 2) is controlling the output of |CTRL-G|.
7521
7522 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007523 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007524 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007525 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526 minwid Minimum width of the item, padding as set by '-' & '0'.
7527 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007528 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 on the left for text items. Numeric items will be
7530 shifted down to maxwid-2 digits followed by '>'number
7531 where number is the amount of missing digits, much like
7532 an exponential notation.
7533 item A one letter code as described below.
7534
7535 Following is a description of the possible statusline items. The
7536 second character in "item" is the type:
7537 N for number
7538 S for string
7539 F for flags as described below
7540 - not applicable
7541
7542 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007543 f S Path to the file in the buffer, as typed or relative to current
7544 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545 F S Full path to the file in the buffer.
7546 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007547 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007549 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007550 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007551 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007553 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007555 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007557 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7559 being used: "<keymap>"
7560 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007561 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 B N As above, in hexadecimal.
7563 o N Byte number in file of byte under cursor, first byte is 1.
7564 Mnemonic: Offset from start of file (with one added)
7565 {not available when compiled without |+byte_offset| feature}
7566 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007567 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 l N Line number.
7569 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007570 c N Column number (byte index).
7571 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007572 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 p N Percentage through file in lines as in |CTRL-G|.
7574 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007575 percentage described for 'ruler'. Always 3 in length, unless
7576 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007577 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007579 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007580 Note that there is no '%' before the closing '}'. The
7581 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007582 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007583 {% - This is almost same as { except the result of the expression is
7584 re-evaluated as a statusline format string. Thus if the
7585 return value of expr contains % items they will get expanded.
7586 The expression can contain the } character, the end of
7587 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007588 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007589 func! Stl_filename() abort
7590 return "%t"
7591 endfunc
7592< `stl=%{Stl_filename()}` results in `"%t"`
7593 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007594 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595 ( - Start of item group. Can be used for setting the width and
7596 alignment of a section. Must be followed by %) somewhere.
7597 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007598 T N For 'tabline': start of tab page N label. Use %T after the last
7599 label. This information is used for mouse clicks.
7600 X N For 'tabline': start of close tab N label. Use %X after the
7601 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7602 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603 < - Where to truncate line if too long. Default is at the start.
7604 No width fields allowed.
7605 = - Separation point between left and right aligned items.
7606 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007607 # - Set highlight group. The name must follow and then a # again.
7608 Thus use %#HLname# for highlight group HLname. The same
7609 highlighting is used, also for the statusline of non-current
7610 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007611 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007612 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007613 The difference between User{N} and StatusLine will be applied
7614 to StatusLineNC for the statusline of non-current windows.
7615 The number N must be between 1 and 9. See |hl-User1..9|
7616
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007617 When displaying a flag, Vim removes the leading comma, if any, when
7618 that flag comes right after plaintext. This will make a nice display
7619 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620
Bram Moolenaar582fd852005-03-28 20:58:01 +00007621 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007622 not set) and a minwid is not set for the group, the whole group will
7623 become empty. This will make a group like the following disappear
7624 completely from the statusline when none of the flags are set. >
7625 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007626< Beware that an expression is evaluated each and every time the status
7627 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007628 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007629 While evaluating %{} the current buffer and current window will be set
7630 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007631 currently being drawn. The expression will evaluate in this context.
7632 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7633 real current buffer and "g:actual_curwin" to the |window-ID| of the
7634 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007635
Bram Moolenaar30b65812012-07-12 22:01:11 +02007636 The 'statusline' option will be evaluated in the |sandbox| if set from
7637 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007638 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007639
7640 It is not allowed to change text or jump to another window while
7641 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642
7643 If the statusline is not updated when you want it (e.g., after setting
7644 a variable that's used in an expression), you can force an update by
7645 setting an option without changing its value. Example: >
7646 :let &ro = &ro
7647
7648< A result of all digits is regarded a number for display purposes.
7649 Otherwise the result is taken as flag text and applied to the rules
7650 described above.
7651
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007652 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007653 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007654 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655
7656 Examples:
7657 Emulate standard status line with 'ruler' set >
7658 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7659< Similar, but add ASCII value of char under the cursor (like "ga") >
7660 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7661< Display byte count and byte value, modified flag in red. >
7662 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7663 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7664< Display a ,GZ flag if a compressed file is loaded >
7665 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7666< In the |:autocmd|'s: >
7667 :let b:gzflag = 1
7668< And: >
7669 :unlet b:gzflag
7670< And define this function: >
7671 :function VarExists(var, val)
7672 : if exists(a:var) | return a:val | else | return '' | endif
7673 :endfunction
7674<
7675 *'suffixes'* *'su'*
7676'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7677 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007678 Files with these suffixes get a lower priority when multiple files
7679 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007680 suffixes. Spaces after the comma are ignored. A dot is also seen as
7681 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682 separator, precede it with a backslash (see |option-backslash| about
7683 including spaces and backslashes).
7684 See 'wildignore' for completely ignoring files.
7685 The use of |:set+=| and |:set-=| is preferred when adding or removing
7686 suffixes from the list. This avoids problems when a future version
7687 uses another default.
7688
7689 *'suffixesadd'* *'sua'*
7690'suffixesadd' 'sua' string (default "")
7691 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007692 {not available when compiled without the
7693 |+file_in_path| feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007694 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007695 file for the "gf", "[I", etc. commands. Example: >
7696 :set suffixesadd=.java
7697<
7698 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7699'swapfile' 'swf' boolean (default on)
7700 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007701 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007702 swapfile is not wanted for a specific buffer. For example, with
7703 confidential information that even root must not be able to access.
7704 Careful: All text will be in memory:
7705 - Don't use this for big files.
7706 - Recovery will be impossible!
7707 A swapfile will only be present when |'updatecount'| is non-zero and
7708 'swapfile' is set.
7709 When 'swapfile' is reset, the swap file for the current buffer is
7710 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7711 non-zero, a swap file is immediately created.
7712 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007713 If you want to open a new buffer without creating a swap file for it,
7714 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007715 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007716
7717 This option is used together with 'bufhidden' and 'buftype' to
7718 specify special kinds of buffers. See |special-buffers|.
7719
7720 *'swapsync'* *'sws'*
7721'swapsync' 'sws' string (default "fsync")
7722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007724 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 When this option is empty parts of the swap file may be in memory and
7726 not written to disk. When the system crashes you may lose more work.
7727 On Unix the system does a sync now and then without Vim asking for it,
7728 so the disadvantage of setting this option off is small. On some
7729 systems the swap file will not be written at all. For a unix system
7730 setting it to "sync" will use the sync() call instead of the default
7731 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007732 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733
7734 *'switchbuf'* *'swb'*
7735'switchbuf' 'swb' string (default "")
7736 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007737 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007738 Mostly for |quickfix| commands some values are also used for other
7739 commands, as mentioned below.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007740 Possible values (comma-separated list):
Bram Moolenaar071d4272004-06-13 20:20:40 +00007741 useopen If included, jump to the first open window that
7742 contains the specified buffer (if there is one).
7743 Otherwise: Do not examine other windows.
7744 This setting is checked with |quickfix| commands, when
7745 jumping to errors (":cc", ":cn", "cp", etc.). It is
7746 also used in all buffer related split commands, for
7747 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007748 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007749 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007750 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007751 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007752 Otherwise: do not split, use current window (when used
7753 in the quickfix window: the previously used window or
7754 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007755 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007756 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007757 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007758 uselast If included, jump to the previously used window when
7759 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007761 *'synmaxcol'* *'smc'*
7762'synmaxcol' 'smc' number (default 3000)
7763 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007764 {not available when compiled without the |+syntax|
7765 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007766 Maximum column in which to search for syntax items. In long lines the
7767 text after this column is not highlighted and following lines may not
7768 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007769 This helps to avoid very slow redrawing for an XML file that is one
7770 long line.
7771 Set to zero to remove the limit.
7772
Bram Moolenaar071d4272004-06-13 20:20:40 +00007773 *'syntax'* *'syn'*
7774'syntax' 'syn' string (default empty)
7775 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007776 {not available when compiled without the |+syntax|
7777 feature}
7778 When this option is set, the syntax with this name is loaded, unless
7779 syntax highlighting has been switched off with ":syntax off".
7780 Otherwise this option does not always reflect the current syntax (the
7781 b:current_syntax variable does).
7782 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007783 not automatically recognized. Example, in an IDL file:
7784 /* vim: set syntax=idl : */ ~
7785 When a dot appears in the value then this separates two filetype
7786 names. Example:
7787 /* vim: set syntax=c.doxygen : */ ~
7788 This will use the "c" syntax first, then the "doxygen" syntax.
7789 Note that the second one must be prepared to be loaded as an addition,
7790 otherwise it will be skipped. More than one dot may appear.
7791 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007792 :set syntax=OFF
7793< To switch syntax highlighting on according to the current value of the
7794 'filetype' option: >
7795 :set syntax=ON
7796< What actually happens when setting the 'syntax' option is that the
7797 Syntax autocommand event is triggered with the value as argument.
7798 This option is not copied to another buffer, independent of the 's' or
7799 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007800 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007801
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007802 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007803'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007804 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00007805 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007806 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007807 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007808
7809 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007810 option and only when there is no GUI tab line. When 'e' is in
7811 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007812 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007813
7814 The value is evaluated like with 'statusline'. You can use
7815 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007816 the text to be displayed. Use "%1T" for the first label, "%2T" for
7817 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007818
Bram Moolenaare12bab32019-01-08 22:02:56 +01007819 When changing something that is used in 'tabline' that does not
7820 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007821 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007822
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007823 Keep in mind that only one of the tab pages is the current one, others
7824 are invisible and you can't jump to their windows.
7825
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007826
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007827 *'tabpagemax'* *'tpm'*
7828'tabpagemax' 'tpm' number (default 10)
7829 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007830 Maximum number of tab pages to be opened by the |-p| command line
7831 argument or the ":tab all" command. |tabpage|
7832
7833
7834 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835'tabstop' 'ts' number (default 8)
7836 local to buffer
7837 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007838 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007839
7840 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007841 appear wrong in many places, e.g., when printing it.
7842 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007843
7844 There are four main ways to use tabs in Vim:
7845 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7846 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007847 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 behave like a tab appears every 4 (or 3) characters.
7849 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7850 'expandtab'. This way you will always insert spaces. The
7851 formatting will never be messed up when 'tabstop' is changed.
7852 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007853 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854 works when using Vim to edit the file.
7855 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7856 'noexpandtab'. This should then work (for initial indents only)
7857 for any tabstop setting that people use. It might be nice to have
7858 tabs after the first non-blank inserted as spaces if you do this
7859 though. Otherwise aligned comments will be wrong when 'tabstop' is
7860 changed.
7861
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007862 If Vim is compiled with the |+vartabs| feature then the value of
7863 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7864 than an empty string.
7865
Bram Moolenaar071d4272004-06-13 20:20:40 +00007866 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7867'tagbsearch' 'tbs' boolean (default on)
7868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007869 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007870 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007871 searching makes searching for a tag a LOT faster, but a linear search
7872 will find more tags if the tags file wasn't properly sorted.
7873 Vim normally assumes that your tags files are sorted, or indicate that
7874 they are not sorted. Only when this is not the case does the
7875 'tagbsearch' option need to be switched off.
7876
7877 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007878 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 certain files, or retry all files with a linear search. When
7880 'tagbsearch' is off, only a linear search is done.
7881
7882 Linear searching is done anyway, for one file, when Vim finds a line
7883 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007884 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007885< [The whitespace before and after the '0' must be a single <Tab>]
7886
7887 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007888 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 instead of a normal tag name, a retry is done with a linear search.
7890 Tags in unsorted tags files, and matches with different case will only
7891 be found in the retry.
7892
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007893 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007894 linear search can be avoided when case is ignored. Use a value of '2'
7895 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7896 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00007897 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
7898 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
7899 used for this as well. Note that case must be folded to uppercase for
7900 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007901
7902 By default, tag searches are case-sensitive. Case is ignored when
7903 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7904 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007905 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7906 'tagcase' is "smart", and the pattern contains only lowercase
7907 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007908
7909 When 'tagbsearch' is off, tags searching is slower when a full match
7910 exists, but faster when no full match exists. Tags in unsorted tags
7911 files may only be found with 'tagbsearch' off.
7912 When the tags file is not sorted, or sorted in a wrong way (not on
7913 ASCII byte value), 'tagbsearch' should be off, or the line given above
7914 must be included in the tags file.
7915 This option doesn't affect commands that find all matching tags (e.g.,
7916 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007917
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007918 *'tagcase'* *'tc'*
7919'tagcase' 'tc' string (default "followic")
7920 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007921 This option specifies how case is handled when searching the tags
7922 file:
7923 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007924 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007925 ignore Ignore case
7926 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007927 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007928 NOTE: This option is set to the Vi default value when 'compatible' is
7929 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007930
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007931 *'tagfunc'* *'tfu'*
7932'tagfunc' 'tfu' string (default: empty)
7933 local to buffer
7934 {not available when compiled without the |+eval|
7935 feature}
7936 This option specifies a function to be used to perform tag searches.
7937 The function gets the tag pattern and should return a List of matching
7938 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007939 function and an example. The value can be the name of a function, a
7940 |lambda| or a |Funcref|. See |option-value-function| for more
7941 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007942
Bram Moolenaar071d4272004-06-13 20:20:40 +00007943 *'taglength'* *'tl'*
7944'taglength' 'tl' number (default 0)
7945 global
7946 If non-zero, tags are significant up to this number of characters.
7947
7948 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7949'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7950 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007951 If on and using a tags file in another directory, file names in that
7952 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953 NOTE: This option is set to the Vi default value when 'compatible' is
7954 set and to the Vim default value when 'compatible' is reset.
7955
7956 *'tags'* *'tag'* *E433*
7957'tags' 'tag' string (default "./tags,tags", when compiled with
7958 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7959 global or local to buffer |global-local|
7960 Filenames for the tag command, separated by spaces or commas. To
7961 include a space or comma in a file name, precede it with a backslash
7962 (see |option-backslash| about including spaces and backslashes).
7963 When a file name starts with "./", the '.' is replaced with the path
7964 of the current file. But only when the 'd' flag is not included in
7965 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7966 |tags-option|.
7967 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007968 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7969 find all files named "tags" below "/lib". The filename itself cannot
7970 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7971 files called "tags?". {not available when compiled without the
7972 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007973 The |tagfiles()| function can be used to get a list of the file names
7974 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7976 files are also supported. They are automatically recognized. The
7977 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7978 differences are ignored (MS-Windows). |emacs-tags|
7979 The use of |:set+=| and |:set-=| is preferred when adding or removing
7980 file names from the list. This avoids problems when a future version
7981 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982
7983 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7984'tagstack' 'tgst' boolean (default on)
7985 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986 When on, the |tagstack| is used normally. When off, a ":tag" or
7987 ":tselect" command with an argument will not push the tag onto the
7988 tagstack. A following ":tag" without an argument, a ":pop" command or
7989 any other command that uses the tagstack will use the unmodified
7990 tagstack, but does change the pointer to the active entry.
7991 Resetting this option is useful when using a ":tag" command in a
7992 mapping which should not change the tagstack.
7993
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007994 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007995'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007996 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007997 {only available when compiled with the |+tcl/dyn|
7998 feature}
7999 Specifies the name of the Tcl shared library. The default is
8000 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008001 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008002 This option cannot be set from a |modeline| or in the |sandbox|, for
8003 security reasons.
8004
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 *'term'* *E529* *E530* *E531*
8006'term' string (default is $TERM, if that fails:
8007 in the GUI: "builtin_gui"
8008 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008009 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008010 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011 on Unix: "ansi"
8012 on VMS: "ansi"
8013 on Win 32: "win32")
8014 global
8015 Name of the terminal. Used for choosing the terminal control
8016 characters. Environment variables are expanded |:set_env|.
8017 For example: >
8018 :set term=$TERM
8019< See |termcap|.
8020
8021 *'termbidi'* *'tbidi'*
8022 *'notermbidi'* *'notbidi'*
8023'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8024 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008025 {only available when compiled with the |+arabic|
8026 feature}
8027 The terminal is in charge of Bi-directionality of text (as specified
8028 by Unicode). The terminal is also expected to do the required shaping
8029 that some languages (such as Arabic) require.
8030 Setting this option implies that 'rightleft' will not be set when
8031 'arabic' is set and the value of 'arabicshape' will be ignored.
8032 Note that setting 'termbidi' has the immediate effect that
8033 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8034 This option is reset when the GUI is started.
8035 For further details see |arabic.txt|.
8036
8037 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008038'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008040 Encoding used for the terminal. This specifies what character
8041 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008042 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008043 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008044 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008045 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008046 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8047 Any attempts to set a different value will be rejected, and an error
8048 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008049 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008050 because the Win32 system always passes Unicode characters.
8051 When empty, the same encoding is used as for the 'encoding' option.
8052 This is the normal value.
8053 Not all combinations for 'termencoding' and 'encoding' are valid. See
8054 |encoding-table|.
8055 The value for this option must be supported by internal conversions or
8056 iconv(). When this is not possible no conversion will be done and you
8057 will probably experience problems with non-ASCII characters.
8058 Example: You are working with the locale set to euc-jp (Japanese) and
8059 want to edit a UTF-8 file: >
8060 :let &termencoding = &encoding
8061 :set encoding=utf-8
8062< You need to do this when your system has no locale support for UTF-8.
8063
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008064 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008065'termguicolors' 'tgc' boolean (default off)
8066 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008067 {not available when compiled without the
8068 |+termguicolors| feature}
8069 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008070 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008071
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008072 Requires a ISO-8613-3 compatible terminal. If setting this option
8073 does not work (produces a colorless UI) reading |xterm-true-color|
8074 might help.
8075
8076 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8077 is required. Use this check to find out: >
8078 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008079< This requires Vim to be built with the |+vtp| feature.
8080
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008081 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008082 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008083
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008084 *'termwinkey'* *'twk'*
8085'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008086 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008087 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008088 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008089 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008090 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008091< The string must be one key stroke but can be multiple bytes.
8092 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008093 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008094 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008095
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008096 *'termwinscroll'* *'twsl'*
8097'termwinscroll' 'twsl' number (default 10000)
8098 local to buffer
8099 {not available when compiled without the
8100 |+terminal| feature}
8101 Number of scrollback lines to keep. When going over this limit the
8102 first 10% of the scrollback lines are deleted. This is just to reduce
8103 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008104 Also used as a limit for text sent to the terminal in one write,
8105 multiplied by the number of columns times 3 (average number of bytes
8106 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008107
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008108 *'termwinsize'* *'tws'*
8109'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008110 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008111 Size used when opening the |terminal| window. Format:
8112 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008113 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008114 - When set with a "x" (e.g., "24x80") the terminal size is not
8115 adjusted to the window size. If the window is smaller only the
8116 top-left part is displayed.
8117 - When set with a "*" (e.g., "10*50") the terminal size follows the
8118 window size, but will not be smaller than the specified rows and/or
8119 columns.
8120 - When rows is zero then use the height of the window.
8121 - When columns is zero then use the width of the window.
8122 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008123 - Can be overruled in the |term_start()| options with "term_rows" and
8124 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008125
8126 Examples:
8127 "30x0" uses 30 rows and the current window width.
8128 "20*0" uses at least 20 rows and the current window width.
8129 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008130 Note that the command running in the terminal window may still change
8131 the size of the terminal. In that case the Vim window will be
8132 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008133
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008134 *'termwintype'* *'twt'*
8135'termwintype' 'twt' string (default "")
8136 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008137 {only available when compiled with the |terminal|
8138 feature on MS-Windows}
8139 Specify the virtual console (pty) used when opening the terminal
8140 window.
8141
8142 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008143 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008144 "winpty" use winpty, fail if not supported
8145 "conpty" use |ConPTY|, fail if not supported
8146
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008147 |ConPTY| support depends on the platform. Windows 10 October 2018
8148 Update is the first version that supports ConPTY, however it is still
8149 considered unstable. ConPTY might become stable in the next release
8150 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008151 supported then you cannot open a terminal window.
8152
Bram Moolenaar071d4272004-06-13 20:20:40 +00008153 *'terse'* *'noterse'*
8154'terse' boolean (default off)
8155 global
8156 When set: Add 's' flag to 'shortmess' option (this makes the message
8157 for a search that hits the start or end of the file not being
8158 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8159 shortens a lot of messages}
8160
8161 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8162'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8163 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008164 This option is obsolete. Use 'fileformats'.
8165 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8166 set to the default value for the current system. When 'textauto' is
8167 reset, 'fileformats' is made empty.
8168 NOTE: This option is set to the Vi default value when 'compatible' is
8169 set and to the Vim default value when 'compatible' is reset.
8170
8171 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008172'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008173 others: default off)
8174 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008175 This option is obsolete. Use 'fileformat'.
8176 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8177 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8178 "unix".
8179
8180 *'textwidth'* *'tw'*
8181'textwidth' 'tw' number (default 0)
8182 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008183 Maximum width of text that is being inserted. A longer line will be
8184 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008185 this.
8186 'textwidth' is set to 0 when the 'paste' option is set and restored
8187 when 'paste' is reset.
8188 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008189 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008190 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008191 NOTE: This option is set to 0 when 'compatible' is set.
8192
8193 *'thesaurus'* *'tsr'*
8194'thesaurus' 'tsr' string (default "")
8195 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008196 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008197 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8198 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008199
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008200 This option is not used if 'thesaurusfunc' is set, either for the
8201 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008202
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008203 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008204 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008205 name. See |option-backslash| about using backslashes. The use of
8206 |:set+=| and |:set-=| is preferred when adding or removing directories
8207 from the list. This avoids problems when a future version uses
8208 another default. Backticks cannot be used in this option for security
8209 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008210
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008211 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008212'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008213 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008214 {not available when compiled without the |+eval|
8215 feature}
8216 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008217 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008218 The value can be the name of a function, a |lambda| or a |Funcref|.
8219 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008220
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008221 This option cannot be set from a |modeline| or in the |sandbox|, for
8222 security reasons.
8223
Bram Moolenaar071d4272004-06-13 20:20:40 +00008224 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8225'tildeop' 'top' boolean (default off)
8226 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227 When on: The tilde command "~" behaves like an operator.
8228 NOTE: This option is reset when 'compatible' is set.
8229
8230 *'timeout'* *'to'* *'notimeout'* *'noto'*
8231'timeout' 'to' boolean (default on)
8232 global
8233 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008234'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008235 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008236 These two options together determine the behavior when part of a
8237 mapped key sequence or keyboard code has been received:
8238
8239 'timeout' 'ttimeout' action ~
8240 off off do not time out
8241 on on or off time out on :mappings and key codes
8242 off on time out on key codes
8243
8244 If both options are off, Vim will wait until either the complete
8245 mapping or key sequence has been received, or it is clear that there
8246 is no mapping or key sequence for the received characters. For
8247 example: if you have mapped "vl" and Vim has received 'v', the next
8248 character is needed to see if the 'v' is followed by an 'l'.
8249 When one of the options is on, Vim will wait for about 1 second for
8250 the next character to arrive. After that the already received
8251 characters are interpreted as single characters. The waiting time can
8252 be changed with the 'timeoutlen' option.
8253 On slow terminals or very busy systems timing out may cause
8254 malfunctioning cursor keys. If both options are off, Vim waits
8255 forever after an entered <Esc> if there are key codes that start
8256 with <Esc>. You will have to type <Esc> twice. If you do not have
8257 problems with key codes, but would like to have :mapped key
8258 sequences not timing out in 1 second, set the 'ttimeout' option and
8259 reset the 'timeout' option.
8260
8261 NOTE: 'ttimeout' is reset when 'compatible' is set.
8262
8263 *'timeoutlen'* *'tm'*
8264'timeoutlen' 'tm' number (default 1000)
8265 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008266
Bram Moolenaar071d4272004-06-13 20:20:40 +00008267 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008268'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008269 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008270 The time in milliseconds that is waited for a key code or mapped key
8271 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8272 when part of a command has been typed.
8273 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8274 different timeout value for key codes is desired set 'ttimeoutlen' to
8275 a non-negative number.
8276
8277 ttimeoutlen mapping delay key code delay ~
8278 < 0 'timeoutlen' 'timeoutlen'
8279 >= 0 'timeoutlen' 'ttimeoutlen'
8280
8281 The timeout only happens when the 'timeout' and 'ttimeout' options
8282 tell so. A useful setting would be >
8283 :set timeout timeoutlen=3000 ttimeoutlen=100
8284< (time out on mapping after three seconds, time out on key codes after
8285 a tenth of a second).
8286
8287 *'title'* *'notitle'*
8288'title' boolean (default off, on when title can be restored)
8289 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008290 When on, the title of the window will be set to the value of
8291 'titlestring' (if it is not empty), or to:
8292 filename [+=-] (path) - VIM
8293 Where:
8294 filename the name of the file being edited
8295 - indicates the file cannot be modified, 'ma' off
8296 + indicates the file was modified
8297 = indicates the file is read-only
8298 =+ indicates the file is read-only and modified
8299 (path) is the path of the file being edited
8300 - VIM the server name |v:servername| or "VIM"
8301 Only works if the terminal supports setting window titles
8302 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008303 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008304 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8305 *X11*
8306 When Vim was compiled with HAVE_X11 defined, the original title will
8307 be restored if possible. The output of ":version" will include "+X11"
8308 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8309 works for the icon name |'icon'|.
8310 But: When Vim was started with the |-X| argument, restoring the title
8311 will not work (except in the GUI).
8312 If the title cannot be restored, it is set to the value of 'titleold'.
8313 You might want to restore the title outside of Vim then.
8314 When using an xterm from a remote machine you can use this command:
8315 rsh machine_name xterm -display $DISPLAY &
8316 then the WINDOWID environment variable should be inherited and the
8317 title of the window should change back to what it should be after
8318 exiting Vim.
8319
8320 *'titlelen'*
8321'titlelen' number (default 85)
8322 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008323 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008324 title. When the title is longer, only the end of the path name is
8325 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008326 Using a percentage makes this adapt to the width of the window. But
8327 it won't work perfectly, because the actual number of characters
8328 available also depends on the font used and other things in the title
8329 bar. When 'titlelen' is zero the full path is used. Otherwise,
8330 values from 1 to 30000 percent can be used.
8331 'titlelen' is also used for the 'titlestring' option.
8332
8333 *'titleold'*
8334'titleold' string (default "Thanks for flying Vim")
8335 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008336 This option will be used for the window title when exiting Vim if the
8337 original title cannot be restored. Only happens if 'title' is on or
8338 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008339 This option cannot be set from a |modeline| or in the |sandbox|, for
8340 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008341 *'titlestring'*
8342'titlestring' string (default "")
8343 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008344 When this option is not empty, it will be used for the title of the
8345 window. This happens only when the 'title' option is on.
8346 Only works if the terminal supports setting window titles (currently
8347 Amiga console, Win32 console, all GUI versions and terminals with a
8348 non-empty 't_ts' option).
8349 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008350 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008351
Bram Moolenaar071d4272004-06-13 20:20:40 +00008352 When this option contains printf-style '%' items, they will be
8353 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008354 This option cannot be set in a modeline when 'modelineexpr' is off.
8355
Bram Moolenaar071d4272004-06-13 20:20:40 +00008356 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008357 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008358 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8359< The value of 'titlelen' is used to align items in the middle or right
8360 of the available space.
8361 Some people prefer to have the file name first: >
8362 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8363< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008364 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365 separating space only when needed.
8366 NOTE: Use of special characters in 'titlestring' may cause the display
8367 to be garbled (e.g., when it contains a CR or NL character).
8368 {not available when compiled without the |+statusline| feature}
8369
8370 *'toolbar'* *'tb'*
8371'toolbar' 'tb' string (default "icons,tooltips")
8372 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008373 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008374 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 possible values are:
8376 icons Toolbar buttons are shown with icons.
8377 text Toolbar buttons shown with text.
8378 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008379 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008380 tooltips Tooltips are active for toolbar buttons.
8381 Tooltips refer to the popup help text which appears after the mouse
8382 cursor is placed over a toolbar button for a brief moment.
8383
8384 If you want the toolbar to be shown with icons as well as text, do the
8385 following: >
8386 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008387< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388 will show icons if both are requested.
8389
8390 If none of the strings specified in 'toolbar' are valid or if
8391 'toolbar' is empty, this option is ignored. If you want to disable
8392 the toolbar, you need to set the 'guioptions' option. For example: >
8393 :set guioptions-=T
8394< Also see |gui-toolbar|.
8395
8396 *'toolbariconsize'* *'tbis'*
8397'toolbariconsize' 'tbis' string (default "small")
8398 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008399 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008401 tiny Use tiny icons.
8402 small Use small icons (default).
8403 medium Use medium-sized icons.
8404 large Use large icons.
8405 huge Use even larger icons.
8406 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008408 the current theme. Common dimensions are giant=48x48, huge=32x32,
8409 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008410
8411 If 'toolbariconsize' is empty, the global default size as determined
8412 by user preferences or the current theme is used.
8413
8414 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8415'ttybuiltin' 'tbi' boolean (default on)
8416 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008417 When on, the builtin termcaps are searched before the external ones.
8418 When off the builtin termcaps are searched after the external ones.
8419 When this option is changed, you should set the 'term' option next for
8420 the change to take effect, for example: >
8421 :set notbi term=$TERM
8422< See also |termcap|.
8423 Rationale: The default for this option is "on", because the builtin
8424 termcap entries are generally better (many systems contain faulty
8425 xterm entries...).
8426
8427 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8428'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8429 sun-cmd, screen, rxvt, dtterm or
8430 iris-ansi; also on when running Vim in
8431 a DOS console)
8432 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008433 Indicates a fast terminal connection. More characters will be sent to
8434 the screen for redrawing, instead of using insert/delete line
8435 commands. Improves smoothness of redrawing when there are multiple
8436 windows and the terminal does not support a scrolling region.
8437 Also enables the extra writing of characters at the end of each screen
8438 line for lines that wrap. This helps when using copy/paste with the
8439 mouse in an xterm and other terminals.
8440
8441 *'ttymouse'* *'ttym'*
8442'ttymouse' 'ttym' string (default depends on 'term')
8443 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008444 {only in Unix and VMS, doesn't work in the GUI; not
8445 available when compiled without |+mouse|}
8446 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008447 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008448 *xterm-mouse*
8449 xterm xterm-like mouse handling. The mouse generates
8450 "<Esc>[Mscr", where "scr" is three bytes:
8451 "s" = button state
8452 "c" = column plus 33
8453 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008454 This only works up to 223 columns! See "dec",
8455 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008456 xterm2 Works like "xterm", but with the xterm reporting the
8457 mouse position while the mouse is dragged. This works
8458 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008459 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008460 work. See below for how Vim detects this
8461 automatically.
8462 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008463 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008464 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008465 for the row and column. No other mouse events are
8466 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008467 *dec-mouse*
8468 dec DEC terminal mouse handling. The mouse generates a
8469 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008470 This is also available for an Xterm, if it was
8471 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008472 *jsbterm-mouse*
8473 jsbterm JSB term mouse handling.
8474 *pterm-mouse*
8475 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008476 *urxvt-mouse*
8477 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008478 The mouse works only if the terminal supports this
8479 encoding style, but it does not have 223 columns limit
8480 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008481 *sgr-mouse*
8482 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008483 mouse reporting. The mouse works even in columns
8484 beyond 223. This option is backward compatible with
8485 "xterm2" because it can also decode "xterm2" style
8486 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487
8488 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008489 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8490 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008491 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8492 recognized, if enabled at compile time. DEC terminal mouse codes
8493 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008494 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8495 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008497 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8498 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8499 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008500 Additionally, if vim is compiled with the |+termresponse| feature and
8501 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008502 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008503 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008504 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8505 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8506 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008507 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8508 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008509 :set t_RV=
8510<
8511 *'ttyscroll'* *'tsl'*
8512'ttyscroll' 'tsl' number (default 999)
8513 global
8514 Maximum number of lines to scroll the screen. If there are more lines
8515 to scroll the window is redrawn. For terminals where scrolling is
8516 very slow and redrawing is not slow this can be set to a small number,
8517 e.g., 3, to speed up displaying.
8518
8519 *'ttytype'* *'tty'*
8520'ttytype' 'tty' string (default from $TERM)
8521 global
8522 Alias for 'term', see above.
8523
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008524 *'undodir'* *'udir'*
8525'undodir' 'udir' string (default ".")
8526 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008527 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008528 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008529 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008530 "." means using the directory of the file. The undo file name for
8531 "file.txt" is ".file.txt.un~".
8532 For other directories the file name is the full path of the edited
8533 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008534 When writing: The first directory that exists is used. "." always
8535 works, no directories after "." will be used for writing.
8536 When reading all entries are tried to find an undo file. The first
8537 undo file that exists is used. When it cannot be read an error is
8538 given, no further entry is used.
8539 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008540 This option cannot be set from a |modeline| or in the |sandbox|, for
8541 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008542
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008543 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008544'undofile' 'udf' boolean (default off)
8545 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008546 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008547 When on, Vim automatically saves undo history to an undo file when
8548 writing a buffer to a file, and restores undo history from the same
8549 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008550 The directory where the undo file is stored is specified by 'undodir'.
8551 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008552 The undo file is not read when 'undoreload' causes the buffer from
8553 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008554 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008555 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008556
Bram Moolenaar071d4272004-06-13 20:20:40 +00008557 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008558'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008559 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008560 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008561 is kept in memory, higher numbers will cause more memory to be used.
8562 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008563 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8564 itself: >
8565 set ul=0
8566< But you can also get Vi compatibility by including the 'u' flag in
8567 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008568 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008569 Set to -1 for no undo at all. You might want to do this only for the
8570 current buffer: >
8571 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008572< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008573
8574 The local value is set to -123456 when the global value is to be used.
8575
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008576 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008577
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008578 *'undoreload'* *'ur'*
8579'undoreload' 'ur' number (default 10000)
8580 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008581 Save the whole buffer for undo when reloading it. This applies to the
8582 ":e!" command and reloading for when the buffer changed outside of
8583 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008584 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008585 of lines is smaller than the value of this option.
8586 Set this option to zero to disable undo for a reload.
8587
8588 When saving undo for a reload, any undo file is not read.
8589
8590 Note that this causes the whole buffer to be stored in memory. Set
8591 this option to a lower value if you run out of memory.
8592
Bram Moolenaar071d4272004-06-13 20:20:40 +00008593 *'updatecount'* *'uc'*
8594'updatecount' 'uc' number (default: 200)
8595 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008596 After typing this many characters the swap file will be written to
8597 disk. When zero, no swap file will be created at all (see chapter on
8598 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8599 Vim with the "-n" option, see |startup|. When editing in readonly
8600 mode this option will be initialized to 10000.
8601 The swapfile can be disabled per buffer with |'swapfile'|.
8602 When 'updatecount' is set from zero to non-zero, swap files are
8603 created for all buffers that have 'swapfile' set. When 'updatecount'
8604 is set to zero, existing swap files are not deleted.
8605 Also see |'swapsync'|.
8606 This option has no meaning in buffers where |'buftype'| is "nofile"
8607 or "nowrite".
8608
8609 *'updatetime'* *'ut'*
8610'updatetime' 'ut' number (default 4000)
8611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008612 If this many milliseconds nothing is typed the swap file will be
8613 written to disk (see |crash-recovery|). Also used for the
8614 |CursorHold| autocommand event.
8615
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008616 *'varsofttabstop'* *'vsts'*
8617'varsofttabstop' 'vsts' string (default "")
8618 local to buffer
8619 {only available when compiled with the |+vartabs|
8620 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008621 A list of the number of spaces that a <Tab> counts for while editing,
8622 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8623 width <Tab>s are being inserted, while in fact a mixture of spaces
8624 and <Tab>s is used. Tab widths are separated with commas, with the
8625 final value applying to all subsequent tabs.
8626
8627 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008628 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008629 to use the following: >
8630 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008631< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8632 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008633
8634 Note that the value of |'softtabstop'| will be ignored while
8635 'varsofttabstop' is set.
8636
8637 *'vartabstop'* *'vts'*
8638'vartabstop' 'vts' string (default "")
8639 local to buffer
8640 {only available when compiled with the |+vartabs|
8641 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008642 A list of the number of spaces that a <Tab> in the file counts for,
8643 separated by commas. Each value corresponds to one tab, with the
8644 final value applying to all subsequent tabs. For example: >
8645 :set vartabstop=4,20,10,8
8646< This will make the first tab 4 spaces wide, the second 20 spaces,
8647 the third 10 spaces, and all following tabs 8 spaces.
8648
8649 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8650 is set.
8651
Bram Moolenaar071d4272004-06-13 20:20:40 +00008652 *'verbose'* *'vbs'*
8653'verbose' 'vbs' number (default 0)
8654 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008655 When bigger than zero, Vim will give messages about what it is doing.
8656 Currently, these messages are given:
8657 >= 1 When the viminfo file is read or written.
8658 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008659 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008660 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661 >= 8 Files for which a group of autocommands is executed.
8662 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008663 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 >= 12 Every executed function.
8665 >= 13 When an exception is thrown, caught, finished, or discarded.
8666 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008667 >= 15 Every executed Ex command from a script (truncated at 200
8668 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008669 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008670
8671 This option can also be set with the "-V" argument. See |-V|.
8672 This option is also set by the |:verbose| command.
8673
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008674 When the 'verbosefile' option is set then the verbose messages are not
8675 displayed.
8676
8677 *'verbosefile'* *'vfile'*
8678'verbosefile' 'vfile' string (default empty)
8679 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008680 When not empty all messages are written in a file with this name.
8681 When the file exists messages are appended.
8682 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008683 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008684 Setting 'verbosefile' to a new value is like making it empty first.
8685 The difference with |:redir| is that verbose messages are not
8686 displayed when 'verbosefile' is set.
8687
Bram Moolenaar071d4272004-06-13 20:20:40 +00008688 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008689'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008690 "$VIM/vimfiles/view",
8691 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008692 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008693 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008695 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 feature}
8697 Name of the directory where to store files for |:mkview|.
8698 This option cannot be set from a |modeline| or in the |sandbox|, for
8699 security reasons.
8700
8701 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008702'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008703 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008704 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008706 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008707 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008708 word save and restore ~
8709 cursor cursor position in file and in window
8710 folds manually created folds, opened/closed folds and local
8711 fold options
8712 options options and mappings local to a window or buffer (not
8713 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008714 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008715 slash backslashes in file names replaced with forward
8716 slashes
8717 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008718 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008719 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008720
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008721 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008722 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008723 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008724
8725 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008726'viminfo' 'vi' string (Vi default: "", Vim default for
8727 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008728 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8729 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008730 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008731 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 feature}
8733 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008734 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8735 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008736 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008737 consisting of a single character identifying the particular parameter,
8738 followed by a number or string which specifies the value of that
8739 parameter. If a particular character is left out, then the default
8740 value is used for that parameter. The following is a list of the
8741 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008742 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008743 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008744 ! When included, save and restore global variables that start
8745 with an uppercase letter, and don't contain a lowercase
8746 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008747 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008748 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008749 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008750 " Maximum number of lines saved for each register. Old name of
8751 the '<' item, with the disadvantage that you need to put a
8752 backslash before the ", otherwise it will be recognized as the
8753 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008754 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008755 % When included, save and restore the buffer list. If Vim is
8756 started with a file name argument, the buffer list is not
8757 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008758 buffer list is restored from the viminfo file. Quickfix
8759 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8760 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008761 When followed by a number, the number specifies the maximum
8762 number of buffers that are stored. Without a number all
8763 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008764 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008765 ' Maximum number of previously edited files for which the marks
8766 are remembered. This parameter must always be included when
8767 'viminfo' is non-empty.
8768 Including this item also means that the |jumplist| and the
8769 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008770 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008772 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008773 patterns are also saved. When not included, the value of
8774 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008775 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008776 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008777 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008778 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779 < Maximum number of lines saved for each register. If zero then
8780 registers are not saved. When not included, all lines are
8781 saved. '"' is the old name for this item.
8782 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008783 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008785 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008786 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008787 c When included, convert the text in the viminfo file from the
8788 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008789 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008790 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008791 f Whether file marks need to be stored. If zero, file marks ('0
8792 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008793 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008794 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008795 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008796 h Disable the effect of 'hlsearch' when loading the viminfo
8797 file. When not included, it depends on whether ":nohlsearch"
8798 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008799 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008801 the 'n'. Must be at the end of the option! If the
8802 'viminfofile' option is set, that file name overrides the one
8803 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008804 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008805 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008806 r Removable media. The argument is a string (up to the next
8807 ','). This parameter can be given several times. Each
8808 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008809 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008810 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8811 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8812 ignored. Maximum length of each 'r' argument is 50
8813 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008814 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008815 s Maximum size of an item in Kbyte. If zero then registers are
8816 not saved. Currently only applies to registers. The default
8817 "s10" will exclude registers with more than 10 Kbyte of text.
8818 Also see the '<' item above: line count limit.
8819
8820 Example: >
8821 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8822<
8823 '50 Marks will be remembered for the last 50 files you
8824 edited.
8825 <1000 Contents of registers (up to 1000 lines each) will be
8826 remembered.
8827 s100 Registers with more than 100 Kbyte text are skipped.
8828 :0 Command-line history will not be saved.
8829 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8830 no / Since '/' is not specified, the default will be used,
8831 that is, save all of the search history, and also the
8832 previous search and substitute patterns.
8833 no % The buffer list will not be saved nor read back.
8834 no h 'hlsearch' highlighting will be restored.
8835
8836 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8837 load the contents of the file, this is not done automatically.
8838
8839 This option cannot be set from a |modeline| or in the |sandbox|, for
8840 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008841 NOTE: This option is set to the Vim default value when 'compatible'
8842 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008843
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008844 *'viminfofile'* *'vif'*
8845'viminfofile' 'vif' string (default: "")
8846 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008847 {not available when compiled without the |+viminfo|
8848 feature}
8849 When non-empty, overrides the file name used for viminfo.
8850 When equal to "NONE" no viminfo file will be read or written.
8851 This option can be set with the |-i| command line flag. The |--clean|
8852 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008853 This option cannot be set from a |modeline| or in the |sandbox|, for
8854 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008855
Bram Moolenaar071d4272004-06-13 20:20:40 +00008856 *'virtualedit'* *'ve'*
8857'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008858 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008859 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008860 block Allow virtual editing in Visual block mode.
8861 insert Allow virtual editing in Insert mode.
8862 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008863 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008864 none When used as the local value, do not allow virtual
8865 editing even when the global value is set. When used
8866 as the global value, "none" is the same as "".
8867 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008868
Bram Moolenaar071d4272004-06-13 20:20:40 +00008869 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008870 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008871 of the line. Useful for selecting a rectangle in Visual mode and
8872 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008873 "onemore" is not the same, it will only allow moving the cursor just
8874 after the last character of the line. This makes some commands more
8875 consistent. Previously the cursor was always past the end of the line
8876 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008877 break some plugins or Vim scripts. For example because |l| can move
8878 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008879 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008880 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008881 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008882 It doesn't make sense to combine "all" with "onemore", but you will
8883 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008884 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008885 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886
8887 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8888'visualbell' 'vb' boolean (default off)
8889 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008890 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008891 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008892 use: >
8893 :set vb t_vb=
8894< If you want a short flash, you can use this on many terminals: >
8895 :set vb t_vb=[?5h$<100>[?5l
8896< Here $<100> specifies the time, you can use a smaller or bigger value
8897 to get a shorter or longer flash.
8898
8899 Note: Vim will limit the bell to once per half a second. This avoids
8900 having to wait for the flashing to finish when there are lots of
8901 bells, e.g. on key repeat. This also happens without 'visualbell'
8902 set.
8903
Bram Moolenaar071d4272004-06-13 20:20:40 +00008904 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8905 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8906 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008907
8908 Note: When the GUI starts, 't_vb' is reset to its default value. You
8909 might want to set it again in your |gvimrc|.
8910
Bram Moolenaar071d4272004-06-13 20:20:40 +00008911 Does not work on the Amiga, you always get a screen flash.
8912 Also see 'errorbells'.
8913
8914 *'warn'* *'nowarn'*
8915'warn' boolean (default on)
8916 global
8917 Give a warning message when a shell command is used while the buffer
8918 has been changed.
8919
8920 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8921'weirdinvert' 'wiv' boolean (default off)
8922 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008923 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008924 It is provided for backwards compatibility with version 4.x.
8925 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8926 vice versa. Has no effect when the GUI is running.
8927
8928 *'whichwrap'* *'ww'*
8929'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8930 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008931 Allow specified keys that move the cursor left/right to move to the
8932 previous/next line when the cursor is on the first/last character in
8933 the line. Concatenate characters to allow this for these keys:
8934 char key mode ~
8935 b <BS> Normal and Visual
8936 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008937 h "h" Normal and Visual (not recommended)
8938 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008939 < <Left> Normal and Visual
8940 > <Right> Normal and Visual
8941 ~ "~" Normal
8942 [ <Left> Insert and Replace
8943 ] <Right> Insert and Replace
8944 For example: >
8945 :set ww=<,>,[,]
8946< allows wrap only when cursor keys are used.
8947 When the movement keys are used in combination with a delete or change
8948 operator, the <EOL> also counts for a character. This makes "3h"
8949 different from "3dh" when the cursor crosses the end of a line. This
8950 is also true for "x" and "X", because they do the same as "dl" and
8951 "dh". If you use this, you may also want to use the mapping
8952 ":map <BS> X" to make backspace delete the character in front of the
8953 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008954 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008955 line (not an empty line) then it will not move to the next line. This
8956 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008957 NOTE: This option is set to the Vi default value when 'compatible' is
8958 set and to the Vim default value when 'compatible' is reset.
8959
8960 *'wildchar'* *'wc'*
8961'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8962 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008963 Character you have to type to start wildcard expansion in the
8964 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008965 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008966 The character is not recognized when used inside a macro. See
8967 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008968 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008969 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008970 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008971< NOTE: This option is set to the Vi default value when 'compatible' is
8972 set and to the Vim default value when 'compatible' is reset.
8973
8974 *'wildcharm'* *'wcm'*
8975'wildcharm' 'wcm' number (default: none (0))
8976 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008977 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008978 recognized when used inside a macro. You can find "spare" command-line
8979 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008980 you'll never actually type 'wildcharm', just use it in mappings that
8981 automatically invoke completion mode, e.g.: >
8982 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008983 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008984< Then after typing :ss you can use CTRL-P & CTRL-N.
8985
8986 *'wildignore'* *'wig'*
8987'wildignore' 'wig' string (default "")
8988 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008989 {not available when compiled without the |+wildignore|
8990 feature}
8991 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008992 patterns is ignored when expanding |wildcards|, completing file or
8993 directory names, and influences the result of |expand()|, |glob()| and
8994 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008995 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8996 Also see 'suffixes'.
8997 Example: >
8998 :set wildignore=*.o,*.obj
8999< The use of |:set+=| and |:set-=| is preferred when adding or removing
9000 a pattern from the list. This avoids problems when a future version
9001 uses another default.
9002
Bram Moolenaar94950a92010-12-02 16:01:29 +01009003
Bram Moolenaar81af9252010-12-10 20:35:50 +01009004 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009005'wildignorecase' 'wic' boolean (default off)
9006 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009007 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009008 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009009 Does not apply when the shell is used to expand wildcards, which
9010 happens when there are special characters.
9011
9012
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009014'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009015 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016 {not available if compiled without the |+wildmenu|
9017 feature}
9018 When 'wildmenu' is on, command-line completion operates in an enhanced
9019 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
9020 the possible matches are shown just above the command line, with the
9021 first match highlighted (overwriting the status line, if there is
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009022 one). This is the behavior without "pum" in 'wildoptions.
9023 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009024 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9025 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9026 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009027 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009028 If there are more matches than can fit in the line, a ">" is shown on
9029 the right and/or a "<" is shown on the left. The status line scrolls
9030 as needed.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009031 When 'wildoptions' contains "pum", then the completion matches are
9032 shown in a popup menu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009033 The "wildmenu" mode is abandoned when a key is hit that is not used
9034 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009035 While the "wildmenu" is active, not using the popup menu, the
9036 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009037
9038 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9039 <Down> - in filename/menu name completion: move into a
9040 subdirectory or submenu.
9041 <CR> - in menu completion, when the cursor is just after a
9042 dot: move into a submenu.
9043 <Up> - in filename/menu name completion: move up into
9044 parent directory or parent menu.
9045
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009046 When using the popup menu for command line completion, the following
9047 keys have special meanings:
9048 <Down> - select next match (like CTRL-N)
9049 <Left> - in filename/menu name completion: move up into
9050 parent directory or parent menu.
9051 <Right> - in filename/menu name completion: move into a
9052 subdirectory or submenu.
9053 <Up> - select previous match (like CTRL-P)
9054 CTRL-E - end completion, go back to what was there before
9055 selecting a match.
9056 CTRL-N - go to the next entry
9057 CTRL-P - go to the previous entry
9058 CTRL-Y - accept the currently selected match and stop
9059 completion.
9060
Bram Moolenaar071d4272004-06-13 20:20:40 +00009061 This makes the menus accessible from the console |console-menus|.
9062
9063 If you prefer the <Left> and <Right> keys to move the cursor instead
9064 of selecting a different match, use this: >
9065 :cnoremap <Left> <Space><BS><Left>
9066 :cnoremap <Right> <Space><BS><Right>
9067<
9068 The "WildMenu" highlighting is used for displaying the current match
9069 |hl-WildMenu|.
9070
9071 *'wildmode'* *'wim'*
9072'wildmode' 'wim' string (Vim default: "full")
9073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009074 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009075 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009076 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009077 first part specifies the behavior for the first use of 'wildchar',
9078 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009079
9080 Each part consists of a colon separated list consisting of the
9081 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009082 "" Complete only the first match.
9083 "full" Complete the next full match. After the last match,
9084 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009085 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009086 "longest" Complete till longest common string. If this doesn't
9087 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009088 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009089 "lastused" When completing buffer names and more than one buffer
9090 matches, sort buffers by time last used (other than
9091 the current buffer).
9092 When there is only a single match, it is fully completed in all cases.
9093
9094 Examples of useful colon-separated values:
9095 "longest:full" Like "longest", but also start 'wildmenu' if it is
9096 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009097 "list:full" When more than one match, list all matches and
9098 complete first match.
9099 "list:longest" When more than one match, list all matches and
9100 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009101 "list:lastused" When more than one buffer matches, list all matches
9102 and sort buffers by time last used (other than the
9103 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009104
9105 Examples: >
9106 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009107< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009108 :set wildmode=longest,full
9109< Complete longest common string, then each full match >
9110 :set wildmode=list:full
9111< List all matches and complete each full match >
9112 :set wildmode=list,full
9113< List all matches without completing, then each full match >
9114 :set wildmode=longest,list
9115< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009116 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009117
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009118 *'wildoptions'* *'wop'*
9119'wildoptions' 'wop' string (default "")
9120 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009121 {not available when compiled without the |+wildignore|
9122 feature}
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009123 A list of words that change how |cmdline-completion| is done.
9124 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009125 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009126 this value is specified, wildcard expansion will not
9127 be used for completion. The matches will be sorted by
9128 the "best match" rather than alphabetically sorted.
9129 This will find more matches than the wildcard
9130 expansion. Currently fuzzy matching based completion
9131 is not supported for file and directory names and
9132 instead wildcard expansion is used.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009133 pum Display the completion matches using the popupmenu
9134 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009135 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009136 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009137 is displayed per line. Often used tag kinds are:
9138 d #define
9139 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009140
Bram Moolenaar071d4272004-06-13 20:20:40 +00009141 *'winaltkeys'* *'wak'*
9142'winaltkeys' 'wak' string (default "menu")
9143 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009144 {only used in Win32, Motif, GTK and Photon GUI}
9145 Some GUI versions allow the access to menu entries by using the ALT
9146 key in combination with a character that appears underlined in the
9147 menu. This conflicts with the use of the ALT key for mappings and
9148 entering special characters. This option tells what to do:
9149 no Don't use ALT keys for menus. ALT key combinations can be
9150 mapped, but there is no automatic handling. This can then be
9151 done with the |:simalt| command.
9152 yes ALT key handling is done by the windowing system. ALT key
9153 combinations cannot be mapped.
9154 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009155 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009156 keys can be mapped.
9157 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9158 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009159 This option is not used for <F10>; on Win32 and with GTK <F10> will
9160 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009161
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009162 *'wincolor'* *'wcr'*
9163'wincolor' 'wcr' string (default empty)
9164 local to window
9165 Highlight group name to use for this window instead of the Normal
9166 color |hl-Normal|.
9167
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009168 *'window'* *'wi'*
9169'window' 'wi' number (default screen height - 1)
9170 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009171 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9172 window and the value is smaller than 'lines' minus one. The screen
9173 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009174 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9175 in a much smarter way, taking care of wrapping lines.
9176 When resizing the Vim window, the value is smaller than 1 or more than
9177 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009178 Note: Do not confuse this with the height of the Vim window, use
9179 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009180
Bram Moolenaar071d4272004-06-13 20:20:40 +00009181 *'winheight'* *'wh'* *E591*
9182'winheight' 'wh' number (default 1)
9183 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009184 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009185 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009186 focus goes to a window that is smaller, its size is increased, at the
9187 cost of the height of other windows.
9188 Set 'winheight' to a small number for normal editing.
9189 Set it to 999 to make the current window fill most of the screen.
9190 Other windows will be only 'winminheight' high. This has the drawback
9191 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9192 to create only two windows, set the option after startup is done,
9193 using the |VimEnter| event: >
9194 au VimEnter * set winheight=999
9195< Minimum value is 1.
9196 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009197 height of the current window.
9198 'winheight' applies to the current window. Use 'winminheight' to set
9199 the minimal height for other windows.
9200
9201 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9202'winfixheight' 'wfh' boolean (default off)
9203 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009204 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009205 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9206 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009207 The height may be changed anyway when running out of room.
9208
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009209 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9210'winfixwidth' 'wfw' boolean (default off)
9211 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009212 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009213 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009214 The width may be changed anyway when running out of room.
9215
Bram Moolenaar071d4272004-06-13 20:20:40 +00009216 *'winminheight'* *'wmh'*
9217'winminheight' 'wmh' number (default 1)
9218 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009219 The minimal height of a window, when it's not the current window.
9220 This is a hard minimum, windows will never become smaller.
9221 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9222 status bar) if necessary. They will return to at least one line when
9223 they become active (since the cursor has to have somewhere to go.)
9224 Use 'winheight' to set the minimal height of the current window.
9225 This option is only checked when making a window smaller. Don't use a
9226 large number, it will cause errors when opening more than a few
9227 windows. A value of 0 to 3 is reasonable.
9228
9229 *'winminwidth'* *'wmw'*
9230'winminwidth' 'wmw' number (default 1)
9231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009232 The minimal width of a window, when it's not the current window.
9233 This is a hard minimum, windows will never become smaller.
9234 When set to zero, windows may be "squashed" to zero columns (i.e. just
9235 a vertical separator) if necessary. They will return to at least one
9236 line when they become active (since the cursor has to have somewhere
9237 to go.)
9238 Use 'winwidth' to set the minimal width of the current window.
9239 This option is only checked when making a window smaller. Don't use a
9240 large number, it will cause errors when opening more than a few
9241 windows. A value of 0 to 12 is reasonable.
9242
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009243 *'winptydll'*
9244'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9245 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009246 {only available when compiled with the |terminal|
9247 feature on MS-Windows}
9248 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009249 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009250 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009251 a fallback.
9252 Environment variables are expanded |:set_env|.
9253 This option cannot be set from a |modeline| or in the |sandbox|, for
9254 security reasons.
9255
Bram Moolenaar071d4272004-06-13 20:20:40 +00009256 *'winwidth'* *'wiw'* *E592*
9257'winwidth' 'wiw' number (default 20)
9258 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009259 Minimal number of columns for the current window. This is not a hard
9260 minimum, Vim will use fewer columns if there is not enough room. If
9261 the current window is smaller, its size is increased, at the cost of
9262 the width of other windows. Set it to 999 to make the current window
9263 always fill the screen. Set it to a small number for normal editing.
9264 The width is not adjusted after one of the commands to change the
9265 width of the current window.
9266 'winwidth' applies to the current window. Use 'winminwidth' to set
9267 the minimal width for other windows.
9268
9269 *'wrap'* *'nowrap'*
9270'wrap' boolean (default on)
9271 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009272 This option changes how text is displayed. It doesn't change the text
9273 in the buffer, see 'textwidth' for that.
9274 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009275 displaying continues on the next line. When off lines will not wrap
9276 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009277 moved to a part that is not shown, the screen will scroll
9278 horizontally.
9279 The line will be broken in the middle of a word if necessary. See
9280 'linebreak' to get the break at a word boundary.
9281 To make scrolling horizontally a bit more useful, try this: >
9282 :set sidescroll=5
9283 :set listchars+=precedes:<,extends:>
9284< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009285 This option can't be set from a |modeline| when the 'diff' option is
9286 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009287
9288 *'wrapmargin'* *'wm'*
9289'wrapmargin' 'wm' number (default 0)
9290 local to buffer
9291 Number of characters from the right window border where wrapping
9292 starts. When typing text beyond this limit, an <EOL> will be inserted
9293 and inserting continues on the next line.
9294 Options that add a margin, such as 'number' and 'foldcolumn', cause
9295 the text width to be further reduced. This is Vi compatible.
9296 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009297 This option is set to 0 when 'paste' is set and restored when 'paste'
9298 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009299 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009300
9301 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9302'wrapscan' 'ws' boolean (default on) *E384* *E385*
9303 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009304 Searches wrap around the end of the file. Also applies to |]s| and
9305 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009306
9307 *'write'* *'nowrite'*
9308'write' boolean (default on)
9309 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009310 Allows writing files. When not set, writing a file is not allowed.
9311 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009312 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009313 argument. Filtering text is still possible, even though this requires
9314 writing a temporary file.
9315
9316 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9317'writeany' 'wa' boolean (default off)
9318 global
9319 Allows writing to any file with no need for "!" override.
9320
9321 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9322'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9323 otherwise)
9324 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009325 Make a backup before overwriting a file. The backup is removed after
9326 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009327 also on.
9328 WARNING: Switching this option off means that when Vim fails to write
9329 your buffer correctly and then, for whatever reason, Vim exits, you
9330 lose both the original file and what you were writing. Only reset
9331 this option if your file system is almost full and it makes the write
9332 fail (and make sure not to exit Vim until the write was successful).
9333 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009334 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009335 Depending on 'backupcopy' the backup is a new file or the original
9336 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009337 NOTE: This option is set to the default value when 'compatible' is
9338 set.
9339
9340 *'writedelay'* *'wd'*
9341'writedelay' 'wd' number (default 0)
9342 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009343 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009344 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009345 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009346
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009347 *'xtermcodes'* *'noxtermcodes'*
9348'xtermcodes' boolean (default on)
9349 global
9350 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009351 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009352 key codes and number of colors from the terminal. This takes care of
9353 various configuration options of the terminal that cannot be obtained
9354 from the termlib/terminfo entry, see |xterm-codes|.
9355 A side effect may be that t_Co changes and Vim will redraw the
9356 display.
9357
9358
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009359 vim:tw=78:ts=8:noet:ft=help:norl: