blob: 0b35e94052501b64620c456925b340eb035b9cc6 [file] [log] [blame]
Bram Moolenaareb490412022-06-28 13:44:46 +01001*options.txt* For Vim version 9.0. Last change: 2022 Jun 27
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
37
Bram Moolenaar47003982021-12-05 21:54:04 +000038:se[t]! termcap Idem, but don't use multiple columns.
39
Bram Moolenaar071d4272004-06-13 20:20:40 +000040 *E518* *E519*
41:se[t] {option}? Show value of {option}.
42
43:se[t] {option} Toggle option: set, switch it on.
44 Number option: show value.
45 String option: show value.
46
47:se[t] no{option} Toggle option: Reset, switch it off.
48
Bram Moolenaar00a927d2010-05-14 23:24:24 +020049 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000050:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020051:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000052
53 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
54:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020055 current value of 'compatible'.
56:se[t] {option}&vi Reset option to its Vi default value.
57:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000058
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010059:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020060 these options are not changed:
61 all terminal options, starting with t_
62 'columns'
63 'cryptmethod'
64 'encoding'
65 'key'
66 'lines'
67 'term'
68 'ttymouse'
69 'ttytype'
70 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000071
72 *:set-args* *E487* *E521*
73:se[t] {option}={value} or
74:se[t] {option}:{value}
75 Set string or number option to {value}.
76 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010077 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000078 The old value can be inserted by typing 'wildchar' (by
79 default this is a <Tab> or CTRL-E if 'compatible' is
80 set). See |cmdline-completion|.
81 White space between {option} and '=' is allowed and
82 will be ignored. White space between '=' and {value}
83 is not allowed.
84 See |option-backslash| for using white space and
85 backslashes in {value}.
86
87:se[t] {option}+={value} *:set+=*
88 Add the {value} to a number option, or append the
89 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010090 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 value was empty.
92 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000093 are removed. When adding a flag that was already
94 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000095 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000096
97:se[t] {option}^={value} *:set^=*
98 Multiply the {value} to a number option, or prepend
99 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100100 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101 value was empty.
102 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103
104:se[t] {option}-={value} *:set-=*
105 Subtract the {value} from a number option, or remove
106 the {value} from a string option, if it is there.
107 If the {value} is not found in a string option, there
108 is no error or warning. When the option is a comma
109 separated list, a comma is deleted, unless the option
110 becomes empty.
111 When the option is a list of flags, {value} must be
112 exactly as they appear in the option. Remove flags
113 one by one to avoid problems.
114 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115
116The {option} arguments to ":set" may be repeated. For example: >
117 :set ai nosi sw=3 ts=3
118If you make an error in one of the arguments, an error message will be given
119and the following arguments will be ignored.
120
121 *:set-verbose*
122When 'verbose' is non-zero, displaying an option value will also tell where it
123was last set. Example: >
124 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200125< shiftwidth=4 ~
126 Last set from modeline line 1 ~
127 cindent ~
128 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000129This is only done when specific option values are requested, not for ":verbose
130set all" or ":verbose set" without an argument.
131When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000132When the option was set while executing a function, user command or
133autocommand, the script in which it was defined is reported.
134Note that an option may also have been set as a side effect of setting
135'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200137 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000138 Option was set in a |modeline|.
139 Last set from --cmd argument ~
140 Option was set with command line argument |--cmd| or +.
141 Last set from -c argument ~
142 Option was set with command line argument |-c|, +, |-S| or
143 |-q|.
144 Last set from environment variable ~
145 Option was set from an environment variable, $VIMINIT,
146 $GVIMINIT or $EXINIT.
147 Last set from error handler ~
148 Option was cleared when evaluating it resulted in an error.
149
Bram Moolenaardb84e452010-08-15 13:50:43 +0200150{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151
152 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000153For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000154override the value from the termcap. You can then use it in a mapping. If
155the "xx" part contains special characters, use the <t_xx> form: >
156 :set <t_#4>=^[Ot
157This can also be used to translate a special code for a normal key. For
158example, if Alt-b produces <Esc>b, use this: >
159 :set <M-b>=^[b
160(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
161The advantage over a mapping is that it works in all situations.
162
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100163You can define any key codes, e.g.: >
164 :set t_xy=^[foo;
165There is no warning for using a name that isn't recognized. You can map these
166codes as you like: >
167 :map <t_xy> something
168< *E846*
169When a key code is not set, it's like it does not exist. Trying to get its
170value will result in an error: >
171 :set t_kb=
172 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000173< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100174
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000175The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
176security reasons.
177
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000179at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180"set all" probably does not fit on the screen, causing Vim to give the
181|more-prompt|.
182
183 *option-backslash*
184To include white space in a string option value it has to be preceded with a
185backslash. To include a backslash you have to use two. Effectively this
186means that the number of backslashes in an option value is halved (rounded
187down).
188A few examples: >
189 :set tags=tags\ /usr/tags results in "tags /usr/tags"
190 :set tags=tags\\,file results in "tags\,file"
191 :set tags=tags\\\ file results in "tags\ file"
192
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000193The "|" character separates a ":set" command from a following command. To
194include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195'titlestring' option to "hi|there": >
196 :set titlestring=hi\|there
197This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
198 :set titlestring=hi|set iconstring=there
199
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200200Similarly, in legacy script the double quote character starts a comment. To
201include the '"' in the option value, use '\"' instead. This example sets the
202'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000203 :set titlestring=hi\ \"there\"
204
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200205In |Vim9| script it's simpler, comments start with a '#' character, and only
206when preceded by white space. A backslash is needed less often: >
207 vim9script
208 set titlestring=hi\ "there"
209 set titlestring=hi#there#
210 set titlestring=hi\ \#there#
211
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100212For Win32 backslashes in file names are mostly not removed. More precise: For
213options that expect a file name (those where environment variables are
214expanded) a backslash before a normal file name character is not removed. But
215a backslash before a special character (space, backslash, comma, etc.) is used
216like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217There is one special situation, when the value starts with "\\": >
218 :set dir=\\machine\path results in "\\machine\path"
219 :set dir=\\\\machine\\path results in "\\machine\path"
220 :set dir=\\path\\file results in "\\path\file" (wrong!)
221For the first one the start is kept, but for the second one the backslashes
222are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000223halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224result which is probably not what you want. Avoid it.
225
226 *add-option-flags* *remove-option-flags*
227 *E539* *E550* *E551* *E552*
228Some options are a list of flags. When you want to add a flag to such an
229option, without changing the existing ones, you can do it like this: >
230 :set guioptions+=a
231Remove a flag from an option like this: >
232 :set guioptions-=a
233This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000234Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
236doesn't appear.
237
238 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000239Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000240environment variable exists the '$' and the following environment variable
241name is replaced with its value. If it does not exist the '$' and the name
242are not modified. Any non-id character (not a letter, digit or '_') may
243follow the environment variable name. That character and what follows is
244appended to the value of the environment variable. Examples: >
245 :set term=$TERM.new
246 :set path=/usr/$INCLUDE,$HOME/include,.
247When adding or removing a string from an option with ":set opt-=val" or ":set
248opt+=val" the expansion is done before the adding or removing.
249
250
251Handling of local options *local-options*
252
253Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100254has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255allows you to set 'list' in one window but not in another. And set
256'shiftwidth' to 3 in one buffer and 4 in another.
257
258The following explains what happens to these local options in specific
259situations. You don't really need to know all of this, since Vim mostly uses
260the option values you would expect. Unfortunately, doing what the user
261expects is a bit complicated...
262
263When splitting a window, the local options are copied to the new window. Thus
264right after the split the contents of the two windows look the same.
265
266When editing a new buffer, its local option values must be initialized. Since
267the local options of the current buffer might be specifically for that buffer,
268these are not used. Instead, for each buffer-local option there also is a
269global value, which is used for new buffers. With ":set" both the local and
270global value is changed. With "setlocal" only the local value is changed,
271thus this value is not used when editing a new buffer.
272
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200273When editing a buffer that has been edited before, the options from the window
274that was last closed are used again. If this buffer has been edited in this
275window, the values from back then are used. Otherwise the values from the
276last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277
278It's possible to set a local window option specifically for a type of buffer.
279When you edit another buffer in the same window, you don't want to keep
280using these local window options. Therefore Vim keeps a global value of the
281local window options, which is used when editing another buffer. Each window
282has its own copy of these values. Thus these are local to the window, but
283global to all buffers in the window. With this you can do: >
284 :e one
285 :set list
286 :e two
287Now the 'list' option will also be set in "two", since with the ":set list"
288command you have also set the global value. >
289 :set nolist
290 :e one
291 :setlocal list
292 :e two
293Now the 'list' option is not set, because ":set nolist" resets the global
294value, ":setlocal list" only changes the local value and ":e two" gets the
295global value. Note that if you do this next: >
296 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200297You will get back the 'list' value as it was the last time you edited "one".
298The options local to a window are remembered for each buffer. This also
299happens when the buffer is not loaded, but they are lost when the buffer is
300wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301
302 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100303:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304 current buffer or window. Not all options have a
305 local value. If the option does not have a local
306 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200307 With the "all" argument: display local values for all
308 local options.
309 Without argument: Display local values for all local
310 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000312 local value. For a global/local boolean option, when
313 the global value is being used, "--" is displayed
314 before the option name.
315 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000318:setl[ocal] {option}< Set the local value of {option} to its global value by
319 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000320
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100321:se[t] {option}< For |global-local| options: Remove the local value of
322 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100325:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 option without changing the local value.
327 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200328 With the "all" argument: display global values for all
329 local options.
330 Without argument: display global values for all local
331 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332
333For buffer-local and window-local options:
334 Command global value local value ~
335 :set option=value set set
336 :setlocal option=value - set
337:setglobal option=value set -
338 :set option? - display
339 :setlocal option? - display
340:setglobal option? display -
341
342
343Global options with a local value *global-local*
344
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000345Options are global when you mostly use one value for all buffers and windows.
346For some global options it's useful to sometimes have a different local value.
347You can set the local value with ":setlocal". That buffer or window will then
348use the local value, while other buffers and windows continue using the global
349value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350
351For example, you have two windows, both on C source code. They use the global
352'makeprg' option. If you do this in one of the two windows: >
353 :set makeprg=gmake
354then the other window will switch to the same value. There is no need to set
355the 'makeprg' option in the other C source window too.
356However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000357another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000358files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359 :setlocal makeprg=perlmake
360You can switch back to using the global value by making the local value empty: >
361 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100362This only works for a string option. For a number or boolean option you need
363to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000364 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100365Note that for non-boolean and non-number options using "<" copies the global
366value to the local value, it doesn't switch back to using the global value
367(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000368 :set path<
369This will make the local value of 'path' empty, so that the global value is
370used. Thus it does the same as: >
371 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000372Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373":setlocal" on a global option might work differently then.
374
375
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000376 *option-value-function*
377Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000378'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000379a function name or a function reference or a lambda function. When using a
380lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000381>
382 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000383 set opfunc=function('MyOpFunc')
384 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000385 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000386
387Set to a script-local function: >
388 set opfunc=s:MyLocalFunc
389 set opfunc=<SID>MyLocalFunc
390In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
391the script: >
392 set opfunc=MyLocalFunc
393
394Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000395 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000396 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000397
398Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000399 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000400
401Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000402 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000403 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000404
405In Vim9 script, in a compiled function, you can use a lambda, but a
406closured does not work, because the function will be called without the
407context of where it was defined.
408
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000409
Bram Moolenaar071d4272004-06-13 20:20:40 +0000410Setting the filetype
411
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200412:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413 Set the 'filetype' option to {filetype}, but only if
414 not done yet in a sequence of (nested) autocommands.
415 This is short for: >
416 :if !did_filetype()
417 : setlocal filetype={filetype}
418 :endif
419< This command is used in a filetype.vim file to avoid
420 setting the 'filetype' option twice, causing different
421 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200422
423 When the optional FALLBACK argument is present, a
424 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100425 'filetype'. This is to be used for filetype
426 detections that are just a guess. |did_filetype()|
427 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200428
Bram Moolenaard58e9292011-02-09 17:07:58 +0100429 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
431:opt[ions] Open a window for viewing and setting all options.
432 Options are grouped by function.
433 Offers short help for each option. Hit <CR> on the
434 short help to open a help window with more help for
435 the option.
436 Modify the value of the option and hit <CR> on the
437 "set" line to set the new value. For window and
438 buffer specific options, the last accessed window is
439 used to set the option value in, unless this is a help
440 window, in which case the window below help window is
441 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100442 {not available when compiled without the |+eval|
443 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000444
445 *$HOME*
446Using "~" is like using "$HOME", but it is only recognized at the start of an
447option and after a space or comma.
448
449On Unix systems "~user" can be used too. It is replaced by the home directory
450of user "user". Example: >
451 :set path=~mool/include,/usr/include,.
452
453On Unix systems the form "${HOME}" can be used too. The name between {} can
454contain non-id characters then. Note that if you want to use this for the
455"gf" command, you need to add the '{' and '}' characters to 'isfname'.
456
457NOTE: expanding environment variables and "~/" is only done with the ":set"
458command, not when assigning a value to an option with ":let".
459
Bram Moolenaarc572da52017-08-27 16:52:01 +0200460 *$HOME-windows*
461On MS-Windows, if $HOME is not defined as an environment variable, then
462at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200463If $HOMEDRIVE is not set then $USERPROFILE is used.
464
465This expanded value is not exported to the environment, this matters when
466running an external command: >
467 :echo system('set | findstr ^HOME=')
468and >
469 :echo luaeval('os.getenv("HOME")')
470should echo nothing (an empty string) despite exists('$HOME') being true.
471When setting $HOME to a non-empty string it will be exported to the
472subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200473
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474
475Note the maximum length of an expanded option is limited. How much depends on
476the system, mostly it is something like 256 or 1024 characters.
477
478 *:fix* *:fixdel*
479:fix[del] Set the value of 't_kD':
480 't_kb' is 't_kD' becomes ~
481 CTRL-? CTRL-H
482 not CTRL-? CTRL-?
483
Bram Moolenaar82be4842021-01-11 19:40:15 +0100484 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000485
486 If your delete key terminal code is wrong, but the
487 code for backspace is alright, you can put this in
488 your .vimrc: >
489 :fixdel
490< This works no matter what the actual code for
491 backspace is.
492
493 If the backspace key terminal code is wrong you can
494 use this: >
495 :if &term == "termname"
496 : set t_kb=^V<BS>
497 : fixdel
498 :endif
499< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000500 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000501 with your terminal name.
502
503 If your <Delete> key sends a strange key sequence (not
504 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
505 :if &term == "termname"
506 : set t_kD=^V<Delete>
507 :endif
508< Where "^V" is CTRL-V and "<Delete>" is the delete key
509 (don't type eight characters!). Replace "termname"
510 with your terminal name.
511
512 *Linux-backspace*
513 Note about Linux: By default the backspace key
514 produces CTRL-?, which is wrong. You can fix it by
515 putting this line in your rc.local: >
516 echo "keycode 14 = BackSpace" | loadkeys
517<
518 *NetBSD-backspace*
519 Note about NetBSD: If your backspace doesn't produce
520 the right code, try this: >
521 xmodmap -e "keycode 22 = BackSpace"
522< If this works, add this in your .Xmodmap file: >
523 keysym 22 = BackSpace
524< You need to restart for this to take effect.
525
526==============================================================================
5272. Automatically setting options *auto-setting*
528
529Besides changing options with the ":set" command, there are three alternatives
530to set options automatically for one or more files:
531
5321. When starting Vim initializations are read from various places. See
533 |initialization|. Most of them are performed for all editing sessions,
534 and some of them depend on the directory where Vim is started.
535 You can create an initialization file with |:mkvimrc|, |:mkview| and
536 |:mksession|.
5372. If you start editing a new file, the automatic commands are executed.
538 This can be used to set options for files matching a particular pattern and
539 many other things. See |autocommand|.
5403. If you start editing a new file, and the 'modeline' option is on, a
541 number of lines at the beginning and end of the file are checked for
542 modelines. This is explained here.
543
544 *modeline* *vim:* *vi:* *ex:* *E520*
545There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100546 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100548[text{white}] empty or any text followed by at least one blank
549 character (<Space> or <Tab>); "ex:" always requires at
550 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200551{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200552[white] optional white space
553{options} a list of option settings, separated with white space
554 or ':', where each part between ':' is the argument
555 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556
Bram Moolenaar14b69452013-06-29 23:05:20 +0200557Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000558 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200559 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560
561The second form (this is compatible with some versions of Vi):
562
Bram Moolenaarade0d392020-01-21 22:33:58 +0100563 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
Bram Moolenaarade0d392020-01-21 22:33:58 +0100565[text{white}] empty or any text followed by at least one blank
566 character (<Space> or <Tab>); "ex:" always requires at
567 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200568{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
569[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200570se[t] the string "set " or "se " (note the space); When
571 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200572{options} a list of options, separated with white space, which
573 is the argument for a ":set" command
574: a colon
575[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576
Bram Moolenaar14b69452013-06-29 23:05:20 +0200577Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000578 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200579 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000580
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200581The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
582chance that a normal word like "lex:" is caught. There is one exception:
583"vi:" and "vim:" can also be at the start of the line (for compatibility with
584version 3.0). Using "ex:" at the start of the line will be ignored (this
585could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586
Hu Jialun9dcd3492021-08-28 20:42:50 +0200587If the modeline is disabled within a modeline, subsequent modelines will be
588ignored. This is to allow turning off modeline on a per-file basis. This is
589useful when a line looks like a modeline but isn't. For example, it would be
590good to start a YAML file containing strings like "vim:" with
591 # vim: nomodeline ~
592so as to avoid modeline misdetection. Following options on the same line
593after modeline deactivation, if any, are still evaluated (but you would
594normally not have any).
595
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596 *modeline-local*
597The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000598buffer and window that contain the file. Although it's possible to set global
599options from a modeline, this is unusual. If you have two windows open and
600the files in it set the same global option to a different value, the result
601depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000602
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000603When editing a file that was already loaded, only the window-local options
604from the modeline are used. Thus if you manually changed a buffer-local
605option after opening the file, it won't be changed if you edit the same buffer
606in another window. But window-local options will be set.
607
Bram Moolenaar071d4272004-06-13 20:20:40 +0000608 *modeline-version*
609If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200610number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 vim{vers}: version {vers} or later
612 vim<{vers}: version before {vers}
613 vim={vers}: version {vers}
614 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100615{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
616For example, to use a modeline only for Vim 7.0:
617 /* vim700: set foldmethod=marker */ ~
618To use a modeline for Vim after version 7.2:
619 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620There can be no blanks between "vim" and the ":".
621
622
623The number of lines that are checked can be set with the 'modelines' option.
624If 'modeline' is off or 'modelines' is 0 no lines are checked.
625
626Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000627like:
628 /* vi:ts=4: */ ~
629will give an error message for the trailing "*/". This line is OK:
630 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631
632If an error is detected the rest of the line is skipped.
633
634If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000635backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100636 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
637This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
638before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200639 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000641might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200642can be set. For some options a flag is set, so that when the value is used
643the |sandbox| is effective. Some options can only be set from the modeline
644when 'modelineexpr' is set (the default is off).
645
646Still, there is always a small risk that a modeline causes trouble. E.g.,
647when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
648So disable modelines before editing untrusted text. The mail ftplugin does
649this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650
651Hint: If you would like to do something else than setting an option, you could
652define an autocommand that checks the file for a specific string. For
653example: >
654 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
655And define a function SetVar() that does something with the line containing
656"VAR".
657
658==============================================================================
6593. Options summary *option-summary*
660
661In the list below all the options are mentioned with their full name and with
662an abbreviation if there is one. Both forms may be used.
663
664In this document when a boolean option is "set" that means that ":set option"
665is entered. When an option is "reset", ":set nooption" is used.
666
667For some options there are two default values: The "Vim default", which is
668used when 'compatible' is not set, and the "Vi default", which is used when
669'compatible' is set.
670
671Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000672are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673different value in each window. For example the 'list' option can be set in
674one window and reset in another for the same text, giving both types of view
675at the same time. There are a few options that are specific to a certain
676file. These can have a different value for each file or buffer. For example
677the 'textwidth' option can be 78 for a normal text file and 0 for a C
678program.
679
680 global one option for all buffers and windows
681 local to window each window has its own copy of this option
682 local to buffer each buffer has its own copy of this option
683
684When creating a new window the option values from the currently active window
685are used as a default value for the window-specific options. For the
686buffer-specific options this depends on the 's' and 'S' flags in the
687'cpoptions' option. If 's' is included (which is the default) the values for
688buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000689first entered. If 'S' is present the options are copied each time the buffer
690is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691present, the options are copied from the currently active buffer when the
692buffer is created.
693
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000694Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000696Not all options are supported in all versions. This depends on the supported
697features and sometimes on the system. A remark about this is in curly braces
698below. When an option is not supported it may still be set without getting an
699error, this is called a hidden option. You can't get the value of a hidden
700option though, it is not stored.
701
702To test if option "foo" can be used with ":set" use something like this: >
703 if exists('&foo')
704This also returns true for a hidden option. To test if option "foo" is really
705supported use something like this: >
706 if exists('+foo')
707<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708 *E355*
709A jump table for the options with a short description can be found at |Q_op|.
710
711 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100712'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714 {only available when compiled with the |+rightleft|
715 feature}
716 The ASCII code for the first letter of the Hebrew alphabet. The
717 routine that maps the keyboard in Hebrew mode, both in Insert mode
718 (when hkmap is set) and on the command-line (when hitting CTRL-_)
719 outputs the Hebrew characters in the range [aleph..aleph+26].
720 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
721 See |rileft.txt|.
722
723 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
724'allowrevins' 'ari' boolean (default off)
725 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726 {only available when compiled with the |+rightleft|
727 feature}
728 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
729 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
730 into reverse Insert mode, and don't know how to get out. See
731 'revins'.
732 NOTE: This option is reset when 'compatible' is set.
733
734 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
735'altkeymap' 'akm' boolean (default off)
736 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737 {only available when compiled with the |+farsi|
738 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100739 This option was for using Farsi, which has been removed. See
740 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741
742 *'ambiwidth'* *'ambw'*
743'ambiwidth' 'ambw' string (default: "single")
744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000745 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
746 Tells Vim what to do with characters with East Asian Width Class
747 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
748 letters, Cyrillic letters).
749
750 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000751 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 expected by most users.
753 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200754 *E834* *E835*
755 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100756 contains a character that would be double width. These errors may
757 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200758
759 The values are overruled for characters specified with
760 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761
762 There are a number of CJK fonts for which the width of glyphs for
763 those characters are solely based on how many octets they take in
764 legacy/traditional CJK encodings. In those encodings, Euro,
765 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000766 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000768 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 Vim is running inside a terminal (emulators) that uses a CJK font
770 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
771 this option should be set to "double" to match the width perceived
772 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100773 to be set to "double" under CJK MS-Windows when the system locale is
774 set to one of CJK locales. See Unicode Standard Annex #11
775 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100777 Vim may set this option automatically at startup time when Vim is
778 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200779 escape sequence to request cursor position report. The response can
780 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100781
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
783'antialias' 'anti' boolean (default: off)
784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200786 on macOS}
787 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
789 which can be easier to read at certain sizes on certain displays.
790 Setting this option can sometimes cause problems if 'guifont' is set
791 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100792 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793
794 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
795'autochdir' 'acd' boolean (default off)
796 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200797 {only available when compiled with it, use
798 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000799 When on, Vim will change the current working directory whenever you
800 open a file, switch buffers, delete a buffer or open/close a window.
801 It will change to the directory containing the file which was opened
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
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100811 escape sequence will be emitted. For example, on Linux, you can
812 source /etc/profile.d/vte.sh in your shell profile if you use bash or
813 zsh. For bash this should work (put it in a bash init file): >
814 if [[ -n "$VIM_TERMINAL" ]]; then
815 PROMPT_COMMAND='_vim_sync_PWD'
816 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100817 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100818 }
819 fi
820<
821 Or, in a zsh init file: >
822 if [[ -n "$VIM_TERMINAL" ]]; then
823 autoload -Uz add-zsh-hook
824 add-zsh-hook -Uz chpwd _vim_sync_PWD
825 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100826 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100827 }
828 fi
829<
830 In a fish init file: >
831 if test -n "$VIM_TERMINAL"
832 function _vim_sync_PWD --on-variable=PWD
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100833 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100834 end
835 end
836<
837 You can find an alternative method at |terminal-autoshelldir|.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000838 When the parsing of the OSC sequence fails you get *E1179* .
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200839
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
841'arabic' 'arab' boolean (default off)
842 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843 {only available when compiled with the |+arabic|
844 feature}
845 This option can be set to start editing Arabic text.
846 Setting this option will:
847 - Set the 'rightleft' option, unless 'termbidi' is set.
848 - Set the 'arabicshape' option, unless 'termbidi' is set.
849 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
850 between typing English and Arabic key mapping.
851 - Set the 'delcombine' option
852 Note that 'encoding' must be "utf-8" for working with Arabic text.
853
854 Resetting this option will:
855 - Reset the 'rightleft' option.
856 - Disable the use of 'keymap' (without changing its value).
857 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200858 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100859 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860 Also see |arabic.txt|.
861
862 *'arabicshape'* *'arshape'*
863 *'noarabicshape'* *'noarshape'*
864'arabicshape' 'arshape' boolean (default on)
865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866 {only available when compiled with the |+arabic|
867 feature}
868 When on and 'termbidi' is off, the required visual character
869 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200870 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871 one which encompasses:
872 a) the changing/morphing of characters based on their location
873 within a word (initial, medial, final and stand-alone).
874 b) the enabling of the ability to compose characters
875 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100876 When disabled the display shows each character's true stand-alone
877 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878 Arabic is a complex language which requires other settings, for
879 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100880 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000881
882 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
883'autoindent' 'ai' boolean (default off)
884 local to buffer
885 Copy indent from current line when starting a new line (typing <CR>
886 in Insert mode or when using the "o" or "O" command). If you do not
887 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000888 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
889 to another line has the same effect, unless the 'I' flag is included
890 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000891 When autoindent is on, formatting (with the "gq" command or when you
892 reach 'textwidth' in Insert mode) uses the indentation of the first
893 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000894 When 'smartindent' or 'cindent' is on the indent is changed in
895 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200896 The 'autoindent' option is reset when the 'paste' option is set and
897 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898
899 *'autoread'* *'ar'* *'noautoread'* *'noar'*
900'autoread' 'ar' boolean (default off)
901 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902 When a file has been detected to have been changed outside of Vim and
903 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200904 When the file has been deleted this is not done, so you have the text
905 from before it was deleted. When it appears again then it is read.
906 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907 If this option has a local value, use this command to switch back to
908 using the global value: >
909 :set autoread<
910<
911 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
912'autowrite' 'aw' boolean (default off)
913 global
914 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000915 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000916 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
917 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000918 to another file.
919 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000920 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921 Note that for some commands the 'autowrite' option is not used, see
922 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200923 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200924 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925
926 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
927'autowriteall' 'awa' boolean (default off)
928 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
930 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
931 Setting this option also implies that Vim behaves like 'autowrite' has
932 been set.
933
934 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200935'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 When set to "dark", Vim will try to use colors that look good on a
938 dark background. When set to "light", Vim will try to use colors that
939 look good on a light background. Any other value is illegal.
940 Vim tries to set the default value according to the terminal used.
941 This will not always be correct.
942 Setting this option does not change the background color, it tells Vim
943 what the background color looks like. For changing the background
944 color, see |:hi-normal|.
945
946 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000947 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000948 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100949 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000950 setting 'background' will cause the color scheme to be reloaded. If
951 the color scheme adjusts to the value of 'background' this will work.
952 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100953 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000954
955 When setting 'background' to the default value with: >
956 :set background&
957< Vim will guess the value. In the GUI this should work correctly,
958 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200959 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200960 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000961
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200962 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200963 color from the terminal. If the returned RGB value is dark/light and
964 'background' is not dark/light, 'background' will be set and the
965 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200966 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100967 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200968
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969 When starting the GUI, the default value for 'background' will be
970 "light". When the value is not set in the .gvimrc, and Vim detects
971 that the background is actually quite dark, 'background' is set to
972 "dark". But this happens only AFTER the .gvimrc file has been read
973 (because the window needs to be opened to find the actual background
974 color). To get around this, force the GUI window to be opened by
975 putting a ":gui" command in the .gvimrc file, before where the value
976 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200977
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100978 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200979 For other systems "dark" is used when 'term' is "linux",
980 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
981 background. Otherwise the default is "light".
982
Bram Moolenaarc572da52017-08-27 16:52:01 +0200983 The |:terminal| command and the |term_start()| function use the
984 'background' value to decide whether the terminal window will start
985 with a white or black background.
986
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987 Normally this option would be set in the .vimrc file. Possibly
988 depending on the terminal name. Example: >
989 :if &term == "pcterm"
990 : set background=dark
991 :endif
992< When this option is set, the default settings for the highlight groups
993 will change. To use other settings, place ":highlight" commands AFTER
994 the setting of the 'background' option.
995 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
996 to select the colors for syntax highlighting. After changing this
997 option, you must load syntax.vim again to see the result. This can be
998 done with ":syntax on".
999
1000 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001001'backspace' 'bs' string (default "", set to "indent,eol,start"
1002 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1005 mode. This is a list of items, separated by commas. Each item allows
1006 a way to backspace over something:
1007 value effect ~
1008 indent allow backspacing over autoindent
1009 eol allow backspacing over line breaks (join lines)
1010 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1011 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001012 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1013 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001014
Bram Moolenaar46eea442022-03-30 10:51:39 +01001015 When the value is empty, Vi compatible backspacing is used, none of
1016 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017
1018 For backwards compatibility with version 5.4 and earlier:
1019 value effect ~
1020 0 same as ":set backspace=" (Vi compatible)
1021 1 same as ":set backspace=indent,eol"
1022 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001023 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001024
1025 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1026 NOTE: This option is set to "" when 'compatible' is set.
1027
1028 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1029'backup' 'bk' boolean (default off)
1030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031 Make a backup before overwriting a file. Leave it around after the
1032 file has been successfully written. If you do not want to keep the
1033 backup file, but you do want a backup while the file is being
1034 written, reset this option and set the 'writebackup' option (this is
1035 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001036 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037 |backup-table| for more explanations.
1038 When the 'backupskip' pattern matches, a backup is not made anyway.
1039 When 'patchmode' is set, the backup may be renamed to become the
1040 oldest version of a file.
1041 NOTE: This option is reset when 'compatible' is set.
1042
1043 *'backupcopy'* *'bkc'*
1044'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001045 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001047 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048
1049 The main values are:
1050 "yes" make a copy of the file and overwrite the original one
1051 "no" rename the file and write a new one
1052 "auto" one of the previous, what works best
1053
1054 Extra values that can be combined with the ones above are:
1055 "breaksymlink" always break symlinks when writing
1056 "breakhardlink" always break hardlinks when writing
1057
1058 Making a copy and overwriting the original file:
1059 - Takes extra time to copy the file.
1060 + When the file has special attributes, is a (hard/symbolic) link or
1061 has a resource fork, all this is preserved.
1062 - When the file is a link the backup will have the name of the link,
1063 not of the real file.
1064
1065 Renaming the file and writing a new one:
1066 + It's fast.
1067 - Sometimes not all attributes of the file can be copied to the new
1068 file.
1069 - When the file is a link the new file will not be a link.
1070
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001071 The "auto" value is the middle way: When Vim sees that renaming the
1072 file is possible without side effects (the attributes can be passed on
1073 and the file is not a link) that is used. When problems are expected,
1074 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075
1076 The "breaksymlink" and "breakhardlink" values can be used in
1077 combination with any of "yes", "no" and "auto". When included, they
1078 force Vim to always break either symbolic or hard links by doing
1079 exactly what the "no" option does, renaming the original file to
1080 become the backup and writing a new file in its place. This can be
1081 useful for example in source trees where all the files are symbolic or
1082 hard links and any changes should stay in the local source tree, not
1083 be propagated back to the original source.
1084 *crontab*
1085 One situation where "no" and "auto" will cause problems: A program
1086 that opens a file, invokes Vim to edit that file, and then tests if
1087 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001088 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089 example.
1090
1091 When a copy is made, the original file is truncated and then filled
1092 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001093 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001094 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095 group of the backup is set to the group of the original file. If this
1096 fails, the protection bits for the group are made the same as for
1097 others.
1098
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001099 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001100 the same attributes of the original file, and the newly written file
1101 is owned by the current user. When the file was a (hard/symbolic)
1102 link, the new file will not! That's why the "auto" value doesn't
1103 rename when the file is a link. The owner and group of the newly
1104 written file will be set to the same ones as the original file, but
1105 the system may refuse to do this. In that case the "auto" value will
1106 again not rename the file.
1107
Bram Moolenaar036986f2017-03-16 17:41:02 +01001108 NOTE: This option is set to the Vi default value when 'compatible' is
1109 set and to the Vim default value when 'compatible' is reset.
1110
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111 *'backupdir'* *'bdir'*
1112'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001113 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114 for Unix: ".,~/tmp,~/")
1115 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 List of directories for the backup file, separated with commas.
1117 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001118 where this is possible. The directory must exist, Vim will not
1119 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001120 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001121 impossible!). Writing may fail because of this.
1122 - A directory "." means to put the backup file in the same directory
1123 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001124 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1125 the backup file relative to where the edited file is. The leading
1126 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127 ("." inside a directory name has no special meaning).
1128 - Spaces after the comma are ignored, other spaces are considered part
1129 of the directory name. To have a space at the start of a directory
1130 name, precede it with a backslash.
1131 - To include a comma in a directory name precede it with a backslash.
1132 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001133 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001134 the backup file name will be built from the complete path to the
1135 file with all path separators changed to percent '%' signs. This
1136 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001137 On Win32, it is also possible to end with "\\". However, When a
1138 separating comma is following, you must use "//", since "\\" will
1139 include the comma in the file name. Therefore it is recommended to
1140 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141 - Environment variables are expanded |:set_env|.
1142 - Careful with '\' characters, type one before a space, type two to
1143 get one in the option (see |option-backslash|), for example: >
1144 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1145< - For backwards compatibility with Vim version 3.0 a '>' at the start
1146 of the option is removed.
1147 See also 'backup' and 'writebackup' options.
1148 If you want to hide your backup files on Unix, consider this value: >
1149 :set backupdir=./.backup,~/.backup,.,/tmp
1150< You must create a ".backup" directory in each directory and in your
1151 home directory for this to work properly.
1152 The use of |:set+=| and |:set-=| is preferred when adding or removing
1153 directories from the list. This avoids problems when a future version
1154 uses another default.
1155 This option cannot be set from a |modeline| or in the |sandbox|, for
1156 security reasons.
1157
1158 *'backupext'* *'bex'* *E589*
1159'backupext' 'bex' string (default "~", for VMS: "_")
1160 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161 String which is appended to a file name to make the name of the
1162 backup file. The default is quite unusual, because this avoids
1163 accidentally overwriting existing files with a backup file. You might
1164 prefer using ".bak", but make sure that you don't have files with
1165 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001166 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001168 If you like to keep a lot of backups, you could use a BufWritePre
1169 autocommand to change 'backupext' just before writing the file to
1170 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001171 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001172< Use 'backupdir' to put the backup in a different directory.
1173
Bram Moolenaar071d4272004-06-13 20:20:40 +00001174 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001175'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1176 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1177 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001178 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 {not available when compiled without the |+wildignore|
1180 feature}
1181 A list of file patterns. When one of the patterns matches with the
1182 name of the file which is written, no backup file is created. Both
1183 the specified file name and the full path name of the file are used.
1184 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1185 Watch out for special characters, see |option-backslash|.
1186 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001187 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001188
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001189 WARNING: Not having a backup file means that when Vim fails to write
1190 your buffer correctly and then, for whatever reason, Vim exits, you
1191 lose both the original file and what you were writing. Only disable
1192 backups if you don't care about losing the file.
1193
Bram Moolenaar02467872007-05-06 13:22:01 +00001194 Note that environment variables are not expanded. If you want to use
1195 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001196 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001197
1198< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001199 backup would be made by renaming the original file crontab won't see
1200 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201
1202 *'balloondelay'* *'bdlay'*
1203'balloondelay' 'bdlay' number (default: 600)
1204 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205 {only available when compiled with the |+balloon_eval|
1206 feature}
1207 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1208
1209 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1210'ballooneval' 'beval' boolean (default off)
1211 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001212 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001213 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001214 Switch on the |balloon-eval| functionality for the GUI.
1215
1216 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1217 *'nobevalterm'*
1218'balloonevalterm' 'bevalterm' boolean (default off)
1219 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001220 {only available when compiled with the
1221 |+balloon_eval_term| feature}
1222 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001223
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001224 *'balloonexpr'* *'bexpr'*
1225'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001226 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001227 {only available when compiled with the |+balloon_eval|
1228 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001229 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001230 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1231 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001232
1233 v:beval_bufnr number of the buffer in which balloon is going to show
1234 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001235 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001236 v:beval_lnum line number
1237 v:beval_col column number (byte index)
1238 v:beval_text word under or after the mouse pointer
1239
Bram Moolenaar54775062019-07-31 21:07:14 +02001240 Instead of showing a balloon, which is limited to plain text, consider
1241 using a popup window, see |popup_beval_example|. A popup window can
1242 use highlighting and show a border.
1243
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001244 The evaluation of the expression must not have side effects!
1245 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001246 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001247 return 'Cursor is at line ' .. v:beval_lnum ..
1248 \ ', column ' .. v:beval_col ..
1249 \ ' of file ' .. bufname(v:beval_bufnr) ..
1250 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001251 endfunction
1252 set bexpr=MyBalloonExpr()
1253 set ballooneval
1254<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001255 Also see |balloon_show()|, it can be used if the content of the balloon
1256 is to be fetched asynchronously. In that case evaluating
1257 'balloonexpr' should result in an empty string. If you get a balloon
1258 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001259
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001260 NOTE: The balloon is displayed only if the cursor is on a text
1261 character. If the result of evaluating 'balloonexpr' is not empty,
1262 Vim does not try to send a message to an external debugger (Netbeans
1263 or Sun Workshop).
1264
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001265 If the expression starts with s: or |<SID>|, then it is replaced with
1266 the script ID (|local-function|). Example: >
1267 set bexpr=s:MyBalloonExpr()
1268 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001269< Otherwise, the expression is evaluated in the context of the script
1270 where the option was set, thus script-local items are available.
1271
Bram Moolenaar30b65812012-07-12 22:01:11 +02001272 The expression will be evaluated in the |sandbox| when set from a
1273 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001274 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001275
1276 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001277 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001278
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001279 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001280 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001281< When they are supported "\n" characters will start a new line. If the
1282 expression evaluates to a |List| this is equal to using each List item
1283 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001284 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001285
Bram Moolenaar165bc692015-07-21 17:53:25 +02001286 *'belloff'* *'bo'*
1287'belloff' 'bo' string (default "")
1288 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001289 Specifies for which events the bell will not be rung. It is a comma
1290 separated list of items. For each item that is present, the bell
1291 will be silenced. This is most useful to specify specific events in
1292 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001293 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001294
1295 item meaning when present ~
1296 all All events.
1297 backspace When hitting <BS> or <Del> and deleting results in an
1298 error.
1299 cursor Fail to move around using the cursor keys or
1300 <PageUp>/<PageDown> in |Insert-mode|.
1301 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1302 |i_CTRL-X_CTRL-T|.
1303 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1304 |i_CTRL-E|.
1305 ctrlg Unknown Char after <C-G> in Insert mode.
1306 error Other Error occurred (e.g. try to join last line)
1307 (mostly used in |Normal-mode| or |Cmdline-mode|).
1308 esc hitting <Esc> in |Normal-mode|.
1309 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001310 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001311 insertmode Pressing <Esc> in 'insertmode'.
1312 lang Calling the beep module for Lua/Mzscheme/TCL.
1313 mess No output available for |g<|.
1314 showmatch Error occurred for 'showmatch' function.
1315 operator Empty region error |cpo-E|.
1316 register Unknown register after <C-R> in |Insert-mode|.
1317 shell Bell from shell output |:!|.
1318 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001319 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001320 wildmode More matches in |cmdline-completion| available
1321 (depends on the 'wildmode' setting).
1322
Bram Moolenaar036986f2017-03-16 17:41:02 +01001323 This is most useful to fine tune when in Insert mode the bell should
1324 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001325 indicate that an error occurred. It can be silenced by adding the
1326 "error" keyword.
1327
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1329'binary' 'bin' boolean (default off)
1330 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331 This option should be set before editing a binary file. You can also
1332 use the |-b| Vim argument. When this option is switched on a few
1333 options will be changed (also when it already was on):
1334 'textwidth' will be set to 0
1335 'wrapmargin' will be set to 0
1336 'modeline' will be off
1337 'expandtab' will be off
1338 Also, 'fileformat' and 'fileformats' options will not be used, the
1339 file is read and written like 'fileformat' was "unix" (a single <NL>
1340 separates lines).
1341 The 'fileencoding' and 'fileencodings' options will not be used, the
1342 file is read without conversion.
1343 NOTE: When you start editing a(nother) file while the 'bin' option is
1344 on, settings from autocommands may change the settings again (e.g.,
1345 'textwidth'), causing trouble when editing. You might want to set
1346 'bin' again when the file has been loaded.
1347 The previous values of these options are remembered and restored when
1348 'bin' is switched from on to off. Each buffer has its own set of
1349 saved option values.
1350 To edit a file with 'binary' set you can use the |++bin| argument.
1351 This avoids you have to do ":set bin", which would have effect for all
1352 files you edit.
1353 When writing a file the <EOL> for the last line is only written if
1354 there was one in the original file (normally Vim appends an <EOL> to
1355 the last line if there is none; this would make the file longer). See
1356 the 'endofline' option.
1357
1358 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1359'bioskey' 'biosk' boolean (default on)
1360 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001361 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001362 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001363
1364 *'bomb'* *'nobomb'*
1365'bomb' boolean (default off)
1366 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 When writing a file and the following conditions are met, a BOM (Byte
1368 Order Mark) is prepended to the file:
1369 - this option is on
1370 - the 'binary' option is off
1371 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1372 endian variants.
1373 Some applications use the BOM to recognize the encoding of the file.
1374 Often used for UCS-2 files on MS-Windows. For other applications it
1375 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001376 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1378 check for the presence of the BOM is done and 'bomb' set accordingly.
1379 Unless 'binary' is set, it is removed from the first line, so that you
1380 don't see it when editing. When you don't change the options, the BOM
1381 will be restored when writing the file.
1382
1383 *'breakat'* *'brk'*
1384'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1385 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001386 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387 feature}
1388 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001389 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1390 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001392 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001393'breakindent' 'bri' boolean (default off)
1394 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001395 {not available when compiled without the |+linebreak|
1396 feature}
1397 Every wrapped line will continue visually indented (same amount of
1398 space as the beginning of that line), thus preserving horizontal blocks
1399 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001400 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001401
1402 *'breakindentopt'* *'briopt'*
1403'breakindentopt' 'briopt' string (default empty)
1404 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001405 {not available when compiled without the |+linebreak|
1406 feature}
1407 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001408 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001409 min:{n} Minimum text width that will be kept after
1410 applying 'breakindent', even if the resulting
1411 text should normally be narrower. This prevents
1412 text indented almost to the right window border
1413 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001414 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001415 shift:{n} After applying 'breakindent', the wrapped line's
1416 beginning will be shifted by the given number of
1417 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001418 indentation (negative) or emphasizing the line
1419 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001420 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001421 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001422 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001423 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001424 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001425 numbered or bulleted list (using the
1426 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001427 list:-1 Uses the length of a match with 'formatlistpat'
1428 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001429 (default: 0)
1430 column:{n} Indent at column {n}. Will overrule the other
1431 sub-options. Note: an additional indent may be
1432 added for the 'showbreak' setting.
1433 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001434
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001436'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001438 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001439 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001440 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001441 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001442 buffer Use the directory of the related buffer.
1443 current Use the current directory.
1444 {path} Use the specified directory
1445
1446 *'bufhidden'* *'bh'*
1447'bufhidden' 'bh' string (default: "")
1448 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001449 This option specifies what happens when a buffer is no longer
1450 displayed in a window:
1451 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001452 hide hide the buffer (don't unload it), even if 'hidden' is
1453 not set
1454 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001455 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001456 delete delete the buffer from the buffer list, even if
1457 'hidden' is set; the |:hide| command will also delete
1458 the buffer, making it behave like |:bdelete|
1459 wipe wipe the buffer from the buffer list, even if
1460 'hidden' is set; the |:hide| command will also wipe
1461 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001463 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001464 are lost without a warning. Also, these values may break autocommands
1465 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466 This option is used together with 'buftype' and 'swapfile' to specify
1467 special kinds of buffers. See |special-buffers|.
1468
1469 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1470'buflisted' 'bl' boolean (default: on)
1471 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001472 When this option is set, the buffer shows up in the buffer list. If
1473 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1474 This option is reset by Vim for buffers that are only used to remember
1475 a file name or marks. Vim sets it when starting to edit a buffer.
1476 But not when moving to a buffer with ":buffer".
1477
1478 *'buftype'* *'bt'* *E382*
1479'buftype' 'bt' string (default: "")
1480 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001481 The value of this option specifies the type of a buffer:
1482 <empty> normal buffer
1483 nofile buffer which is not related to a file and will not be
1484 written
1485 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001486 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001487 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001489 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490 help help buffer (you are not supposed to set this
1491 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001492 terminal buffer for a |terminal| (you are not supposed to set
1493 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001494 prompt buffer where only the last line can be edited, meant
1495 to be used by a plugin, see |prompt-buffer|
1496 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001497 popup buffer used in a popup window, see |popup|.
1498 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499
1500 This option is used together with 'bufhidden' and 'swapfile' to
1501 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001502 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503
1504 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001505 One such effect is that Vim will not check the timestamp of the file,
1506 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507
Bram Moolenaar280f1262006-01-30 00:14:18 +00001508 A "quickfix" buffer is only used for the error list and the location
1509 list. This value is set by the |:cwindow| and |:lwindow| commands and
1510 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511
1512 "nofile" and "nowrite" buffers are similar:
1513 both: The buffer is not to be written to disk, ":w" doesn't
1514 work (":w filename" does work though).
1515 both: The buffer is never considered to be |'modified'|.
1516 There is no warning when the changes will be lost, for
1517 example when you quit Vim.
1518 both: A swap file is only created when using too much memory
1519 (when 'swapfile' has been reset there is never a swap
1520 file).
1521 nofile only: The buffer name is fixed, it is not handled like a
1522 file name. It is not modified in response to a |:cd|
1523 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001524 both: When using ":e bufname" and already editing "bufname"
1525 the buffer is made empty and autocommands are
1526 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001527 *E676*
1528 "acwrite" implies that the buffer name is not related to a file, like
1529 "nofile", but it will be written. Thus, in contrast to "nofile" and
1530 "nowrite", ":w" does work and a modified buffer can't be abandoned
1531 without saving. For writing there must be matching |BufWriteCmd|,
1532 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533
1534 *'casemap'* *'cmp'*
1535'casemap' 'cmp' string (default: "internal,keepascii")
1536 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537 Specifies details about changing the case of letters. It may contain
1538 these words, separated by a comma:
1539 internal Use internal case mapping functions, the current
1540 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001541 matters when 'encoding' is a Unicode encoding,
1542 "latin1" or "iso-8859-15". When "internal" is
1543 omitted, the towupper() and towlower() system library
1544 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1546 case mapping, the current locale is not effective.
1547 This probably only matters for Turkish.
1548
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001549 *'cdhome'* *'cdh'*
1550'cdhome' 'cdh' boolean (default: off)
1551 global
1552 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1553 current working directory to the |$HOME| directory like in Unix.
1554 When off, those commands just print the current directory name.
1555 On Unix this option has no effect.
1556 NOTE: This option is reset when 'compatible' is set.
1557
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 *'cdpath'* *'cd'* *E344* *E346*
1559'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1560 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561 {not available when compiled without the
1562 |+file_in_path| feature}
1563 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001564 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1565 searched for has a relative path, not an absolute part starting with
1566 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567 The 'cdpath' option's value has the same form and semantics as
1568 |'path'|. Also see |file-searching|.
1569 The default value is taken from $CDPATH, with a "," prepended to look
1570 in the current directory first.
1571 If the default value taken from $CDPATH is not what you want, include
1572 a modified version of the following command in your vimrc file to
1573 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001574 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001575< This option cannot be set from a |modeline| or in the |sandbox|, for
1576 security reasons.
1577 (parts of 'cdpath' can be passed to the shell to expand file names).
1578
1579 *'cedit'*
1580'cedit' string (Vi default: "", Vim default: CTRL-F)
1581 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582 The key used in Command-line Mode to open the command-line window.
1583 The default is CTRL-F when 'compatible' is off.
1584 Only non-printable keys are allowed.
1585 The key can be specified as a single character, but it is difficult to
1586 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001587 :exe "set cedit=\<C-Y>"
1588 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589< |Nvi| also has this option, but it only uses the first character.
1590 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001591 NOTE: This option is set to the Vim default value when 'compatible'
1592 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001593
1594 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1595'charconvert' 'ccv' string (default "")
1596 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001597 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001598 An expression that is used for character encoding conversion. It is
1599 evaluated when a file that is to be read or has been written has a
1600 different encoding from what is desired.
1601 'charconvert' is not used when the internal iconv() function is
1602 supported and is able to do the conversion. Using iconv() is
1603 preferred, because it is much faster.
1604 'charconvert' is not used when reading stdin |--|, because there is no
1605 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001606 The expression must return zero, false or an empty string for success,
1607 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608 The possible encoding names encountered are in 'encoding'.
1609 Additionally, names given in 'fileencodings' and 'fileencoding' are
1610 used.
1611 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1612 is done internally by Vim, 'charconvert' is not used for this.
1613 'charconvert' is also used to convert the viminfo file, if the 'c'
1614 flag is present in 'viminfo'. Also used for Unicode conversion.
1615 Example: >
1616 set charconvert=CharConvert()
1617 fun CharConvert()
1618 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001619 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1620 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621 return v:shell_error
1622 endfun
1623< The related Vim variables are:
1624 v:charconvert_from name of the current encoding
1625 v:charconvert_to name of the desired encoding
1626 v:fname_in name of the input file
1627 v:fname_out name of the output file
1628 Note that v:fname_in and v:fname_out will never be the same.
1629 Note that v:charconvert_from and v:charconvert_to may be different
1630 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001631
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 Encryption is not done by Vim when using 'charconvert'. If you want
1633 to encrypt the file after conversion, 'charconvert' should take care
1634 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001635
1636 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1637 replaced with the script ID (|local-function|). Example: >
1638 set charconvert=s:MyConvert()
1639 set charconvert=<SID>SomeConvert()
1640< Otherwise the expression is evaluated in the context of the script
1641 where the option was set, thus script-local items are available.
1642
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643 This option cannot be set from a |modeline| or in the |sandbox|, for
1644 security reasons.
1645
1646 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1647'cindent' 'cin' boolean (default off)
1648 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001649 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650 that trigger reindenting in insert mode and 'cinoptions' to set your
1651 preferred indent style.
1652 If 'indentexpr' is not empty, it overrules 'cindent'.
1653 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1654 the "=" operator indents using this algorithm rather than calling an
1655 external program.
1656 See |C-indenting|.
1657 When you don't like the way 'cindent' works, try the 'smartindent'
1658 option or 'indentexpr'.
1659 This option is not used when 'paste' is set.
1660 NOTE: This option is reset when 'compatible' is set.
1661
1662 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001663'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 A list of keys that, when typed in Insert mode, cause reindenting of
1666 the current line. Only used if 'cindent' is on and 'indentexpr' is
1667 empty.
1668 For the format of this option see |cinkeys-format|.
1669 See |C-indenting|.
1670
1671 *'cinoptions'* *'cino'*
1672'cinoptions' 'cino' string (default "")
1673 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1675 program. See |cinoptions-values| for the values of this option, and
1676 |C-indenting| for info on C indenting in general.
1677
1678
1679 *'cinwords'* *'cinw'*
1680'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1681 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001682 These keywords start an extra indent in the next line when
1683 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1684 an appropriate place (inside {}).
1685 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1686 matter, include the keyword both the uppercase and lowercase:
1687 "if,If,IF".
1688
Tom Praschan3506cf32022-04-07 12:39:08 +01001689 *'cinscopedecls'* *'cinsd'*
1690'cinscopedecls' 'cinsd' string (default "public,protected,private")
1691 local to buffer
Tom Praschan3506cf32022-04-07 12:39:08 +01001692 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1693 Useful e.g. for working with the Qt framework that defines additional
1694 scope declarations "signals", "public slots" and "private slots": >
1695 set cinscopedecls+=signals,public\ slots,private\ slots
1696
1697< *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001698'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1699 for X-windows, "" otherwise)
1700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701 {only in GUI versions or when the |+xterm_clipboard|
1702 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001703 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001704 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001705 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001706 prepend, e.g.: >
1707 set clipboard^=unnamed
1708< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001710 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 unnamed When included, Vim will use the clipboard register '*'
1712 for all yank, delete, change and put operations which
1713 would normally go to the unnamed register. When a
1714 register is explicitly specified, it will always be
1715 used regardless of whether "unnamed" is in 'clipboard'
1716 or not. The clipboard register can always be
1717 explicitly accessed using the "* notation. Also see
1718 |gui-clipboard|.
1719
Bram Moolenaar30b65812012-07-12 22:01:11 +02001720 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001721 unnamedplus A variant of the "unnamed" flag which uses the
1722 clipboard register '+' (|quoteplus|) instead of
1723 register '*' for all yank, delete, change and put
1724 operations which would normally go to the unnamed
1725 register. When "unnamed" is also included to the
1726 option, yank operations (but not delete, change or
1727 put) will additionally copy the text into register
1728 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001729 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001730 Availability can be checked with: >
1731 if has('unnamedplus')
1732<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001733 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 autoselect Works like the 'a' flag in 'guioptions': If present,
1735 then whenever Visual mode is started, or the Visual
1736 area extended, Vim tries to become the owner of the
1737 windowing system's global selection or put the
1738 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001739 register "*. See |'go-a'| and |quotestar| for details.
1740 When the GUI is active, the 'a' flag in 'guioptions'
1741 is used, when the GUI is not active, this "autoselect"
1742 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743 Also applies to the modeless selection.
1744
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001745 *clipboard-autoselectplus*
1746 autoselectplus Like "autoselect" but using the + register instead of
1747 the * register. Compare to the 'P' flag in
1748 'guioptions'.
1749
1750 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751 autoselectml Like "autoselect", but for the modeless selection
1752 only. Compare to the 'A' flag in 'guioptions'.
1753
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001754 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001755 html When the clipboard contains HTML, use this when
1756 pasting. When putting text on the clipboard, mark it
1757 as HTML. This works to copy rendered HTML from
1758 Firefox, paste it as raw HTML in Vim, select the HTML
1759 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001760 You probably want to add this only temporarily,
1761 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001762 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001763
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001764 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001765 exclude:{pattern}
1766 Defines a pattern that is matched against the name of
1767 the terminal 'term'. If there is a match, no
1768 connection will be made to the X server. This is
1769 useful in this situation:
1770 - Running Vim in a console.
1771 - $DISPLAY is set to start applications on another
1772 display.
1773 - You do not want to connect to the X server in the
1774 console, but do want this in a terminal emulator.
1775 To never connect to the X server use: >
1776 exclude:.*
1777< This has the same effect as using the |-X| argument.
1778 Note that when there is no connection to the X server
1779 the window title won't be restored and the clipboard
1780 cannot be accessed.
1781 The value of 'magic' is ignored, {pattern} is
1782 interpreted as if 'magic' was on.
1783 The rest of the option value will be used for
1784 {pattern}, this must be the last entry.
1785
1786 *'cmdheight'* *'ch'*
1787'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001788 global or local to tab page
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789 Number of screen lines to use for the command-line. Helps avoiding
1790 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001791 The value of this option is stored with the tab page, so that each tab
1792 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001793
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001794 When 'cmdheight' is zero, there is no command-line unless it is being
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01001795 used. Some informative messages will not be displayed, any other
Bram Moolenaare1f3fd12022-08-15 18:51:32 +01001796 messages will cause the |hit-enter| prompt. Expect some other
1797 unexpected behavior too.
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001798
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 *'cmdwinheight'* *'cwh'*
1800'cmdwinheight' 'cwh' number (default 7)
1801 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 Number of screen lines to use for the command-line window. |cmdwin|
1803
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001804 *'colorcolumn'* *'cc'*
1805'colorcolumn' 'cc' string (default "")
1806 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001807 {not available when compiled without the |+syntax|
1808 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001809 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001810 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1811 text. Will make screen redrawing slower.
1812 The screen column can be an absolute number, or a number preceded with
1813 '+' or '-', which is added to or subtracted from 'textwidth'. >
1814
1815 :set cc=+1 " highlight column after 'textwidth'
1816 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1817 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1818<
1819 When 'textwidth' is zero then the items with '-' and '+' are not used.
1820 A maximum of 256 columns are highlighted.
1821
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822 *'columns'* *'co'* *E594*
1823'columns' 'co' number (default 80 or terminal width)
1824 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001826 initialization and does not have to be set by hand. Also see
1827 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001828 When Vim is running in the GUI or in a resizable window, setting this
1829 option will cause the window size to be changed. When you only want
1830 to use the size for the GUI, put the command in your |gvimrc| file.
1831 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001832 number of columns of the display, the display may be messed up. For
1833 the GUI it is always possible and Vim limits the number of columns to
1834 what fits on the screen. You can use this command to get the widest
1835 window possible: >
1836 :set columns=9999
1837< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838
1839 *'comments'* *'com'* *E524* *E525*
1840'comments' 'com' string (default
1841 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1842 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001843 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 |format-comments|. See |option-backslash| about using backslashes to
1845 insert a space.
1846
1847 *'commentstring'* *'cms'* *E537*
1848'commentstring' 'cms' string (default "/*%s*/")
1849 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 {not available when compiled without the |+folding|
1851 feature}
1852 A template for a comment. The "%s" in the value is replaced with the
1853 comment text. Currently only used to add markers for folding, see
1854 |fold-marker|.
1855
1856 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001857'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001858 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 This option has the effect of making Vim either more Vi-compatible, or
1861 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001862
Bram Moolenaar071d4272004-06-13 20:20:40 +00001863 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001864 other options are also changed as a side effect.
1865 NOTE: Setting or resetting this option can have a lot of unexpected
1866 effects: Mappings are interpreted in another way, undo behaves
1867 differently, etc. If you set this option in your vimrc file, you
1868 should probably put it at the very start.
1869
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870 By default this option is on and the Vi defaults are used for the
1871 options. This default was chosen for those people who want to use Vim
1872 just like Vi, and don't even (want to) know about the 'compatible'
1873 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001874 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001875 this option is switched off, and all options that have not been
1876 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001877 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001878 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001879 happen for the system-wide vimrc or gvimrc file, nor for a file given
1880 with the |-u| argument). Also see |compatible-default| and
1881 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001882 You can also set this option with the "-C" argument, and reset it with
1883 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001884 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885
Bram Moolenaar214641f2017-03-05 17:04:09 +01001886 When this option is set, numerous other options are set to make Vim as
1887 Vi-compatible as possible. When this option is unset, various options
1888 are set to make Vim more useful. The table below lists all the
1889 options affected.
1890 The {?} column indicates when the options are affected:
1891 + Means that the option is set to the value given in {set value} when
1892 'compatible' is set.
1893 & Means that the option is set to the value given in {set value} when
1894 'compatible' is set AND is set to its Vim default value when
1895 'compatible' is unset.
1896 - Means the option is NOT changed when setting 'compatible' but IS
1897 set to its Vim default when 'compatible' is unset.
1898 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001899
Bram Moolenaar036986f2017-03-16 17:41:02 +01001900 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001901
1902 'allowrevins' + off no CTRL-_ command
1903 'antialias' + off don't use antialiased fonts
1904 'arabic' + off reset arabic-related options
1905 'arabicshape' + on correct character shapes
1906 'backspace' + "" normal backspace
1907 'backup' + off no backup file
1908 'backupcopy' & Unix: "yes" backup file is a copy
1909 else: "auto" copy or rename backup file
1910 'balloonexpr' + "" text to show in evaluation balloon
1911 'breakindent' + off don't indent when wrapping lines
1912 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001913 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001914 'cindent' + off no C code indentation
1915 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1916 'copyindent' + off don't copy indent structure
1917 'cpoptions' & (all flags) Vi-compatible flags
1918 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001919 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001920 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001921 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001922 'cscopeverbose' + off see |cscopeverbose|
1923 'delcombine' + off unicode: delete whole char combination
1924 'digraph' + off no digraphs
1925 'esckeys' & off no <Esc>-keys in Insert mode
1926 'expandtab' + off tabs not expanded to spaces
1927 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001928 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001929 'formatexpr' + "" use 'formatprg' for auto-formatting
1930 'formatoptions' & "vt" Vi compatible formatting
1931 'gdefault' + off no default 'g' flag for ":s"
1932 'history' & 0 no commandline history
1933 'hkmap' + off no Hebrew keyboard mapping
1934 'hkmapp' + off no phonetic Hebrew keyboard mapping
1935 'hlsearch' + off no highlighting of search matches
1936 'incsearch' + off no incremental searching
1937 'indentexpr' + "" no indenting by expression
1938 'insertmode' + off do not start in Insert mode
1939 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001941 'joinspaces' + on insert 2 spaces after period
1942 'modeline' & off no modelines
1943 'more' & off no pauses in listings
1944 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1945 'numberwidth' & 8 min number of columns for line number
1946 'preserveindent'+ off don't preserve current indent structure
1947 when changing it
1948 'revins' + off no reverse insert
1949 'ruler' + off no ruler
1950 'scrolljump' + 1 no jump scroll
1951 'scrolloff' + 0 no scroll offset
1952 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1953 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001954 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001955 'showcmd' & off command characters not shown
1956 'showmode' & off current mode not shown
1957 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1958 'smartcase' + off no automatic ignore case switch
1959 'smartindent' + off no smart indentation
1960 'smarttab' + off no smart tab size
1961 'softtabstop' + 0 tabs are always 'tabstop' positions
1962 'startofline' + on goto startofline with some commands
1963 'tagcase' & "followic" 'ignorecase' when searching tags file
1964 'tagrelative' & off tag file names are not relative
1965 'termguicolors' + off don't use highlight-(guifg|guibg)
1966 'textauto' & off no automatic textmode detection
1967 'textwidth' + 0 no automatic line wrap
1968 'tildeop' + off tilde is not an operator
1969 'ttimeout' + off no terminal timeout
1970 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001971 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001972 'virtualedit' + "" cursor can only be placed on characters
1973 'whichwrap' & "" left-right movements don't wrap
1974 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001975 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001976 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001977
1978 *'complete'* *'cpt'* *E535*
1979'complete' 'cpt' string (default: ".,w,b,u,t,i")
1980 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001981 This option specifies how keyword completion |ins-completion| works
1982 when CTRL-P or CTRL-N are used. It is also used for whole-line
1983 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001984 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001985 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001986 w scan buffers from other windows
1987 b scan other loaded buffers that are in the buffer list
1988 u scan the unloaded buffers that are in the buffer list
1989 U scan the buffers that are not in the buffer list
1990 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001991 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992 k{dict} scan the file {dict}. Several "k" flags can be given,
1993 patterns are valid too. For example: >
1994 :set cpt=k/usr/dict/*,k~/spanish
1995< s scan the files given with the 'thesaurus' option
1996 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1997 are valid too.
1998 i scan current and included files
1999 d scan current and included files for defined name or macro
2000 |i_CTRL-X_CTRL-D|
2001 ] tag completion
2002 t same as "]"
2003
2004 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2005 not executed, this may lead to unexpected completions from some files
2006 (gzipped files for example). Unloaded buffers are not scanned for
2007 whole-line completion.
2008
2009 The default is ".,w,b,u,t,i", which means to scan:
2010 1. the current buffer
2011 2. buffers in other windows
2012 3. other loaded buffers
2013 4. unloaded buffers
2014 5. tags
2015 6. included files
2016
2017 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002018 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2019 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002021 *'completefunc'* *'cfu'*
2022'completefunc' 'cfu' string (default: empty)
2023 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002024 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002025 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002026 This option specifies a function to be used for Insert mode completion
2027 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002028 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002029 invoked and what it should return. The value can be the name of a
2030 function, a |lambda| or a |Funcref|. See |option-value-function| for
2031 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002032 This option cannot be set from a |modeline| or in the |sandbox|, for
2033 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002034
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002035 *'completeslash'* *'csl'*
2036'completeslash' 'csl' string (default: "")
2037 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002038 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002039 When this option is set it overrules 'shellslash' for completion:
2040 - When this option is set to "slash", a forward slash is used for path
2041 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002042 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002043 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002044 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002045 - When this option is empty, same character is used as for
2046 'shellslash'.
2047 For Insert mode completion the buffer-local value is used. For
2048 command line completion the global value is used.
2049
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002050 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002051'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002052 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002053 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002054 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002055
2056 menu Use a popup menu to show the possible completions. The
2057 menu is only shown when there is more than one match and
2058 sufficient colors are available. |ins-completion-menu|
2059
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002060 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002061 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002062 match, e.g., what file it comes from.
2063
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002064 longest Only insert the longest common text of the matches. If
2065 the menu is displayed you can use CTRL-L to add more
2066 characters. Whether case is ignored depends on the kind
2067 of completion. For buffer text the 'ignorecase' option is
2068 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002069
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002070 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002071 completion in the preview window. Only works in
2072 combination with "menu" or "menuone".
2073
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002074 popup Show extra information about the currently selected
2075 completion in a popup window. Only works in combination
2076 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002077 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002078 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002079
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002080 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002081 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002082 |CompleteChanged| autocommand to fetch the info and call
2083 |popup_show()| once the popup has been filled.
2084 See the example at |complete-popuphidden|.
2085 {only works when compiled with the |+textprop| feature}
2086
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002087 noinsert Do not insert any text for a match until the user selects
2088 a match from the menu. Only works in combination with
2089 "menu" or "menuone". No effect if "longest" is present.
2090
2091 noselect Do not select a match in the menu, force the user to
2092 select one from the menu. Only works in combination with
2093 "menu" or "menuone".
2094
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002095
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002096 *'completepopup'* *'cpp'*
2097'completepopup' 'cpp' string (default empty)
2098 global
2099 {not available when compiled without the |+textprop|
2100 or |+quickfix| feature}
2101 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002102 properties of the info popup when it is created. If an info popup
2103 window already exists it is closed, so that the option value is
2104 applied when it is created again.
2105 You can also use |popup_findinfo()| and then set properties for an
2106 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002107
2108
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002109 *'concealcursor'* *'cocu'*
2110'concealcursor' 'cocu' string (default: "")
2111 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002112 {not available when compiled without the |+conceal|
2113 feature}
2114 Sets the modes in which text in the cursor line can also be concealed.
2115 When the current mode is listed then concealing happens just like in
2116 other lines.
2117 n Normal mode
2118 v Visual mode
2119 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002120 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002121
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002122 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002123 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002124 are moving around text is concealed, but when starting to insert text
2125 or selecting a Visual area the concealed text is displayed, so that
2126 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002127 Keep in mind that the cursor position is not always where it's
2128 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002129
2130
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002131 *'conceallevel'* *'cole'*
2132'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002133 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002134 {not available when compiled without the |+conceal|
2135 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002136 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2137 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002138
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002139 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002140 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002141 1 Each block of concealed text is replaced with one
2142 character. If the syntax item does not have a custom
2143 replacement character defined (see |:syn-cchar|) the
2144 character defined in 'listchars' is used (default is a
2145 space).
2146 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002147 2 Concealed text is completely hidden unless it has a
2148 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002149 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002150 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002151
Bram Moolenaara7781e02010-07-19 20:13:22 +02002152 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002153 edit and copy the text. This can be changed with the 'concealcursor'
2154 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002155
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2157'confirm' 'cf' boolean (default off)
2158 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159 When 'confirm' is on, certain operations that would normally
2160 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2161 instead raise a |dialog| asking if you wish to save the current
2162 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2163 If 'confirm' is off you can still activate confirmation for one
2164 command only (this is most useful in mappings) with the |:confirm|
2165 command.
2166 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2167
2168 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2169'conskey' 'consk' boolean (default off)
2170 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002171 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172
2173 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2174'copyindent' 'ci' boolean (default off)
2175 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176 Copy the structure of the existing lines indent when autoindenting a
2177 new line. Normally the new indent is reconstructed by a series of
2178 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2179 in which case only spaces are used). Enabling this option makes the
2180 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002181 existing line. 'expandtab' has no effect on these characters, a Tab
2182 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002184 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185 Also see 'preserveindent'.
2186
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002187 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002188'cpoptions' 'cpo' string (Vim default: "aABceFs",
2189 Vi default: all flags)
2190 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002192 this indicates Vi-compatible behavior. This is used for things where
2193 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002194 'cpoptions' stands for "compatible-options".
2195 Commas can be added for readability.
2196 To avoid problems with flags that are added in the future, use the
2197 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002198
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199 NOTE: This option is set to the Vi default value when 'compatible' is
2200 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002201
2202 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2203 is saved, 'cpoptions' is set to the Vim default, and the saved value
2204 is restored at the end of the script. Changes to the value of
2205 'cpoptions' will be applied to the saved value, but keep in mind that
2206 removing a flag that is not present when 'cpoptions' is changed has no
2207 effect. In the |.vimrc| file the value is not restored, thus using
2208 `vim9script` in the |.vimrc| file results in using the Vim default.
2209
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002210 NOTE: This option is set to the POSIX default value at startup when
2211 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002212 variable exists |posix|. This means Vim tries to behave like the
2213 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214
2215 contains behavior ~
2216 *cpo-a*
2217 a When included, a ":read" command with a file name
2218 argument will set the alternate file name for the
2219 current window.
2220 *cpo-A*
2221 A When included, a ":write" command with a file name
2222 argument will set the alternate file name for the
2223 current window.
2224 *cpo-b*
2225 b "\|" in a ":map" command is recognized as the end of
2226 the map command. The '\' is included in the mapping,
2227 the text after the '|' is interpreted as the next
2228 command. Use a CTRL-V instead of a backslash to
2229 include the '|' in the mapping. Applies to all
2230 mapping, abbreviation, menu and autocmd commands.
2231 See also |map_bar|.
2232 *cpo-B*
2233 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002234 abbreviations, user commands and the "to" part of the
2235 menu commands. Remove this flag to be able to use a
2236 backslash like a CTRL-V. For example, the command
2237 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002238 'B' included: "\^[" (^[ is a real <Esc>)
2239 'B' excluded: "<Esc>" (5 characters)
2240 ('<' excluded in both cases)
2241 *cpo-c*
2242 c Searching continues at the end of any match at the
2243 cursor position, but not further than the start of the
2244 next line. When not present searching continues
2245 one character from the cursor position. With 'c'
2246 "abababababab" only gets three matches when repeating
2247 "/abab", without 'c' there are five matches.
2248 *cpo-C*
2249 C Do not concatenate sourced lines that start with a
2250 backslash. See |line-continuation|.
2251 *cpo-d*
2252 d Using "./" in the 'tags' option doesn't mean to use
2253 the tags file relative to the current file, but the
2254 tags file in the current directory.
2255 *cpo-D*
2256 D Can't use CTRL-K to enter a digraph after Normal mode
2257 commands with a character argument, like |r|, |f| and
2258 |t|.
2259 *cpo-e*
2260 e When executing a register with ":@r", always add a
2261 <CR> to the last line, also when the register is not
2262 linewise. If this flag is not present, the register
2263 is not linewise and the last line does not end in a
2264 <CR>, then the last line is put on the command-line
2265 and can be edited before hitting <CR>.
2266 *cpo-E*
2267 E It is an error when using "y", "d", "c", "g~", "gu" or
2268 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002269 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270 This makes "y0" fail in the first column.
2271 *cpo-f*
2272 f When included, a ":read" command with a file name
2273 argument will set the file name for the current buffer,
2274 if the current buffer doesn't have a file name yet.
2275 *cpo-F*
2276 F When included, a ":write" command with a file name
2277 argument will set the file name for the current
2278 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002279 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280 *cpo-g*
2281 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002282 *cpo-H*
2283 H When using "I" on a line with only blanks, insert
2284 before the last blank. Without this flag insert after
2285 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286 *cpo-i*
2287 i When included, interrupting the reading of a file will
2288 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002289 *cpo-I*
2290 I When moving the cursor up or down just after inserting
2291 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002292 *cpo-j*
2293 j When joining lines, only add two spaces after a '.',
2294 not after '!' or '?'. Also see 'joinspaces'.
2295 *cpo-J*
2296 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002297 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002298 white space.
2299 *cpo-k*
2300 k Disable the recognition of raw key codes in
2301 mappings, abbreviations, and the "to" part of menu
2302 commands. For example, if <Key> sends ^[OA (where ^[
2303 is <Esc>), the command ":map X ^[OA" results in X
2304 being mapped to:
2305 'k' included: "^[OA" (3 characters)
2306 'k' excluded: "<Key>" (one key code)
2307 Also see the '<' flag below.
2308 *cpo-K*
2309 K Don't wait for a key code to complete when it is
2310 halfway a mapping. This breaks mapping <F1><F1> when
2311 only part of the second <F1> has been read. It
2312 enables cancelling the mapping by typing <F1><Esc>.
2313 *cpo-l*
2314 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002315 literally, only "\]", "\^", "\-" and "\\" are special.
2316 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2318 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002319 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002320 *cpo-L*
2321 L When the 'list' option is set, 'wrapmargin',
2322 'textwidth', 'softtabstop' and Virtual Replace mode
2323 (see |gR|) count a <Tab> as two characters, instead of
2324 the normal behavior of a <Tab>.
2325 *cpo-m*
2326 m When included, a showmatch will always wait half a
2327 second. When not included, a showmatch will wait half
2328 a second or until a character is typed. |'showmatch'|
2329 *cpo-M*
2330 M When excluded, "%" matching will take backslashes into
2331 account. Thus in "( \( )" and "\( ( \)" the outer
2332 parenthesis match. When included "%" ignores
2333 backslashes, which is Vi compatible.
2334 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002335 n When included, the column used for 'number' and
2336 'relativenumber' will also be used for text of wrapped
2337 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338 *cpo-o*
2339 o Line offset to search command is not remembered for
2340 next search.
2341 *cpo-O*
2342 O Don't complain if a file is being overwritten, even
2343 when it didn't exist when editing it. This is a
2344 protection against a file unexpectedly created by
2345 someone else. Vi didn't complain about this.
2346 *cpo-p*
2347 p Vi compatible Lisp indenting. When not present, a
2348 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002349 *cpo-P*
2350 P When included, a ":write" command that appends to a
2351 file will set the file name for the current buffer, if
2352 the current buffer doesn't have a file name yet and
2353 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002354 *cpo-q*
2355 q When joining multiple lines leave the cursor at the
2356 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357 *cpo-r*
2358 r Redo ("." command) uses "/" to repeat a search
2359 command, instead of the actually used search string.
2360 *cpo-R*
2361 R Remove marks from filtered lines. Without this flag
2362 marks are kept like |:keepmarks| was used.
2363 *cpo-s*
2364 s Set buffer options when entering the buffer for the
2365 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002366 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 set when the buffer is created.
2368 *cpo-S*
2369 S Set buffer options always when entering a buffer
2370 (except 'readonly', 'fileformat', 'filetype' and
2371 'syntax'). This is the (most) Vi compatible setting.
2372 The options are set to the values in the current
2373 buffer. When you change an option and go to another
2374 buffer, the value is copied. Effectively makes the
2375 buffer options global to all buffers.
2376
2377 's' 'S' copy buffer options
2378 no no when buffer created
2379 yes no when buffer first entered (default)
2380 X yes each time when buffer entered (vi comp.)
2381 *cpo-t*
2382 t Search pattern for the tag command is remembered for
2383 "n" command. Otherwise Vim only puts the pattern in
2384 the history for search pattern, but doesn't change the
2385 last used search pattern.
2386 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002387 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 *cpo-v*
2389 v Backspaced characters remain visible on the screen in
2390 Insert mode. Without this flag the characters are
2391 erased from the screen right away. With this flag the
2392 screen newly typed text overwrites backspaced
2393 characters.
2394 *cpo-w*
2395 w When using "cw" on a blank character, only change one
2396 character and not all blanks until the start of the
2397 next word.
2398 *cpo-W*
2399 W Don't overwrite a readonly file. When omitted, ":w!"
2400 overwrites a readonly file, if possible.
2401 *cpo-x*
2402 x <Esc> on the command-line executes the command-line.
2403 The default in Vim is to abandon the command-line,
2404 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002405 *cpo-X*
2406 X When using a count with "R" the replaced text is
2407 deleted only once. Also when repeating "R" with "."
2408 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002410 y A yank command can be redone with ".". Think twice if
2411 you really want to use this, it may break some
2412 plugins, since most people expect "." to only repeat a
2413 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002414 *cpo-Z*
2415 Z When using "w!" while the 'readonly' option is set,
2416 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002417 *cpo-!*
2418 ! When redoing a filter command, use the last used
2419 external command, whatever it was. Otherwise the last
2420 used -filter- command is used.
2421 *cpo-$*
2422 $ When making a change to one line, don't redisplay the
2423 line, but put a '$' at the end of the changed text.
2424 The changed text will be overwritten when you type the
2425 new text. The line is redisplayed if you type any
2426 command that moves the cursor from the insertion
2427 point.
2428 *cpo-%*
2429 % Vi-compatible matching is done for the "%" command.
2430 Does not recognize "#if", "#endif", etc.
2431 Does not recognize "/*" and "*/".
2432 Parens inside single and double quotes are also
2433 counted, causing a string that contains a paren to
2434 disturb the matching. For example, in a line like
2435 "if (strcmp("foo(", s))" the first paren does not
2436 match the last one. When this flag is not included,
2437 parens inside single and double quotes are treated
2438 specially. When matching a paren outside of quotes,
2439 everything inside quotes is ignored. When matching a
2440 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002441 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002442 This flag is also used for other features, such as
2443 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002444 *cpo--*
2445 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002446 it would go above the first line or below the last
2447 line. Without it the cursor moves to the first or
2448 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002449 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002450 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002451 *cpo-+*
2452 + When included, a ":write file" command will reset the
2453 'modified' flag of the buffer, even though the buffer
2454 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002455 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456 * Use ":*" in the same way as ":@". When not included,
2457 ":*" is an alias for ":'<,'>", select the Visual area.
2458 *cpo-<*
2459 < Disable the recognition of special key codes in |<>|
2460 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002461 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002462 ":map X <Tab>" results in X being mapped to:
2463 '<' included: "<Tab>" (5 characters)
2464 '<' excluded: "^I" (^I is a real <Tab>)
2465 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002466 *cpo->*
2467 > When appending to a register, put a line break before
2468 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002469 *cpo-;*
2470 ; When using |,| or |;| to repeat the last |t| search
2471 and the cursor is right in front of the searched
2472 character, the cursor won't move. When not included,
2473 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002474 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002475
2476 POSIX flags. These are not included in the Vi default value, except
2477 when $VIM_POSIX was set on startup. |posix|
2478
2479 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002480 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002481 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002482 *cpo-&*
2483 & When ":preserve" was used keep the swap file when
2484 exiting normally while this buffer is still loaded.
2485 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002486 *cpo-\*
2487 \ Backslash in a [] range in a search pattern is taken
2488 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002489 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2490 '\' excluded: "/[ \-]" finds <Space> and '-'
2491 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002492 *cpo-/*
2493 / When "%" is used as the replacement string in a |:s|
2494 command, use the previous replacement string. |:s%|
2495 *cpo-{*
2496 { The |{| and |}| commands also stop at a "{" character
2497 at the start of a line.
2498 *cpo-.*
2499 . The ":chdir" and ":cd" commands fail if the current
2500 buffer is modified, unless ! is used. Vim doesn't
2501 need this, since it remembers the full path of an
2502 opened file.
2503 *cpo-bar*
2504 | The value of the $LINES and $COLUMNS environment
2505 variables overrule the terminal size values obtained
2506 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002507
Bram Moolenaar071d4272004-06-13 20:20:40 +00002508
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002509 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002510'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002511 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002512 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002513 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002514 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002515 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002516 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002517 blowfish Blowfish method. Medium strong encryption but it has
2518 an implementation flaw. Requires Vim 7.3 or later,
2519 files can NOT be read by Vim 7.2 and older. This adds
2520 a "seed" to the file, every time you write the file
2521 the encrypted bytes will be different.
2522 *blowfish2*
2523 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002524 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002525 and older. This adds a "seed" to the file, every time
2526 you write the file the encrypted bytes will be
2527 different. The whole undo file is encrypted, not just
2528 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002529 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002530 *E1197* *E1198* *E1199* *E1200* *E1201*
2531 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2532 Code. Medium strong till strong encryption.
2533 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002534 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002535 It adds a seed and a message authentication code (MAC)
2536 to the file. This needs at least a Vim 8.2.3022 to
2537 read the encrypted file.
2538 Encryption of swap files is not supported, therefore
2539 no swap file will be used when xchacha20 encryption is
2540 enabled.
2541 Encryption of undo files is not yet supported,
2542 therefore no undo file will currently be written.
2543 CURRENTLY EXPERIMENTAL: Files written with this method
2544 might have to be read back with the same version of
2545 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002546
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002547 You should use "blowfish2", also to re-encrypt older files.
2548
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002549 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002550 to the detected method of the file being read. Thus if you write it
2551 without changing 'cryptmethod' the same method will be used.
2552 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002553 explicitly write it, you don't get a warning unless there are other
2554 modifications. Also see |:X|.
2555
2556 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002557 the value "blowfish2". When setting the local value to an empty
2558 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002559
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002560 When a new encryption method is added in a later version of Vim, and
2561 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002562 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002563
2564
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565 *'cscopepathcomp'* *'cspc'*
2566'cscopepathcomp' 'cspc' number (default 0)
2567 global
2568 {not available when compiled without the |+cscope|
2569 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570 Determines how many components of the path to show in a list of tags.
2571 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002572 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573
2574 *'cscopeprg'* *'csprg'*
2575'cscopeprg' 'csprg' string (default "cscope")
2576 global
2577 {not available when compiled without the |+cscope|
2578 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579 Specifies the command to execute cscope. See |cscopeprg|.
2580 This option cannot be set from a |modeline| or in the |sandbox|, for
2581 security reasons.
2582
2583 *'cscopequickfix'* *'csqf'*
2584'cscopequickfix' 'csqf' string (default "")
2585 global
2586 {not available when compiled without the |+cscope|
2587 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588 Specifies whether to use quickfix window to show cscope results.
2589 See |cscopequickfix|.
2590
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002591 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002592'cscoperelative' 'csre' boolean (default off)
2593 global
2594 {not available when compiled without the |+cscope|
2595 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002596 In the absence of a prefix (-P) for cscope. setting this option enables
2597 to use the basename of cscope.out path as the prefix.
2598 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002599 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002600
Bram Moolenaar071d4272004-06-13 20:20:40 +00002601 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2602'cscopetag' 'cst' boolean (default off)
2603 global
2604 {not available when compiled without the |+cscope|
2605 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002606 Use cscope for tag commands. See |cscope-options|.
2607 NOTE: This option is reset when 'compatible' is set.
2608
2609 *'cscopetagorder'* *'csto'*
2610'cscopetagorder' 'csto' number (default 0)
2611 global
2612 {not available when compiled without the |+cscope|
2613 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 Determines the order in which ":cstag" performs a search. See
2615 |cscopetagorder|.
2616 NOTE: This option is set to 0 when 'compatible' is set.
2617
2618 *'cscopeverbose'* *'csverb'*
2619 *'nocscopeverbose'* *'nocsverb'*
2620'cscopeverbose' 'csverb' boolean (default off)
2621 global
2622 {not available when compiled without the |+cscope|
2623 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 Give messages when adding a cscope database. See |cscopeverbose|.
2625 NOTE: This option is reset when 'compatible' is set.
2626
Bram Moolenaar860cae12010-06-05 23:22:07 +02002627 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2628'cursorbind' 'crb' boolean (default off)
2629 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002630 When this option is set, as the cursor in the current
2631 window moves other cursorbound windows (windows that also have
2632 this option set) move their cursors to the corresponding line and
2633 column. This option is useful for viewing the
2634 differences between two versions of a file (see 'diff'); in diff mode,
2635 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002636 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002637
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002638
2639 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2640'cursorcolumn' 'cuc' boolean (default off)
2641 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002642 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002643 feature}
2644 Highlight the screen column of the cursor with CursorColumn
2645 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2646 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002647 If you only want the highlighting in the current window you can use
2648 these autocommands: >
2649 au WinLeave * set nocursorline nocursorcolumn
2650 au WinEnter * set cursorline cursorcolumn
2651<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002652
2653 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2654'cursorline' 'cul' boolean (default off)
2655 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002656 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002657 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002658 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2659 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002660 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002661 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002662
2663
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002664 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002665'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002666 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002667 {not available when compiled without the |+syntax|
2668 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002669 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002670 Valid values:
2671 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002672 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002673 "screenline" Highlight only the screen line of the cursor with
2674 CursorLine |hl-CursorLine|.
2675 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002676 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002677
2678 Special value:
2679 "both" Alias for the values "line,number".
2680
2681 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002682
2683
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684 *'debug'*
2685'debug' string (default "")
2686 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002687 These values can be used:
2688 msg Error messages that would otherwise be omitted will be given
2689 anyway.
2690 throw Error messages that would otherwise be omitted will be given
2691 anyway and also throw an exception and set |v:errmsg|.
2692 beep A message will be given when otherwise only a beep would be
2693 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002694 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002695 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2696 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697
2698 *'define'* *'def'*
2699'define' 'def' string (default "^\s*#\s*define")
2700 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002701 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 pattern, just like for the "/" command. This option is used for the
2703 commands like "[i" and "[d" |include-search|. The 'isident' option is
2704 used to recognize the defined name after the match:
2705 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2706 See |option-backslash| about inserting backslashes to include a space
2707 or backslash.
2708 The default value is for C programs. For C++ this value would be
2709 useful, to include const type declarations: >
2710 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002711< You can also use "\ze" just before the name and continue the pattern
2712 to check what is following. E.g. for Javascript, if a function is
2713 defined with "func_name = function(args)": >
2714 ^\s*\ze\i\+\s*=\s*function(
2715< If the function is defined with "func_name : function() {...": >
2716 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002718 To avoid that use `:let` with a single quote string: >
2719 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002720<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721
2722 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2723'delcombine' 'deco' boolean (default off)
2724 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 If editing Unicode and this option is set, backspace and Normal mode
2726 "x" delete each combining character on its own. When it is off (the
2727 default) the character along with its combining characters are
2728 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002729 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730
2731 This is useful for Arabic, Hebrew and many other languages where one
2732 may have combining characters overtop of base characters, and want
2733 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002734 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735
2736 *'dictionary'* *'dict'*
2737'dictionary' 'dict' string (default "")
2738 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739 List of file names, separated by commas, that are used to lookup words
2740 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2741 contain a list of words. This can be one word per line, or several
2742 words per line, separated by non-keyword characters (white space is
2743 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002744
2745 When this option is empty or an entry "spell" is present, and spell
2746 checking is enabled, words in the word lists for the currently active
2747 'spelllang' are used. See |spell|.
2748
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002749 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 after a comma are ignored, otherwise spaces are included in the file
2751 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002752 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 Where to find a list of words?
2754 - On FreeBSD, there is the file "/usr/share/dict/words".
2755 - In the Simtel archive, look in the "msdos/linguist" directory.
2756 - In "miscfiles" of the GNU collection.
2757 The use of |:set+=| and |:set-=| is preferred when adding or removing
2758 directories from the list. This avoids problems when a future version
2759 uses another default.
2760 Backticks cannot be used in this option for security reasons.
2761
2762 *'diff'* *'nodiff'*
2763'diff' boolean (default off)
2764 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 {not available when compiled without the |+diff|
2766 feature}
2767 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002768 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769
2770 *'dex'* *'diffexpr'*
2771'diffexpr' 'dex' string (default "")
2772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 {not available when compiled without the |+diff|
2774 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002775 Expression which is evaluated to obtain a diff file (either ed-style
2776 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777 This option cannot be set from a |modeline| or in the |sandbox|, for
2778 security reasons.
2779
2780 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002781'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 {not available when compiled without the |+diff|
2784 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002785 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786 All are optional. Items must be separated by a comma.
2787
2788 filler Show filler lines, to keep the text
2789 synchronized with a window that has inserted
2790 lines at the same position. Mostly useful
2791 when windows are side-by-side and 'scrollbind'
2792 is set.
2793
2794 context:{n} Use a context of {n} lines between a change
2795 and a fold that contains unchanged lines.
2796 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002797 When using zero the context is actually one,
2798 since folds require a line in between, also
2799 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800 See |fold-diff|.
2801
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002802 iblank Ignore changes where lines are all blank. Adds
2803 the "-B" 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 NOTE: the diff windows will get out of sync,
2808 because no differences between blank lines are
2809 taken into account.
2810
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811 icase Ignore changes in case of text. "a" and "A"
2812 are considered the same. Adds the "-i" flag
2813 to the "diff" command if 'diffexpr' is empty.
2814
2815 iwhite Ignore changes in amount of white space. Adds
2816 the "-b" flag to the "diff" command if
2817 'diffexpr' is empty. Check the documentation
2818 of the "diff" command for what this does
2819 exactly. It should ignore adding trailing
2820 white space, but not leading white space.
2821
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002822 iwhiteall Ignore all white space changes. Adds
2823 the "-w" flag to the "diff" command if
2824 'diffexpr' is empty. Check the documentation
2825 of the "diff" command for what this does
2826 exactly.
2827
2828 iwhiteeol Ignore white space changes at end of line.
2829 Adds the "-Z" flag to the "diff" command if
2830 'diffexpr' is empty. Check the documentation
2831 of the "diff" command for what this does
2832 exactly.
2833
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002834 horizontal Start diff mode with horizontal splits (unless
2835 explicitly specified otherwise).
2836
2837 vertical Start diff mode with vertical splits (unless
2838 explicitly specified otherwise).
2839
Bram Moolenaarc8234772019-11-10 21:00:27 +01002840 closeoff When a window is closed where 'diff' is set
2841 and there is only one window remaining in the
2842 same tab page with 'diff' set, execute
2843 `:diffoff` in that window. This undoes a
2844 `:diffsplit` command.
2845
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002846 hiddenoff Do not use diff mode for a buffer when it
2847 becomes hidden.
2848
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002849 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2850 starting diff mode. Without this 2 is used.
2851
Bram Moolenaar4223d432021-02-10 13:18:17 +01002852 followwrap Follow the 'wrap' option and leave as it is.
2853
Bram Moolenaare828b762018-09-10 17:51:58 +02002854 internal Use the internal diff library. This is
2855 ignored when 'diffexpr' is set. *E960*
2856 When running out of memory when writing a
2857 buffer this item will be ignored for diffs
2858 involving that buffer. Set the 'verbose'
2859 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860
Bram Moolenaare828b762018-09-10 17:51:58 +02002861 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002862 Use the indent heuristic for the internal
2863 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002864
2865 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002866 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002867 algorithms are:
2868 myers the default algorithm
2869 minimal spend extra time to generate the
2870 smallest possible diff
2871 patience patience diff algorithm
2872 histogram histogram diff algorithm
2873
2874 Examples: >
2875 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002877 :set diffopt=internal,filler,foldcolumn:3
2878 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879<
2880 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2881'digraph' 'dg' boolean (default off)
2882 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883 {not available when compiled without the |+digraphs|
2884 feature}
2885 Enable the entering of digraphs in Insert mode with {char1} <BS>
2886 {char2}. See |digraphs|.
2887 NOTE: This option is reset when 'compatible' is set.
2888
2889 *'directory'* *'dir'*
2890'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002891 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 for Unix: ".,~/tmp,/var/tmp,/tmp")
2893 global
2894 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002895 Recommended value: ".,~/vimswap//" - this will put the swap file next
2896 to the edited file if possible, and in your personal swap directory
2897 otherwise. Make sure "~/vimswap//" is only readable for you.
2898
2899 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 - The swap file will be created in the first directory where this is
2901 possible.
2902 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002903 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 - A directory "." means to put the swap file in the same directory as
2905 the edited file. On Unix, a dot is prepended to the file name, so
2906 it doesn't show in a directory listing. On MS-Windows the "hidden"
2907 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002908 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2909 the swap file relative to where the edited file is. The leading "."
2910 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002911 - For Unix and Win32, if a directory ends in two path separators "//",
2912 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002913 with all path separators replaced by percent '%' signs (including
2914 the colon following the drive letter on Win32). This will ensure
2915 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002916 On Win32, it is also possible to end with "\\". However, When a
2917 separating comma is following, you must use "//", since "\\" will
2918 include the comma in the file name. Therefore it is recommended to
2919 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 - Spaces after the comma are ignored, other spaces are considered part
2921 of the directory name. To have a space at the start of a directory
2922 name, precede it with a backslash.
2923 - To include a comma in a directory name precede it with a backslash.
2924 - A directory name may end in an ':' or '/'.
2925 - Environment variables are expanded |:set_env|.
2926 - Careful with '\' characters, type one before a space, type two to
2927 get one in the option (see |option-backslash|), for example: >
2928 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2929< - For backwards compatibility with Vim version 3.0 a '>' at the start
2930 of the option is removed.
2931 Using "." first in the list is recommended. This means that editing
2932 the same file twice will result in a warning. Using "/tmp" on Unix is
2933 discouraged: When the system crashes you lose the swap file.
2934 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002935 choice than "/tmp". But others on the computer may be able to see the
2936 files, and it can contain a lot of files, your swap files get lost in
2937 the crowd. That is why a "tmp" directory in your home directory is
2938 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 The use of |:set+=| and |:set-=| is preferred when adding or removing
2940 directories from the list. This avoids problems when a future version
2941 uses another default.
2942 This option cannot be set from a |modeline| or in the |sandbox|, for
2943 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944
2945 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002946'display' 'dy' string (default "", set to "truncate" in
2947 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002949 Change the way text is displayed. This is comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 flags:
2951 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002952 in a window will be displayed. "@@@" is put in the
2953 last columns of the last screen line to indicate the
2954 rest of the line is not displayed.
2955 truncate Like "lastline", but "@@@" is displayed in the first
2956 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957 uhex Show unprintable characters hexadecimal as <xx>
2958 instead of using ^C and ~C.
2959
Bram Moolenaard0796902016-09-16 20:02:31 +02002960 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002961 doesn't fit is replaced with "@" lines.
2962
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 *'eadirection'* *'ead'*
2964'eadirection' 'ead' string (default "both")
2965 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 Tells when the 'equalalways' option applies:
2967 ver vertically, width of windows is not affected
2968 hor horizontally, height of windows is not affected
2969 both width and height of windows is affected
2970
2971 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2972'edcompatible' 'ed' boolean (default off)
2973 global
2974 Makes the 'g' and 'c' flags of the ":substitute" command to be
2975 toggled each time the flag is given. See |complex-change|. See
2976 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002977 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002978 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979
Bram Moolenaar03413f42016-04-12 21:07:15 +02002980 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002981'emoji' 'emo' boolean (default: on)
2982 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002983 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002984 This excludes "text emoji" characters, which are normally displayed as
2985 single width. Unfortunately there is no good specification for this
2986 and it has been determined on trial-and-error basis. Use the
2987 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002988
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002990'encoding' 'enc' string (default for MS-Windows: "utf-8",
2991 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 Sets the character encoding used inside Vim. It applies to text in
2994 the buffers, registers, Strings in expressions, text stored in the
2995 viminfo file, etc. It sets the kind of characters which Vim can work
2996 with. See |encoding-names| for the possible values.
2997
2998 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002999 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003001 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002
Bram Moolenaar865242e2010-07-14 21:12:05 +02003003 This option cannot be set from a |modeline|. It would most likely
3004 corrupt the text.
3005
Bram Moolenaar3df01732017-02-17 22:47:16 +01003006 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3007 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 'encoding', "utf-8" is the natural choice for the environment and
3009 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003010 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 versions, and to avoid changing the encoding of newly created files
3012 without your knowledge (in case 'fileencodings' is empty).
3013
3014 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003015 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 iconv() or as specified with 'charconvert'.
3017
Bram Moolenaar207f0092020-08-30 17:20:20 +02003018 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003019 can use: >
3020 if has("multi_byte_encoding")
3021<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 Normally 'encoding' will be equal to your current locale. This will
3023 be the default if Vim recognizes your environment settings. If
3024 'encoding' is not set to the current locale, 'termencoding' must be
3025 set to convert typed and displayed text. See |encoding-table|.
3026
3027 When you set this option, it fires the |EncodingChanged| autocommand
3028 event so that you can set up fonts if necessary.
3029
3030 When the option is set, the value is converted to lowercase. Thus
3031 you can set it with uppercase values too. Underscores are translated
3032 to '-' signs.
3033 When the encoding is recognized, it is changed to the standard name.
3034 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3035 "iso-8859-2" and "utf8" becomes "utf-8".
3036
3037 Note: "latin1" is also used when the encoding could not be detected.
3038 This only works when editing files in the same encoding! When the
3039 actual character set is not latin1, make sure 'fileencoding' and
3040 'fileencodings' are empty. When conversion is needed, switch to using
3041 utf-8.
3042
3043 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3044 You don't notice this while editing, but it does matter for the
3045 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3046 setting 'encoding' to one of these values instead of utf-8 only has
3047 effect for encoding used for files when 'fileencoding' is empty.
3048
Bram Moolenaar661b1822005-07-28 22:36:45 +00003049 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3050 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051
3052 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3053'endofline' 'eol' boolean (default on)
3054 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003056 is on, or 'fixeol' option is off, no <EOL> will be written for the
3057 last line in the file. This option is automatically set or reset when
3058 starting to edit a new file, depending on whether file has an <EOL>
3059 for the last line in the file. Normally you don't have to set or
3060 reset this option.
3061 When 'binary' is off and 'fixeol' is on the value is not used when
3062 writing the file. When 'binary' is on or 'fixeol' is off it is used
3063 to remember the presence of a <EOL> for the last line in the file, so
3064 that when you write the file the situation from the original file can
3065 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066
3067 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3068'equalalways' 'ea' boolean (default on)
3069 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003071 splitting or closing a window. This also happens the moment the
3072 option is switched on. When off, splitting a window will reduce the
3073 size of the current window and leave the other windows the same. When
3074 closing a window the extra lines are given to the window next to it
3075 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 When mixing vertically and horizontally split windows, a minimal size
3077 is computed and some windows may be larger if there is room. The
3078 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003079 Changing the height and width of a window can be avoided by setting
3080 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003081 If a window size is specified when creating a new window sizes are
3082 currently not equalized (it's complicated, but may be implemented in
3083 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084
3085 *'equalprg'* *'ep'*
3086'equalprg' 'ep' string (default "")
3087 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003089 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003090 or 'indentexpr'. When Vim was compiled without internal formatting,
3091 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003092 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 about including spaces and backslashes.
3094 This option cannot be set from a |modeline| or in the |sandbox|, for
3095 security reasons.
3096
3097 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3098'errorbells' 'eb' boolean (default off)
3099 global
3100 Ring the bell (beep or screen flash) for error messages. This only
3101 makes a difference for error messages, the bell will be used always
3102 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003103 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003104 screen flash or do nothing. See 'belloff' to finetune when to ring the
3105 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106
3107 *'errorfile'* *'ef'*
3108'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3109 others: "errors.err")
3110 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 {not available when compiled without the |+quickfix|
3112 feature}
3113 Name of the errorfile for the QuickFix mode (see |:cf|).
3114 When the "-q" command-line argument is used, 'errorfile' is set to the
3115 following argument. See |-q|.
3116 NOT used for the ":make" command. See 'makeef' for that.
3117 Environment variables are expanded |:set_env|.
3118 See |option-backslash| about including spaces and backslashes.
3119 This option cannot be set from a |modeline| or in the |sandbox|, for
3120 security reasons.
3121
3122 *'errorformat'* *'efm'*
3123'errorformat' 'efm' string (default is very long)
3124 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 {not available when compiled without the |+quickfix|
3126 feature}
3127 Scanf-like description of the format for the lines in the error file
3128 (see |errorformat|).
3129
3130 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3131'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3132 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 Function keys that start with an <Esc> are recognized in Insert
3134 mode. When this option is off, the cursor and function keys cannot be
3135 used in Insert mode if they start with an <Esc>. The advantage of
3136 this is that the single <Esc> is recognized immediately, instead of
3137 after one second. Instead of resetting this option, you might want to
3138 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3139 when 'esckeys' is off, you can still map anything, but the cursor keys
3140 won't work by default.
3141 NOTE: This option is set to the Vi default value when 'compatible' is
3142 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003143 NOTE: when this option is off then the |modifyOtherKeys| functionality
3144 is disabled while in Insert mode to avoid ending Insert mode with any
3145 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146
3147 *'eventignore'* *'ei'*
3148'eventignore' 'ei' string (default "")
3149 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003151 When set to "all" or when "all" is one of the items, all autocommand
3152 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003153 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 :set ei=WinEnter,WinLeave
3155<
3156 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3157'expandtab' 'et' boolean (default off)
3158 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003160 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3162 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003163 This option is reset when the 'paste' option is set and restored when
3164 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165 NOTE: This option is reset when 'compatible' is set.
3166
3167 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3168'exrc' 'ex' boolean (default off)
3169 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003171 directory.
3172
3173 Setting this option is a potential security leak. E.g., consider
3174 unpacking a package or fetching files from github, a .vimrc in there
3175 might be a trojan horse. BETTER NOT SET THIS OPTION!
3176 Instead, define an autocommand in your .vimrc to set options for a
3177 matching directory.
3178
3179 If you do switch this option on you should also consider setting the
3180 'secure' option (see |initialization|).
3181 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 This option cannot be set from a |modeline| or in the |sandbox|, for
3183 security reasons.
3184
3185 *'fileencoding'* *'fenc'* *E213*
3186'fileencoding' 'fenc' string (default: "")
3187 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003189
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003191 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 When 'fileencoding' is empty, the same value as 'encoding' will be
3193 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003194 No error will be given when the value is set, only when it is used,
3195 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003196 Conversion will also be done when 'encoding' and 'fileencoding' are
3197 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3198 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003199 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003200 'encoding' is "utf-8" or another Unicode encoding, conversion
3201 is most likely done in a way that the reverse conversion
3202 results in the same text. When 'encoding' is not "utf-8" some
3203 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003204
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205 See 'encoding' for the possible values. Additionally, values may be
3206 specified that can be handled by the converter, see
3207 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003208
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209 When reading a file 'fileencoding' will be set from 'fileencodings'.
3210 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003211 'fileencoding', use the |++enc| argument. One exception: when
3212 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003213 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003214
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3216 When the option is set, the value is converted to lowercase. Thus
3217 you can set it with uppercase values too. '_' characters are
3218 replaced with '-'. If a name is recognized from the list for
3219 'encoding', it is replaced by the standard name. For example
3220 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003221
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222 When this option is set, after starting to edit a file, the 'modified'
3223 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003224
3225 Keep in mind that changing 'fenc' from a modeline happens
3226 AFTER the text has been read, thus it applies to when the file will be
3227 written. If you do set 'fenc' in a modeline, you might want to set
3228 'nomodified' to avoid not being able to ":q".
3229
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230 This option can not be changed when 'modifiable' is off.
3231
3232 *'fe'*
3233 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003234 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 old short name was 'fe', which is no longer used.
3236
3237 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003238'fileencodings' 'fencs' string (default: "ucs-bom",
3239 "ucs-bom,utf-8,default,latin1" when
3240 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 This is a list of character encodings considered when starting to edit
3243 an existing file. When a file is read, Vim tries to use the first
3244 mentioned character encoding. If an error is detected, the next one
3245 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003246 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 an empty string, which means the value of 'encoding' is used.
3248 WARNING: Conversion can cause loss of information! When
3249 'encoding' is "utf-8" (or one of the other Unicode variants)
3250 conversion is most likely done in a way that the reverse
3251 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003252 "utf-8" some non-ASCII characters may be lost! You can use
3253 the |++bad| argument to specify what is done with characters
3254 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 For an empty file or a file with only ASCII characters most encodings
3256 will work and the first entry of 'fileencodings' will be used (except
3257 "ucs-bom", which requires the BOM to be present). If you prefer
3258 another encoding use an BufReadPost autocommand event to test if your
3259 preferred encoding is to be used. Example: >
3260 au BufReadPost * if search('\S', 'w') == 0 |
3261 \ set fenc=iso-2022-jp | endif
3262< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3263 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003264 When the |++enc| argument is used then the value of 'fileencodings' is
3265 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003266 Note that 'fileencodings' is not used for a new file, the global value
3267 of 'fileencoding' is used instead. You can set it with: >
3268 :setglobal fenc=iso-8859-2
3269< This means that a non-existing file may get a different encoding than
3270 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 The special value "ucs-bom" can be used to check for a Unicode BOM
3272 (Byte Order Mark) at the start of the file. It must not be preceded
3273 by "utf-8" or another Unicode encoding for this to work properly.
3274 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3275 because Vim cannot detect an error, thus the encoding is always
3276 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003277 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003278 environment. On MS-Windows this is the system encoding. Otherwise
3279 this is the default value for 'encoding'. It is useful when
3280 'encoding' is set to "utf-8" and your environment uses a non-latin1
3281 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003282 When 'encoding' is "utf-8" and a file contains an illegal byte
3283 sequence it won't be recognized as UTF-8. You can use the |8g8|
3284 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 WRONG VALUES: WHAT'S WRONG:
3286 latin1,utf-8 "latin1" will always be used
3287 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3288 file
3289 cp1250,latin1 "cp1250" will always be used
3290 If 'fileencodings' is empty, 'fileencoding' is not modified.
3291 See 'fileencoding' for the possible values.
3292 Setting this option does not have an effect until the next time a file
3293 is read.
3294
3295 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003296'fileformat' 'ff' string (MS-Windows default: "dos",
3297 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 This gives the <EOL> of the current buffer, which is used for
3300 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003301 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003302 unix <NL>
3303 mac <CR>
3304 When "dos" is used, CTRL-Z at the end of a file is ignored.
3305 See |file-formats| and |file-read|.
3306 For the character encoding of the file see 'fileencoding'.
3307 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003308 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 This option is set automatically when starting to edit a file and
3310 'fileformats' is not empty and 'binary' is off.
3311 When this option is set, after starting to edit a file, the 'modified'
3312 option is set, because the file would be different when written.
3313 This option can not be changed when 'modifiable' is off.
3314 For backwards compatibility: When this option is set to "dos",
3315 'textmode' is set, otherwise 'textmode' is reset.
3316
3317 *'fileformats'* *'ffs'*
3318'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003319 Vim+Vi MS-Windows: "dos,unix",
3320 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 Vi Cygwin: "unix,dos",
3322 Vi others: "")
3323 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 This gives the end-of-line (<EOL>) formats that will be tried when
3325 starting to edit a new buffer and when reading a file into an existing
3326 buffer:
3327 - When empty, the format defined with 'fileformat' will be used
3328 always. It is not set automatically.
3329 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003330 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 'fileformats' name will be used when a file is read into an existing
3332 buffer, no matter what 'fileformat' for that buffer is set to.
3333 - When more than one name is present, separated by commas, automatic
3334 <EOL> detection will be done when reading a file. When starting to
3335 edit a file, a check is done for the <EOL>:
3336 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3337 'fileformat' is set to "dos".
3338 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003339 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003341 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3342 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003343 This means that "mac" is only chosen when:
3344 "unix" is not present or no <NL> is found in the file, and
3345 "dos" is not present or no <CR><NL> is found in the file.
3346 Except: if "unix" was chosen, but there is a <CR> before
3347 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003348 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 4. If 'fileformat' is still not set, the first name from
3350 'fileformats' is used.
3351 When reading a file into an existing buffer, the same is done, but
3352 this happens like 'fileformat' has been set appropriately for that
3353 file only, the option is not changed.
3354 When 'binary' is set, the value of 'fileformats' is not used.
3355
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003356 When Vim starts up with an empty buffer the first item is used. You
3357 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003358
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3360 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3361 done:
3362 - When 'fileformats' is empty, there is no automatic detection. Dos
3363 format will be used.
3364 - When 'fileformats' is set to one or more names, automatic detection
3365 is done. This is based on the first <NL> in the file: If there is a
3366 <CR> in front of it, Dos format is used, otherwise Unix format is
3367 used.
3368 Also see |file-formats|.
3369 For backwards compatibility: When this option is set to an empty
3370 string or one format (no comma is included), 'textauto' is reset,
3371 otherwise 'textauto' is set.
3372 NOTE: This option is set to the Vi default value when 'compatible' is
3373 set and to the Vim default value when 'compatible' is reset.
3374
Bram Moolenaarbf884932013-04-05 22:26:15 +02003375 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3376'fileignorecase' 'fic' boolean (default on for systems where case in file
3377 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003378 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003379 When set case is ignored when using file names and directories.
3380 See 'wildignorecase' for only ignoring case when doing completion.
3381
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 *'filetype'* *'ft'*
3383'filetype' 'ft' string (default: "")
3384 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 When this option is set, the FileType autocommand event is triggered.
3386 All autocommands that match with the value of this option will be
3387 executed. Thus the value of 'filetype' is used in place of the file
3388 name.
3389 Otherwise this option does not always reflect the current file type.
3390 This option is normally set when the file type is detected. To enable
3391 this use the ":filetype on" command. |:filetype|
3392 Setting this option to a different value is most useful in a modeline,
3393 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003394 Example, for in an IDL file:
3395 /* vim: set filetype=idl : */ ~
3396 |FileType| |filetypes|
3397 When a dot appears in the value then this separates two filetype
3398 names. Example:
3399 /* vim: set filetype=c.doxygen : */ ~
3400 This will use the "c" filetype first, then the "doxygen" filetype.
3401 This works both for filetype plugins and for syntax files. More than
3402 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 This option is not copied to another buffer, independent of the 's' or
3404 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003405 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406
3407 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003408'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003409 global or local to window |global-local|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003410 {not available when compiled without the |+folding|
3411 feature}
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003412 Characters to fill the statuslines, vertical separators and special
3413 lines in the window.
3414 It is a comma-separated list of items. Each item has a name, a colon
3415 and the value of that item:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003417 item name default Used for ~
3418 stl ' ' or '^' statusline of the current window
3419 stlnc ' ' or '=' statusline of the non-current windows
3420 vert '|' vertical separators |:vsplit|
3421 fold '-' filling 'foldtext'
3422 foldopen '-' mark the beginning of a fold
3423 foldclose '+' show a closed fold
3424 foldsep '|' open fold middle character
3425 diff '-' deleted lines of the 'diff' option
3426 eob '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003428 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003429 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 otherwise.
3431
3432 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003433 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434< This is similar to the default, except that these characters will also
3435 be used when there is highlighting.
3436
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003437 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3438 single-byte and multibyte characters are supported. But double-width
3439 characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003440
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003442 item name highlight group ~
3443 stl StatusLine |hl-StatusLine|
3444 stlnc StatusLineNC |hl-StatusLineNC|
3445 vert VertSplit |hl-VertSplit|
3446 fold Folded |hl-Folded|
3447 diff DiffDelete |hl-DiffDelete|
3448 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003450 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3451'fixendofline' 'fixeol' boolean (default on)
3452 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003453 When writing a file and this option is on, <EOL> at the end of file
3454 will be restored if missing. Turn this option off if you want to
3455 preserve the situation from the original file.
3456 When the 'binary' option is set the value of this option doesn't
3457 matter.
3458 See the 'endofline' option.
3459
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003461'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 {only available when compiled with the |+rightleft|
3464 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003465 This option was for using Farsi, which has been removed. See
3466 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467
3468 *'foldclose'* *'fcl'*
3469'foldclose' 'fcl' string (default "")
3470 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471 {not available when compiled without the |+folding|
3472 feature}
3473 When set to "all", a fold is closed when the cursor isn't in it and
3474 its level is higher than 'foldlevel'. Useful if you want folds to
3475 automatically close when moving out of them.
3476
3477 *'foldcolumn'* *'fdc'*
3478'foldcolumn' 'fdc' number (default 0)
3479 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 {not available when compiled without the |+folding|
3481 feature}
3482 When non-zero, a column with the specified width is shown at the side
3483 of the window which indicates open and closed folds. The maximum
3484 value is 12.
3485 See |folding|.
3486
3487 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3488'foldenable' 'fen' boolean (default on)
3489 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 {not available when compiled without the |+folding|
3491 feature}
3492 When off, all folds are open. This option can be used to quickly
3493 switch between showing all text unfolded and viewing the text with
3494 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003495 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 'foldenable' is off.
3497 This option is set by commands that create a new fold or close a fold.
3498 See |folding|.
3499
3500 *'foldexpr'* *'fde'*
3501'foldexpr' 'fde' string (default: "0")
3502 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003504 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003506 for each line to obtain its fold level. The context is set to the
3507 script where 'foldexpr' was set, script-local items can be accessed.
3508 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003509
Bram Moolenaar30b65812012-07-12 22:01:11 +02003510 The expression will be evaluated in the |sandbox| if set from a
3511 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003512 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003513 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003514
3515 It is not allowed to change text or jump to another window while
3516 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517
3518 *'foldignore'* *'fdi'*
3519'foldignore' 'fdi' string (default: "#")
3520 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 {not available when compiled without the |+folding|
3522 feature}
3523 Used only when 'foldmethod' is "indent". Lines starting with
3524 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003525 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 The default "#" works well for C programs. See |fold-indent|.
3527
3528 *'foldlevel'* *'fdl'*
3529'foldlevel' 'fdl' number (default: 0)
3530 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531 {not available when compiled without the |+folding|
3532 feature}
3533 Sets the fold level: Folds with a higher level will be closed.
3534 Setting this option to zero will close all folds. Higher numbers will
3535 close fewer folds.
3536 This option is set by commands like |zm|, |zM| and |zR|.
3537 See |fold-foldlevel|.
3538
3539 *'foldlevelstart'* *'fdls'*
3540'foldlevelstart' 'fdls' number (default: -1)
3541 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 {not available when compiled without the |+folding|
3543 feature}
3544 Sets 'foldlevel' when starting to edit another buffer in a window.
3545 Useful to always start editing with all folds closed (value zero),
3546 some folds closed (one) or no folds closed (99).
3547 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003548 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 ignores this option and closes all folds.
3550 It is also done before BufReadPre autocommands, to allow an autocmd to
3551 overrule the 'foldlevel' value for specific files.
3552 When the value is negative, it is not used.
3553
3554 *'foldmarker'* *'fmr'* *E536*
3555'foldmarker' 'fmr' string (default: "{{{,}}}")
3556 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 {not available when compiled without the |+folding|
3558 feature}
3559 The start and end marker used when 'foldmethod' is "marker". There
3560 must be one comma, which separates the start and end marker. The
3561 marker is a literal string (a regular expression would be too slow).
3562 See |fold-marker|.
3563
3564 *'foldmethod'* *'fdm'*
3565'foldmethod' 'fdm' string (default: "manual")
3566 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 {not available when compiled without the |+folding|
3568 feature}
3569 The kind of folding used for the current window. Possible values:
3570 |fold-manual| manual Folds are created manually.
3571 |fold-indent| indent Lines with equal indent form a fold.
3572 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3573 |fold-marker| marker Markers are used to specify folds.
3574 |fold-syntax| syntax Syntax highlighting items specify folds.
3575 |fold-diff| diff Fold text that is not changed.
3576
3577 *'foldminlines'* *'fml'*
3578'foldminlines' 'fml' number (default: 1)
3579 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 {not available when compiled without the |+folding|
3581 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003582 Sets the number of screen lines above which a fold can be displayed
3583 closed. Also for manually closed folds. With the default value of
3584 one a fold can only be closed if it takes up two or more screen lines.
3585 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003586 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 "zc" to close a fold, which is displayed open because it's smaller
3588 than 'foldminlines', a following "zc" may close a containing fold.
3589
3590 *'foldnestmax'* *'fdn'*
3591'foldnestmax' 'fdn' number (default: 20)
3592 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593 {not available when compiled without the |+folding|
3594 feature}
3595 Sets the maximum nesting of folds for the "indent" and "syntax"
3596 methods. This avoids that too many folds will be created. Using more
3597 than 20 doesn't work, because the internal limit is 20.
3598
3599 *'foldopen'* *'fdo'*
3600'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3601 search,tag,undo")
3602 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 {not available when compiled without the |+folding|
3604 feature}
3605 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003606 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003608 NOTE: When the command is part of a mapping this option is not used.
3609 Add the |zv| command to the mapping to get the same effect.
3610 (rationale: the mapping may want to control opening folds itself)
3611
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 item commands ~
3613 all any
3614 block "(", "{", "[[", "[{", etc.
3615 hor horizontal movements: "l", "w", "fx", etc.
3616 insert any command in Insert mode
3617 jump far jumps: "G", "gg", etc.
3618 mark jumping to a mark: "'m", CTRL-O, etc.
3619 percent "%"
3620 quickfix ":cn", ":crew", ":make", etc.
3621 search search for a pattern: "/", "n", "*", "gd", etc.
3622 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003623 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 tag jumping to a tag: ":ta", CTRL-T, etc.
3625 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003626 When a movement command is used for an operator (e.g., "dl" or "y%")
3627 this option is not used. This means the operator will include the
3628 whole closed fold.
3629 Note that vertical movements are not here, because it would make it
3630 very difficult to move onto a closed fold.
3631 In insert mode the folds containing the cursor will always be open
3632 when text is inserted.
3633 To close folds you can re-apply 'foldlevel' with the |zx| command or
3634 set the 'foldclose' option to "all".
3635
3636 *'foldtext'* *'fdt'*
3637'foldtext' 'fdt' string (default: "foldtext()")
3638 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 {not available when compiled without the |+folding|
3640 feature}
3641 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003642 fold. The context is set to the script where 'foldexpr' was set,
3643 script-local items can be accessed. See |fold-foldtext| for the
3644 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645
Bram Moolenaar30b65812012-07-12 22:01:11 +02003646 The expression will be evaluated in the |sandbox| if set from a
3647 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003648 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003649
3650 It is not allowed to change text or jump to another window while
3651 evaluating 'foldtext' |textlock|.
3652
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003653 *'formatexpr'* *'fex'*
3654'formatexpr' 'fex' string (default "")
3655 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003656 {not available when compiled without the |+eval|
3657 feature}
3658 Expression which is evaluated to format a range of lines for the |gq|
3659 operator or automatic formatting (see 'formatoptions'). When this
3660 option is empty 'formatprg' is used.
3661
3662 The |v:lnum| variable holds the first line to be formatted.
3663 The |v:count| variable holds the number of lines to be formatted.
3664 The |v:char| variable holds the character that is going to be
3665 inserted if the expression is being evaluated due to
3666 automatic formatting. This can be empty. Don't insert
3667 it yet!
3668
3669 Example: >
3670 :set formatexpr=mylang#Format()
3671< This will invoke the mylang#Format() function in the
3672 autoload/mylang.vim file in 'runtimepath'. |autoload|
3673
3674 The expression is also evaluated when 'textwidth' is set and adding
3675 text beyond that limit. This happens under the same conditions as
3676 when internal formatting is used. Make sure the cursor is kept in the
3677 same spot relative to the text then! The |mode()| function will
3678 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003679
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003680 When the expression evaluates to non-zero Vim will fall back to using
3681 the internal format mechanism.
3682
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003683 If the expression starts with s: or |<SID>|, then it is replaced with
3684 the script ID (|local-function|). Example: >
3685 set formatexpr=s:MyFormatExpr()
3686 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003687< Otherwise, the expression is evaluated in the context of the script
3688 where the option was set, thus script-local items are available.
3689
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003690 The expression will be evaluated in the |sandbox| when set from a
3691 modeline, see |sandbox-option|. That stops the option from working,
3692 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003693 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003694 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003695
Bram Moolenaar86b68352004-12-27 21:59:20 +00003696 *'formatlistpat'* *'flp'*
3697'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3698 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003699 A pattern that is used to recognize a list header. This is used for
3700 the "n" flag in 'formatoptions'.
3701 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003702 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003703 while still checking more characters. There must be a character
3704 following the pattern, when it matches the whole line it is handled
3705 like there is no match.
3706 The default recognizes a number, followed by an optional punctuation
3707 character and white space.
3708
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003709 *'formatoptions'* *'fo'*
3710'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3711 local to buffer
3712 This is a sequence of letters which describes how automatic
3713 formatting is to be done. See |fo-table|. When the 'paste' option is
3714 on, no formatting is done (like 'formatoptions' is empty). Commas can
3715 be inserted for readability.
3716 To avoid problems with flags that are added in the future, use the
3717 "+=" and "-=" feature of ":set" |add-option-flags|.
3718 NOTE: This option is set to the Vi default value when 'compatible' is
3719 set and to the Vim default value when 'compatible' is reset.
3720
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 *'formatprg'* *'fp'*
3722'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003723 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003725 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003727 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003728 If the 'formatexpr' option is not empty it will be used instead.
3729 Otherwise, if 'formatprg' option is an empty string, the internal
3730 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003731 Environment variables are expanded |:set_env|. See |option-backslash|
3732 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003733 This option cannot be set from a |modeline| or in the |sandbox|, for
3734 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735
Bram Moolenaard94464e2015-11-02 15:28:18 +01003736 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003737'fsync' 'fs' boolean (default on)
3738 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003739 When on, the library function fsync() will be called after writing a
3740 file. This will flush a file to disk, ensuring that it is safely
3741 written even on filesystems which do metadata-only journaling. This
3742 will force the harddrive to spin up on Linux systems running in laptop
3743 mode, so it may be undesirable in some situations. Be warned that
3744 turning this off increases the chances of data loss after a crash. On
3745 systems without an fsync() implementation, this variable is always
3746 off.
3747 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003748 'fsync' also applies to |writefile()| (unless a flag is used to
3749 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003750 This option cannot be set from a |modeline| or in the |sandbox|, for
3751 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003752
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3754'gdefault' 'gd' boolean (default off)
3755 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756 When on, the ":substitute" flag 'g' is default on. This means that
3757 all matches in a line are substituted instead of one. When a 'g' flag
3758 is given to a ":substitute" command, this will toggle the substitution
3759 of all or one match. See |complex-change|.
3760
3761 command 'gdefault' on 'gdefault' off ~
3762 :s/// subst. all subst. one
3763 :s///g subst. one subst. all
3764 :s///gg subst. all subst. one
3765
3766 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003767 DEPRECATED: Setting this option may break plugins that are not aware
3768 of this option. Also, many users get confused that adding the /g flag
3769 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003770 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771
3772 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003773'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775 Format to recognize for the ":grep" command output.
3776 This is a scanf-like string that uses the same format as the
3777 'errorformat' option: see |errorformat|.
3778
3779 *'grepprg'* *'gp'*
3780'grepprg' 'gp' string (default "grep -n ",
3781 Unix: "grep -n $* /dev/null",
3782 Win32: "findstr /n" or "grep -n",
3783 VMS: "SEARCH/NUMBERS ")
3784 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003785 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 and '#' characters, which are expanded like when used in a command-
3787 line. The placeholder "$*" is allowed to specify where the arguments
3788 will be included. Environment variables are expanded |:set_env|. See
3789 |option-backslash| about including spaces and backslashes.
3790 When your "grep" accepts the "-H" argument, use this to make ":grep"
3791 also work well with a single file: >
3792 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003793< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003794 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3795 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003796 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 apply equally to 'grepprg'.
3798 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3799 otherwise it's "grep -n".
3800 This option cannot be set from a |modeline| or in the |sandbox|, for
3801 security reasons.
3802
3803 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3804'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3805 ve:ver35-Cursor,
3806 o:hor50-Cursor,
3807 i-ci:ver25-Cursor/lCursor,
3808 r-cr:hor20-Cursor/lCursor,
3809 sm:block-Cursor
3810 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003811 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 "n-v-c:block,o:hor50,i-ci:hor15,
3813 r-cr:hor30,sm:block")
3814 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003816 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003818 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003819 height of the cursor can be changed. This can be done by specifying a
3820 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003821 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3822 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003824 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 mode-list and an argument-list:
3826 mode-list:argument-list,mode-list:argument-list,..
3827 The mode-list is a dash separated list of these modes:
3828 n Normal mode
3829 v Visual mode
3830 ve Visual mode with 'selection' "exclusive" (same as 'v',
3831 if not specified)
3832 o Operator-pending mode
3833 i Insert mode
3834 r Replace mode
3835 c Command-line Normal (append) mode
3836 ci Command-line Insert mode
3837 cr Command-line Replace mode
3838 sm showmatch in Insert mode
3839 a all modes
3840 The argument-list is a dash separated list of these arguments:
3841 hor{N} horizontal bar, {N} percent of the character height
3842 ver{N} vertical bar, {N} percent of the character width
3843 block block cursor, fills the whole character
3844 [only one of the above three should be present]
3845 blinkwait{N} *cursor-blinking*
3846 blinkon{N}
3847 blinkoff{N}
3848 blink times for cursor: blinkwait is the delay before
3849 the cursor starts blinking, blinkon is the time that
3850 the cursor is shown and blinkoff is the time that the
3851 cursor is not shown. The times are in msec. When one
3852 of the numbers is zero, there is no blinking. The
3853 default is: "blinkwait700-blinkon400-blinkoff250".
3854 These numbers are used for a missing entry. This
3855 means that blinking is enabled by default. To switch
3856 blinking off you can use "blinkon0". The cursor only
3857 blinks when Vim is waiting for input, not while
3858 executing a command.
3859 To make the cursor blink in an xterm, see
3860 |xterm-blink|.
3861 {group-name}
3862 a highlight group name, that sets the color and font
3863 for the cursor
3864 {group-name}/{group-name}
3865 Two highlight group names, the first is used when
3866 no language mappings are used, the other when they
3867 are. |language-mapping|
3868
3869 Examples of parts:
3870 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3871 block cursor with colors from the "nCursor"
3872 highlight group
3873 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3874 In Insert and Command-line Insert mode, use a
3875 30% vertical bar cursor with colors from the
3876 "iCursor" highlight group. Blink a bit
3877 faster.
3878
3879 The 'a' mode is different. It will set the given argument-list for
3880 all modes. It does not reset anything to defaults. This can be used
3881 to do a common setting for all modes. For example, to switch off
3882 blinking: "a:blinkon0"
3883
3884 Examples of cursor highlighting: >
3885 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3886 :highlight Cursor gui=NONE guifg=bg guibg=fg
3887<
3888 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003889 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890'guifont' 'gfn' string (default "")
3891 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003892 {only available when compiled with GUI enabled}
3893 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003894 In its simplest form the value is just one font name.
3895 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896
3897 *'guifontset'* *'gfs'*
3898 *E250* *E252* *E234* *E597* *E598*
3899'guifontset' 'gfs' string (default "")
3900 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 {only available when compiled with GUI enabled and
3902 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003903 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 When not empty, specifies two (or more) fonts to be used. The first
3905 one for normal English, the second one for your special language. See
3906 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003907
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3909'guifontwide' 'gfw' string (default "")
3910 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 {only available when compiled with GUI enabled}
3912 When not empty, specifies a comma-separated list of fonts to be used
3913 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003914 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003915
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 *'guiheadroom'* *'ghr'*
3917'guiheadroom' 'ghr' number (default 50)
3918 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003919 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920 The number of pixels subtracted from the screen height when fitting
3921 the GUI window on the screen. Set this before the GUI is started,
3922 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003923 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 lines will be left for window decorations and other items on the
3925 screen. Set it to a negative value to allow windows taller than the
3926 screen.
3927
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003928 *'guiligatures'* *'gli'* *E1243*
3929'guiligatures' 'gli' string (default "")
3930 global
3931 {only for GTK GUI}
3932 List of ASCII characters that, when combined together, can create more
3933 complex shapes. Each character must be a printable ASCII character
3934 with a value in the 32-127 range.
3935 Example: >
3936 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3937< Changing this option updates screen output immediately. Set it to an
3938 empty string to disable ligatures.
3939
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003941'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3942 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003943 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003944 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003947 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 sequence of letters which describes what components and options of the
3949 GUI should be used.
3950 To avoid problems with flags that are added in the future, use the
3951 "+=" and "-=" feature of ":set" |add-option-flags|.
3952
Bram Moolenaar13568252018-03-16 20:46:58 +01003953 Valid characters are as follows:
3954 *'go-!'*
3955 '!' External commands are executed in a terminal window. Without
3956 this flag the MS-Windows GUI will open a console window to
3957 execute the command. The Unix GUI will simulate a dumb
3958 terminal to list the command output.
3959 The terminal window will be positioned at the bottom, and grow
3960 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003961 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 'a' Autoselect: If present, then whenever VISUAL mode is started,
3963 or the Visual area extended, Vim tries to become the owner of
3964 the windowing system's global selection. This means that the
3965 Visually highlighted text is available for pasting into other
3966 applications as well as into Vim itself. When the Visual mode
3967 ends, possibly due to an operation on the text, or when an
3968 application wants to paste the selection, the highlighted text
3969 is automatically yanked into the "* selection register.
3970 Thus the selection is still available for pasting into other
3971 applications after the VISUAL mode has ended.
3972 If not present, then Vim won't become the owner of the
3973 windowing system's global selection unless explicitly told to
3974 by a yank or delete operation for the "* register.
3975 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003976 *'go-P'*
3977 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003978 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003979 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003980 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 applies to the modeless selection.
3982
3983 'guioptions' autoselect Visual autoselect modeless ~
3984 "" - -
3985 "a" yes yes
3986 "A" - yes
3987 "aA" yes yes
3988
Bram Moolenaar02467872007-05-06 13:22:01 +00003989 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 'c' Use console dialogs instead of popup dialogs for simple
3991 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003992 *'go-d'*
3993 'd' Use dark theme variant if available. Currently only works for
3994 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003995 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003996 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003997 'guitablabel' can be used to change the text in the labels.
3998 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003999 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004000 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004001 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 'f' Foreground: Don't use fork() to detach the GUI from the shell
4003 where it was started. Use this for programs that wait for the
4004 editor to finish (e.g., an e-mail program). Alternatively you
4005 can use "gvim -f" or ":gui -f" to start the GUI in the
4006 foreground. |gui-fork|
4007 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004008 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004009 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4011 corner of the window. It's black&white on non-GTK, because of
4012 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004013 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004015 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004016 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004018 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004020 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004021 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 'g' Grey menu items: Make menu items that are not active grey. If
4023 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004024 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 't' Include tearoff menu items. Currently only works for Win32,
4026 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004027 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004028 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4029 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004030 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004032 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 'R' Right-hand scrollbar is present when there is a vertically
4034 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004035 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004037 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 'L' Left-hand scrollbar is present when there is a vertically
4039 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004040 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4042 the longest visible line, or on the cursor line if the 'h'
4043 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004044 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 'h' Limit horizontal scrollbar size to the length of the cursor
4046 line. Reduces computations. |gui-horiz-scroll|
4047
4048 And yes, you may even have scrollbars on the left AND the right if
4049 you really want to :-). See |gui-scrollbars| for more information.
4050
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004051 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004052 'v' Use a vertical button layout for dialogs. When not included,
4053 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004054 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004055 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 'p' Use Pointer callbacks for X11 GUI. This is required for some
4057 window managers. If the cursor is not blinking or hollow at
4058 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004059 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004061 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004062 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004063 *'go-k'*
4064 'k' Keep the GUI window size when adding/removing a scrollbar, or
4065 toolbar, tabline, etc. Instead, the behavior is similar to
4066 when the window is maximized and will adjust 'lines' and
4067 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004068 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004069 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004070
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 *'guipty'* *'noguipty'*
4072'guipty' boolean (default on)
4073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004074 {only available when compiled with GUI enabled}
4075 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4076 I/O to/from shell commands. See |gui-pty|.
4077
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004078 *'guitablabel'* *'gtl'*
4079'guitablabel' 'gtl' string (default empty)
4080 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004081 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004082 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004083 pages line. When empty and when the result is empty Vim will use a
4084 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004085
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004086 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004087 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004088 The expression will be evaluated in the |sandbox| when set from a
4089 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004090 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004091
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004092 Only used when the GUI tab pages line is displayed. 'e' must be
4093 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4094 used.
4095
Bram Moolenaar57657d82006-04-21 22:12:41 +00004096 *'guitabtooltip'* *'gtt'*
4097'guitabtooltip' 'gtt' string (default empty)
4098 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004099 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004100 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004101 pages line. When empty Vim will use a default tooltip.
4102 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004103 You can include a line break. Simplest method is to use |:let|: >
4104 :let &guitabtooltip = "line one\nline two"
4105<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004106
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004108'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 (others) "$VIMRUNTIME/doc/help.txt")
4110 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 Name of the main help file. All distributed help files should be
4112 placed together in one directory. Additionally, all "doc" directories
4113 in 'runtimepath' will be used.
4114 Environment variables are expanded |:set_env|. For example:
4115 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004116 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 spaces and backslashes.
4118 This option cannot be set from a |modeline| or in the |sandbox|, for
4119 security reasons.
4120
4121 *'helpheight'* *'hh'*
4122'helpheight' 'hh' number (default 20)
4123 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 Minimal initial height of the help window when it is opened with the
4125 ":help" command. The initial height of the help window is half of the
4126 current window, or (when the 'ea' option is on) the same as other
4127 windows. When the height is less than 'helpheight', the height is
4128 set to 'helpheight'. Set to zero to disable.
4129
4130 *'helplang'* *'hlg'*
4131'helplang' 'hlg' string (default: messages language or empty)
4132 global
4133 {only available when compiled with the |+multi_lang|
4134 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004135 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 for which the desired help can be found. The English help will always
4137 be used as a last resort. You can add "en" to prefer English over
4138 another language, but that will only find tags that exist in that
4139 language and not in the English help.
4140 Example: >
4141 :set helplang=de,it
4142< This will first search German, then Italian and finally English help
4143 files.
4144 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4145 try to find the tag in the current language before using this option.
4146 See |help-translated|.
4147
4148 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4149'hidden' 'hid' boolean (default off)
4150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 When off a buffer is unloaded when it is |abandon|ed. When on a
4152 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4153 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004154
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004156 hidden even if the 'hidden' option is off when these three are true:
4157 - the buffer is modified
4158 - 'autowrite' is off or writing is not possible
4159 - the '!' flag was used
4160 Also see |windows.txt|.
4161
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004162 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 This option is set for one command with ":hide {command}" |:hide|.
4164 WARNING: It's easy to forget that you have changes in hidden buffers.
4165 Think twice when using ":q!" or ":qa!".
4166
4167 *'highlight'* *'hl'*
4168'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004169 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4170 d:Directory,e:ErrorMsg,i:IncSearch,
4171 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004172 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004173 N:CursorLineNr,r:Question,s:StatusLine,
4174 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004175 v:Visual,V:VisualNOS,w:WarningMsg,
4176 W:WildMenu,f:Folded,F:FoldColumn,
4177 A:DiffAdd,C:DiffChange,D:DiffDelete,
4178 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004179 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004180 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004181 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4182 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004183 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004184 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004187 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004189 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004191 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4192 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193 characters from 'showbreak'
4194 |hl-Directory| d directories in CTRL-D listing and other special
4195 things in listings
4196 |hl-ErrorMsg| e error messages
4197 h (obsolete, ignored)
4198 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004199 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4201 |hl-MoreMsg| m |more-prompt|
4202 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004203 |hl-LineNr| n line number for ":number" and ":#" commands, and
4204 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004205 |hl-LineNrAbove| a line number above the cursor for when the
4206 'relativenumber' option is set.
4207 |hl-LineNrBelow| b line number below the cursor for when the
4208 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004209 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4210 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 |hl-Question| r |hit-enter| prompt and yes/no questions
4212 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004213 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4215 |hl-VertSplit| c column used to separate vertically split windows
4216 |hl-Visual| v Visual mode
4217 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4218 Selection" Only X11 Gui's |gui-x11| and
4219 |xterm-clipboard|.
4220 |hl-WarningMsg| w warning messages
4221 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4222 |hl-Folded| f line used for closed folds
4223 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004224 |hl-DiffAdd| A added line in diff mode
4225 |hl-DiffChange| C changed line in diff mode
4226 |hl-DiffDelete| D deleted line in diff mode
4227 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004229 |hl-Conceal| - the placeholders used for concealed characters
4230 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004231 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004232 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004233 |hl-SpellRare| R rare word |spell|
4234 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004235 |hl-Pmenu| + popup menu normal line
4236 |hl-PmenuSel| = popup menu selected line
4237 |hl-PmenuSbar| x popup menu scrollbar
4238 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239
4240 The display modes are:
4241 r reverse (termcap entry "mr" and "me")
4242 i italic (termcap entry "ZH" and "ZR")
4243 b bold (termcap entry "md" and "me")
4244 s standout (termcap entry "so" and "se")
4245 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004246 c undercurl (termcap entry "Us" and "Ce")
4247 2 double underline (termcap entry "Ds" and "Ce")
4248 d dotted underline (termcap entry "ds" and "Ce")
4249 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004250 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251 n no highlighting
4252 - no highlighting
4253 : use a highlight group
4254 The default is used for occasions that are not included.
4255 If you want to change what the display modes do, see |dos-colors|
4256 for an example.
4257 When using the ':' display mode, this must be followed by the name of
4258 a highlight group. A highlight group can be used to define any type
4259 of highlighting, including using color. See |:highlight| on how to
4260 define one. The default uses a different group for each occasion.
4261 See |highlight-default| for the default highlight groups.
4262
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004264'history' 'hi' number (Vim default: 50, Vi default: 0,
4265 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004268 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004270 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 NOTE: This option is set to the Vi default value when 'compatible' is
4272 set and to the Vim default value when 'compatible' is reset.
4273
4274 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4275'hkmap' 'hk' boolean (default off)
4276 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 {only available when compiled with the |+rightleft|
4278 feature}
4279 When on, the keyboard is mapped for the Hebrew character set.
4280 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4281 toggle this option. See |rileft.txt|.
4282 NOTE: This option is reset when 'compatible' is set.
4283
4284 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4285'hkmapp' 'hkp' boolean (default off)
4286 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 {only available when compiled with the |+rightleft|
4288 feature}
4289 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4290 This is useful if you have a non-Hebrew keyboard.
4291 See |rileft.txt|.
4292 NOTE: This option is reset when 'compatible' is set.
4293
Bram Moolenaar036986f2017-03-16 17:41:02 +01004294 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4295'hlsearch' 'hls' boolean (default off)
4296 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004297 {not available when compiled without the
4298 |+extra_search| feature}
4299 When there is a previous search pattern, highlight all its matches.
4300 The type of highlighting used can be set with the 'l' occasion in the
4301 'highlight' option. This uses the "Search" highlight group by
4302 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004303 are not applied. If the "CurSearch" highlight group is set then the
4304 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004305 See also: 'incsearch' and |:match|.
4306 When you get bored looking at the highlighted matches, you can turn it
4307 off with |:nohlsearch|. This does not change the option value, as
4308 soon as you use a search command, the highlighting comes back.
4309 'redrawtime' specifies the maximum time spent on finding matches.
4310 When the search pattern can match an end-of-line, Vim will try to
4311 highlight all of the matched text. However, this depends on where the
4312 search starts. This will be the first line in the window or the first
4313 line below a closed fold. A match in a previous line which is not
4314 drawn may not continue in a newly drawn line.
4315 You can specify whether the highlight status is restored on startup
4316 with the 'h' flag in 'viminfo' |viminfo-h|.
4317 NOTE: This option is reset when 'compatible' is set.
4318
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319 *'icon'* *'noicon'*
4320'icon' boolean (default off, on when title can be restored)
4321 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 When on, the icon text of the window will be set to the value of
4323 'iconstring' (if it is not empty), or to the name of the file
4324 currently being edited. Only the last part of the name is used.
4325 Overridden by the 'iconstring' option.
4326 Only works if the terminal supports setting window icons (currently
4327 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4328 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4329 builtin termcap).
4330 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004331 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004332 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004333 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334
4335 *'iconstring'*
4336'iconstring' string (default "")
4337 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 When this option is not empty, it will be used for the icon text of
4339 the window. This happens only when the 'icon' option is on.
4340 Only works if the terminal supports setting window icon text
4341 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004342 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 When Vim was compiled with HAVE_X11 defined, the original icon will be
4344 restored if possible |X11|.
4345 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004346 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004348 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 {not available when compiled without the |+statusline| feature}
4350
4351 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4352'ignorecase' 'ic' boolean (default off)
4353 global
4354 Ignore case in search patterns. Also used when searching in the tags
4355 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004356 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004357 Can be overruled by using "\c" or "\C" in the pattern, see
4358 |/ignorecase|.
4359
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004360 *'imactivatefunc'* *'imaf'*
4361'imactivatefunc' 'imaf' string (default "")
4362 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004363 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004364 activate or deactivate the Input Method. The value can be the name of
4365 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4366 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004367 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004368 The expression will be evaluated in the |sandbox| when set from a
4369 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004370
4371 Example: >
4372 function ImActivateFunc(active)
4373 if a:active
4374 ... do something
4375 else
4376 ... do something
4377 endif
4378 " return value is not used
4379 endfunction
4380 set imactivatefunc=ImActivateFunc
4381<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382 *'imactivatekey'* *'imak'*
4383'imactivatekey' 'imak' string (default "")
4384 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004386 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387 Specifies the key that your Input Method in X-Windows uses for
4388 activation. When this is specified correctly, vim can fully control
4389 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4390 You can't use this option to change the activation key, the option
4391 tells Vim what the key is.
4392 Format:
4393 [MODIFIER_FLAG-]KEY_STRING
4394
4395 These characters can be used for MODIFIER_FLAG (case is ignored):
4396 S Shift key
4397 L Lock key
4398 C Control key
4399 1 Mod1 key
4400 2 Mod2 key
4401 3 Mod3 key
4402 4 Mod4 key
4403 5 Mod5 key
4404 Combinations are allowed, for example "S-C-space" or "SC-space" are
4405 both shift+ctrl+space.
4406 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4407
4408 Example: >
4409 :set imactivatekey=S-space
4410< "S-space" means shift+space. This is the activation key for kinput2 +
4411 canna (Japanese), and ami (Korean).
4412
4413 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4414'imcmdline' 'imc' boolean (default off)
4415 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 When set the Input Method is always on when starting to edit a command
4417 line, unless entering a search pattern (see 'imsearch' for that).
4418 Setting this option is useful when your input method allows entering
4419 English characters directly, e.g., when it's used to type accented
4420 characters with dead keys.
4421
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004422 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4424 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 When set the Input Method is never used. This is useful to disable
4426 the IM when it doesn't work properly.
4427 Currently this option is on by default for SGI/IRIX machines. This
4428 may change in later releases.
4429
4430 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004431'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 Specifies whether :lmap or an Input Method (IM) is to be used in
4434 Insert mode. Valid values:
4435 0 :lmap is off and IM is off
4436 1 :lmap is ON and IM is off
4437 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438 To always reset the option to zero when leaving Insert mode with <Esc>
4439 this can be used: >
4440 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4441< This makes :lmap and IM turn off automatically when leaving Insert
4442 mode.
4443 Note that this option changes when using CTRL-^ in Insert mode
4444 |i_CTRL-^|.
4445 The value is set to 1 when setting 'keymap' to a valid keymap name.
4446 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004447 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 methods. Use 'imdisable' to disable XIM then.
4449
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004450 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004451 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004452 |+multi_byte_ime| or |global-ime|.
4453
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004455'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 Specifies whether :lmap or an Input Method (IM) is to be used when
4458 entering a search pattern. Valid values:
4459 -1 the value of 'iminsert' is used, makes it look like
4460 'iminsert' is also used when typing a search pattern
4461 0 :lmap is off and IM is off
4462 1 :lmap is ON and IM is off
4463 2 :lmap is off and IM is ON
4464 Note that this option changes when using CTRL-^ in Command-line mode
4465 |c_CTRL-^|.
4466 The value is set to 1 when it is not -1 and setting the 'keymap'
4467 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004468 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 methods. Use 'imdisable' to disable XIM then.
4470
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004471 *'imstatusfunc'* *'imsf'*
4472'imstatusfunc' 'imsf' string (default "")
4473 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004474 This option specifies a function that is called to obtain the status
4475 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004476 The value can be the name of a function, a |lambda| or a |Funcref|.
4477 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004478 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004479
4480 Example: >
4481 function ImStatusFunc()
4482 let is_active = ...do something
4483 return is_active ? 1 : 0
4484 endfunction
4485 set imstatusfunc=ImStatusFunc
4486<
4487 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004488 The expression will be evaluated in the |sandbox| when set from a
4489 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004490
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004491 *'imstyle'* *'imst'*
4492'imstyle' 'imst' number (default 1)
4493 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004494 {only available when compiled with |+xim| and
4495 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004496 This option specifies the input style of Input Method:
4497 0 use on-the-spot style
4498 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004499 See: |xim-input-style|
4500
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004501 For a long time on-the-spot style had been used in the GTK version of
4502 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004503 |single-repeat|, etc. Therefore over-the-spot style becomes the
4504 default now. This should work fine for most people, however if you
4505 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004506 The expression will be evaluated in the |sandbox| when set from a
4507 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004508
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 *'include'* *'inc'*
4510'include' 'inc' string (default "^\s*#\s*include")
4511 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004512 {not available when compiled without the
4513 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004514 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515 pattern, just like for the "/" command (See |pattern|). The default
4516 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004517 "]I", "[d", etc.
4518 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004519 comes after the matched pattern. But if "\zs" appears in the pattern
4520 then the text matched from "\zs" to the end, or until "\ze" if it
4521 appears, is used as the file name. Use this to include characters
4522 that are not in 'isfname', such as a space. You can then use
4523 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004524 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525
4526 *'includeexpr'* *'inex'*
4527'includeexpr' 'inex' string (default "")
4528 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004530 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004532 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533 :set includeexpr=substitute(v:fname,'\\.','/','g')
4534< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004535
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004537 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538 Also used for |<cfile>|.
4539
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004540 If the expression starts with s: or |<SID>|, then it is replaced with
4541 the script ID (|local-function|). Example: >
4542 set includeexpr=s:MyIncludeExpr(v:fname)
4543 set includeexpr=<SID>SomeIncludeExpr(v:fname)
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004544< Otherwise, the expression is evaluated in the context of the script
4545 where the option was set, thus script-local items are available.
4546
Bram Moolenaar30b65812012-07-12 22:01:11 +02004547 The expression will be evaluated in the |sandbox| when set from a
4548 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004549 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004550
4551 It is not allowed to change text or jump to another window while
4552 evaluating 'includeexpr' |textlock|.
4553
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004555'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004556 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004559 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004560 While typing a search command, show where the pattern, as it was typed
4561 so far, matches. The matched string is highlighted. If the pattern
4562 is invalid or not found, nothing is shown. The screen will be updated
4563 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004564 Also applies to the pattern in commands: >
4565 :global
4566 :lvimgrep
4567 :lvimgrepadd
4568 :smagic
4569 :snomagic
4570 :sort
4571 :substitute
4572 :vglobal
4573 :vimgrep
4574 :vimgrepadd
4575< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004576 original position when no match is found and when pressing <Esc>. You
4577 still need to finish the search command with <Enter> to move the
4578 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004579 You can use the CTRL-G and CTRL-T keys to move to the next and
4580 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004581 When compiled with the |+reltime| feature Vim only searches for about
4582 half a second. With a complicated pattern and/or a lot of text the
4583 match may not be found. This is to avoid that Vim hangs while you
4584 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004585 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004586 When 'hlsearch' is on, all matched strings are highlighted too while
4587 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004588 If you don't want to turn 'hlsearch' on, but want to highlight all
4589 matches while searching, you can turn on and off 'hlsearch' with
4590 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004591 augroup vimrc-incsearch-highlight
4592 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004593 autocmd CmdlineEnter /,\? :set hlsearch
4594 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004595 augroup END
4596<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004597 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004598 to the command line. If 'ignorecase' and 'smartcase' are set and the
4599 command line has no uppercase characters, the added character is
4600 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004601 CTRL-R CTRL-W can be used to add the word at the end of the current
4602 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 NOTE: This option is reset when 'compatible' is set.
4604
4605 *'indentexpr'* *'inde'*
4606'indentexpr' 'inde' string (default "")
4607 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004608 {not available when compiled without the |+eval|
4609 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004610 Expression which is evaluated to obtain the proper indent for a line.
4611 It is used when a new line is created, for the |=| operator and
4612 in Insert mode as specified with the 'indentkeys' option.
4613 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004614 'smartindent' indenting. When 'lisp' is set, this option is
4615 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 When 'paste' is set this option is not used for indenting.
4617 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004618 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004620
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004621 If the expression starts with s: or |<SID>|, then it is replaced with
4622 the script ID (|local-function|). Example: >
4623 set indentexpr=s:MyIndentExpr()
4624 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004625< Otherwise, the expression is evaluated in the context of the script
4626 where the option was set, thus script-local items are available.
4627
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 The expression must return the number of spaces worth of indent. It
4629 can return "-1" to keep the current indent (this means 'autoindent' is
4630 used for the indent).
4631 Functions useful for computing the indent are |indent()|, |cindent()|
4632 and |lispindent()|.
4633 The evaluation of the expression must not have side effects! It must
4634 not change the text, jump to another window, etc. Afterwards the
4635 cursor position is always restored, thus the cursor may be moved.
4636 Normally this option would be set to call a function: >
4637 :set indentexpr=GetMyIndent()
4638< Error messages will be suppressed, unless the 'debug' option contains
4639 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004640 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004641 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642
Bram Moolenaar30b65812012-07-12 22:01:11 +02004643 The expression will be evaluated in the |sandbox| when set from a
4644 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004645 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004646
4647 It is not allowed to change text or jump to another window while
4648 evaluating 'indentexpr' |textlock|.
4649
4650
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004652'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 A list of keys that, when typed in Insert mode, cause reindenting of
4655 the current line. Only happens if 'indentexpr' isn't empty.
4656 The format is identical to 'cinkeys', see |indentkeys-format|.
4657 See |C-indenting| and |indent-expression|.
4658
4659 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4660'infercase' 'inf' boolean (default off)
4661 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004663 'ignorecase' is also on, the case of the match is adjusted depending
4664 on the typed text. If the typed text contains a lowercase letter
4665 where the match has an upper case letter, the completed part is made
4666 lowercase. If the typed text has no lowercase letters and the match
4667 has a lowercase letter where the typed text has an uppercase letter,
4668 and there is a letter before it, the completed part is made uppercase.
4669 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670
4671 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4672'insertmode' 'im' boolean (default off)
4673 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004674 Makes Vim work in a way that Insert mode is the default mode. Useful
4675 if you want to use Vim as a modeless editor. Used for |evim|.
4676 These Insert mode commands will be useful:
4677 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004678 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679 this is a mapping, it is executed as if 'insertmode' was off.
4680 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004682 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4683 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684
4685 These items change when 'insertmode' is set:
4686 - when starting to edit of a file, Vim goes to Insert mode.
4687 - <Esc> in Insert mode is a no-op and beeps.
4688 - <Esc> in Normal mode makes Vim go to Insert mode.
4689 - CTRL-L in Insert mode is a command, it is not inserted.
4690 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4691 However, when <Esc> is used inside a mapping, it behaves like
4692 'insertmode' was not set. This was done to be able to use the same
4693 mappings with 'insertmode' set or not set.
4694 When executing commands with |:normal| 'insertmode' is not used.
4695
4696 NOTE: This option is reset when 'compatible' is set.
4697
4698 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004699'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4701 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4702 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4703 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4704 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4705 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004706 The characters specified by this option are included in file names and
4707 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004708 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709 Multi-byte characters 256 and above are always included, only the
4710 characters up to 255 are specified with this option.
4711 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004712 Think twice before adding white space to this option. Although a
4713 space may appear inside a file name, the effect will be that Vim
4714 doesn't know where a file name starts or ends when doing completion.
4715 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004716
4717 Note that on systems using a backslash as path separator, Vim tries to
4718 do its best to make it work as you would expect. That is a bit
4719 tricky, since Vi originally used the backslash to escape special
4720 characters. Vim will not remove a backslash in front of a normal file
4721 name character on these systems, but it will on Unix and alikes. The
4722 '&' and '^' are not included by default, because these are special for
4723 cmd.exe.
4724
4725 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004726 Each part can be a single character number or a range. A range is two
4727 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728 decimal number between 0 and 255 or the ASCII character itself (does
4729 not work for digits). Example:
4730 "_,-,128-140,#-43" (include '_' and '-' and the range
4731 128 to 140 and '#' to 43)
4732 If a part starts with '^', the following character number or range
4733 will be excluded from the option. The option is interpreted from left
4734 to right. Put the excluded character after the range where it is
4735 included. To include '^' itself use it as the last character of the
4736 option or the end of a range. Example:
4737 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4738 If the character is '@', all characters where isalpha() returns TRUE
4739 are included. Normally these are the characters a to z and A to Z,
4740 plus accented characters. To include '@' itself use "@-@". Examples:
4741 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004742 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743 "a-z,A-Z,@-@" All letters plus the '@' character.
4744 A comma can be included by using it where a character number is
4745 expected. Example:
4746 "48-57,,,_" Digits, comma and underscore.
4747 A comma can be excluded by prepending a '^'. Example:
4748 " -~,^,,9" All characters from space to '~', excluding
4749 comma, plus <Tab>.
4750 See |option-backslash| about including spaces and backslashes.
4751
4752 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004753'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 "@,48-57,_,128-167,224-235"
4755 otherwise: "@,48-57,_,192-255")
4756 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757 The characters given by this option are included in identifiers.
4758 Identifiers are used in recognizing environment variables and after a
4759 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004760 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004761 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004763 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4765
4766 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004767'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768 "@,48-57,_,128-167,224-235"
4769 otherwise: "@,48-57,_,192-255"
4770 Vi default: "@,48-57,_")
4771 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004773 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004774 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004775 characters above 255 check the "word" character class (any character
4776 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004777 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 For a help file it is set to all non-blank printable characters except
4779 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4780 command).
4781 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004782 This option also influences syntax highlighting, unless the syntax
4783 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784 NOTE: This option is set to the Vi default value when 'compatible' is
4785 set and to the Vim default value when 'compatible' is reset.
4786
4787 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004788'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 "@,~-255"; otherwise: "@,161-255")
4790 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 The characters given by this option are displayed directly on the
4792 screen. It is also used for "\p" in a |pattern|. The characters from
4793 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4794 even when they are not included in 'isprint' or excluded. See
4795 'isfname' for a description of the format of this option.
4796
4797 Non-printable characters are displayed with two characters:
4798 0 - 31 "^@" - "^_"
4799 32 - 126 always single characters
4800 127 "^?"
4801 128 - 159 "~@" - "~_"
4802 160 - 254 "| " - "|~"
4803 255 "~?"
4804 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4805 displayed as <xx>, with the hexadecimal value of the byte.
4806 When 'display' contains "uhex" all unprintable characters are
4807 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004808 The SpecialKey highlighting will be used for unprintable characters.
4809 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810
4811 Multi-byte characters 256 and above are always included, only the
4812 characters up to 255 are specified with this option. When a character
4813 is printable but it is not available in the current font, a
4814 replacement character will be shown.
4815 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4816 There is no option to specify these characters.
4817
4818 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4819'joinspaces' 'js' boolean (default on)
4820 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004821 Insert two spaces after a '.', '?' and '!' with a join command.
4822 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4823 Otherwise only one space is inserted.
4824 NOTE: This option is set when 'compatible' is set.
4825
4826 *'key'*
4827'key' string (default "")
4828 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004829 {only available when compiled with the |+cryptv|
4830 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004832 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833 Careful: Do not set the key value by hand, someone might see the typed
4834 key. Use the |:X| command. But you can make 'key' empty: >
4835 :set key=
4836< It is not possible to get the value of this option with ":set key" or
4837 "echo &key". This is to avoid showing it to someone who shouldn't
4838 know. It also means you cannot see it yourself once you have set it,
4839 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004840 You can use "&key" in an expression to detect whether encryption is
4841 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004842
4843 *'keymap'* *'kmp'* *E544*
4844'keymap' 'kmp' string (default "")
4845 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 {only available when compiled with the |+keymap|
4847 feature}
4848 Name of a keyboard mapping. See |mbyte-keymap|.
4849 Setting this option to a valid keymap name has the side effect of
4850 setting 'iminsert' to one, so that the keymap becomes effective.
4851 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004852 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853
4854 *'keymodel'* *'km'*
4855'keymodel' 'km' string (default "")
4856 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004857 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 can do. These values can be used:
4859 startsel Using a shifted special key starts selection (either
4860 Select mode or Visual mode, depending on "key" being
4861 present in 'selectmode').
4862 stopsel Using a not-shifted special key stops selection.
4863 Special keys in this context are the cursor keys, <End>, <Home>,
4864 <PageUp> and <PageDown>.
4865 The 'keymodel' option is set by the |:behave| command.
4866
4867 *'keywordprg'* *'kp'*
4868'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004869 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 Program to use for the |K| command. Environment variables are
4872 expanded |:set_env|. ":help" may be used to access the Vim internal
4873 help. (Note that previously setting the global option to the empty
4874 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004875 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01004876 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004877 When "man", "man -s" or an Ex command is used, Vim will automatically
4878 translate a count for the "K" command and pass it as the first
4879 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004880 See |option-backslash| about including spaces and backslashes.
4881 Example: >
4882 :set keywordprg=man\ -s
4883< This option cannot be set from a |modeline| or in the |sandbox|, for
4884 security reasons.
4885
4886 *'langmap'* *'lmap'* *E357* *E358*
4887'langmap' 'lmap' string (default "")
4888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889 {only available when compiled with the |+langmap|
4890 feature}
4891 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004892 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004893 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 care of translating these special characters to the original meaning
4895 of the key. This means you don't have to change the keyboard mode to
4896 be able to execute Normal mode commands.
4897 This is the opposite of the 'keymap' option, where characters are
4898 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004899 Also consider setting 'langremap' to off, to prevent 'langmap' from
4900 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004901 This option cannot be set from a |modeline| or in the |sandbox|, for
4902 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004904 Example (for Greek, in UTF-8): *greek* >
4905 :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 +00004906< Example (exchanges meaning of z and y for commands): >
4907 :set langmap=zy,yz,ZY,YZ
4908<
4909 The 'langmap' option is a list of parts, separated with commas. Each
4910 part can be in one of two forms:
4911 1. A list of pairs. Each pair is a "from" character immediately
4912 followed by the "to" character. Examples: "aA", "aAbBcC".
4913 2. A list of "from" characters, a semi-colon and a list of "to"
4914 characters. Example: "abc;ABC"
4915 Example: "aA,fgh;FGH,cCdDeE"
4916 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004917 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918
4919 This will allow you to activate vim actions without having to switch
4920 back and forth between the languages. Your language characters will
4921 be understood as normal vim English characters (according to the
4922 langmap mappings) in the following cases:
4923 o Normal/Visual mode (commands, buffer/register names, user mappings)
4924 o Insert/Replace Mode: Register names after CTRL-R
4925 o Insert/Replace Mode: Mappings
4926 Characters entered in Command-line mode will NOT be affected by
4927 this option. Note that this option can be changed at any time
4928 allowing to switch between mappings for different languages/encodings.
4929 Use a mapping to avoid having to type it each time!
4930
4931 *'langmenu'* *'lm'*
4932'langmenu' 'lm' string (default "")
4933 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934 {only available when compiled with the |+menu| and
4935 |+multi_lang| features}
4936 Language to use for menu translation. Tells which file is loaded
4937 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004938 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939< (without the spaces). For example, to always use the Dutch menus, no
4940 matter what $LANG is set to: >
4941 :set langmenu=nl_NL.ISO_8859-1
4942< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004943 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 If your $LANG is set to a non-English language but you do want to use
4945 the English menus: >
4946 :set langmenu=none
4947< This option must be set before loading menus, switching on filetype
4948 detection or syntax highlighting. Once the menus are defined setting
4949 this option has no effect. But you could do this: >
4950 :source $VIMRUNTIME/delmenu.vim
4951 :set langmenu=de_DE.ISO_8859-1
4952 :source $VIMRUNTIME/menu.vim
4953< Warning: This deletes all menus that you defined yourself!
4954
Bram Moolenaard94464e2015-11-02 15:28:18 +01004955 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004956'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004957 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004958 {only available when compiled with the |+langmap|
4959 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004960 This is just like 'langremap' but with the value inverted. It only
4961 exists for backwards compatibility. When setting 'langremap' then
4962 'langnoremap' is set to the inverted value, and the other way around.
4963
4964 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004965'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004966 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004967 {only available when compiled with the |+langmap|
4968 feature}
4969 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004970 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004971 'langmap' disables some of your mappings, try resetting this option.
4972 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004973 that works for you to avoid mappings to break.
4974
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 *'laststatus'* *'ls'*
4976'laststatus' 'ls' number (default 1)
4977 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978 The value of this option influences when the last window will have a
4979 status line:
4980 0: never
4981 1: only if there are at least two windows
4982 2: always
4983 The screen looks nicer with a status line if you have several
4984 windows, but it takes another screen line. |status-line|
4985
4986 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4987'lazyredraw' 'lz' boolean (default off)
4988 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989 When this option is set, the screen will not be redrawn while
4990 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004991 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01004993 This may occasionally cause display errors. It is only meant to be set
4994 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01004995 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996
4997 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4998'linebreak' 'lbr' boolean (default off)
4999 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005000 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005002 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 than at the last character that fits on the screen. Unlike
5004 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005005 it only affects the way the file is displayed, not its contents.
5006 If 'breakindent' is set, line is visually indented. Then, the value
5007 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005008 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009 Note that <Tab> characters after an <EOL> are mostly not displayed
5010 with the right amount of white space.
5011
5012 *'lines'* *E593*
5013'lines' number (default 24 or terminal height)
5014 global
5015 Number of lines of the Vim window.
5016 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005017 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018 When Vim is running in the GUI or in a resizable window, setting this
5019 option will cause the window size to be changed. When you only want
5020 to use the size for the GUI, put the command in your |gvimrc| file.
5021 Vim limits the number of lines to what fits on the screen. You can
5022 use this command to get the tallest window possible: >
5023 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005024< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005025 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005026 When you set this option and Vim is unable to change the physical
5027 number of lines of the display, the display may be messed up.
5028
5029 *'linespace'* *'lsp'*
5030'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005032 {only in the GUI}
5033 Number of pixel lines inserted between characters. Useful if the font
5034 uses the full character cell height, making lines touch each other.
5035 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005036 With some fonts there can be too much room between lines (to have
5037 space for ascents and descents). Then it makes sense to set
5038 'linespace' to a negative value. This may cause display problems
5039 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040
5041 *'lisp'* *'nolisp'*
5042'lisp' boolean (default off)
5043 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044 Lisp mode: When <Enter> is typed in insert mode set the indent for
5045 the next line to Lisp standards (well, sort of). Also happens with
5046 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5047 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5048 better. Also see 'lispwords'.
5049 The '-' character is included in keyword characters. Redefines the
5050 "=" operator to use this same indentation algorithm rather than
5051 calling an external program if 'equalprg' is empty.
5052 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053
5054 *'lispwords'* *'lw'*
5055'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005056 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005057 Comma-separated list of words that influence the Lisp indenting when
5058 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005059
5060 *'list'* *'nolist'*
5061'list' boolean (default off)
5062 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005063 List mode: By default show tabs as CTRL-I is displayed, display $
5064 after end of line. Useful to see the difference between tabs and
5065 spaces and for trailing blanks. Further changed by the 'listchars'
5066 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005067
5068 The cursor is displayed at the start of the space a Tab character
5069 occupies, not at the end as usual in Normal mode. To get this cursor
5070 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005071 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005072<
5073 Note that list mode will also affect formatting (set with 'textwidth'
5074 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 changing the way tabs are displayed.
5076
5077 *'listchars'* *'lcs'*
5078'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005079 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005080 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005081 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005082 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005083 eol:c Character to show at the end of each line. When
5084 omitted, there is no extra character at the end of the
5085 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005086 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005087 tab:xy[z] Two or three characters to be used to show a tab.
5088 The third character is optional.
5089
5090 tab:xy The 'x' is always used, then 'y' as many times as will
5091 fit. Thus "tab:>-" displays:
5092 >
5093 >-
5094 >--
5095 etc.
5096
5097 tab:xyz The 'z' is always used, then 'x' is prepended, and
5098 then 'y' is used as many times as will fit. Thus
5099 "tab:<->" displays:
5100 >
5101 <>
5102 <->
5103 <-->
5104 etc.
5105
5106 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005107 *lcs-space*
5108 space:c Character to show for a space. When omitted, spaces
5109 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005110 *lcs-multispace*
5111 multispace:c...
5112 One or more characters to use cyclically to show for
5113 multiple consecutive spaces. Overrides the "space"
5114 setting, except for single spaces. When omitted, the
5115 "space" setting is used. For example,
5116 `:set listchars=multispace:---+` shows ten consecutive
5117 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005118 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005119 *lcs-lead*
5120 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005121 leading spaces are blank. Overrides the "space" and
5122 "multispace" settings for leading spaces. You can
5123 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005124 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005125< *lcs-leadmultispace*
5126 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005127 Like the |lcs-multispace| value, but for leading
5128 spaces only. Also overrides |lcs-lead| for leading
5129 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005130 `:set listchars=leadmultispace:---+` shows ten
5131 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005132 ---+---+--XXX ~
5133 Where "XXX" denotes the first non-blank characters in
5134 the line.
5135 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005136 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005137 trailing spaces are blank. Overrides the "space" and
5138 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005139 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005140 extends:c Character to show in the last column, when 'wrap' is
5141 off and the line continues beyond the right of the
5142 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005143 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005144 precedes:c Character to show in the first visible column of the
5145 physical line, when there is text preceding the
5146 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005147 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005148 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005149 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005150 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005151 nbsp:c Character to show for a non-breakable space character
5152 (0xA0 (160 decimal) and U+202F). Left blank when
5153 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005155 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005157 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005159 Each character can be specified as hex: >
5160 set listchars=eol:\\x24
5161 set listchars=eol:\\u21b5
5162 set listchars=eol:\\U000021b5
5163< Note that a double backslash is used. The number of hex characters
5164 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5165
Bram Moolenaar071d4272004-06-13 20:20:40 +00005166 Examples: >
5167 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005168 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 :set lcs=extends:>,precedes:<
5170< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005171 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5172 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005173 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174
5175 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5176'loadplugins' 'lpl' boolean (default on)
5177 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178 When on the plugin scripts are loaded when starting up |load-plugins|.
5179 This option can be reset in your |vimrc| file to disable the loading
5180 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005181 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5182 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183
Bram Moolenaard94464e2015-11-02 15:28:18 +01005184 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005185'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005186 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005187 {only available when compiled with the |+lua/dyn|
5188 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005189 Specifies the name of the Lua shared library. The default is
5190 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005191 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005192 This option cannot be set from a |modeline| or in the |sandbox|, for
5193 security reasons.
5194
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005195 *'macatsui'* *'nomacatsui'*
5196'macatsui' boolean (default on)
5197 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005198 {not supported}
5199 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005200
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201 *'magic'* *'nomagic'*
5202'magic' boolean (default on)
5203 global
5204 Changes the special characters that can be used in search patterns.
5205 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005206 WARNING: Switching this option off most likely breaks plugins! That
5207 is because many patterns assume it's on and will fail when it's off.
5208 Only switch it off when working with old Vi scripts. In any other
5209 situation write patterns that work when 'magic' is on. Include "\M"
5210 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005211 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5212 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213
5214 *'makeef'* *'mef'*
5215'makeef' 'mef' string (default: "")
5216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 {not available when compiled without the |+quickfix|
5218 feature}
5219 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5220 and the |:grep| command.
5221 When it is empty, an internally generated temp file will be used.
5222 When "##" is included, it is replaced by a number to make the name
5223 unique. This makes sure that the ":make" command doesn't overwrite an
5224 existing file.
5225 NOT used for the ":cf" command. See 'errorfile' for that.
5226 Environment variables are expanded |:set_env|.
5227 See |option-backslash| about including spaces and backslashes.
5228 This option cannot be set from a |modeline| or in the |sandbox|, for
5229 security reasons.
5230
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005231 *'makeencoding'* *'menc'*
5232'makeencoding' 'menc' string (default "")
5233 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005234 Encoding used for reading the output of external commands. When empty,
5235 encoding is not converted.
5236 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5237 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5238 and `:laddfile`.
5239
5240 This would be mostly useful when you use MS-Windows and set 'encoding'
5241 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5242 'makeencoding' to "char" has the same effect as setting to the system
5243 locale encoding. Example: >
5244 :set encoding=utf-8
5245 :set makeencoding=char " system locale is used
5246<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247 *'makeprg'* *'mp'*
5248'makeprg' 'mp' string (default "make", VMS: "MMS")
5249 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005250 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005251 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5252 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005253 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005254 Environment variables are expanded |:set_env|. See |option-backslash|
5255 about including spaces and backslashes.
5256 Note that a '|' must be escaped twice: once for ":set" and once for
5257 the interpretation of a command. When you use a filter called
5258 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005259 :set makeprg=gmake\ \\\|\ myfilter
5260< The placeholder "$*" can be given (even multiple times) to specify
5261 where the arguments will be included, for example: >
5262 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5263< This option cannot be set from a |modeline| or in the |sandbox|, for
5264 security reasons.
5265
5266 *'matchpairs'* *'mps'*
5267'matchpairs' 'mps' string (default "(:),{:},[:]")
5268 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005269 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005270 other.
5271 Only character pairs are allowed that are different, thus you cannot
5272 jump between two double quotes.
5273 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005274 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005275 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 :set mps+=<:>
5277
5278< A more exotic example, to jump between the '=' and ';' in an
5279 assignment, useful for languages like C and Java: >
5280 :au FileType c,cpp,java set mps+==:;
5281
5282< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005283 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284
5285 *'matchtime'* *'mat'*
5286'matchtime' 'mat' number (default 5)
5287 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 Tenths of a second to show the matching paren, when 'showmatch' is
5289 set. Note that this is not in milliseconds, like other options that
5290 set a time. This is to be compatible with Nvi.
5291
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005292 *'maxcombine'* *'mco'*
5293'maxcombine' 'mco' number (default 2)
5294 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005295 The maximum number of combining characters supported for displaying.
5296 Only used when 'encoding' is "utf-8".
5297 The default is OK for most languages. Hebrew may require 4.
5298 Maximum value is 6.
5299 Even when this option is set to 2 you can still edit text with more
5300 combining characters, you just can't see them. Use |g8| or |ga|.
5301 See |mbyte-combining|.
5302
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303 *'maxfuncdepth'* *'mfd'*
5304'maxfuncdepth' 'mfd' number (default 100)
5305 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005306 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005307 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 Maximum depth of function calls for user functions. This normally
5309 catches endless recursion. When using a recursive function with
5310 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5311 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005312 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005313 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314 See also |:function|.
5315
5316 *'maxmapdepth'* *'mmd'* *E223*
5317'maxmapdepth' 'mmd' number (default 1000)
5318 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319 Maximum number of times a mapping is done without resulting in a
5320 character to be used. This normally catches endless mappings, like
5321 ":map x y" with ":map y x". It still does not catch ":map g wg",
5322 because the 'w' is used before the next mapping is done. See also
5323 |key-mapping|.
5324
5325 *'maxmem'* *'mm'*
5326'maxmem' 'mm' number (default between 256 to 5120 (system
5327 dependent) or half the amount of memory
5328 available)
5329 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005330 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5331 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005332 other memory to be freed.
5333 The maximum usable value is about 2000000. Use this to work without a
5334 limit.
5335 The value is ignored when 'swapfile' is off.
5336 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005337
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005338 *'maxmempattern'* *'mmp'*
5339'maxmempattern' 'mmp' number (default 1000)
5340 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005341 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005342 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005343 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005344 When Vim runs into the limit it gives an error message and mostly
5345 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005346 Running into the limit often means that the pattern is very
5347 inefficient or too complex. This may already happen with the pattern
5348 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005349 Might also happen on redraw, when syntax rules try to match a complex
5350 text structure.
5351 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5352 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005353
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 *'maxmemtot'* *'mmt'*
5355'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5356 dependent) or half the amount of memory
5357 available)
5358 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005359 Maximum amount of memory in Kbyte to use for all buffers together.
5360 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005361 without a limit.
5362 On 64 bit machines higher values might work. But hey, do you really
5363 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005364 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005365 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005366 Buffers with 'swapfile' off still count to the total amount of memory
5367 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005368 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369
5370 *'menuitems'* *'mis'*
5371'menuitems' 'mis' number (default 25)
5372 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373 {not available when compiled without the |+menu|
5374 feature}
5375 Maximum number of items to use in a menu. Used for menus that are
5376 generated from a list of items, e.g., the Buffers menu. Changing this
5377 option has no direct effect, the menu must be refreshed first.
5378
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005379 *'mkspellmem'* *'msm'*
5380'mkspellmem' 'msm' string (default "460000,2000,500")
5381 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005382 {not available when compiled without the |+syntax|
5383 feature}
5384 Parameters for |:mkspell|. This tunes when to start compressing the
5385 word tree. Compression can be slow when there are many words, but
5386 it's needed to avoid running out of memory. The amount of memory used
5387 per word depends very much on how similar the words are, that's why
5388 this tuning is complicated.
5389
5390 There are three numbers, separated by commas:
5391 {start},{inc},{added}
5392
5393 For most languages the uncompressed word tree fits in memory. {start}
5394 gives the amount of memory in Kbyte that can be used before any
5395 compression is done. It should be a bit smaller than the amount of
5396 memory that is available to Vim.
5397
5398 When going over the {start} limit the {inc} number specifies the
5399 amount of memory in Kbyte that can be allocated before another
5400 compression is done. A low number means compression is done after
5401 less words are added, which is slow. A high number means more memory
5402 will be allocated.
5403
5404 After doing compression, {added} times 1024 words can be added before
5405 the {inc} limit is ignored and compression is done when any extra
5406 amount of memory is needed. A low number means there is a smaller
5407 chance of hitting the {inc} limit, less memory is used but it's
5408 slower.
5409
5410 The languages for which these numbers are important are Italian and
5411 Hungarian. The default works for when you have about 512 Mbyte. If
5412 you have 1 Gbyte you could use: >
5413 :set mkspellmem=900000,3000,800
5414< If you have less than 512 Mbyte |:mkspell| may fail for some
5415 languages, no matter what you set 'mkspellmem' to.
5416
Bram Moolenaar07607392019-05-26 19:20:43 +02005417 This option cannot be set from a |modeline| or in the |sandbox|.
5418
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005420'modeline' 'ml' boolean (Vim default: on (off for root),
5421 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005423 If 'modeline' is on 'modelines' gives the number of lines that is
5424 checked for set commands. If 'modeline' is off or 'modelines' is zero
5425 no lines are checked. See |modeline|.
5426
5427 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5428'modelineexpr' 'mle' boolean (default: off)
5429 global
5430 When on allow some options that are an expression to be set in the
5431 modeline. Check the option for whether it is affected by
5432 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005433 This option cannot be set from a |modeline| or in the |sandbox|, for
5434 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005435
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 *'modelines'* *'mls'*
5437'modelines' 'mls' number (default 5)
5438 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439 If 'modeline' is on 'modelines' gives the number of lines that is
5440 checked for set commands. If 'modeline' is off or 'modelines' is zero
5441 no lines are checked. See |modeline|.
5442 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5443 set and to the Vim default value when 'compatible' is reset.
5444
5445 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005446 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447'modifiable' 'ma' boolean (default on)
5448 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005449 When off the buffer contents cannot be changed. The 'fileformat' and
5450 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005451 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452
5453 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5454'modified' 'mod' boolean (default off)
5455 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456 When on, the buffer is considered to be modified. This option is set
5457 when:
5458 1. A change was made to the text since it was last written. Using the
5459 |undo| command to go back to the original text will reset the
5460 option. But undoing changes that were made before writing the
5461 buffer will set the option again, since the text is different from
5462 when it was written.
5463 2. 'fileformat' or 'fileencoding' is different from its original
5464 value. The original value is set when the buffer is read or
5465 written. A ":set nomodified" command also resets the original
5466 values to the current values and the 'modified' option will be
5467 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005468 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005469 This option is not set when a change is made to the buffer as the
5470 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5471 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5472 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005473 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5474 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005475 Note that the text may actually be the same, e.g. 'modified' is set
5476 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477
5478 *'more'* *'nomore'*
5479'more' boolean (Vim default: on, Vi default: off)
5480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 When on, listings pause when the whole screen is filled. You will get
5482 the |more-prompt|. When this option is off there are no pauses, the
5483 listing continues until finished.
5484 NOTE: This option is set to the Vi default value when 'compatible' is
5485 set and to the Vim default value when 'compatible' is reset.
5486
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005487 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005488'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005489 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005491 Enable the use of the mouse. Works for most terminals (xterm, Win32
5492 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5493 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5494 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005495 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 v Visual mode
5497 i Insert mode
5498 c Command-line mode
5499 h all previous modes when editing a help file
5500 a all previous modes
5501 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005502 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005504< If your terminal can't overrule the mouse events going to the
5505 application, use: >
5506 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005507< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005508 back to Vim using the mouse events.
5509 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5510 "xterm".
5511
5512 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513 modeless selection. This doesn't move the text cursor.
5514
5515 See |mouse-using|. Also see |'clipboard'|.
5516
5517 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005518 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519 the mouse buttons can still be used by keeping the shift key pressed.
5520 Also see the 'clipboard' option.
5521
5522 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5523'mousefocus' 'mousef' boolean (default off)
5524 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525 {only works in the GUI}
5526 The window that the mouse pointer is on is automatically activated.
5527 When changing the window layout or window focus in another way, the
5528 mouse pointer is moved to the window with keyboard focus. Off is the
5529 default because it makes using the pull down menus a little goofy, as
5530 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005531 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005532 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533
5534 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5535'mousehide' 'mh' boolean (default on)
5536 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 {only works in the GUI}
5538 When on, the mouse pointer is hidden when characters are typed.
5539 The mouse pointer is restored when the mouse is moved.
5540
5541 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005542'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 Sets the model to use for the mouse. The name mostly specifies what
5545 the right mouse button is used for:
5546 extend Right mouse button extends a selection. This works
5547 like in an xterm.
5548 popup Right mouse button pops up a menu. The shifted left
5549 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005550 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 popup_setpos Like "popup", but the cursor will be moved to the
5552 position where the mouse was clicked, and thus the
5553 selected operation will act upon the clicked object.
5554 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005555 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 course, that right clicking outside a selection will
5557 end Visual mode.
5558 Overview of what button does what for each model:
5559 mouse extend popup(_setpos) ~
5560 left click place cursor place cursor
5561 left drag start selection start selection
5562 shift-left search word extend selection
5563 right click extend selection popup menu (place cursor)
5564 right drag extend selection -
5565 middle click paste paste
5566
5567 In the "popup" model the right mouse button produces a pop-up menu.
5568 You need to define this first, see |popup-menu|.
5569
5570 Note that you can further refine the meaning of buttons with mappings.
5571 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5572 selection (because that's handled in the GUI code directly).
5573
5574 The 'mousemodel' option is set by the |:behave| command.
5575
Ernie Raelc4cb5442022-04-03 15:47:28 +01005576 *'mousemoveevent'* *'mousemev'*
5577'mousemoveevent' 'mousemev' boolean (default off)
5578 global
5579 {only works in the GUI}
5580 When on, mouse move events are delivered to the input queue and are
5581 available for mapping. The default, off, avoids the mouse movement
5582 overhead except when needed. See |gui-mouse-mapping|.
5583 Warning: Setting this option can make pending mappings to be aborted
5584 when the mouse is moved.
5585 Currently only works in the GUI, may be made to work in a terminal
5586 later.
5587
Bram Moolenaar071d4272004-06-13 20:20:40 +00005588 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005589'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5590 vs:leftright,vd:lrsizing,m:no,
5591 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005592 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593 {only available when compiled with the |+mouseshape|
5594 feature}
5595 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005596 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597 like used for 'guicursor'. Each part consist of a mode/location-list
5598 and an argument-list:
5599 mode-list:shape,mode-list:shape,..
5600 The mode-list is a dash separated list of these modes/locations:
5601 In a normal window: ~
5602 n Normal mode
5603 v Visual mode
5604 ve Visual mode with 'selection' "exclusive" (same as 'v',
5605 if not specified)
5606 o Operator-pending mode
5607 i Insert mode
5608 r Replace mode
5609
5610 Others: ~
5611 c appending to the command-line
5612 ci inserting in the command-line
5613 cr replacing in the command-line
5614 m at the 'Hit ENTER' or 'More' prompts
5615 ml idem, but cursor in the last line
5616 e any mode, pointer below last window
5617 s any mode, pointer on a status line
5618 sd any mode, while dragging a status line
5619 vs any mode, pointer on a vertical separator line
5620 vd any mode, while dragging a vertical separator line
5621 a everywhere
5622
5623 The shape is one of the following:
5624 avail name looks like ~
5625 w x arrow Normal mouse pointer
5626 w x blank no pointer at all (use with care!)
5627 w x beam I-beam
5628 w x updown up-down sizing arrows
5629 w x leftright left-right sizing arrows
5630 w x busy The system's usual busy pointer
5631 w x no The system's usual 'no input' pointer
5632 x udsizing indicates up-down resizing
5633 x lrsizing indicates left-right resizing
5634 x crosshair like a big thin +
5635 x hand1 black hand
5636 x hand2 white hand
5637 x pencil what you write with
5638 x question big ?
5639 x rightup-arrow arrow pointing right-up
5640 w x up-arrow arrow pointing up
5641 x <number> any X11 pointer number (see X11/cursorfont.h)
5642
5643 The "avail" column contains a 'w' if the shape is available for Win32,
5644 x for X11.
5645 Any modes not specified or shapes not available use the normal mouse
5646 pointer.
5647
5648 Example: >
5649 :set mouseshape=s:udsizing,m:no
5650< will make the mouse turn to a sizing arrow over the status lines and
5651 indicate no input when the hit-enter prompt is displayed (since
5652 clicking the mouse has no effect in this state.)
5653
5654 *'mousetime'* *'mouset'*
5655'mousetime' 'mouset' number (default 500)
5656 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005657 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005658 time in msec between two mouse clicks for the second click to be
5659 recognized as a multi click.
5660
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005661 *'mzschemedll'*
5662'mzschemedll' string (default depends on the build)
5663 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005664 {only available when compiled with the |+mzscheme/dyn|
5665 feature}
5666 Specifies the name of the MzScheme shared library. The default is
5667 DYNAMIC_MZSCH_DLL which was specified at compile time.
5668 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005669 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005670 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005671 This option cannot be set from a |modeline| or in the |sandbox|, for
5672 security reasons.
5673
5674 *'mzschemegcdll'*
5675'mzschemegcdll' string (default depends on the build)
5676 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005677 {only available when compiled with the |+mzscheme/dyn|
5678 feature}
5679 Specifies the name of the MzScheme GC shared library. The default is
5680 DYNAMIC_MZGC_DLL which was specified at compile time.
5681 The value can be equal to 'mzschemedll' if it includes the GC code.
5682 Environment variables are expanded |:set_env|.
5683 This option cannot be set from a |modeline| or in the |sandbox|, for
5684 security reasons.
5685
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005686 *'mzquantum'* *'mzq'*
5687'mzquantum' 'mzq' number (default 100)
5688 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005689 {not available when compiled without the |+mzscheme|
5690 feature}
5691 The number of milliseconds between polls for MzScheme threads.
5692 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005693 NOTE: This option is set to the Vim default value when 'compatible'
5694 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005695
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005697'nrformats' 'nf' string (default "bin,octal,hex",
5698 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 This defines what bases Vim will consider for numbers when using the
5701 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5702 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005703 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005705 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005706 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005708 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 considered to be hexadecimal. Example: Using CTRL-X on
5710 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005711 bin If included, numbers starting with "0b" or "0B" will be
5712 considered to be binary. Example: Using CTRL-X on
5713 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005714 unsigned If included, numbers are recognized as unsigned. Thus a
5715 leading dash or negative sign won't be considered as part of
5716 the number. Examples:
5717 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5718 (without "unsigned" it would become "9-2021").
5719 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5720 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005721 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5722 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723 Numbers which simply begin with a digit in the range 1-9 are always
5724 considered decimal. This also happens for numbers that are not
5725 recognized as octal or hex.
5726
5727 *'number'* *'nu'* *'nonumber'* *'nonu'*
5728'number' 'nu' boolean (default off)
5729 local to window
5730 Print the line number in front of each line. When the 'n' option is
5731 excluded from 'cpoptions' a wrapped line will not use the column of
5732 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005733 The 'numberwidth' option can be used to set the room used for the line
5734 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 When a long, wrapped line doesn't start with the first character, '-'
5736 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005737 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5738 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005739 *number_relativenumber*
5740 The 'relativenumber' option changes the displayed number to be
5741 relative to the cursor. Together with 'number' there are these
5742 four combinations (cursor in line 3):
5743
Bram Moolenaar3848e002016-03-19 18:42:29 +01005744 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005745 'nornu' 'nornu' 'rnu' 'rnu'
5746
5747 |apple | 1 apple | 2 apple | 2 apple
5748 |pear | 2 pear | 1 pear | 1 pear
5749 |nobody | 3 nobody | 0 nobody |3 nobody
5750 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005752 *'numberwidth'* *'nuw'*
5753'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5754 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005755 {only available when compiled with the |+linebreak|
5756 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005757 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005758 when the 'number' or 'relativenumber' option is set or printing lines
5759 with a line number. Since one space is always between the number and
5760 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005761 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005762 fit the highest line number in the buffer respectively the number of
5763 rows in the window, depending on whether 'number' or 'relativenumber'
5764 is set. Thus with the Vim default of 4 there is room for a line number
5765 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005766 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005767 NOTE: This option is set to the Vi default value when 'compatible' is
5768 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005769
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005770 *'omnifunc'* *'ofu'*
5771'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005772 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005773 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005774 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005775 This option specifies a function to be used for Insert mode omni
5776 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005777 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005778 invoked and what it should return. The value can be the name of a
5779 function, a |lambda| or a |Funcref|. See |option-value-function| for
5780 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005781 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005782 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005783 This option cannot be set from a |modeline| or in the |sandbox|, for
5784 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005785
5786
Bram Moolenaar02467872007-05-06 13:22:01 +00005787 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005788'opendevice' 'odev' boolean (default off)
5789 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005790 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005791 Enable reading and writing from devices. This may get Vim stuck on a
5792 device that can be opened but doesn't actually do the I/O. Therefore
5793 it is off by default.
5794 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5795 result in editing a device.
5796
5797
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005798 *'operatorfunc'* *'opfunc'*
5799'operatorfunc' 'opfunc' string (default: empty)
5800 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005801 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005802 See |:map-operator| for more info and an example. The value can be
5803 the name of a function, a |lambda| or a |Funcref|. See
5804 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005805
5806 This option cannot be set from a |modeline| or in the |sandbox|, for
5807 security reasons.
5808
5809
Bram Moolenaar251e1912011-06-19 05:09:16 +02005810 *'osfiletype'* *'oft'*
5811'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005812 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005813 This option was supported on RISC OS, which has been removed.
5814
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005816 *'packpath'* *'pp'*
5817'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005818 Directories used to find packages. See |packages|.
5819
5820
Bram Moolenaar071d4272004-06-13 20:20:40 +00005821 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005822'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005823 global
5824 Specifies the nroff macros that separate paragraphs. These are pairs
5825 of two letters (see |object-motions|).
5826
5827 *'paste'* *'nopaste'*
5828'paste' boolean (default off)
5829 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005830 Put Vim in Paste mode. This is useful if you want to cut or copy
5831 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005832 unexpected effects.
5833 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005834 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005835 knows about pasting and will mostly do the right thing without 'paste'
5836 being set. The same is true for a terminal where Vim handles the
5837 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005838 This option is reset when starting the GUI. Thus if you set it in
5839 your .vimrc it will work in a terminal, but not in the GUI. Setting
5840 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5841 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005842 When the 'paste' option is switched on (also when it was already on):
5843 - mapping in Insert mode and Command-line mode is disabled
5844 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005845 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005846 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005847 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005848 - 'revins' is reset
5849 - 'ruler' is reset
5850 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005851 - 'smarttab' is reset
5852 - 'softtabstop' is set to 0
5853 - 'textwidth' is set to 0
5854 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005855 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005857 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005858 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005859 - 'indentexpr'
5860 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005861 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005862 NOTE: When you start editing another file while the 'paste' option is
5863 on, settings from the modelines or autocommands may change the
5864 settings again, causing trouble when pasting text. You might want to
5865 set the 'paste' option again.
5866 When the 'paste' option is reset the mentioned options are restored to
5867 the value before the moment 'paste' was switched from off to on.
5868 Resetting 'paste' before ever setting it does not have any effect.
5869 Since mapping doesn't work while 'paste' is active, you need to use
5870 the 'pastetoggle' option to toggle the 'paste' option with some key.
5871
5872 *'pastetoggle'* *'pt'*
5873'pastetoggle' 'pt' string (default "")
5874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005875 When non-empty, specifies the key sequence that toggles the 'paste'
5876 option. This is like specifying a mapping: >
5877 :map {keys} :set invpaste<CR>
5878< Where {keys} is the value of 'pastetoggle'.
5879 The difference is that it will work even when 'paste' is set.
5880 'pastetoggle' works in Insert mode and Normal mode, but not in
5881 Command-line mode.
5882 Mappings are checked first, thus overrule 'pastetoggle'. However,
5883 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5884 this: >
5885 :map <F10> :set paste<CR>
5886 :map <F11> :set nopaste<CR>
5887 :imap <F10> <C-O>:set paste<CR>
5888 :imap <F11> <nop>
5889 :set pastetoggle=<F11>
5890< This will make <F10> start paste mode and <F11> stop paste mode.
5891 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5892 mode everything is inserted literally, except the 'pastetoggle' key
5893 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005894 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005895
5896 *'pex'* *'patchexpr'*
5897'patchexpr' 'pex' string (default "")
5898 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 {not available when compiled without the |+diff|
5900 feature}
5901 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005902 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005903
Bram Moolenaardbc28022014-07-26 13:40:44 +02005904 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005905'patchmode' 'pm' string (default "")
5906 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 When non-empty the oldest version of a file is kept. This can be used
5908 to keep the original version of a file if you are changing files in a
5909 source distribution. Only the first time that a file is written a
5910 copy of the original file will be kept. The name of the copy is the
5911 name of the original file with the string in the 'patchmode' option
5912 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005913 ".orig" or ".org". 'backupdir' must not be empty for this to work
5914 (Detail: The backup file is renamed to the patchmode file after the
5915 new file has been successfully written, that's why it must be possible
5916 to write a backup file). If there was no file to be backed up, an
5917 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918 When the 'backupskip' pattern matches, a patchmode file is not made.
5919 Using 'patchmode' for compressed files appends the extension at the
5920 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5921 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005922 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005923
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005924 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005926 other systems: ".,,")
5927 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005928 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005929 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5930 provided that the file being searched for has a relative path (not
5931 starting with "/", "./" or "../"). The directories in the 'path'
5932 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005933 - Use commas to separate directory names: >
5934 :set path=.,/usr/local/include,/usr/include
5935< - Spaces can also be used to separate directory names (for backwards
5936 compatibility with version 3.0). To have a space in a directory
5937 name, precede it with an extra backslash, and escape the space: >
5938 :set path=.,/dir/with\\\ space
5939< - To include a comma in a directory name precede it with an extra
5940 backslash: >
5941 :set path=.,/dir/with\\,comma
5942< - To search relative to the directory of the current file, use: >
5943 :set path=.
5944< - To search in the current directory use an empty string between two
5945 commas: >
5946 :set path=,,
5947< - A directory name may end in a ':' or '/'.
5948 - Environment variables are expanded |:set_env|.
5949 - When using |netrw.vim| URLs can be used. For example, adding
5950 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005951 - Search upwards and downwards in a directory tree using "*", "**" and
5952 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005953 {not available when compiled without the |+path_extra| feature}
5954 - Careful with '\' characters, type two to get one in the option: >
5955 :set path=.,c:\\include
5956< Or just use '/' instead: >
5957 :set path=.,c:/include
5958< Don't forget "." or files won't even be found in the same directory as
5959 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005960 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005961 it is something like 256 or 1024 characters.
5962 You can check if all the include files are found, using the value of
5963 'path', see |:checkpath|.
5964 The use of |:set+=| and |:set-=| is preferred when adding or removing
5965 directories from the list. This avoids problems when a future version
5966 uses another default. To remove the current directory use: >
5967 :set path-=
5968< To add the current directory use: >
5969 :set path+=
5970< To use an environment variable, you probably need to replace the
5971 separator. Here is an example to append $INCL, in which directory
5972 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005973 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005974< Replace the ';' with a ':' or whatever separator is used. Note that
5975 this doesn't work when $INCL contains a comma or white space.
5976
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005977 *'perldll'*
5978'perldll' string (default depends on the build)
5979 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005980 {only available when compiled with the |+perl/dyn|
5981 feature}
5982 Specifies the name of the Perl shared library. The default is
5983 DYNAMIC_PERL_DLL, which was specified at compile time.
5984 Environment variables are expanded |:set_env|.
5985 This option cannot be set from a |modeline| or in the |sandbox|, for
5986 security reasons.
5987
Bram Moolenaar071d4272004-06-13 20:20:40 +00005988 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5989'preserveindent' 'pi' boolean (default off)
5990 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005991 When changing the indent of the current line, preserve as much of the
5992 indent structure as possible. Normally the indent is replaced by a
5993 series of tabs followed by spaces as required (unless |'expandtab'| is
5994 enabled, in which case only spaces are used). Enabling this option
5995 means the indent will preserve as many existing characters as possible
5996 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005997 'expandtab' does not apply to the preserved white space, a Tab remains
5998 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999 NOTE: When using ">>" multiple times the resulting indent is a mix of
6000 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006001 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002 Also see 'copyindent'.
6003 Use |:retab| to clean up white space.
6004
6005 *'previewheight'* *'pvh'*
6006'previewheight' 'pvh' number (default 12)
6007 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006008 {not available when compiled without the |+quickfix|
6009 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006011 commands. Used for |CTRL-W_}| when no count is given. Not used when
6012 'previewpopup' is set.
6013
6014 *'previewpopup'* *'pvp'*
6015'previewpopup' 'pvp' string (default empty)
6016 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006017 {not available when compiled without the |+textprop|
6018 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006019 When not empty a popup window is used for commands that would open a
6020 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006021 Not used for the insert completion info, add "popup" to
6022 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023
6024 *'previewwindow'* *'nopreviewwindow'*
6025 *'pvw'* *'nopvw'* *E590*
6026'previewwindow' 'pvw' boolean (default off)
6027 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006028 {not available when compiled without the |+quickfix|
6029 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006030 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 set. It's normally not set directly, but by using one of the commands
6032 |:ptag|, |:pedit|, etc.
6033
6034 *'printdevice'* *'pdev'*
6035'printdevice' 'pdev' string (default empty)
6036 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006037 {only available when compiled with the |+printer|
6038 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006039 The name of the printer to be used for |:hardcopy|.
6040 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006041 This option cannot be set from a |modeline| or in the |sandbox|, for
6042 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006043
Bram Moolenaar8299df92004-07-10 09:47:34 +00006044 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006045'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006047 {only available when compiled with the |+printer|
6048 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006049 Sets the character encoding used when printing.
6050 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051
6052 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006053'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055 {only available when compiled with the |+printer|
6056 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006057 Expression used to print the PostScript produced with |:hardcopy|.
6058 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006059 This option cannot be set from a |modeline| or in the |sandbox|, for
6060 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061
Bram Moolenaar8299df92004-07-10 09:47:34 +00006062 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063'printfont' 'pfn' string (default "courier")
6064 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006065 {only available when compiled with the |+printer|
6066 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006067 The name of the font that will be used for |:hardcopy|.
6068 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006069
6070 *'printheader'* *'pheader'*
6071'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006073 {only available when compiled with the |+printer|
6074 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006075 The format of the header produced in |:hardcopy| output.
6076 See |pheader-option|.
6077
6078 *'printmbcharset'* *'pmbcs'*
6079'printmbcharset' 'pmbcs' string (default "")
6080 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006081 {only available when compiled with the |+printer|
6082 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006083 The CJK character set to be used for CJK output from |:hardcopy|.
6084 See |pmbcs-option|.
6085
6086 *'printmbfont'* *'pmbfn'*
6087'printmbfont' 'pmbfn' string (default "")
6088 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006089 {only available when compiled with the |+printer|
6090 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006091 List of font names to be used for CJK output from |:hardcopy|.
6092 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093
6094 *'printoptions'* *'popt'*
6095'printoptions' 'popt' string (default "")
6096 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006097 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006098 List of items that control the format of the output of |:hardcopy|.
6099 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006101 *'prompt'* *'noprompt'*
6102'prompt' boolean (default on)
6103 global
6104 When on a ":" prompt is used in Ex mode.
6105
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006106 *'pumheight'* *'ph'*
6107'pumheight' 'ph' number (default 0)
6108 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006109 Determines the maximum number of items to show in the popup menu for
6110 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006111 |ins-completion-menu|.
6112
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006113 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006114'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006115 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006116 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006117 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006118
Bram Moolenaard94464e2015-11-02 15:28:18 +01006119 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006120'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006121 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006122 {only available when compiled with the |+python/dyn|
6123 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006124 Specifies the name of the Python 2.x shared library. The default is
6125 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006126 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006127 This option cannot be set from a |modeline| or in the |sandbox|, for
6128 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006129
Bram Moolenaar94073162018-01-31 21:49:05 +01006130 *'pythonhome'*
6131'pythonhome' string (default "")
6132 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006133 {only available when compiled with the |+python/dyn|
6134 feature}
6135 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6136 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6137 which was specified at compile time, will be used for the Python 2.x
6138 home directory.
6139 Environment variables are expanded |:set_env|.
6140 This option cannot be set from a |modeline| or in the |sandbox|, for
6141 security reasons.
6142
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006143 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006144'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006145 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006146 {only available when compiled with the |+python3/dyn|
6147 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006148 Specifies the name of the Python 3 shared library. The default is
6149 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006150 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006151 This option cannot be set from a |modeline| or in the |sandbox|, for
6152 security reasons.
6153
Bram Moolenaar94073162018-01-31 21:49:05 +01006154 *'pythonthreehome'*
6155'pythonthreehome' string (default "")
6156 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006157 {only available when compiled with the |+python3/dyn|
6158 feature}
6159 Specifies the name of the Python 3 home directory. When
6160 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6161 PYTHON3_HOME, which was specified at compile time, will be used for
6162 the Python 3 home directory.
6163 Environment variables are expanded |:set_env|.
6164 This option cannot be set from a |modeline| or in the |sandbox|, for
6165 security reasons.
6166
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006167 *'pyxversion'* *'pyx'*
6168'pyxversion' 'pyx' number (default depends on the build)
6169 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006170 {only available when compiled with the |+python| or
6171 the |+python3| feature}
6172 Specifies the python version used for pyx* functions and commands
6173 |python_x|. The default value is as follows:
6174
6175 Compiled with Default ~
6176 |+python| and |+python3| 0
6177 only |+python| 2
6178 only |+python3| 3
6179
6180 Available values are 0, 2 and 3.
6181 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6182 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6183 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6184 to 2 if Python 2 is available.
6185 See also: |has-pythonx|
6186
6187 If Vim is compiled with only |+python| or |+python3| setting
6188 'pyxversion' has no effect. The pyx* functions and commands are
6189 always the same as the compiled version.
6190
6191 This option cannot be set from a |modeline| or in the |sandbox|, for
6192 security reasons.
6193
Bram Moolenaar858ba062020-05-31 23:11:59 +02006194 *'quickfixtextfunc'* *'qftf'*
6195'quickfixtextfunc' 'qftf' string (default "")
6196 global
6197 {only available when compiled with the |+quickfix|
6198 feature}
6199 This option specifies a function to be used to get the text to display
6200 in the quickfix and location list windows. This can be used to
6201 customize the information displayed in the quickfix or location window
6202 for each entry in the corresponding quickfix or location list. See
6203 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006204 function and an example. The value can be the name of a function, a
6205 |lambda| or a |Funcref|. See |option-value-function| for more
6206 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006207
6208 This option cannot be set from a |modeline| or in the |sandbox|, for
6209 security reasons.
6210
Bram Moolenaar677ee682005-01-27 14:41:15 +00006211 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006212'quoteescape' 'qe' string (default "\")
6213 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006214 The characters that are used to escape quotes in a string. Used for
6215 objects like a', a" and a` |a'|.
6216 When one of the characters in this option is found inside a string,
6217 the following character will be skipped. The default value makes the
6218 text "foo\"bar\\" considered to be one string.
6219
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6221'readonly' 'ro' boolean (default off)
6222 local to buffer
6223 If on, writes fail unless you use a '!'. Protects you from
6224 accidentally overwriting a file. Default on when Vim is started
6225 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006226 When using ":w!" the 'readonly' option is reset for the current
6227 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006228 When using the ":view" command the 'readonly' option is set for the
6229 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006230 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006232 *'redrawtime'* *'rdt'*
6233'redrawtime' 'rdt' number (default 2000)
6234 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006235 {only available when compiled with the |+reltime|
6236 feature}
6237 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006238 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006239 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006240 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006241 matches will be highlighted.
6242 For syntax highlighting the time applies per window. When over the
6243 limit syntax highlighting is disabled until |CTRL-L| is used.
6244 This is used to avoid that Vim hangs when using a very complicated
6245 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006246
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006247 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006248'regexpengine' 're' number (default 0)
6249 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006250 This selects the default regexp engine. |two-engines|
6251 The possible values are:
6252 0 automatic selection
6253 1 old engine
6254 2 NFA engine
6255 Note that when using the NFA engine and the pattern contains something
6256 that is not supported the pattern will not match. This is only useful
6257 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006258 Using automatic selection enables Vim to switch the engine, if the
6259 default engine becomes too costly. E.g., when the NFA engine uses too
6260 many states. This should prevent Vim from hanging on a combination of
6261 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006262
Bram Moolenaar64486672010-05-16 15:46:46 +02006263 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6264'relativenumber' 'rnu' boolean (default off)
6265 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006266 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006267 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006268 precede some vertical motion commands (e.g. j k + -) with, without
6269 having to calculate it yourself. Especially useful in combination with
6270 other commands (e.g. y d c < > gq gw =).
6271 When the 'n' option is excluded from 'cpoptions' a wrapped
6272 line will not use the column of line numbers (this is the default when
6273 'compatible' isn't set).
6274 The 'numberwidth' option can be used to set the room used for the line
6275 number.
6276 When a long, wrapped line doesn't start with the first character, '-'
6277 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006278 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6279 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006280
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006281 The number in front of the cursor line also depends on the value of
6282 'number', see |number_relativenumber| for all combinations of the two
6283 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006284
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 *'remap'* *'noremap'*
6286'remap' boolean (default on)
6287 global
6288 Allows for mappings to work recursively. If you do not want this for
6289 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006290 NOTE: To avoid portability problems with Vim scripts, always keep
6291 this option at the default "on". Only switch it off when working with
6292 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006294 *'renderoptions'* *'rop'*
6295'renderoptions' 'rop' string (default: empty)
6296 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006297 {only available when compiled with GUI and DIRECTX on
6298 MS-Windows}
6299 Select a text renderer and set its options. The options depend on the
6300 renderer.
6301
6302 Syntax: >
6303 set rop=type:{renderer}(,{name}:{value})*
6304<
6305 Currently, only one optional renderer is available.
6306
6307 render behavior ~
6308 directx Vim will draw text using DirectX (DirectWrite). It makes
6309 drawn glyphs more beautiful than default GDI.
6310 It requires 'encoding' is "utf-8", and only works on
6311 MS-Windows Vista or newer version.
6312
6313 Options:
6314 name meaning type value ~
6315 gamma gamma float 1.0 - 2.2 (maybe)
6316 contrast enhancedContrast float (unknown)
6317 level clearTypeLevel float (unknown)
6318 geom pixelGeometry int 0 - 2 (see below)
6319 renmode renderingMode int 0 - 6 (see below)
6320 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006321 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006322
Bram Moolenaar92467d32017-12-05 13:22:16 +01006323 See this URL for detail (except for scrlines):
6324 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006325
6326 For geom: structure of a device pixel.
6327 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6328 1 - DWRITE_PIXEL_GEOMETRY_RGB
6329 2 - DWRITE_PIXEL_GEOMETRY_BGR
6330
6331 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006332 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006333
6334 For renmode: method of rendering glyphs.
6335 0 - DWRITE_RENDERING_MODE_DEFAULT
6336 1 - DWRITE_RENDERING_MODE_ALIASED
6337 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6338 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6339 4 - DWRITE_RENDERING_MODE_NATURAL
6340 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6341 6 - DWRITE_RENDERING_MODE_OUTLINE
6342
6343 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006344 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006345
6346 For taamode: antialiasing mode used for drawing text.
6347 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6348 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6349 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6350 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6351
6352 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006353 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6354
Bram Moolenaara338adc2018-01-31 20:51:47 +01006355 For scrlines:
6356 This was used for optimizing scrolling behavior, however this
6357 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006358
6359 Example: >
6360 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006361 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006362 set rop=type:directx
6363<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006364 If select a raster font (Courier, Terminal or FixedSys which
6365 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006366 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006367
6368 NOTE: It is known that some fonts and options combination
6369 causes trouble on drawing glyphs.
6370
Bram Moolenaar92467d32017-12-05 13:22:16 +01006371 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006372 special made fonts (True-Type fonts which includes only
6373 bitmap glyphs).
6374 - 'taamode:3' will not work with some vector fonts.
6375
6376 NOTE: With this option, you can display colored emoji
6377 (emoticon) in Windows 8.1 or later. To display colored emoji,
6378 there are some conditions which you should notice.
6379
6380 - If your font includes non-colored emoji already, it will
6381 be used.
6382 - If your font doesn't have emoji, the system chooses an
6383 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6384 will be used.
6385 - When this alternative font didn't have fixed width glyph,
6386 emoji might be rendered beyond the bounding box of drawing
6387 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006388
6389 Other render types are currently not supported.
6390
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 *'report'*
6392'report' number (default 2)
6393 global
6394 Threshold for reporting number of lines changed. When the number of
6395 changed lines is more than 'report' a message will be given for most
6396 ":" commands. If you want it always, set 'report' to 0.
6397 For the ":substitute" command the number of substitutions is used
6398 instead of the number of lines.
6399
6400 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6401'restorescreen' 'rs' boolean (default on)
6402 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006403 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404 When set, the screen contents is restored when exiting Vim. This also
6405 happens when executing external commands.
6406
6407 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6408 options in your .vimrc. To disable restoring:
6409 set t_ti= t_te=
6410 To enable restoring (for an xterm):
6411 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6412 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6413
6414 *'revins'* *'ri'* *'norevins'* *'nori'*
6415'revins' 'ri' boolean (default off)
6416 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006417 {only available when compiled with the |+rightleft|
6418 feature}
6419 Inserting characters in Insert mode will work backwards. See "typing
6420 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6421 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006422 NOTE: This option is reset when 'compatible' is set.
6423 This option is reset when 'paste' is set and restored when 'paste' is
6424 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425
6426 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6427'rightleft' 'rl' boolean (default off)
6428 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 {only available when compiled with the |+rightleft|
6430 feature}
6431 When on, display orientation becomes right-to-left, i.e., characters
6432 that are stored in the file appear from the right to the left.
6433 Using this option, it is possible to edit files for languages that
6434 are written from the right to the left such as Hebrew and Arabic.
6435 This option is per window, so it is possible to edit mixed files
6436 simultaneously, or to view the same file in both ways (this is
6437 useful whenever you have a mixed text file with both right-to-left
6438 and left-to-right strings so that both sets are displayed properly
6439 in different windows). Also see |rileft.txt|.
6440
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006441 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442'rightleftcmd' 'rlc' string (default "search")
6443 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444 {only available when compiled with the |+rightleft|
6445 feature}
6446 Each word in this option enables the command line editing to work in
6447 right-to-left mode for a group of commands:
6448
6449 search "/" and "?" commands
6450
6451 This is useful for languages such as Hebrew, Arabic and Farsi.
6452 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6453
Bram Moolenaard94464e2015-11-02 15:28:18 +01006454 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006455'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006456 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006457 {only available when compiled with the |+ruby/dyn|
6458 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006459 Specifies the name of the Ruby shared library. The default is
6460 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006461 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006462 This option cannot be set from a |modeline| or in the |sandbox|, for
6463 security reasons.
6464
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006466'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 {not available when compiled without the
6469 |+cmdline_info| feature}
6470 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006471 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006472 text in the file is shown on the far right:
6473 Top first line is visible
6474 Bot last line is visible
6475 All first and last line are visible
6476 45% relative position in the file
6477 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006478 Each window has its own ruler. If a window has a status line, the
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01006479 ruler is shown there. If a window doesn't have a status line and
6480 'cmdheight' is zero, the ruler is not shown. Otherwise it is shown in
6481 the last line of the screen. If the statusline is given by
6482 'statusline' (i.e. not empty), this option takes precedence over
zeertzjq75020942022-07-31 11:37:20 +01006483 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006485 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006486 the text column (byte number) and the screen column are shown,
6487 separated with a dash.
6488 For an empty line "0-1" is shown.
6489 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006490 This option is reset when 'paste' is set and restored when 'paste' is
6491 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492 If you don't want to see the ruler all the time but want to know where
6493 you are, use "g CTRL-G" |g_CTRL-G|.
6494 NOTE: This option is reset when 'compatible' is set.
6495
6496 *'rulerformat'* *'ruf'*
6497'rulerformat' 'ruf' string (default empty)
6498 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006499 {not available when compiled without the |+statusline|
6500 feature}
6501 When this option is not empty, it determines the content of the ruler
6502 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006503 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006504 This option cannot be set in a modeline when 'modelineexpr' is off.
6505
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 The default ruler width is 17 characters. To make the ruler 15
6507 characters wide, put "%15(" at the start and "%)" at the end.
6508 Example: >
6509 :set rulerformat=%15(%c%V\ %p%%%)
6510<
6511 *'runtimepath'* *'rtp'* *vimfiles*
6512'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006513 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514 $VIM/vimfiles,
6515 $VIMRUNTIME,
6516 $VIM/vimfiles/after,
6517 $HOME/.vim/after"
6518 Amiga: "home:vimfiles,
6519 $VIM/vimfiles,
6520 $VIMRUNTIME,
6521 $VIM/vimfiles/after,
6522 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006523 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 $VIM/vimfiles,
6525 $VIMRUNTIME,
6526 $VIM/vimfiles/after,
6527 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006528 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529 $VIMRUNTIME,
6530 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006531 Haiku: "$BE_USER_SETTINGS/vim,
6532 $VIM/vimfiles,
6533 $VIMRUNTIME,
6534 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006535 $BE_USER_SETTINGS/vim/after"
6536 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 $VIM/vimfiles,
6538 $VIMRUNTIME,
6539 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006540 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006542 This is a list of directories which will be searched for runtime
6543 files:
6544 filetype.vim filetypes by file name |new-filetype|
6545 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006546 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006547 colors/ color scheme files |:colorscheme|
6548 compiler/ compiler files |:compiler|
6549 doc/ documentation |write-local-help|
6550 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006551 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006552 indent/ indent scripts |indent-expression|
6553 keymap/ key mapping files |mbyte-keymap|
6554 lang/ menu translations |:menutrans|
6555 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006556 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557 plugin/ plugin scripts |write-plugin|
6558 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006559 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006560 syntax/ syntax files |mysyntaxfile|
6561 tutor/ files for vimtutor |tutor|
6562
6563 And any other file searched for with the |:runtime| command.
6564
6565 The defaults for most systems are setup to search five locations:
6566 1. In your home directory, for your personal preferences.
6567 2. In a system-wide Vim directory, for preferences from the system
6568 administrator.
6569 3. In $VIMRUNTIME, for files distributed with Vim.
6570 *after-directory*
6571 4. In the "after" directory in the system-wide Vim directory. This is
6572 for the system administrator to overrule or add to the distributed
6573 defaults (rarely needed)
6574 5. In the "after" directory in your home directory. This is for
6575 personal preferences to overrule or add to the distributed defaults
6576 or system-wide settings (rarely needed).
6577
Bram Moolenaard0796902016-09-16 20:02:31 +02006578 More entries are added when using |packages|. If it gets very long
6579 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6580 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006581
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6583 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006584 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006585 wildcards.
6586 See |:runtime|.
6587 Example: >
6588 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6589< This will use the directory "~/vimruntime" first (containing your
6590 personal Vim runtime files), then "/mygroup/vim" (shared between a
6591 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6592 files).
6593 You probably should always include $VIMRUNTIME somewhere, to use the
6594 distributed runtime files. You can put a directory before $VIMRUNTIME
6595 to find files which replace a distributed runtime files. You can put
6596 a directory after $VIMRUNTIME to find files which add to distributed
6597 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006598 When Vim is started with |--clean| the home directory entries are not
6599 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600 This option cannot be set from a |modeline| or in the |sandbox|, for
6601 security reasons.
6602
6603 *'scroll'* *'scr'*
6604'scroll' 'scr' number (default: half the window height)
6605 local to window
6606 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6607 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006608 changes. This may happen when enabling the |status-line| or
6609 'tabline' option after setting the 'scroll' option.
6610 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006611 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006612 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613
6614 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6615'scrollbind' 'scb' boolean (default off)
6616 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 See also |scroll-binding|. When this option is set, the current
6618 window scrolls as other scrollbind windows (windows that also have
6619 this option set) scroll. This option is useful for viewing the
6620 differences between two versions of a file, see 'diff'.
6621 See |'scrollopt'| for options that determine how this option should be
6622 interpreted.
6623 This option is mostly reset when splitting a window to edit another
6624 file. This means that ":split | edit file" results in two windows
6625 with scroll-binding, but ":split file" does not.
6626
Bram Moolenaarae20f342019-11-05 21:09:23 +01006627 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6628'scrollfocus' 'scf' boolean (default off)
6629 global
6630 {only for MS-Windows GUI}
6631 When using the scroll wheel and this option is set, the window under
6632 the mouse pointer is scrolled. With this option off the current
6633 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006634 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006635
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636 *'scrolljump'* *'sj'*
6637'scrolljump' 'sj' number (default 1)
6638 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 Minimal number of lines to scroll when the cursor gets off the
6640 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6641 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006642 When set to a negative number from -1 to -100 this is used as the
6643 percentage of the window height. Thus -50 scrolls half the window
6644 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006645 NOTE: This option is set to 1 when 'compatible' is set.
6646
6647 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006648'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006649 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006650 Minimal number of screen lines to keep above and below the cursor.
6651 This will make some context visible around where you are working. If
6652 you set it to a very large value (999) the cursor line will always be
6653 in the middle of the window (except at the start or end of the file or
6654 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006655 After using the local value, go back the global value with one of
6656 these two: >
6657 setlocal scrolloff<
6658 setlocal scrolloff=-1
6659< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660 NOTE: This option is set to 0 when 'compatible' is set.
6661
6662 *'scrollopt'* *'sbo'*
6663'scrollopt' 'sbo' string (default "ver,jump")
6664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006666 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6667 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 The following words are available:
6669 ver Bind vertical scrolling for 'scrollbind' windows
6670 hor Bind horizontal scrolling for 'scrollbind' windows
6671 jump Applies to the offset between two windows for vertical
6672 scrolling. This offset is the difference in the first
6673 displayed line of the bound windows. When moving
6674 around in a window, another 'scrollbind' window may
6675 reach a position before the start or after the end of
6676 the buffer. The offset is not changed though, when
6677 moving back the 'scrollbind' window will try to scroll
6678 to the desired position when possible.
6679 When now making that window the current one, two
6680 things can be done with the relative offset:
6681 1. When "jump" is not included, the relative offset is
6682 adjusted for the scroll position in the new current
6683 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006684 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 2. When "jump" is included, the other windows are
6686 scrolled to keep the same relative offset. When
6687 going back to the other window, it still uses the
6688 same relative offset.
6689 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006690 When 'diff' mode is active there always is vertical scroll binding,
6691 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692
6693 *'sections'* *'sect'*
6694'sections' 'sect' string (default "SHNHH HUnhsh")
6695 global
6696 Specifies the nroff macros that separate sections. These are pairs of
6697 two letters (See |object-motions|). The default makes a section start
6698 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6699
6700 *'secure'* *'nosecure'* *E523*
6701'secure' boolean (default off)
6702 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006703 When on, ":autocmd", shell and write commands are not allowed in
6704 ".vimrc" and ".exrc" in the current directory and map commands are
6705 displayed. Switch it off only if you know that you will not run into
6706 problems, or when the 'exrc' option is off. On Unix this option is
6707 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006708 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 'secure' at the end of your ~/.vimrc then.
6710 This option cannot be set from a |modeline| or in the |sandbox|, for
6711 security reasons.
6712
6713 *'selection'* *'sel'*
6714'selection' 'sel' string (default "inclusive")
6715 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716 This option defines the behavior of the selection. It is only used
6717 in Visual and Select mode.
6718 Possible values:
6719 value past line inclusive ~
6720 old no yes
6721 inclusive yes yes
6722 exclusive yes no
6723 "past line" means that the cursor is allowed to be positioned one
6724 character past the line.
6725 "inclusive" means that the last character of the selection is included
6726 in an operation. For example, when "x" is used to delete the
6727 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006728 When "old" is used and 'virtualedit' allows the cursor to move past
6729 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 Note that when "exclusive" is used and selecting from the end
6731 backwards, you cannot include the last character of a line, when
6732 starting in Normal mode and 'virtualedit' empty.
6733
6734 The 'selection' option is set by the |:behave| command.
6735
6736 *'selectmode'* *'slm'*
6737'selectmode' 'slm' string (default "")
6738 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006739 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 Select mode instead of Visual mode, when a selection is started.
6741 Possible values:
6742 mouse when using the mouse
6743 key when using shifted special keys
6744 cmd when using "v", "V" or CTRL-V
6745 See |Select-mode|.
6746 The 'selectmode' option is set by the |:behave| command.
6747
6748 *'sessionoptions'* *'ssop'*
6749'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006750 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006752 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 feature}
6754 Changes the effect of the |:mksession| command. It is a comma
6755 separated list of words. Each word enables saving and restoring
6756 something:
6757 word save and restore ~
6758 blank empty windows
6759 buffers hidden and unloaded buffers, not just those in windows
6760 curdir the current directory
6761 folds manually created folds, opened/closed folds and local
6762 fold options
6763 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006764 and contain at least one lowercase letter. Only
6765 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766 help the help window
6767 localoptions options and mappings local to a window or buffer (not
6768 global values for local options)
6769 options all options and mappings (also global values for local
6770 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006771 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 resize size of the Vim window: 'lines' and 'columns'
6773 sesdir the directory in which the session file is located
6774 will become the current directory (useful with
6775 projects accessed over a network from different
6776 systems)
6777 slash backslashes in file names replaced with forward
6778 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006779 tabpages all tab pages; without this only the current tab page
6780 is restored, so that you can make a session for each
6781 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006782 terminal include terminal windows where the command can be
6783 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 unix with Unix end-of-line format (single <NL>), even when
6785 on Windows or DOS
6786 winpos position of the whole Vim window
6787 winsize window sizes
6788
6789 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006790 When neither "curdir" nor "sesdir" is included, file names are stored
6791 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006792 If you leave out "options" many things won't work well after restoring
6793 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794 "slash" and "unix" are useful on Windows when sharing session files
6795 with Unix. The Unix version of Vim cannot source dos format scripts,
6796 but the Windows version of Vim can source unix format scripts.
6797
6798 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006799'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800 global
6801 Name of the shell to use for ! and :! commands. When changing the
6802 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6803 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006804 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 See |option-backslash| about including spaces and backslashes.
6806 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006807
Bram Moolenaara2baa732022-02-04 16:09:54 +00006808 In |restricted-mode| shell commands will not be possible. This mode
6809 is used if the value of $SHELL ends in "false" or "nologin".
6810
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006811 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006812 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6814< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006815 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006817 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006819 Example with escaped space (Vim will do this when initializing the
6820 option from $SHELL): >
6821 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006822< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006823 backslashes are consumed by `:set`.
6824
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825 Under MS-Windows, when the executable ends in ".com" it must be
6826 included. Thus setting the shell to "command.com" or "4dos.com"
6827 works, but "command" and "4dos" do not work for all commands (e.g.,
6828 filtering).
6829 For unknown reasons, when using "4dos.com" the current directory is
6830 changed to "C:\". To avoid this set 'shell' like this: >
6831 :set shell=command.com\ /c\ 4dos
6832< This option cannot be set from a |modeline| or in the |sandbox|, for
6833 security reasons.
6834
6835 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006836'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006837 Win32, when 'shell' contains "powershell":
6838 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006839 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006842 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6843 For MS-Windows, the default is set according to the value of 'shell',
6844 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006845 On Unix it can have more than one flag. Each white space separated
6846 part is passed as an argument to the shell command.
6847 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006848 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006849 This option cannot be set from a |modeline| or in the |sandbox|, for
6850 security reasons.
6851
6852 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006853'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6854 "2>&1| tee", or
6855 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006857 {not available when compiled without the |+quickfix|
6858 feature}
6859 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006860 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006861 including spaces and backslashes.
6862 The name of the temporary file can be represented by "%s" if necessary
6863 (the file name is appended automatically if no %s appears in the value
6864 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006865 For the Amiga the default is ">". For MS-Windows using powershell the
6866 default is "2>&1 | Out-File -Encoding default", otherwise the default
6867 is ">%s 2>&1". The output is directly saved in a file and not echoed
6868 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006869 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006870 in a file and echoed to the screen. If the 'shell' option is "csh" or
6871 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006872 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006873 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6874 means that stderr is also included. Before using the 'shell' option a
6875 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006876 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6877 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878 The initialization of this option is done after reading the ".vimrc"
6879 and the other initializations, so that when the 'shell' option is set
6880 there, the 'shellpipe' option changes automatically, unless it was
6881 explicitly set before.
6882 When 'shellpipe' is set to an empty string, no redirection of the
6883 ":make" output will be done. This is useful if you use a 'makeprg'
6884 that writes to 'makeef' by itself. If you want no piping, but do
6885 want to include the 'makeef', set 'shellpipe' to a single space.
6886 Don't forget to precede the space with a backslash: ":set sp=\ ".
6887 In the future pipes may be used for filtering and this option will
6888 become obsolete (at least for Unix).
6889 This option cannot be set from a |modeline| or in the |sandbox|, for
6890 security reasons.
6891
6892 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006893'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 Quoting character(s), put around the command passed to the shell, for
6896 the "!" and ":!" commands. The redirection is kept outside of the
6897 quoting. See 'shellxquote' to include the redirection. It's
6898 probably not useful to set both options.
6899 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006900 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006901 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 This option cannot be set from a |modeline| or in the |sandbox|, for
6903 security reasons.
6904
6905 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006906'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6907 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006909 String to be used to put the output of a filter command in a temporary
6910 file. See also |:!|. See |option-backslash| about including spaces
6911 and backslashes.
6912 The name of the temporary file can be represented by "%s" if necessary
6913 (the file name is appended automatically if no %s appears in the value
6914 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006915 The default is ">". For Unix, if the 'shell' option is "csh" or
6916 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006917 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006918 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6919 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006920 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6921 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006922 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6923 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006924 The initialization of this option is done after reading the ".vimrc"
6925 and the other initializations, so that when the 'shell' option is set
6926 there, the 'shellredir' option changes automatically unless it was
6927 explicitly set before.
6928 In the future pipes may be used for filtering and this option will
6929 become obsolete (at least for Unix).
6930 This option cannot be set from a |modeline| or in the |sandbox|, for
6931 security reasons.
6932
6933 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6934'shellslash' 'ssl' boolean (default off)
6935 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006936 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006938 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006939 powershell.exe. Backward slashes can still be typed, but they are
6940 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941 Note that setting or resetting this option has no effect for some
6942 existing file names, thus this option needs to be set before opening
6943 any file for best results. This might change in the future.
6944 'shellslash' only works when a backslash can be used as a path
6945 separator. To test if this is so use: >
6946 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006947< Also see 'completeslash'.
6948
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006949 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6950'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6951 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006952 When on, use temp files for shell commands. When off use a pipe.
6953 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006954 Currently a pipe is only supported on Unix and MS-Windows 2K and
6955 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006956 :if has("filterpipe")
6957< The advantage of using a pipe is that nobody can read the temp file
6958 and the 'shell' command does not need to support redirection.
6959 The advantage of using a temp file is that the file type and encoding
6960 can be detected.
6961 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6962 |FilterWritePost| autocommands event are not triggered when
6963 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006964 The `system()` function does not respect this option and always uses
6965 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006966 NOTE: This option is set to the Vim default value when 'compatible'
6967 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006968
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 *'shelltype'* *'st'*
6970'shelltype' 'st' number (default 0)
6971 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006972 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 On the Amiga this option influences the way how the commands work
6974 which use a shell.
6975 0 and 1: always use the shell
6976 2 and 3: use the shell only to filter lines
6977 4 and 5: use shell only for ':sh' command
6978 When not using the shell, the command is executed directly.
6979
6980 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6981 1 and 3: use "shell cmd" to start external commands
6982
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006983 *'shellxescape'* *'sxe'*
6984'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006985 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006986 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006987 When 'shellxquote' is set to "(" then the characters listed in this
6988 option will be escaped with a '^' character. This makes it possible
6989 to execute most external commands with cmd.exe.
6990
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991 *'shellxquote'* *'sxq'*
6992'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006993 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006994 for Win32, when 'shell' is
6995 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006996 for Win32, when 'shell' contains "sh"
6997 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006998 for Unix, when using system(): "\"")
6999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 Quoting character(s), put around the command passed to the shell, for
7001 the "!" and ":!" commands. Includes the redirection. See
7002 'shellquote' to exclude the redirection. It's probably not useful
7003 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007004 When the value is '(' then ')' is appended. When the value is '"('
7005 then ')"' is appended.
7006 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007007 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007008 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7009 pwsh.exe which automatically strips off the first and last quote on a
7010 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7011 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007012 'shell', to reduce the need to set this option by the user. See
7013 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 This option cannot be set from a |modeline| or in the |sandbox|, for
7015 security reasons.
7016
7017 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7018'shiftround' 'sr' boolean (default off)
7019 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 Round indent to multiple of 'shiftwidth'. Applies to > and <
7021 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7022 a multiple of 'shiftwidth' (this is Vi compatible).
7023 NOTE: This option is reset when 'compatible' is set.
7024
7025 *'shiftwidth'* *'sw'*
7026'shiftwidth' 'sw' number (default 8)
7027 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007028 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007030 When zero the 'ts' value will be used. Use the |shiftwidth()|
7031 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032
7033 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007034'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7035 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007036 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007037 This option helps to avoid all the |hit-enter| prompts caused by file
7038 messages, for example with CTRL-G, and to avoid some other messages.
7039 It is a list of flags:
7040 flag meaning when present ~
7041 f use "(3 of 5)" instead of "(file 3 of 5)"
7042 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02007043 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 m use "[+]" instead of "[Modified]"
7045 n use "[New]" instead of "[New File]"
7046 r use "[RO]" instead of "[readonly]"
7047 w use "[w]" instead of "written" for file write message
7048 and "[a]" instead of "appended" for ':w >> file' command
7049 x use "[dos]" instead of "[dos format]", "[unix]" instead of
7050 "[unix format]" and "[mac]" instead of "[mac format]".
7051 a all of the above abbreviations
7052
7053 o overwrite message for writing a file with subsequent message
7054 for reading a file (useful for ":wn" or when 'autowrite' on)
7055 O message for reading a file overwrites any previous message.
7056 Also for quickfix message (e.g., ":cn").
7057 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02007058 hit TOP, continuing at BOTTOM" messages; when using the search
7059 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 t truncate file message at the start if it is too long to fit
7061 on the command-line, "<" will appear in the left most column.
7062 Ignored in Ex mode.
7063 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00007064 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007065 Ignored in Ex mode.
7066 W don't give "written" or "[w]" when writing a file
7067 A don't give the "ATTENTION" message when an existing swap file
7068 is found.
7069 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02007070 c don't give |ins-completion-menu| messages. For example,
7071 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
7072 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01007073 q use "recording" instead of "recording @a"
7074 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02007075 was used for the command; note that this also affects messages
7076 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007077 S do not show search count message when searching, e.g.
7078 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079
7080 This gives you the opportunity to avoid that a change between buffers
7081 requires you to hit <Enter>, but still gives as useful a message as
7082 possible for the space available. To get the whole message that you
7083 would have got with 'shm' empty, use ":file!"
7084 Useful values:
7085 shm= No abbreviation of message.
7086 shm=a Abbreviation, but no loss of information.
7087 shm=at Abbreviation, and truncate message when necessary.
7088
7089 NOTE: This option is set to the Vi default value when 'compatible' is
7090 set and to the Vim default value when 'compatible' is reset.
7091
7092 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7093'shortname' 'sn' boolean (default off)
7094 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 Filenames are assumed to be 8 characters plus one extension of 3
7096 characters. Multiple dots in file names are not allowed. When this
7097 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007098 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007100 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007101
7102 *'showbreak'* *'sbr'* *E595*
7103'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007104 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007105 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106 feature}
7107 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007108 values are "> " or "+++ ": >
7109 :set showbreak=>\
7110< Note the backslash to escape the trailing space. It's easier like
7111 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007112 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007113< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 comma (in a future version the comma might be used to separate the
7115 part that is shown at the end and at the start of a line).
7116 The characters are highlighted according to the '@' flag in
7117 'highlight'.
7118 Note that tabs after the showbreak will be displayed differently.
7119 If you want the 'showbreak' to appear in between line numbers, add the
7120 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007121 A window-local value overrules a global value. If the global value is
7122 set and you want no value in the current window use NONE: >
7123 :setlocal showbreak=NONE
7124<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007126'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7127 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 {not available when compiled without the
7130 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007131 Show (partial) command in the last line of the screen. Set this
7132 option off if your terminal is slow.
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01007133 The option has no effect when 'cmdheight' is zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 In Visual mode the size of the selected area is shown:
7135 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007136 If the number of bytes is different it is also displayed: "2-6"
7137 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007139 - When selecting a block, the size in screen characters:
7140 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 NOTE: This option is set to the Vi default value when 'compatible' is
7142 set and to the Vim default value when 'compatible' is reset.
7143
7144 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7145'showfulltag' 'sft' boolean (default off)
7146 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 When completing a word in insert mode (see |ins-completion|) from the
7148 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007149 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007150 matched a C function, you can see a template for what arguments are
7151 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007152 Note that this doesn't work well together with having "longest" in
7153 'completeopt', because the completion from the search pattern may not
7154 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007155
7156 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7157'showmatch' 'sm' boolean (default off)
7158 global
7159 When a bracket is inserted, briefly jump to the matching one. The
7160 jump is only done if the match can be seen on the screen. The time to
7161 show the match can be set with 'matchtime'.
7162 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007163 seen or not).
7164 This option is reset when 'paste' is set and restored when 'paste' is
7165 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 When the 'm' flag is not included in 'cpoptions', typing a character
7167 will immediately move the cursor back to where it belongs.
7168 See the "sm" field in 'guicursor' for setting the cursor shape and
7169 blinking when showing the match.
7170 The 'matchpairs' option can be used to specify the characters to show
7171 matches for. 'rightleft' and 'revins' are used to look for opposite
7172 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007173 Also see the matchparen plugin for highlighting the match when moving
7174 around |pi_paren.txt|.
7175 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007176
7177 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7178'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7179 global
7180 If in Insert, Replace or Visual mode put a message on the last line.
7181 Use the 'M' flag in 'highlight' to set the type of highlighting for
7182 this message.
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01007183 The option has no effect when 'cmdheight' is zero.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007184 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185 doesn't mean XIM is really active, especially when 'imactivatekey' is
7186 not set.
7187 NOTE: This option is set to the Vi default value when 'compatible' is
7188 set and to the Vim default value when 'compatible' is reset.
7189
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007190 *'showtabline'* *'stal'*
7191'showtabline' 'stal' number (default 1)
7192 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007193 The value of this option specifies when the line with tab page labels
7194 will be displayed:
7195 0: never
7196 1: only if there are at least two tab pages
7197 2: always
7198 This is both for the GUI and non-GUI implementation of the tab pages
7199 line.
7200 See |tab-page| for more information about tab pages.
7201
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 *'sidescroll'* *'ss'*
7203'sidescroll' 'ss' number (default 0)
7204 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007205 The minimal number of columns to scroll horizontally. Used only when
7206 the 'wrap' option is off and the cursor is moved off of the screen.
7207 When it is zero the cursor will be put in the middle of the screen.
7208 When using a slow terminal set it to a large number or 0. When using
7209 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7210 commands.
7211
7212 *'sidescrolloff'* *'siso'*
7213'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007214 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007216 right of the cursor if 'nowrap' is set. Setting this option to a
7217 value greater than 0 while having |'sidescroll'| also at a non-zero
7218 value makes some context visible in the line you are scrolling in
7219 horizontally (except at beginning of the line). Setting this option
7220 to a large value (like 999) has the effect of keeping the cursor
7221 horizontally centered in the window, as long as one does not come too
7222 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007223 After using the local value, go back the global value with one of
7224 these two: >
7225 setlocal sidescrolloff<
7226 setlocal sidescrolloff=-1
7227< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228
7229 Example: Try this together with 'sidescroll' and 'listchars' as
7230 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007231 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232
7233 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7234 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007235<
7236 *'signcolumn'* *'scl'*
7237'signcolumn' 'scl' string (default "auto")
7238 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007239 {not available when compiled without the |+signs|
7240 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007241 Whether or not to draw the signcolumn. Valid values are:
7242 "auto" only when there is a sign to display
7243 "no" never
7244 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007245 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007246 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247
7248
7249 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7250'smartcase' 'scs' boolean (default off)
7251 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 Override the 'ignorecase' option if the search pattern contains upper
7253 case characters. Only used when the search pattern is typed and
7254 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007255 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007256 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7257 recalling the search pattern from history and hitting <Enter>.
7258 NOTE: This option is reset when 'compatible' is set.
7259
7260 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7261'smartindent' 'si' boolean (default off)
7262 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007263 Do smart autoindenting when starting a new line. Works for C-like
7264 programs, but can also be used for other languages. 'cindent' does
7265 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007266 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007267 setting 'si' has no effect. 'indentexpr' is a more advanced
7268 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 Normally 'autoindent' should also be on when using 'smartindent'.
7270 An indent is automatically inserted:
7271 - After a line ending in '{'.
7272 - After a line starting with a keyword from 'cinwords'.
7273 - Before a line starting with '}' (only with the "O" command).
7274 When typing '}' as the first character in a new line, that line is
7275 given the same indent as the matching '{'.
7276 When typing '#' as the first character in a new line, the indent for
7277 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007278 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7280 When using the ">>" command, lines starting with '#' are not shifted
7281 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007282 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007283 This option is reset when 'paste' is set and restored when 'paste' is
7284 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285
7286 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7287'smarttab' 'sta' boolean (default off)
7288 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007289 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007290 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7291 <BS> will delete a 'shiftwidth' worth of space at the start of the
7292 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007293 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007294 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7295 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007296 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007298 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007299 This option is reset when 'paste' is set and restored when 'paste' is
7300 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007301 NOTE: This option is reset when 'compatible' is set.
7302
7303 *'softtabstop'* *'sts'*
7304'softtabstop' 'sts' number (default 0)
7305 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306 Number of spaces that a <Tab> counts for while performing editing
7307 operations, like inserting a <Tab> or using <BS>. It "feels" like
7308 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7309 used. This is useful to keep the 'ts' setting at its standard value
7310 of 8, while being able to edit like it is set to 'sts'. However,
7311 commands like "x" still work on the actual characters.
7312 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007313 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007314 'softtabstop' is set to 0 when the 'paste' option is set and restored
7315 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7317 spaces is minimized by using <Tab>s.
7318 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7319 set.
7320 NOTE: This option is set to 0 when 'compatible' is set.
7321
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007322 If Vim is compiled with the |+vartabs| feature then the value of
7323 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7324 anything other than an empty string.
7325
Bram Moolenaar217ad922005-03-20 22:37:15 +00007326 *'spell'* *'nospell'*
7327'spell' boolean (default off)
7328 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007329 {not available when compiled without the |+syntax|
7330 feature}
7331 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007332 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007333
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007334 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007335'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007336 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007337 {not available when compiled without the |+syntax|
7338 feature}
7339 Pattern to locate the end of a sentence. The following word will be
7340 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007341 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007342 When this check is not wanted make this option empty.
7343 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007344 Be careful with special characters, see |option-backslash| about
7345 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007346 To set this option automatically depending on the language, see
7347 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007348
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007349 *'spellfile'* *'spf'*
7350'spellfile' 'spf' string (default empty)
7351 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007352 {not available when compiled without the |+syntax|
7353 feature}
7354 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007355 commands. It must end in ".{encoding}.add". You need to include the
7356 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007357 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007358 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007359 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007360 |zg| and |zw| commands can be used to access each. This allows using
7361 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007362 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007363 you: Using the first directory in 'runtimepath' that is writable. If
7364 there is no "spell" directory yet it will be created. For the file
7365 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007366 ignoring the region.
7367 The resulting ".spl" file will be used for spell checking, it does not
7368 have to appear in 'spelllang'.
7369 Normally one file is used for all regions, but you can add the region
7370 name if you want to. However, it will then only be used when
7371 'spellfile' is set to it, for entries in 'spelllang' only files
7372 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007373 This option cannot be set from a |modeline| or in the |sandbox|, for
7374 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007375
Bram Moolenaar217ad922005-03-20 22:37:15 +00007376 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007377'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007378 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007379 {not available when compiled without the |+syntax|
7380 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007381 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007382 on spellchecking will be done for these languages. Example: >
7383 set spelllang=en_us,nl,medical
7384< This means US English, Dutch and medical words are recognized. Words
7385 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007386 The word list name must consist of alphanumeric characters, a dash or
7387 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007388 recommended to separate the two letter language name from a
7389 specification. Thus "en-rare" is used for rare English words.
7390 A region name must come last and have the form "_xx", where "xx" is
7391 the two-letter, lower case region name. You can use more than one
7392 region by listing them: "en_us,en_ca" supports both US and Canadian
7393 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007394 Britain. (Note: currently en_au and en_nz dictionaries are older than
7395 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007396 If the name "cjk" is included East Asian characters are excluded from
7397 spell checking. This is useful when editing text that also has Asian
7398 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007399 Note that the "medical" dictionary does not exist, it is just an
7400 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007401 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007402 As a special case the name of a .spl file can be given as-is. The
7403 first "_xx" in the name is removed and used as the region name
7404 (_xx is an underscore, two letters and followed by a non-letter).
7405 This is mainly for testing purposes. You must make sure the correct
7406 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007407 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007408 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7409 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007410 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007411
Bram Moolenaar98692072006-02-04 00:57:42 +00007412 If the |spellfile.vim| plugin is active and you use a language name
7413 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7414 will ask you if you want to download the file.
7415
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007416 After this option has been set successfully, Vim will source the files
7417 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007418 up to the first character that is not an ASCII letter or number and
7419 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007420
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007421 *'spelloptions'* *'spo'*
7422'spelloptions' 'spo' string (default "")
7423 local to buffer
7424 {not available when compiled without the |+syntax|
7425 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007426 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007427 camel When a word is CamelCased, assume "Cased" is a
7428 separate word: every upper-case character in a word
7429 that comes after a lower case character indicates the
7430 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007431
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007432 *'spellsuggest'* *'sps'*
7433'spellsuggest' 'sps' string (default "best")
7434 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007435 {not available when compiled without the |+syntax|
7436 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007437 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007438 the |spellsuggest()| function. This is a comma-separated list of
7439 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007440
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007441 best Internal method that works best for English. Finds
7442 changes like "fast" and uses a bit of sound-a-like
7443 scoring to improve the ordering.
7444
7445 double Internal method that uses two methods and mixes the
7446 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007447 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007448 word. That only works when the language specifies
7449 sound folding. Can be slow and doesn't always give
7450 better results.
7451
7452 fast Internal method that only checks for simple changes:
7453 character inserts/deletes/swaps. Works well for
7454 simple typing mistakes.
7455
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007456 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007457 Not used for |spellsuggest()|. The number of
7458 suggestions is never more than the value of 'lines'
7459 minus two.
7460
Bram Moolenaar585ee072022-01-29 11:22:17 +00007461 timeout:{millisec} Limit the time searching for suggestions to
7462 {millisec} milli seconds. Applies to the following
7463 methods. When omitted the limit is 5000. When
7464 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007465 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007466
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007467 file:{filename} Read file {filename}, which must have two columns,
7468 separated by a slash. The first column contains the
7469 bad word, the second column the suggested good word.
7470 Example:
7471 theribal/terrible ~
7472 Use this for common mistakes that do not appear at the
7473 top of the suggestion list with the internal methods.
7474 Lines without a slash are ignored, use this for
7475 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007476 The word in the second column must be correct,
7477 otherwise it will not be used. Add the word to an
7478 ".add" file if it is currently flagged as a spelling
7479 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007480 The file is used for all languages.
7481
7482 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7483 trouble with spaces. |v:val| holds the badly spelled
7484 word. The expression must evaluate to a List of
7485 Lists, each with a suggestion and a score.
7486 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007487 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007488 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007489 internal methods use. A lower score is better.
7490 This may invoke |spellsuggest()| if you temporarily
7491 set 'spellsuggest' to exclude the "expr:" part.
7492 Errors are silently ignored, unless you set the
7493 'verbose' option to a non-zero value.
7494
7495 Only one of "best", "double" or "fast" may be used. The others may
7496 appear several times in any order. Example: >
7497 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7498<
7499 This option cannot be set from a |modeline| or in the |sandbox|, for
7500 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007501
7502
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7504'splitbelow' 'sb' boolean (default off)
7505 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007506 When on, splitting a window will put the new window below the current
7507 one. |:split|
7508
7509 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7510'splitright' 'spr' boolean (default off)
7511 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007512 When on, splitting a window will put the new window right of the
7513 current one. |:vsplit|
7514
7515 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7516'startofline' 'sol' boolean (default on)
7517 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007519 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007520 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007521 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 with a linewise operator, with "%" with a count and to buffer changing
7523 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7524 only has a line number, e.g., ":25" or ":+".
7525 In case of buffer changing commands the cursor is placed at the column
7526 where it was the last time the buffer was edited.
7527 NOTE: This option is set when 'compatible' is set.
7528
Bram Moolenaar00654022011-02-25 14:42:19 +01007529 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007530'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007531 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532 {not available when compiled without the |+statusline|
7533 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007534 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535 Also see |status-line|.
7536
7537 The option consists of printf style '%' items interspersed with
7538 normal text. Each status line item is of the form:
7539 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007540 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007541 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542
Bram Moolenaar238a5642006-02-21 22:12:05 +00007543 When the option starts with "%!" then it is used as an expression,
7544 evaluated and the result is used as the option value. Example: >
7545 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007546< The *g:statusline_winid* variable will be set to the |window-ID| of the
7547 window that the status line belongs to.
7548 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007549 Note that the "%!" expression is evaluated in the context of the
7550 current window and buffer, while %{} items are evaluated in the
7551 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007552
7553 When there is error while evaluating the option then it will be made
7554 empty to avoid further errors. Otherwise screen updating would loop.
7555
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556 Note that the only effect of 'ruler' when this option is set (and
7557 'laststatus' is 2) is controlling the output of |CTRL-G|.
7558
7559 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007560 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007561 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007562 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007563 minwid Minimum width of the item, padding as set by '-' & '0'.
7564 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007565 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 on the left for text items. Numeric items will be
7567 shifted down to maxwid-2 digits followed by '>'number
7568 where number is the amount of missing digits, much like
7569 an exponential notation.
7570 item A one letter code as described below.
7571
7572 Following is a description of the possible statusline items. The
7573 second character in "item" is the type:
7574 N for number
7575 S for string
7576 F for flags as described below
7577 - not applicable
7578
7579 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007580 f S Path to the file in the buffer, as typed or relative to current
7581 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 F S Full path to the file in the buffer.
7583 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007584 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007585 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007586 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007588 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007590 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007592 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007593 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007594 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7596 being used: "<keymap>"
7597 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007598 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 B N As above, in hexadecimal.
7600 o N Byte number in file of byte under cursor, first byte is 1.
7601 Mnemonic: Offset from start of file (with one added)
7602 {not available when compiled without |+byte_offset| feature}
7603 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007604 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007605 l N Line number.
7606 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007607 c N Column number (byte index).
7608 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007609 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007610 p N Percentage through file in lines as in |CTRL-G|.
7611 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007612 percentage described for 'ruler'. Always 3 in length, unless
7613 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007614 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007615 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007616 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007617 Note that there is no '%' before the closing '}'. The
7618 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007619 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007620 {% - This is almost same as { except the result of the expression is
7621 re-evaluated as a statusline format string. Thus if the
7622 return value of expr contains % items they will get expanded.
7623 The expression can contain the } character, the end of
7624 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007625 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007626 func! Stl_filename() abort
7627 return "%t"
7628 endfunc
7629< `stl=%{Stl_filename()}` results in `"%t"`
7630 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007631 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632 ( - Start of item group. Can be used for setting the width and
7633 alignment of a section. Must be followed by %) somewhere.
7634 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007635 T N For 'tabline': start of tab page N label. Use %T after the last
7636 label. This information is used for mouse clicks.
7637 X N For 'tabline': start of close tab N label. Use %X after the
7638 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7639 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640 < - Where to truncate line if too long. Default is at the start.
7641 No width fields allowed.
7642 = - Separation point between left and right aligned items.
7643 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007644 # - Set highlight group. The name must follow and then a # again.
7645 Thus use %#HLname# for highlight group HLname. The same
7646 highlighting is used, also for the statusline of non-current
7647 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007649 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650 The difference between User{N} and StatusLine will be applied
7651 to StatusLineNC for the statusline of non-current windows.
7652 The number N must be between 1 and 9. See |hl-User1..9|
7653
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007654 When displaying a flag, Vim removes the leading comma, if any, when
7655 that flag comes right after plaintext. This will make a nice display
7656 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007657
Bram Moolenaar582fd852005-03-28 20:58:01 +00007658 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007659 not set) and a minwid is not set for the group, the whole group will
7660 become empty. This will make a group like the following disappear
7661 completely from the statusline when none of the flags are set. >
7662 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007663< Beware that an expression is evaluated each and every time the status
7664 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007665 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007666 While evaluating %{} the current buffer and current window will be set
7667 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007668 currently being drawn. The expression will evaluate in this context.
7669 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7670 real current buffer and "g:actual_curwin" to the |window-ID| of the
7671 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007672
Bram Moolenaar30b65812012-07-12 22:01:11 +02007673 The 'statusline' option will be evaluated in the |sandbox| if set from
7674 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007675 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007676
7677 It is not allowed to change text or jump to another window while
7678 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007679
7680 If the statusline is not updated when you want it (e.g., after setting
7681 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007682 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007683
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007684 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007685 Otherwise the result is taken as flag text and applied to the rules
7686 described above.
7687
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007688 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007689 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007690 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007691
7692 Examples:
7693 Emulate standard status line with 'ruler' set >
7694 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7695< Similar, but add ASCII value of char under the cursor (like "ga") >
7696 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7697< Display byte count and byte value, modified flag in red. >
7698 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7699 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7700< Display a ,GZ flag if a compressed file is loaded >
7701 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7702< In the |:autocmd|'s: >
7703 :let b:gzflag = 1
7704< And: >
7705 :unlet b:gzflag
7706< And define this function: >
7707 :function VarExists(var, val)
7708 : if exists(a:var) | return a:val | else | return '' | endif
7709 :endfunction
7710<
7711 *'suffixes'* *'su'*
7712'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7713 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007714 Files with these suffixes get a lower priority when multiple files
7715 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007716 suffixes. Spaces after the comma are ignored. A dot is also seen as
7717 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007718 separator, precede it with a backslash (see |option-backslash| about
7719 including spaces and backslashes).
7720 See 'wildignore' for completely ignoring files.
7721 The use of |:set+=| and |:set-=| is preferred when adding or removing
7722 suffixes from the list. This avoids problems when a future version
7723 uses another default.
7724
7725 *'suffixesadd'* *'sua'*
7726'suffixesadd' 'sua' string (default "")
7727 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007728 {not available when compiled without the
7729 |+file_in_path| feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007730 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007731 file for the "gf", "[I", etc. commands. Example: >
7732 :set suffixesadd=.java
7733<
7734 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7735'swapfile' 'swf' boolean (default on)
7736 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007737 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007738 swapfile is not wanted for a specific buffer. For example, with
7739 confidential information that even root must not be able to access.
7740 Careful: All text will be in memory:
7741 - Don't use this for big files.
7742 - Recovery will be impossible!
7743 A swapfile will only be present when |'updatecount'| is non-zero and
7744 'swapfile' is set.
7745 When 'swapfile' is reset, the swap file for the current buffer is
7746 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7747 non-zero, a swap file is immediately created.
7748 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007749 If you want to open a new buffer without creating a swap file for it,
7750 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007751 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752
7753 This option is used together with 'bufhidden' and 'buftype' to
7754 specify special kinds of buffers. See |special-buffers|.
7755
7756 *'swapsync'* *'sws'*
7757'swapsync' 'sws' string (default "fsync")
7758 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007759 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007760 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007761 When this option is empty parts of the swap file may be in memory and
7762 not written to disk. When the system crashes you may lose more work.
7763 On Unix the system does a sync now and then without Vim asking for it,
7764 so the disadvantage of setting this option off is small. On some
7765 systems the swap file will not be written at all. For a unix system
7766 setting it to "sync" will use the sync() call instead of the default
7767 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007768 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007769
7770 *'switchbuf'* *'swb'*
7771'switchbuf' 'swb' string (default "")
7772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007773 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007774 Mostly for |quickfix| commands some values are also used for other
7775 commands, as mentioned below.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007776 Possible values (comma-separated list):
Bram Moolenaar071d4272004-06-13 20:20:40 +00007777 useopen If included, jump to the first open window that
7778 contains the specified buffer (if there is one).
7779 Otherwise: Do not examine other windows.
7780 This setting is checked with |quickfix| commands, when
7781 jumping to errors (":cc", ":cn", "cp", etc.). It is
7782 also used in all buffer related split commands, for
7783 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007784 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007785 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007786 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007787 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007788 Otherwise: do not split, use current window (when used
7789 in the quickfix window: the previously used window or
7790 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007791 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007792 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007793 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007794 uselast If included, jump to the previously used window when
7795 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007796
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007797 *'synmaxcol'* *'smc'*
7798'synmaxcol' 'smc' number (default 3000)
7799 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007800 {not available when compiled without the |+syntax|
7801 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007802 Maximum column in which to search for syntax items. In long lines the
7803 text after this column is not highlighted and following lines may not
7804 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007805 This helps to avoid very slow redrawing for an XML file that is one
7806 long line.
7807 Set to zero to remove the limit.
7808
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809 *'syntax'* *'syn'*
7810'syntax' 'syn' string (default empty)
7811 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812 {not available when compiled without the |+syntax|
7813 feature}
7814 When this option is set, the syntax with this name is loaded, unless
7815 syntax highlighting has been switched off with ":syntax off".
7816 Otherwise this option does not always reflect the current syntax (the
7817 b:current_syntax variable does).
7818 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007819 not automatically recognized. Example, in an IDL file:
7820 /* vim: set syntax=idl : */ ~
7821 When a dot appears in the value then this separates two filetype
7822 names. Example:
7823 /* vim: set syntax=c.doxygen : */ ~
7824 This will use the "c" syntax first, then the "doxygen" syntax.
7825 Note that the second one must be prepared to be loaded as an addition,
7826 otherwise it will be skipped. More than one dot may appear.
7827 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007828 :set syntax=OFF
7829< To switch syntax highlighting on according to the current value of the
7830 'filetype' option: >
7831 :set syntax=ON
7832< What actually happens when setting the 'syntax' option is that the
7833 Syntax autocommand event is triggered with the value as argument.
7834 This option is not copied to another buffer, independent of the 's' or
7835 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007836 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007838 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007839'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007840 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00007841 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007842 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007843 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007844
7845 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007846 option and only when there is no GUI tab line. When 'e' is in
7847 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007848 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007849
7850 The value is evaluated like with 'statusline'. You can use
7851 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007852 the text to be displayed. Use "%1T" for the first label, "%2T" for
7853 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007854
Bram Moolenaare12bab32019-01-08 22:02:56 +01007855 When changing something that is used in 'tabline' that does not
7856 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007857 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007858
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007859 Keep in mind that only one of the tab pages is the current one, others
7860 are invisible and you can't jump to their windows.
7861
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007862
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007863 *'tabpagemax'* *'tpm'*
7864'tabpagemax' 'tpm' number (default 10)
7865 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007866 Maximum number of tab pages to be opened by the |-p| command line
7867 argument or the ":tab all" command. |tabpage|
7868
7869
7870 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007871'tabstop' 'ts' number (default 8)
7872 local to buffer
7873 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007874 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875
7876 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007877 appear wrong in many places, e.g., when printing it.
7878 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879
7880 There are four main ways to use tabs in Vim:
7881 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7882 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007883 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 behave like a tab appears every 4 (or 3) characters.
7885 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7886 'expandtab'. This way you will always insert spaces. The
7887 formatting will never be messed up when 'tabstop' is changed.
7888 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007889 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007890 works when using Vim to edit the file.
7891 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7892 'noexpandtab'. This should then work (for initial indents only)
7893 for any tabstop setting that people use. It might be nice to have
7894 tabs after the first non-blank inserted as spaces if you do this
7895 though. Otherwise aligned comments will be wrong when 'tabstop' is
7896 changed.
7897
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007898 If Vim is compiled with the |+vartabs| feature then the value of
7899 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7900 than an empty string.
7901
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7903'tagbsearch' 'tbs' boolean (default on)
7904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007905 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007906 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907 searching makes searching for a tag a LOT faster, but a linear search
7908 will find more tags if the tags file wasn't properly sorted.
7909 Vim normally assumes that your tags files are sorted, or indicate that
7910 they are not sorted. Only when this is not the case does the
7911 'tagbsearch' option need to be switched off.
7912
7913 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007914 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915 certain files, or retry all files with a linear search. When
7916 'tagbsearch' is off, only a linear search is done.
7917
7918 Linear searching is done anyway, for one file, when Vim finds a line
7919 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007920 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007921< [The whitespace before and after the '0' must be a single <Tab>]
7922
7923 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007924 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925 instead of a normal tag name, a retry is done with a linear search.
7926 Tags in unsorted tags files, and matches with different case will only
7927 be found in the retry.
7928
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007929 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007930 linear search can be avoided when case is ignored. Use a value of '2'
7931 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7932 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00007933 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
7934 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
7935 used for this as well. Note that case must be folded to uppercase for
7936 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007937
7938 By default, tag searches are case-sensitive. Case is ignored when
7939 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7940 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007941 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7942 'tagcase' is "smart", and the pattern contains only lowercase
7943 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007944
7945 When 'tagbsearch' is off, tags searching is slower when a full match
7946 exists, but faster when no full match exists. Tags in unsorted tags
7947 files may only be found with 'tagbsearch' off.
7948 When the tags file is not sorted, or sorted in a wrong way (not on
7949 ASCII byte value), 'tagbsearch' should be off, or the line given above
7950 must be included in the tags file.
7951 This option doesn't affect commands that find all matching tags (e.g.,
7952 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007954 *'tagcase'* *'tc'*
7955'tagcase' 'tc' string (default "followic")
7956 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007957 This option specifies how case is handled when searching the tags
7958 file:
7959 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007960 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007961 ignore Ignore case
7962 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007963 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007964 NOTE: This option is set to the Vi default value when 'compatible' is
7965 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007966
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007967 *'tagfunc'* *'tfu'*
7968'tagfunc' 'tfu' string (default: empty)
7969 local to buffer
7970 {not available when compiled without the |+eval|
7971 feature}
7972 This option specifies a function to be used to perform tag searches.
7973 The function gets the tag pattern and should return a List of matching
7974 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007975 function and an example. The value can be the name of a function, a
7976 |lambda| or a |Funcref|. See |option-value-function| for more
7977 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007978
Bram Moolenaar071d4272004-06-13 20:20:40 +00007979 *'taglength'* *'tl'*
7980'taglength' 'tl' number (default 0)
7981 global
7982 If non-zero, tags are significant up to this number of characters.
7983
7984 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7985'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7986 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007987 If on and using a tags file in another directory, file names in that
7988 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007989 NOTE: This option is set to the Vi default value when 'compatible' is
7990 set and to the Vim default value when 'compatible' is reset.
7991
7992 *'tags'* *'tag'* *E433*
7993'tags' 'tag' string (default "./tags,tags", when compiled with
7994 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7995 global or local to buffer |global-local|
7996 Filenames for the tag command, separated by spaces or commas. To
7997 include a space or comma in a file name, precede it with a backslash
7998 (see |option-backslash| about including spaces and backslashes).
7999 When a file name starts with "./", the '.' is replaced with the path
8000 of the current file. But only when the 'd' flag is not included in
8001 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8002 |tags-option|.
8003 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008004 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8005 find all files named "tags" below "/lib". The filename itself cannot
8006 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
8007 files called "tags?". {not available when compiled without the
8008 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008009 The |tagfiles()| function can be used to get a list of the file names
8010 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8012 files are also supported. They are automatically recognized. The
8013 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8014 differences are ignored (MS-Windows). |emacs-tags|
8015 The use of |:set+=| and |:set-=| is preferred when adding or removing
8016 file names from the list. This avoids problems when a future version
8017 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008018
8019 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8020'tagstack' 'tgst' boolean (default on)
8021 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 When on, the |tagstack| is used normally. When off, a ":tag" or
8023 ":tselect" command with an argument will not push the tag onto the
8024 tagstack. A following ":tag" without an argument, a ":pop" command or
8025 any other command that uses the tagstack will use the unmodified
8026 tagstack, but does change the pointer to the active entry.
8027 Resetting this option is useful when using a ":tag" command in a
8028 mapping which should not change the tagstack.
8029
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008030 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008031'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008032 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008033 {only available when compiled with the |+tcl/dyn|
8034 feature}
8035 Specifies the name of the Tcl shared library. The default is
8036 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008037 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008038 This option cannot be set from a |modeline| or in the |sandbox|, for
8039 security reasons.
8040
Bram Moolenaar071d4272004-06-13 20:20:40 +00008041 *'term'* *E529* *E530* *E531*
8042'term' string (default is $TERM, if that fails:
8043 in the GUI: "builtin_gui"
8044 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008045 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008046 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047 on Unix: "ansi"
8048 on VMS: "ansi"
8049 on Win 32: "win32")
8050 global
8051 Name of the terminal. Used for choosing the terminal control
8052 characters. Environment variables are expanded |:set_env|.
8053 For example: >
8054 :set term=$TERM
8055< See |termcap|.
8056
8057 *'termbidi'* *'tbidi'*
8058 *'notermbidi'* *'notbidi'*
8059'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8060 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008061 {only available when compiled with the |+arabic|
8062 feature}
8063 The terminal is in charge of Bi-directionality of text (as specified
8064 by Unicode). The terminal is also expected to do the required shaping
8065 that some languages (such as Arabic) require.
8066 Setting this option implies that 'rightleft' will not be set when
8067 'arabic' is set and the value of 'arabicshape' will be ignored.
8068 Note that setting 'termbidi' has the immediate effect that
8069 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8070 This option is reset when the GUI is started.
8071 For further details see |arabic.txt|.
8072
8073 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008074'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008075 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008076 Encoding used for the terminal. This specifies what character
8077 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008078 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008079 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008080 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008081 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8083 Any attempts to set a different value will be rejected, and an error
8084 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008085 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008086 because the Win32 system always passes Unicode characters.
8087 When empty, the same encoding is used as for the 'encoding' option.
8088 This is the normal value.
8089 Not all combinations for 'termencoding' and 'encoding' are valid. See
8090 |encoding-table|.
8091 The value for this option must be supported by internal conversions or
8092 iconv(). When this is not possible no conversion will be done and you
8093 will probably experience problems with non-ASCII characters.
8094 Example: You are working with the locale set to euc-jp (Japanese) and
8095 want to edit a UTF-8 file: >
8096 :let &termencoding = &encoding
8097 :set encoding=utf-8
8098< You need to do this when your system has no locale support for UTF-8.
8099
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008100 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008101'termguicolors' 'tgc' boolean (default off)
8102 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008103 {not available when compiled without the
8104 |+termguicolors| feature}
8105 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008106 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008107
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008108 Requires a ISO-8613-3 compatible terminal. If setting this option
8109 does not work (produces a colorless UI) reading |xterm-true-color|
8110 might help.
8111
8112 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8113 is required. Use this check to find out: >
8114 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008115< This requires Vim to be built with the |+vtp| feature.
8116
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008117 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008118
8119 When using Vim with Windows Terminal, the background of Windows
8120 Terminal is normally filled with the Vim background color. Setting
8121 'termguicolors' and the guibg of the Normal highlight group to NONE
8122 will make the background transparent: >
8123 :hi Normal guibg=NONE
8124<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008125 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008126
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008127 *'termwinkey'* *'twk'*
8128'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008129 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008130 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008131 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008132 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008133 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008134< The string must be one key stroke but can be multiple bytes.
8135 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008136 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008137 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008138
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008139 *'termwinscroll'* *'twsl'*
8140'termwinscroll' 'twsl' number (default 10000)
8141 local to buffer
8142 {not available when compiled without the
8143 |+terminal| feature}
8144 Number of scrollback lines to keep. When going over this limit the
8145 first 10% of the scrollback lines are deleted. This is just to reduce
8146 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008147 Also used as a limit for text sent to the terminal in one write,
8148 multiplied by the number of columns times 3 (average number of bytes
8149 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008150
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008151 *'termwinsize'* *'tws'*
8152'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008153 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008154 Size used when opening the |terminal| window. Format:
8155 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008156 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008157 - When set with a "x" (e.g., "24x80") the terminal size is not
8158 adjusted to the window size. If the window is smaller only the
8159 top-left part is displayed.
8160 - When set with a "*" (e.g., "10*50") the terminal size follows the
8161 window size, but will not be smaller than the specified rows and/or
8162 columns.
8163 - When rows is zero then use the height of the window.
8164 - When columns is zero then use the width of the window.
8165 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008166 - Can be overruled in the |term_start()| options with "term_rows" and
8167 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008168
8169 Examples:
8170 "30x0" uses 30 rows and the current window width.
8171 "20*0" uses at least 20 rows and the current window width.
8172 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008173 Note that the command running in the terminal window may still change
8174 the size of the terminal. In that case the Vim window will be
8175 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008176
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008177 *'termwintype'* *'twt'*
8178'termwintype' 'twt' string (default "")
8179 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008180 {only available when compiled with the |terminal|
8181 feature on MS-Windows}
8182 Specify the virtual console (pty) used when opening the terminal
8183 window.
8184
8185 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008186 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008187 "winpty" use winpty, fail if not supported
8188 "conpty" use |ConPTY|, fail if not supported
8189
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008190 |ConPTY| support depends on the platform. Windows 10 October 2018
8191 Update is the first version that supports ConPTY, however it is still
8192 considered unstable. ConPTY might become stable in the next release
8193 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008194 supported then you cannot open a terminal window.
8195
Bram Moolenaar071d4272004-06-13 20:20:40 +00008196 *'terse'* *'noterse'*
8197'terse' boolean (default off)
8198 global
8199 When set: Add 's' flag to 'shortmess' option (this makes the message
8200 for a search that hits the start or end of the file not being
8201 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8202 shortens a lot of messages}
8203
8204 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8205'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8206 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008207 This option is obsolete. Use 'fileformats'.
8208 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8209 set to the default value for the current system. When 'textauto' is
8210 reset, 'fileformats' is made empty.
8211 NOTE: This option is set to the Vi default value when 'compatible' is
8212 set and to the Vim default value when 'compatible' is reset.
8213
8214 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008215'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008216 others: default off)
8217 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008218 This option is obsolete. Use 'fileformat'.
8219 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8220 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8221 "unix".
8222
8223 *'textwidth'* *'tw'*
8224'textwidth' 'tw' number (default 0)
8225 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008226 Maximum width of text that is being inserted. A longer line will be
8227 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008228 this.
8229 'textwidth' is set to 0 when the 'paste' option is set and restored
8230 when 'paste' is reset.
8231 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008232 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008233 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008234 NOTE: This option is set to 0 when 'compatible' is set.
8235
8236 *'thesaurus'* *'tsr'*
8237'thesaurus' 'tsr' string (default "")
8238 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008239 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008240 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8241 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008242
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008243 This option is not used if 'thesaurusfunc' is set, either for the
8244 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008245
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008246 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008247 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008248 name. See |option-backslash| about using backslashes. The use of
8249 |:set+=| and |:set-=| is preferred when adding or removing directories
8250 from the list. This avoids problems when a future version uses
8251 another default. Backticks cannot be used in this option for security
8252 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008253
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008254 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008255'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008256 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008257 {not available when compiled without the |+eval|
8258 feature}
8259 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008260 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008261 The value can be the name of a function, a |lambda| or a |Funcref|.
8262 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008263
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008264 This option cannot be set from a |modeline| or in the |sandbox|, for
8265 security reasons.
8266
Bram Moolenaar071d4272004-06-13 20:20:40 +00008267 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8268'tildeop' 'top' boolean (default off)
8269 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008270 When on: The tilde command "~" behaves like an operator.
8271 NOTE: This option is reset when 'compatible' is set.
8272
8273 *'timeout'* *'to'* *'notimeout'* *'noto'*
8274'timeout' 'to' boolean (default on)
8275 global
8276 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008277'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008278 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008279 These two options together determine the behavior when part of a
8280 mapped key sequence or keyboard code has been received:
8281
8282 'timeout' 'ttimeout' action ~
8283 off off do not time out
8284 on on or off time out on :mappings and key codes
8285 off on time out on key codes
8286
8287 If both options are off, Vim will wait until either the complete
8288 mapping or key sequence has been received, or it is clear that there
8289 is no mapping or key sequence for the received characters. For
8290 example: if you have mapped "vl" and Vim has received 'v', the next
8291 character is needed to see if the 'v' is followed by an 'l'.
8292 When one of the options is on, Vim will wait for about 1 second for
8293 the next character to arrive. After that the already received
8294 characters are interpreted as single characters. The waiting time can
8295 be changed with the 'timeoutlen' option.
8296 On slow terminals or very busy systems timing out may cause
8297 malfunctioning cursor keys. If both options are off, Vim waits
8298 forever after an entered <Esc> if there are key codes that start
8299 with <Esc>. You will have to type <Esc> twice. If you do not have
8300 problems with key codes, but would like to have :mapped key
8301 sequences not timing out in 1 second, set the 'ttimeout' option and
8302 reset the 'timeout' option.
8303
8304 NOTE: 'ttimeout' is reset when 'compatible' is set.
8305
8306 *'timeoutlen'* *'tm'*
8307'timeoutlen' 'tm' number (default 1000)
8308 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008309
Bram Moolenaar071d4272004-06-13 20:20:40 +00008310 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008311'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008313 The time in milliseconds that is waited for a key code or mapped key
8314 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8315 when part of a command has been typed.
8316 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8317 different timeout value for key codes is desired set 'ttimeoutlen' to
8318 a non-negative number.
8319
8320 ttimeoutlen mapping delay key code delay ~
8321 < 0 'timeoutlen' 'timeoutlen'
8322 >= 0 'timeoutlen' 'ttimeoutlen'
8323
8324 The timeout only happens when the 'timeout' and 'ttimeout' options
8325 tell so. A useful setting would be >
8326 :set timeout timeoutlen=3000 ttimeoutlen=100
8327< (time out on mapping after three seconds, time out on key codes after
8328 a tenth of a second).
8329
8330 *'title'* *'notitle'*
8331'title' boolean (default off, on when title can be restored)
8332 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008333 When on, the title of the window will be set to the value of
8334 'titlestring' (if it is not empty), or to:
8335 filename [+=-] (path) - VIM
8336 Where:
8337 filename the name of the file being edited
8338 - indicates the file cannot be modified, 'ma' off
8339 + indicates the file was modified
8340 = indicates the file is read-only
8341 =+ indicates the file is read-only and modified
8342 (path) is the path of the file being edited
8343 - VIM the server name |v:servername| or "VIM"
8344 Only works if the terminal supports setting window titles
8345 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008346 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8348 *X11*
8349 When Vim was compiled with HAVE_X11 defined, the original title will
8350 be restored if possible. The output of ":version" will include "+X11"
8351 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8352 works for the icon name |'icon'|.
8353 But: When Vim was started with the |-X| argument, restoring the title
8354 will not work (except in the GUI).
8355 If the title cannot be restored, it is set to the value of 'titleold'.
8356 You might want to restore the title outside of Vim then.
8357 When using an xterm from a remote machine you can use this command:
8358 rsh machine_name xterm -display $DISPLAY &
8359 then the WINDOWID environment variable should be inherited and the
8360 title of the window should change back to what it should be after
8361 exiting Vim.
8362
8363 *'titlelen'*
8364'titlelen' number (default 85)
8365 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008366 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008367 title. When the title is longer, only the end of the path name is
8368 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008369 Using a percentage makes this adapt to the width of the window. But
8370 it won't work perfectly, because the actual number of characters
8371 available also depends on the font used and other things in the title
8372 bar. When 'titlelen' is zero the full path is used. Otherwise,
8373 values from 1 to 30000 percent can be used.
8374 'titlelen' is also used for the 'titlestring' option.
8375
8376 *'titleold'*
8377'titleold' string (default "Thanks for flying Vim")
8378 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008379 This option will be used for the window title when exiting Vim if the
8380 original title cannot be restored. Only happens if 'title' is on or
8381 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008382 This option cannot be set from a |modeline| or in the |sandbox|, for
8383 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 *'titlestring'*
8385'titlestring' string (default "")
8386 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008387 When this option is not empty, it will be used for the title of the
8388 window. This happens only when the 'title' option is on.
8389 Only works if the terminal supports setting window titles (currently
8390 Amiga console, Win32 console, all GUI versions and terminals with a
8391 non-empty 't_ts' option).
8392 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008393 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008394
Bram Moolenaar071d4272004-06-13 20:20:40 +00008395 When this option contains printf-style '%' items, they will be
8396 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008397 This option cannot be set in a modeline when 'modelineexpr' is off.
8398
Bram Moolenaar071d4272004-06-13 20:20:40 +00008399 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008400 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008401 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8402< The value of 'titlelen' is used to align items in the middle or right
8403 of the available space.
8404 Some people prefer to have the file name first: >
8405 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8406< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008407 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008408 separating space only when needed.
8409 NOTE: Use of special characters in 'titlestring' may cause the display
8410 to be garbled (e.g., when it contains a CR or NL character).
8411 {not available when compiled without the |+statusline| feature}
8412
8413 *'toolbar'* *'tb'*
8414'toolbar' 'tb' string (default "icons,tooltips")
8415 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008416 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008417 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008418 possible values are:
8419 icons Toolbar buttons are shown with icons.
8420 text Toolbar buttons shown with text.
8421 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008422 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008423 tooltips Tooltips are active for toolbar buttons.
8424 Tooltips refer to the popup help text which appears after the mouse
8425 cursor is placed over a toolbar button for a brief moment.
8426
8427 If you want the toolbar to be shown with icons as well as text, do the
8428 following: >
8429 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008430< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008431 will show icons if both are requested.
8432
8433 If none of the strings specified in 'toolbar' are valid or if
8434 'toolbar' is empty, this option is ignored. If you want to disable
8435 the toolbar, you need to set the 'guioptions' option. For example: >
8436 :set guioptions-=T
8437< Also see |gui-toolbar|.
8438
8439 *'toolbariconsize'* *'tbis'*
8440'toolbariconsize' 'tbis' string (default "small")
8441 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008442 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008443 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008444 tiny Use tiny icons.
8445 small Use small icons (default).
8446 medium Use medium-sized icons.
8447 large Use large icons.
8448 huge Use even larger icons.
8449 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008450 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008451 the current theme. Common dimensions are giant=48x48, huge=32x32,
8452 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008453
8454 If 'toolbariconsize' is empty, the global default size as determined
8455 by user preferences or the current theme is used.
8456
8457 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8458'ttybuiltin' 'tbi' boolean (default on)
8459 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008460 When on, the builtin termcaps are searched before the external ones.
8461 When off the builtin termcaps are searched after the external ones.
8462 When this option is changed, you should set the 'term' option next for
8463 the change to take effect, for example: >
8464 :set notbi term=$TERM
8465< See also |termcap|.
8466 Rationale: The default for this option is "on", because the builtin
8467 termcap entries are generally better (many systems contain faulty
8468 xterm entries...).
8469
8470 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8471'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8472 sun-cmd, screen, rxvt, dtterm or
8473 iris-ansi; also on when running Vim in
8474 a DOS console)
8475 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008476 Indicates a fast terminal connection. More characters will be sent to
8477 the screen for redrawing, instead of using insert/delete line
8478 commands. Improves smoothness of redrawing when there are multiple
8479 windows and the terminal does not support a scrolling region.
8480 Also enables the extra writing of characters at the end of each screen
8481 line for lines that wrap. This helps when using copy/paste with the
8482 mouse in an xterm and other terminals.
8483
8484 *'ttymouse'* *'ttym'*
8485'ttymouse' 'ttym' string (default depends on 'term')
8486 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 {only in Unix and VMS, doesn't work in the GUI; not
8488 available when compiled without |+mouse|}
8489 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008490 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008491 *xterm-mouse*
8492 xterm xterm-like mouse handling. The mouse generates
8493 "<Esc>[Mscr", where "scr" is three bytes:
8494 "s" = button state
8495 "c" = column plus 33
8496 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008497 This only works up to 223 columns! See "dec",
8498 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008499 xterm2 Works like "xterm", but with the xterm reporting the
8500 mouse position while the mouse is dragged. This works
8501 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008502 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008503 work. See below for how Vim detects this
8504 automatically.
8505 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008506 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008507 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008508 for the row and column. No other mouse events are
8509 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008510 *dec-mouse*
8511 dec DEC terminal mouse handling. The mouse generates a
8512 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008513 This is also available for an Xterm, if it was
8514 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008515 *jsbterm-mouse*
8516 jsbterm JSB term mouse handling.
8517 *pterm-mouse*
8518 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008519 *urxvt-mouse*
8520 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008521 The mouse works only if the terminal supports this
8522 encoding style, but it does not have 223 columns limit
8523 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008524 *sgr-mouse*
8525 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008526 mouse reporting. The mouse works even in columns
8527 beyond 223. This option is backward compatible with
8528 "xterm2" because it can also decode "xterm2" style
8529 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008530
8531 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008532 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8533 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008534 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8535 recognized, if enabled at compile time. DEC terminal mouse codes
8536 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008537 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8538 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008539 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008540 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8541 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8542 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008543 Additionally, if vim is compiled with the |+termresponse| feature and
8544 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008545 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008546 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008547 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8548 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8549 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008550 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8551 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008552 :set t_RV=
8553<
8554 *'ttyscroll'* *'tsl'*
8555'ttyscroll' 'tsl' number (default 999)
8556 global
8557 Maximum number of lines to scroll the screen. If there are more lines
8558 to scroll the window is redrawn. For terminals where scrolling is
8559 very slow and redrawing is not slow this can be set to a small number,
8560 e.g., 3, to speed up displaying.
8561
8562 *'ttytype'* *'tty'*
8563'ttytype' 'tty' string (default from $TERM)
8564 global
8565 Alias for 'term', see above.
8566
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008567 *'undodir'* *'udir'*
8568'undodir' 'udir' string (default ".")
8569 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008570 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008571 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008572 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008573 "." means using the directory of the file. The undo file name for
8574 "file.txt" is ".file.txt.un~".
8575 For other directories the file name is the full path of the edited
8576 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008577 When writing: The first directory that exists is used. "." always
8578 works, no directories after "." will be used for writing.
8579 When reading all entries are tried to find an undo file. The first
8580 undo file that exists is used. When it cannot be read an error is
8581 given, no further entry is used.
8582 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008583 This option cannot be set from a |modeline| or in the |sandbox|, for
8584 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008585
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008586 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008587'undofile' 'udf' boolean (default off)
8588 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008589 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008590 When on, Vim automatically saves undo history to an undo file when
8591 writing a buffer to a file, and restores undo history from the same
8592 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008593 The directory where the undo file is stored is specified by 'undodir'.
8594 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008595 The undo file is not read when 'undoreload' causes the buffer from
8596 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008597 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008598 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008599
Bram Moolenaar071d4272004-06-13 20:20:40 +00008600 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008601'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008602 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008603 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008604 is kept in memory, higher numbers will cause more memory to be used.
8605 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008606 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8607 itself: >
8608 set ul=0
8609< But you can also get Vi compatibility by including the 'u' flag in
8610 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008611 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008612 Set to -1 for no undo at all. You might want to do this only for the
8613 current buffer: >
8614 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008615< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008616
8617 The local value is set to -123456 when the global value is to be used.
8618
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008619 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008620
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008621 *'undoreload'* *'ur'*
8622'undoreload' 'ur' number (default 10000)
8623 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008624 Save the whole buffer for undo when reloading it. This applies to the
8625 ":e!" command and reloading for when the buffer changed outside of
8626 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008627 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008628 of lines is smaller than the value of this option.
8629 Set this option to zero to disable undo for a reload.
8630
8631 When saving undo for a reload, any undo file is not read.
8632
8633 Note that this causes the whole buffer to be stored in memory. Set
8634 this option to a lower value if you run out of memory.
8635
Bram Moolenaar071d4272004-06-13 20:20:40 +00008636 *'updatecount'* *'uc'*
8637'updatecount' 'uc' number (default: 200)
8638 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008639 After typing this many characters the swap file will be written to
8640 disk. When zero, no swap file will be created at all (see chapter on
8641 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8642 Vim with the "-n" option, see |startup|. When editing in readonly
8643 mode this option will be initialized to 10000.
8644 The swapfile can be disabled per buffer with |'swapfile'|.
8645 When 'updatecount' is set from zero to non-zero, swap files are
8646 created for all buffers that have 'swapfile' set. When 'updatecount'
8647 is set to zero, existing swap files are not deleted.
8648 Also see |'swapsync'|.
8649 This option has no meaning in buffers where |'buftype'| is "nofile"
8650 or "nowrite".
8651
8652 *'updatetime'* *'ut'*
8653'updatetime' 'ut' number (default 4000)
8654 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008655 If this many milliseconds nothing is typed the swap file will be
8656 written to disk (see |crash-recovery|). Also used for the
8657 |CursorHold| autocommand event.
8658
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008659 *'varsofttabstop'* *'vsts'*
8660'varsofttabstop' 'vsts' string (default "")
8661 local to buffer
8662 {only available when compiled with the |+vartabs|
8663 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008664 A list of the number of spaces that a <Tab> counts for while editing,
8665 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8666 width <Tab>s are being inserted, while in fact a mixture of spaces
8667 and <Tab>s is used. Tab widths are separated with commas, with the
8668 final value applying to all subsequent tabs.
8669
8670 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008671 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008672 to use the following: >
8673 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008674< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8675 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008676
8677 Note that the value of |'softtabstop'| will be ignored while
8678 'varsofttabstop' is set.
8679
8680 *'vartabstop'* *'vts'*
8681'vartabstop' 'vts' string (default "")
8682 local to buffer
8683 {only available when compiled with the |+vartabs|
8684 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008685 A list of the number of spaces that a <Tab> in the file counts for,
8686 separated by commas. Each value corresponds to one tab, with the
8687 final value applying to all subsequent tabs. For example: >
8688 :set vartabstop=4,20,10,8
8689< This will make the first tab 4 spaces wide, the second 20 spaces,
8690 the third 10 spaces, and all following tabs 8 spaces.
8691
8692 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8693 is set.
8694
Bram Moolenaar071d4272004-06-13 20:20:40 +00008695 *'verbose'* *'vbs'*
8696'verbose' 'vbs' number (default 0)
8697 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008698 When bigger than zero, Vim will give messages about what it is doing.
8699 Currently, these messages are given:
8700 >= 1 When the viminfo file is read or written.
8701 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008702 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008703 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008704 >= 8 Files for which a group of autocommands is executed.
8705 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008706 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008707 >= 12 Every executed function.
8708 >= 13 When an exception is thrown, caught, finished, or discarded.
8709 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008710 >= 15 Every executed Ex command from a script (truncated at 200
8711 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008712 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713
8714 This option can also be set with the "-V" argument. See |-V|.
8715 This option is also set by the |:verbose| command.
8716
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008717 When the 'verbosefile' option is set then the verbose messages are not
8718 displayed.
8719
8720 *'verbosefile'* *'vfile'*
8721'verbosefile' 'vfile' string (default empty)
8722 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008723 When not empty all messages are written in a file with this name.
8724 When the file exists messages are appended.
8725 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008726 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008727 Setting 'verbosefile' to a new value is like making it empty first.
8728 The difference with |:redir| is that verbose messages are not
8729 displayed when 'verbosefile' is set.
8730
Bram Moolenaar071d4272004-06-13 20:20:40 +00008731 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008732'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733 "$VIM/vimfiles/view",
8734 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008735 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008736 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008737 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008738 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008739 feature}
8740 Name of the directory where to store files for |:mkview|.
8741 This option cannot be set from a |modeline| or in the |sandbox|, for
8742 security reasons.
8743
8744 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008745'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008746 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008747 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008748 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008749 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008750 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751 word save and restore ~
8752 cursor cursor position in file and in window
8753 folds manually created folds, opened/closed folds and local
8754 fold options
8755 options options and mappings local to a window or buffer (not
8756 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008757 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008758 slash backslashes in file names replaced with forward
8759 slashes
8760 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008761 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008762 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008764 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008765 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008766 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008767
8768 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008769'viminfo' 'vi' string (Vi default: "", Vim default for
8770 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008771 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8772 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008773 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008774 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008775 feature}
8776 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008777 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8778 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008779 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008780 consisting of a single character identifying the particular parameter,
8781 followed by a number or string which specifies the value of that
8782 parameter. If a particular character is left out, then the default
8783 value is used for that parameter. The following is a list of the
8784 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008785 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008786 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008787 ! When included, save and restore global variables that start
8788 with an uppercase letter, and don't contain a lowercase
8789 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008790 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008791 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008792 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008793 " Maximum number of lines saved for each register. Old name of
8794 the '<' item, with the disadvantage that you need to put a
8795 backslash before the ", otherwise it will be recognized as the
8796 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008797 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798 % When included, save and restore the buffer list. If Vim is
8799 started with a file name argument, the buffer list is not
8800 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008801 buffer list is restored from the viminfo file. Quickfix
8802 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8803 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008804 When followed by a number, the number specifies the maximum
8805 number of buffers that are stored. Without a number all
8806 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008807 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008808 ' Maximum number of previously edited files for which the marks
8809 are remembered. This parameter must always be included when
8810 'viminfo' is non-empty.
8811 Including this item also means that the |jumplist| and the
8812 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008813 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008814 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008815 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008816 patterns are also saved. When not included, the value of
8817 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008818 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008819 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008820 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008821 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008822 < Maximum number of lines saved for each register. If zero then
8823 registers are not saved. When not included, all lines are
8824 saved. '"' is the old name for this item.
8825 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008826 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008827 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008828 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008829 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008830 c When included, convert the text in the viminfo file from the
8831 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008832 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008833 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008834 f Whether file marks need to be stored. If zero, file marks ('0
8835 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008836 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008837 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008838 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008839 h Disable the effect of 'hlsearch' when loading the viminfo
8840 file. When not included, it depends on whether ":nohlsearch"
8841 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008842 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008843 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008844 the 'n'. Must be at the end of the option! If the
8845 'viminfofile' option is set, that file name overrides the one
8846 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008847 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008848 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008849 r Removable media. The argument is a string (up to the next
8850 ','). This parameter can be given several times. Each
8851 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008852 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008853 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8854 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8855 ignored. Maximum length of each 'r' argument is 50
8856 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008857 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008858 s Maximum size of an item in Kbyte. If zero then registers are
8859 not saved. Currently only applies to registers. The default
8860 "s10" will exclude registers with more than 10 Kbyte of text.
8861 Also see the '<' item above: line count limit.
8862
8863 Example: >
8864 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8865<
8866 '50 Marks will be remembered for the last 50 files you
8867 edited.
8868 <1000 Contents of registers (up to 1000 lines each) will be
8869 remembered.
8870 s100 Registers with more than 100 Kbyte text are skipped.
8871 :0 Command-line history will not be saved.
8872 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8873 no / Since '/' is not specified, the default will be used,
8874 that is, save all of the search history, and also the
8875 previous search and substitute patterns.
8876 no % The buffer list will not be saved nor read back.
8877 no h 'hlsearch' highlighting will be restored.
8878
8879 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8880 load the contents of the file, this is not done automatically.
8881
8882 This option cannot be set from a |modeline| or in the |sandbox|, for
8883 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008884 NOTE: This option is set to the Vim default value when 'compatible'
8885 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008887 *'viminfofile'* *'vif'*
8888'viminfofile' 'vif' string (default: "")
8889 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008890 {not available when compiled without the |+viminfo|
8891 feature}
8892 When non-empty, overrides the file name used for viminfo.
8893 When equal to "NONE" no viminfo file will be read or written.
8894 This option can be set with the |-i| command line flag. The |--clean|
8895 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008896 This option cannot be set from a |modeline| or in the |sandbox|, for
8897 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008898
Bram Moolenaar071d4272004-06-13 20:20:40 +00008899 *'virtualedit'* *'ve'*
8900'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008901 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008902 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008903 block Allow virtual editing in Visual block mode.
8904 insert Allow virtual editing in Insert mode.
8905 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008906 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008907 none When used as the local value, do not allow virtual
8908 editing even when the global value is set. When used
8909 as the global value, "none" is the same as "".
8910 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008911
Bram Moolenaar071d4272004-06-13 20:20:40 +00008912 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008913 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008914 of the line. Useful for selecting a rectangle in Visual mode and
8915 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008916 "onemore" is not the same, it will only allow moving the cursor just
8917 after the last character of the line. This makes some commands more
8918 consistent. Previously the cursor was always past the end of the line
8919 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008920 break some plugins or Vim scripts. For example because |l| can move
8921 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008922 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008923 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008924 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008925 It doesn't make sense to combine "all" with "onemore", but you will
8926 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008927 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008928 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008929
8930 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8931'visualbell' 'vb' boolean (default off)
8932 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008933 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008934 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008935 use: >
8936 :set vb t_vb=
8937< If you want a short flash, you can use this on many terminals: >
8938 :set vb t_vb=[?5h$<100>[?5l
8939< Here $<100> specifies the time, you can use a smaller or bigger value
8940 to get a shorter or longer flash.
8941
8942 Note: Vim will limit the bell to once per half a second. This avoids
8943 having to wait for the flashing to finish when there are lots of
8944 bells, e.g. on key repeat. This also happens without 'visualbell'
8945 set.
8946
Bram Moolenaar071d4272004-06-13 20:20:40 +00008947 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8948 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8949 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008950
8951 Note: When the GUI starts, 't_vb' is reset to its default value. You
8952 might want to set it again in your |gvimrc|.
8953
Bram Moolenaar071d4272004-06-13 20:20:40 +00008954 Does not work on the Amiga, you always get a screen flash.
8955 Also see 'errorbells'.
8956
8957 *'warn'* *'nowarn'*
8958'warn' boolean (default on)
8959 global
8960 Give a warning message when a shell command is used while the buffer
8961 has been changed.
8962
8963 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8964'weirdinvert' 'wiv' boolean (default off)
8965 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008966 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008967 It is provided for backwards compatibility with version 4.x.
8968 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8969 vice versa. Has no effect when the GUI is running.
8970
8971 *'whichwrap'* *'ww'*
8972'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8973 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008974 Allow specified keys that move the cursor left/right to move to the
8975 previous/next line when the cursor is on the first/last character in
8976 the line. Concatenate characters to allow this for these keys:
8977 char key mode ~
8978 b <BS> Normal and Visual
8979 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008980 h "h" Normal and Visual (not recommended)
8981 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008982 < <Left> Normal and Visual
8983 > <Right> Normal and Visual
8984 ~ "~" Normal
8985 [ <Left> Insert and Replace
8986 ] <Right> Insert and Replace
8987 For example: >
8988 :set ww=<,>,[,]
8989< allows wrap only when cursor keys are used.
8990 When the movement keys are used in combination with a delete or change
8991 operator, the <EOL> also counts for a character. This makes "3h"
8992 different from "3dh" when the cursor crosses the end of a line. This
8993 is also true for "x" and "X", because they do the same as "dl" and
8994 "dh". If you use this, you may also want to use the mapping
8995 ":map <BS> X" to make backspace delete the character in front of the
8996 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008997 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008998 line (not an empty line) then it will not move to the next line. This
8999 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009000 NOTE: This option is set to the Vi default value when 'compatible' is
9001 set and to the Vim default value when 'compatible' is reset.
9002
9003 *'wildchar'* *'wc'*
9004'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009006 Character you have to type to start wildcard expansion in the
9007 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009008 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009009 The character is not recognized when used inside a macro. See
9010 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009011 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009012 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009013 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009014< NOTE: This option is set to the Vi default value when 'compatible' is
9015 set and to the Vim default value when 'compatible' is reset.
9016
9017 *'wildcharm'* *'wcm'*
9018'wildcharm' 'wcm' number (default: none (0))
9019 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009020 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009021 recognized when used inside a macro. You can find "spare" command-line
9022 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009023 you'll never actually type 'wildcharm', just use it in mappings that
9024 automatically invoke completion mode, e.g.: >
9025 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009026 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009027< Then after typing :ss you can use CTRL-P & CTRL-N.
9028
9029 *'wildignore'* *'wig'*
9030'wildignore' 'wig' string (default "")
9031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009032 {not available when compiled without the |+wildignore|
9033 feature}
9034 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009035 patterns is ignored when expanding |wildcards|, completing file or
9036 directory names, and influences the result of |expand()|, |glob()| and
9037 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009038 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9039 Also see 'suffixes'.
9040 Example: >
9041 :set wildignore=*.o,*.obj
9042< The use of |:set+=| and |:set-=| is preferred when adding or removing
9043 a pattern from the list. This avoids problems when a future version
9044 uses another default.
9045
Bram Moolenaar94950a92010-12-02 16:01:29 +01009046
Bram Moolenaar81af9252010-12-10 20:35:50 +01009047 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009048'wildignorecase' 'wic' boolean (default off)
9049 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009050 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009051 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009052 Does not apply when the shell is used to expand wildcards, which
9053 happens when there are special characters.
9054
9055
Bram Moolenaar071d4272004-06-13 20:20:40 +00009056 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009057'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009058 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009059 {not available if compiled without the |+wildmenu|
9060 feature}
9061 When 'wildmenu' is on, command-line completion operates in an enhanced
9062 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
9063 the possible matches are shown just above the command line, with the
9064 first match highlighted (overwriting the status line, if there is
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009065 one). This is the behavior without "pum" in 'wildoptions'.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009066 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009067 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9068 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9069 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009070 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009071 If there are more matches than can fit in the line, a ">" is shown on
9072 the right and/or a "<" is shown on the left. The status line scrolls
9073 as needed.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009074 When 'wildoptions' contains "pum", then the completion matches are
9075 shown in a popup menu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009076 The "wildmenu" mode is abandoned when a key is hit that is not used
9077 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009078 While the "wildmenu" is active, not using the popup menu, the
9079 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080
9081 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9082 <Down> - in filename/menu name completion: move into a
9083 subdirectory or submenu.
9084 <CR> - in menu completion, when the cursor is just after a
9085 dot: move into a submenu.
9086 <Up> - in filename/menu name completion: move up into
9087 parent directory or parent menu.
9088
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009089 When using the popup menu for command line completion, the following
9090 keys have special meanings:
9091 <Down> - select next match (like CTRL-N)
9092 <Left> - in filename/menu name completion: move up into
9093 parent directory or parent menu.
9094 <Right> - in filename/menu name completion: move into a
9095 subdirectory or submenu.
9096 <Up> - select previous match (like CTRL-P)
9097 CTRL-E - end completion, go back to what was there before
9098 selecting a match.
9099 CTRL-N - go to the next entry
9100 CTRL-P - go to the previous entry
9101 CTRL-Y - accept the currently selected match and stop
9102 completion.
9103
Bram Moolenaar071d4272004-06-13 20:20:40 +00009104 This makes the menus accessible from the console |console-menus|.
9105
9106 If you prefer the <Left> and <Right> keys to move the cursor instead
9107 of selecting a different match, use this: >
9108 :cnoremap <Left> <Space><BS><Left>
9109 :cnoremap <Right> <Space><BS><Right>
9110<
9111 The "WildMenu" highlighting is used for displaying the current match
9112 |hl-WildMenu|.
9113
9114 *'wildmode'* *'wim'*
9115'wildmode' 'wim' string (Vim default: "full")
9116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009117 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009118 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009119 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009120 first part specifies the behavior for the first use of 'wildchar',
9121 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009122
9123 Each part consists of a colon separated list consisting of the
9124 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009125 "" Complete only the first match.
9126 "full" Complete the next full match. After the last match,
9127 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009128 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009129 "longest" Complete till longest common string. If this doesn't
9130 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009131 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009132 "lastused" When completing buffer names and more than one buffer
9133 matches, sort buffers by time last used (other than
9134 the current buffer).
9135 When there is only a single match, it is fully completed in all cases.
9136
9137 Examples of useful colon-separated values:
9138 "longest:full" Like "longest", but also start 'wildmenu' if it is
9139 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009140 "list:full" When more than one match, list all matches and
9141 complete first match.
9142 "list:longest" When more than one match, list all matches and
9143 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009144 "list:lastused" When more than one buffer matches, list all matches
9145 and sort buffers by time last used (other than the
9146 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009147
9148 Examples: >
9149 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009150< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009151 :set wildmode=longest,full
9152< Complete longest common string, then each full match >
9153 :set wildmode=list:full
9154< List all matches and complete each full match >
9155 :set wildmode=list,full
9156< List all matches without completing, then each full match >
9157 :set wildmode=longest,list
9158< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009159 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009160
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009161 *'wildoptions'* *'wop'*
9162'wildoptions' 'wop' string (default "")
9163 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009164 {not available when compiled without the |+wildignore|
9165 feature}
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009166 A list of words that change how |cmdline-completion| is done.
9167 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009168 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009169 this value is specified, wildcard expansion will not
9170 be used for completion. The matches will be sorted by
9171 the "best match" rather than alphabetically sorted.
9172 This will find more matches than the wildcard
9173 expansion. Currently fuzzy matching based completion
9174 is not supported for file and directory names and
9175 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009176 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009177 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009178 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009179 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009180 is displayed per line. Often used tag kinds are:
9181 d #define
9182 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009183
Bram Moolenaar071d4272004-06-13 20:20:40 +00009184 *'winaltkeys'* *'wak'*
9185'winaltkeys' 'wak' string (default "menu")
9186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009187 {only used in Win32, Motif, GTK and Photon GUI}
9188 Some GUI versions allow the access to menu entries by using the ALT
9189 key in combination with a character that appears underlined in the
9190 menu. This conflicts with the use of the ALT key for mappings and
9191 entering special characters. This option tells what to do:
9192 no Don't use ALT keys for menus. ALT key combinations can be
9193 mapped, but there is no automatic handling. This can then be
9194 done with the |:simalt| command.
9195 yes ALT key handling is done by the windowing system. ALT key
9196 combinations cannot be mapped.
9197 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009198 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009199 keys can be mapped.
9200 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9201 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009202 This option is not used for <F10>; on Win32 and with GTK <F10> will
9203 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009204
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009205 *'wincolor'* *'wcr'*
9206'wincolor' 'wcr' string (default empty)
9207 local to window
9208 Highlight group name to use for this window instead of the Normal
9209 color |hl-Normal|.
9210
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009211 *'window'* *'wi'*
9212'window' 'wi' number (default screen height - 1)
9213 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009214 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9215 window and the value is smaller than 'lines' minus one. The screen
9216 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009217 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9218 in a much smarter way, taking care of wrapping lines.
9219 When resizing the Vim window, the value is smaller than 1 or more than
9220 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009221 Note: Do not confuse this with the height of the Vim window, use
9222 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009223
Bram Moolenaar071d4272004-06-13 20:20:40 +00009224 *'winheight'* *'wh'* *E591*
9225'winheight' 'wh' number (default 1)
9226 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009227 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009228 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009229 focus goes to a window that is smaller, its size is increased, at the
9230 cost of the height of other windows.
9231 Set 'winheight' to a small number for normal editing.
9232 Set it to 999 to make the current window fill most of the screen.
9233 Other windows will be only 'winminheight' high. This has the drawback
9234 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9235 to create only two windows, set the option after startup is done,
9236 using the |VimEnter| event: >
9237 au VimEnter * set winheight=999
9238< Minimum value is 1.
9239 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009240 height of the current window.
9241 'winheight' applies to the current window. Use 'winminheight' to set
9242 the minimal height for other windows.
9243
9244 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9245'winfixheight' 'wfh' boolean (default off)
9246 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009247 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009248 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9249 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009250 The height may be changed anyway when running out of room.
9251
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009252 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9253'winfixwidth' 'wfw' boolean (default off)
9254 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009255 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009256 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009257 The width may be changed anyway when running out of room.
9258
Bram Moolenaar071d4272004-06-13 20:20:40 +00009259 *'winminheight'* *'wmh'*
9260'winminheight' 'wmh' number (default 1)
9261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009262 The minimal height of a window, when it's not the current window.
9263 This is a hard minimum, windows will never become smaller.
9264 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9265 status bar) if necessary. They will return to at least one line when
9266 they become active (since the cursor has to have somewhere to go.)
9267 Use 'winheight' to set the minimal height of the current window.
9268 This option is only checked when making a window smaller. Don't use a
9269 large number, it will cause errors when opening more than a few
9270 windows. A value of 0 to 3 is reasonable.
9271
9272 *'winminwidth'* *'wmw'*
9273'winminwidth' 'wmw' number (default 1)
9274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009275 The minimal width of a window, when it's not the current window.
9276 This is a hard minimum, windows will never become smaller.
9277 When set to zero, windows may be "squashed" to zero columns (i.e. just
9278 a vertical separator) if necessary. They will return to at least one
9279 line when they become active (since the cursor has to have somewhere
9280 to go.)
9281 Use 'winwidth' to set the minimal width of the current window.
9282 This option is only checked when making a window smaller. Don't use a
9283 large number, it will cause errors when opening more than a few
9284 windows. A value of 0 to 12 is reasonable.
9285
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009286 *'winptydll'*
9287'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9288 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009289 {only available when compiled with the |terminal|
9290 feature on MS-Windows}
9291 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009292 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009293 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009294 a fallback.
9295 Environment variables are expanded |:set_env|.
9296 This option cannot be set from a |modeline| or in the |sandbox|, for
9297 security reasons.
9298
Bram Moolenaar071d4272004-06-13 20:20:40 +00009299 *'winwidth'* *'wiw'* *E592*
9300'winwidth' 'wiw' number (default 20)
9301 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009302 Minimal number of columns for the current window. This is not a hard
9303 minimum, Vim will use fewer columns if there is not enough room. If
9304 the current window is smaller, its size is increased, at the cost of
9305 the width of other windows. Set it to 999 to make the current window
9306 always fill the screen. Set it to a small number for normal editing.
9307 The width is not adjusted after one of the commands to change the
9308 width of the current window.
9309 'winwidth' applies to the current window. Use 'winminwidth' to set
9310 the minimal width for other windows.
9311
9312 *'wrap'* *'nowrap'*
9313'wrap' boolean (default on)
9314 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009315 This option changes how text is displayed. It doesn't change the text
9316 in the buffer, see 'textwidth' for that.
9317 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009318 displaying continues on the next line. When off lines will not wrap
9319 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009320 moved to a part that is not shown, the screen will scroll
9321 horizontally.
9322 The line will be broken in the middle of a word if necessary. See
9323 'linebreak' to get the break at a word boundary.
9324 To make scrolling horizontally a bit more useful, try this: >
9325 :set sidescroll=5
9326 :set listchars+=precedes:<,extends:>
9327< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009328 This option can't be set from a |modeline| when the 'diff' option is
9329 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009330
9331 *'wrapmargin'* *'wm'*
9332'wrapmargin' 'wm' number (default 0)
9333 local to buffer
9334 Number of characters from the right window border where wrapping
9335 starts. When typing text beyond this limit, an <EOL> will be inserted
9336 and inserting continues on the next line.
9337 Options that add a margin, such as 'number' and 'foldcolumn', cause
9338 the text width to be further reduced. This is Vi compatible.
9339 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009340 This option is set to 0 when 'paste' is set and restored when 'paste'
9341 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009342 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009343
9344 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9345'wrapscan' 'ws' boolean (default on) *E384* *E385*
9346 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009347 Searches wrap around the end of the file. Also applies to |]s| and
9348 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009349
9350 *'write'* *'nowrite'*
9351'write' boolean (default on)
9352 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009353 Allows writing files. When not set, writing a file is not allowed.
9354 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009355 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009356 argument. Filtering text is still possible, even though this requires
9357 writing a temporary file.
9358
9359 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9360'writeany' 'wa' boolean (default off)
9361 global
9362 Allows writing to any file with no need for "!" override.
9363
9364 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9365'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9366 otherwise)
9367 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009368 Make a backup before overwriting a file. The backup is removed after
9369 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009370 also on.
9371 WARNING: Switching this option off means that when Vim fails to write
9372 your buffer correctly and then, for whatever reason, Vim exits, you
9373 lose both the original file and what you were writing. Only reset
9374 this option if your file system is almost full and it makes the write
9375 fail (and make sure not to exit Vim until the write was successful).
9376 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009377 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009378 Depending on 'backupcopy' the backup is a new file or the original
9379 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009380 NOTE: This option is set to the default value when 'compatible' is
9381 set.
9382
9383 *'writedelay'* *'wd'*
9384'writedelay' 'wd' number (default 0)
9385 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009386 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009387 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009388 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009389
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009390 *'xtermcodes'* *'noxtermcodes'*
9391'xtermcodes' boolean (default on)
9392 global
9393 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009394 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009395 key codes and number of colors from the terminal. This takes care of
9396 various configuration options of the terminal that cannot be obtained
9397 from the termlib/terminfo entry, see |xterm-codes|.
9398 A side effect may be that t_Co changes and Vim will redraw the
9399 display.
9400
9401
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009402 vim:tw=78:ts=8:noet:ft=help:norl: