blob: 116bb2a8758e85a267e214db11f05103dfa95135 [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
Bram Moolenaare8008642022-08-19 17:15:35 +0100802 or selected. When a buffer has no name it also has no directory, thus
803 the current directory won't change when navigating to it.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000804 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200806 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
807'autoshelldir' 'asd' boolean (default off)
808 global
809 When on, Vim will change the current working directory whenever you
810 change the directory of the shell running in a terminal window. You
811 need proper setting-up, so whenever the shell's pwd changes an OSC 7
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100812 escape sequence will be emitted. For example, on Linux, you can
813 source /etc/profile.d/vte.sh in your shell profile if you use bash or
814 zsh. For bash this should work (put it in a bash init file): >
815 if [[ -n "$VIM_TERMINAL" ]]; then
816 PROMPT_COMMAND='_vim_sync_PWD'
817 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100818 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100819 }
820 fi
821<
822 Or, in a zsh init file: >
823 if [[ -n "$VIM_TERMINAL" ]]; then
824 autoload -Uz add-zsh-hook
825 add-zsh-hook -Uz chpwd _vim_sync_PWD
826 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100827 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100828 }
829 fi
830<
831 In a fish init file: >
832 if test -n "$VIM_TERMINAL"
833 function _vim_sync_PWD --on-variable=PWD
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100834 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100835 end
836 end
837<
838 You can find an alternative method at |terminal-autoshelldir|.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000839 When the parsing of the OSC sequence fails you get *E1179* .
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200840
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
842'arabic' 'arab' boolean (default off)
843 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844 {only available when compiled with the |+arabic|
845 feature}
846 This option can be set to start editing Arabic text.
847 Setting this option will:
848 - Set the 'rightleft' option, unless 'termbidi' is set.
849 - Set the 'arabicshape' option, unless 'termbidi' is set.
850 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
851 between typing English and Arabic key mapping.
852 - Set the 'delcombine' option
853 Note that 'encoding' must be "utf-8" for working with Arabic text.
854
855 Resetting this option will:
856 - Reset the 'rightleft' option.
857 - Disable the use of 'keymap' (without changing its value).
858 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200859 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100860 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861 Also see |arabic.txt|.
862
863 *'arabicshape'* *'arshape'*
864 *'noarabicshape'* *'noarshape'*
865'arabicshape' 'arshape' boolean (default on)
866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 {only available when compiled with the |+arabic|
868 feature}
869 When on and 'termbidi' is off, the required visual character
870 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200871 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872 one which encompasses:
873 a) the changing/morphing of characters based on their location
874 within a word (initial, medial, final and stand-alone).
875 b) the enabling of the ability to compose characters
876 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100877 When disabled the display shows each character's true stand-alone
878 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879 Arabic is a complex language which requires other settings, for
880 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100881 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882
883 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
884'autoindent' 'ai' boolean (default off)
885 local to buffer
886 Copy indent from current line when starting a new line (typing <CR>
887 in Insert mode or when using the "o" or "O" command). If you do not
888 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000889 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
890 to another line has the same effect, unless the 'I' flag is included
891 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000892 When autoindent is on, formatting (with the "gq" command or when you
893 reach 'textwidth' in Insert mode) uses the indentation of the first
894 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 When 'smartindent' or 'cindent' is on the indent is changed in
896 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200897 The 'autoindent' option is reset when the 'paste' option is set and
898 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899
900 *'autoread'* *'ar'* *'noautoread'* *'noar'*
901'autoread' 'ar' boolean (default off)
902 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903 When a file has been detected to have been changed outside of Vim and
904 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200905 When the file has been deleted this is not done, so you have the text
906 from before it was deleted. When it appears again then it is read.
907 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908 If this option has a local value, use this command to switch back to
909 using the global value: >
910 :set autoread<
911<
912 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
913'autowrite' 'aw' boolean (default off)
914 global
915 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000916 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000917 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
918 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000919 to another file.
920 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000921 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 Note that for some commands the 'autowrite' option is not used, see
923 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200924 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200925 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926
927 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
928'autowriteall' 'awa' boolean (default off)
929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
931 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
932 Setting this option also implies that Vim behaves like 'autowrite' has
933 been set.
934
935 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200936'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 When set to "dark", Vim will try to use colors that look good on a
939 dark background. When set to "light", Vim will try to use colors that
940 look good on a light background. Any other value is illegal.
941 Vim tries to set the default value according to the terminal used.
942 This will not always be correct.
943 Setting this option does not change the background color, it tells Vim
944 what the background color looks like. For changing the background
945 color, see |:hi-normal|.
946
947 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000948 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000949 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100950 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951 setting 'background' will cause the color scheme to be reloaded. If
952 the color scheme adjusts to the value of 'background' this will work.
953 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100954 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955
956 When setting 'background' to the default value with: >
957 :set background&
958< Vim will guess the value. In the GUI this should work correctly,
959 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200960 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200961 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200963 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200964 color from the terminal. If the returned RGB value is dark/light and
965 'background' is not dark/light, 'background' will be set and the
966 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200967 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100968 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200969
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 When starting the GUI, the default value for 'background' will be
971 "light". When the value is not set in the .gvimrc, and Vim detects
972 that the background is actually quite dark, 'background' is set to
973 "dark". But this happens only AFTER the .gvimrc file has been read
974 (because the window needs to be opened to find the actual background
975 color). To get around this, force the GUI window to be opened by
976 putting a ":gui" command in the .gvimrc file, before where the value
977 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200978
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100979 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200980 For other systems "dark" is used when 'term' is "linux",
981 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
982 background. Otherwise the default is "light".
983
Bram Moolenaarc572da52017-08-27 16:52:01 +0200984 The |:terminal| command and the |term_start()| function use the
985 'background' value to decide whether the terminal window will start
986 with a white or black background.
987
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988 Normally this option would be set in the .vimrc file. Possibly
989 depending on the terminal name. Example: >
990 :if &term == "pcterm"
991 : set background=dark
992 :endif
993< When this option is set, the default settings for the highlight groups
994 will change. To use other settings, place ":highlight" commands AFTER
995 the setting of the 'background' option.
996 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
997 to select the colors for syntax highlighting. After changing this
998 option, you must load syntax.vim again to see the result. This can be
999 done with ":syntax on".
1000
1001 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001002'backspace' 'bs' string (default "", set to "indent,eol,start"
1003 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1006 mode. This is a list of items, separated by commas. Each item allows
1007 a way to backspace over something:
1008 value effect ~
1009 indent allow backspacing over autoindent
1010 eol allow backspacing over line breaks (join lines)
1011 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1012 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001013 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1014 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015
Bram Moolenaar46eea442022-03-30 10:51:39 +01001016 When the value is empty, Vi compatible backspacing is used, none of
1017 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018
1019 For backwards compatibility with version 5.4 and earlier:
1020 value effect ~
1021 0 same as ":set backspace=" (Vi compatible)
1022 1 same as ":set backspace=indent,eol"
1023 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001024 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025
1026 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1027 NOTE: This option is set to "" when 'compatible' is set.
1028
1029 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1030'backup' 'bk' boolean (default off)
1031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032 Make a backup before overwriting a file. Leave it around after the
1033 file has been successfully written. If you do not want to keep the
1034 backup file, but you do want a backup while the file is being
1035 written, reset this option and set the 'writebackup' option (this is
1036 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001037 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038 |backup-table| for more explanations.
1039 When the 'backupskip' pattern matches, a backup is not made anyway.
1040 When 'patchmode' is set, the backup may be renamed to become the
1041 oldest version of a file.
1042 NOTE: This option is reset when 'compatible' is set.
1043
1044 *'backupcopy'* *'bkc'*
1045'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001046 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001048 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049
1050 The main values are:
1051 "yes" make a copy of the file and overwrite the original one
1052 "no" rename the file and write a new one
1053 "auto" one of the previous, what works best
1054
1055 Extra values that can be combined with the ones above are:
1056 "breaksymlink" always break symlinks when writing
1057 "breakhardlink" always break hardlinks when writing
1058
1059 Making a copy and overwriting the original file:
1060 - Takes extra time to copy the file.
1061 + When the file has special attributes, is a (hard/symbolic) link or
1062 has a resource fork, all this is preserved.
1063 - When the file is a link the backup will have the name of the link,
1064 not of the real file.
1065
1066 Renaming the file and writing a new one:
1067 + It's fast.
1068 - Sometimes not all attributes of the file can be copied to the new
1069 file.
1070 - When the file is a link the new file will not be a link.
1071
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001072 The "auto" value is the middle way: When Vim sees that renaming the
1073 file is possible without side effects (the attributes can be passed on
1074 and the file is not a link) that is used. When problems are expected,
1075 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001076
1077 The "breaksymlink" and "breakhardlink" values can be used in
1078 combination with any of "yes", "no" and "auto". When included, they
1079 force Vim to always break either symbolic or hard links by doing
1080 exactly what the "no" option does, renaming the original file to
1081 become the backup and writing a new file in its place. This can be
1082 useful for example in source trees where all the files are symbolic or
1083 hard links and any changes should stay in the local source tree, not
1084 be propagated back to the original source.
1085 *crontab*
1086 One situation where "no" and "auto" will cause problems: A program
1087 that opens a file, invokes Vim to edit that file, and then tests if
1088 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001089 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090 example.
1091
1092 When a copy is made, the original file is truncated and then filled
1093 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001094 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001095 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 group of the backup is set to the group of the original file. If this
1097 fails, the protection bits for the group are made the same as for
1098 others.
1099
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001100 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 the same attributes of the original file, and the newly written file
1102 is owned by the current user. When the file was a (hard/symbolic)
1103 link, the new file will not! That's why the "auto" value doesn't
1104 rename when the file is a link. The owner and group of the newly
1105 written file will be set to the same ones as the original file, but
1106 the system may refuse to do this. In that case the "auto" value will
1107 again not rename the file.
1108
Bram Moolenaar036986f2017-03-16 17:41:02 +01001109 NOTE: This option is set to the Vi default value when 'compatible' is
1110 set and to the Vim default value when 'compatible' is reset.
1111
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112 *'backupdir'* *'bdir'*
1113'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001114 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115 for Unix: ".,~/tmp,~/")
1116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 List of directories for the backup file, separated with commas.
1118 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001119 where this is possible. The directory must exist, Vim will not
1120 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001121 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122 impossible!). Writing may fail because of this.
1123 - A directory "." means to put the backup file in the same directory
1124 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001125 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1126 the backup file relative to where the edited file is. The leading
1127 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128 ("." inside a directory name has no special meaning).
1129 - Spaces after the comma are ignored, other spaces are considered part
1130 of the directory name. To have a space at the start of a directory
1131 name, precede it with a backslash.
1132 - To include a comma in a directory name precede it with a backslash.
1133 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001134 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001135 the backup file name will be built from the complete path to the
1136 file with all path separators changed to percent '%' signs. This
1137 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001138 On Win32, it is also possible to end with "\\". However, When a
1139 separating comma is following, you must use "//", since "\\" will
1140 include the comma in the file name. Therefore it is recommended to
1141 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142 - Environment variables are expanded |:set_env|.
1143 - Careful with '\' characters, type one before a space, type two to
1144 get one in the option (see |option-backslash|), for example: >
1145 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1146< - For backwards compatibility with Vim version 3.0 a '>' at the start
1147 of the option is removed.
1148 See also 'backup' and 'writebackup' options.
1149 If you want to hide your backup files on Unix, consider this value: >
1150 :set backupdir=./.backup,~/.backup,.,/tmp
1151< You must create a ".backup" directory in each directory and in your
1152 home directory for this to work properly.
1153 The use of |:set+=| and |:set-=| is preferred when adding or removing
1154 directories from the list. This avoids problems when a future version
1155 uses another default.
1156 This option cannot be set from a |modeline| or in the |sandbox|, for
1157 security reasons.
1158
1159 *'backupext'* *'bex'* *E589*
1160'backupext' 'bex' string (default "~", for VMS: "_")
1161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162 String which is appended to a file name to make the name of the
1163 backup file. The default is quite unusual, because this avoids
1164 accidentally overwriting existing files with a backup file. You might
1165 prefer using ".bak", but make sure that you don't have files with
1166 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001167 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001169 If you like to keep a lot of backups, you could use a BufWritePre
1170 autocommand to change 'backupext' just before writing the file to
1171 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001172 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001173< Use 'backupdir' to put the backup in a different directory.
1174
Bram Moolenaar071d4272004-06-13 20:20:40 +00001175 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001176'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1177 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1178 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 A list of file patterns. When one of the patterns matches with the
1181 name of the file which is written, no backup file is created. Both
1182 the specified file name and the full path name of the file are used.
1183 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1184 Watch out for special characters, see |option-backslash|.
1185 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001186 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001187
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001188 WARNING: Not having a backup file means that when Vim fails to write
1189 your buffer correctly and then, for whatever reason, Vim exits, you
1190 lose both the original file and what you were writing. Only disable
1191 backups if you don't care about losing the file.
1192
Bram Moolenaar02467872007-05-06 13:22:01 +00001193 Note that environment variables are not expanded. If you want to use
1194 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001195 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001196
1197< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001198 backup would be made by renaming the original file crontab won't see
1199 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001200
1201 *'balloondelay'* *'bdlay'*
1202'balloondelay' 'bdlay' number (default: 600)
1203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 {only available when compiled with the |+balloon_eval|
1205 feature}
1206 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1207
1208 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1209'ballooneval' 'beval' boolean (default off)
1210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001212 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001213 Switch on the |balloon-eval| functionality for the GUI.
1214
1215 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1216 *'nobevalterm'*
1217'balloonevalterm' 'bevalterm' boolean (default off)
1218 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001219 {only available when compiled with the
1220 |+balloon_eval_term| feature}
1221 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001222
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001223 *'balloonexpr'* *'bexpr'*
1224'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001225 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001226 {only available when compiled with the |+balloon_eval|
1227 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001228 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001229 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1230 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001231
1232 v:beval_bufnr number of the buffer in which balloon is going to show
1233 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001234 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001235 v:beval_lnum line number
1236 v:beval_col column number (byte index)
1237 v:beval_text word under or after the mouse pointer
1238
Bram Moolenaar54775062019-07-31 21:07:14 +02001239 Instead of showing a balloon, which is limited to plain text, consider
1240 using a popup window, see |popup_beval_example|. A popup window can
1241 use highlighting and show a border.
1242
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001243 The evaluation of the expression must not have side effects!
1244 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001245 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001246 return 'Cursor is at line ' .. v:beval_lnum ..
1247 \ ', column ' .. v:beval_col ..
1248 \ ' of file ' .. bufname(v:beval_bufnr) ..
1249 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001250 endfunction
1251 set bexpr=MyBalloonExpr()
1252 set ballooneval
1253<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001254 Also see |balloon_show()|, it can be used if the content of the balloon
1255 is to be fetched asynchronously. In that case evaluating
1256 'balloonexpr' should result in an empty string. If you get a balloon
1257 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001258
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001259 NOTE: The balloon is displayed only if the cursor is on a text
1260 character. If the result of evaluating 'balloonexpr' is not empty,
1261 Vim does not try to send a message to an external debugger (Netbeans
1262 or Sun Workshop).
1263
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001264 If the expression starts with s: or |<SID>|, then it is replaced with
1265 the script ID (|local-function|). Example: >
1266 set bexpr=s:MyBalloonExpr()
1267 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001268< Otherwise, the expression is evaluated in the context of the script
1269 where the option was set, thus script-local items are available.
1270
Bram Moolenaar30b65812012-07-12 22:01:11 +02001271 The expression will be evaluated in the |sandbox| when set from a
1272 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001273 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001274
1275 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001276 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001277
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001278 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001279 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001280< When they are supported "\n" characters will start a new line. If the
1281 expression evaluates to a |List| this is equal to using each List item
1282 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001283 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001284
Bram Moolenaar165bc692015-07-21 17:53:25 +02001285 *'belloff'* *'bo'*
1286'belloff' 'bo' string (default "")
1287 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001288 Specifies for which events the bell will not be rung. It is a comma
1289 separated list of items. For each item that is present, the bell
1290 will be silenced. This is most useful to specify specific events in
1291 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001292 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001293
1294 item meaning when present ~
1295 all All events.
1296 backspace When hitting <BS> or <Del> and deleting results in an
1297 error.
1298 cursor Fail to move around using the cursor keys or
1299 <PageUp>/<PageDown> in |Insert-mode|.
1300 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1301 |i_CTRL-X_CTRL-T|.
1302 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1303 |i_CTRL-E|.
1304 ctrlg Unknown Char after <C-G> in Insert mode.
1305 error Other Error occurred (e.g. try to join last line)
1306 (mostly used in |Normal-mode| or |Cmdline-mode|).
1307 esc hitting <Esc> in |Normal-mode|.
1308 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001309 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001310 insertmode Pressing <Esc> in 'insertmode'.
1311 lang Calling the beep module for Lua/Mzscheme/TCL.
1312 mess No output available for |g<|.
1313 showmatch Error occurred for 'showmatch' function.
1314 operator Empty region error |cpo-E|.
1315 register Unknown register after <C-R> in |Insert-mode|.
1316 shell Bell from shell output |:!|.
1317 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001318 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001319 wildmode More matches in |cmdline-completion| available
1320 (depends on the 'wildmode' setting).
1321
Bram Moolenaar036986f2017-03-16 17:41:02 +01001322 This is most useful to fine tune when in Insert mode the bell should
1323 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001324 indicate that an error occurred. It can be silenced by adding the
1325 "error" keyword.
1326
Bram Moolenaar071d4272004-06-13 20:20:40 +00001327 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1328'binary' 'bin' boolean (default off)
1329 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001330 This option should be set before editing a binary file. You can also
1331 use the |-b| Vim argument. When this option is switched on a few
1332 options will be changed (also when it already was on):
1333 'textwidth' will be set to 0
1334 'wrapmargin' will be set to 0
1335 'modeline' will be off
1336 'expandtab' will be off
1337 Also, 'fileformat' and 'fileformats' options will not be used, the
1338 file is read and written like 'fileformat' was "unix" (a single <NL>
1339 separates lines).
1340 The 'fileencoding' and 'fileencodings' options will not be used, the
1341 file is read without conversion.
1342 NOTE: When you start editing a(nother) file while the 'bin' option is
1343 on, settings from autocommands may change the settings again (e.g.,
1344 'textwidth'), causing trouble when editing. You might want to set
1345 'bin' again when the file has been loaded.
1346 The previous values of these options are remembered and restored when
1347 'bin' is switched from on to off. Each buffer has its own set of
1348 saved option values.
1349 To edit a file with 'binary' set you can use the |++bin| argument.
1350 This avoids you have to do ":set bin", which would have effect for all
1351 files you edit.
1352 When writing a file the <EOL> for the last line is only written if
1353 there was one in the original file (normally Vim appends an <EOL> to
1354 the last line if there is none; this would make the file longer). See
1355 the 'endofline' option.
1356
1357 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1358'bioskey' 'biosk' boolean (default on)
1359 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001360 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001361 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362
1363 *'bomb'* *'nobomb'*
1364'bomb' boolean (default off)
1365 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366 When writing a file and the following conditions are met, a BOM (Byte
1367 Order Mark) is prepended to the file:
1368 - this option is on
1369 - the 'binary' option is off
1370 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1371 endian variants.
1372 Some applications use the BOM to recognize the encoding of the file.
1373 Often used for UCS-2 files on MS-Windows. For other applications it
1374 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001375 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001376 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1377 check for the presence of the BOM is done and 'bomb' set accordingly.
1378 Unless 'binary' is set, it is removed from the first line, so that you
1379 don't see it when editing. When you don't change the options, the BOM
1380 will be restored when writing the file.
1381
1382 *'breakat'* *'brk'*
1383'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1384 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001385 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386 feature}
1387 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001388 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1389 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001391 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001392'breakindent' 'bri' boolean (default off)
1393 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001394 {not available when compiled without the |+linebreak|
1395 feature}
1396 Every wrapped line will continue visually indented (same amount of
1397 space as the beginning of that line), thus preserving horizontal blocks
1398 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001399 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001400
1401 *'breakindentopt'* *'briopt'*
1402'breakindentopt' 'briopt' string (default empty)
1403 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001404 {not available when compiled without the |+linebreak|
1405 feature}
1406 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001407 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001408 min:{n} Minimum text width that will be kept after
1409 applying 'breakindent', even if the resulting
1410 text should normally be narrower. This prevents
1411 text indented almost to the right window border
1412 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001413 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001414 shift:{n} After applying 'breakindent', the wrapped line's
1415 beginning will be shifted by the given number of
1416 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001417 indentation (negative) or emphasizing the line
1418 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001419 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001420 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001421 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001422 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001423 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001424 numbered or bulleted list (using the
1425 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001426 list:-1 Uses the length of a match with 'formatlistpat'
1427 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001428 (default: 0)
1429 column:{n} Indent at column {n}. Will overrule the other
1430 sub-options. Note: an additional indent may be
1431 added for the 'showbreak' setting.
1432 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001433
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001435'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001437 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001439 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001440 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441 buffer Use the directory of the related buffer.
1442 current Use the current directory.
1443 {path} Use the specified directory
1444
1445 *'bufhidden'* *'bh'*
1446'bufhidden' 'bh' string (default: "")
1447 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448 This option specifies what happens when a buffer is no longer
1449 displayed in a window:
1450 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001451 hide hide the buffer (don't unload it), even if 'hidden' is
1452 not set
1453 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001454 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001455 delete delete the buffer from the buffer list, even if
1456 'hidden' is set; the |:hide| command will also delete
1457 the buffer, making it behave like |:bdelete|
1458 wipe wipe the buffer from the buffer list, even if
1459 'hidden' is set; the |:hide| command will also wipe
1460 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001462 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001463 are lost without a warning. Also, these values may break autocommands
1464 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 This option is used together with 'buftype' and 'swapfile' to specify
1466 special kinds of buffers. See |special-buffers|.
1467
1468 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1469'buflisted' 'bl' boolean (default: on)
1470 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471 When this option is set, the buffer shows up in the buffer list. If
1472 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1473 This option is reset by Vim for buffers that are only used to remember
1474 a file name or marks. Vim sets it when starting to edit a buffer.
1475 But not when moving to a buffer with ":buffer".
1476
1477 *'buftype'* *'bt'* *E382*
1478'buftype' 'bt' string (default: "")
1479 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001480 The value of this option specifies the type of a buffer:
1481 <empty> normal buffer
1482 nofile buffer which is not related to a file and will not be
1483 written
1484 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001485 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001486 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001488 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 help help buffer (you are not supposed to set this
1490 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001491 terminal buffer for a |terminal| (you are not supposed to set
1492 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001493 prompt buffer where only the last line can be edited, meant
1494 to be used by a plugin, see |prompt-buffer|
1495 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001496 popup buffer used in a popup window, see |popup|.
1497 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498
1499 This option is used together with 'bufhidden' and 'swapfile' to
1500 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001501 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502
1503 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001504 One such effect is that Vim will not check the timestamp of the file,
1505 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506
Bram Moolenaar280f1262006-01-30 00:14:18 +00001507 A "quickfix" buffer is only used for the error list and the location
1508 list. This value is set by the |:cwindow| and |:lwindow| commands and
1509 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001510
1511 "nofile" and "nowrite" buffers are similar:
1512 both: The buffer is not to be written to disk, ":w" doesn't
1513 work (":w filename" does work though).
1514 both: The buffer is never considered to be |'modified'|.
1515 There is no warning when the changes will be lost, for
1516 example when you quit Vim.
1517 both: A swap file is only created when using too much memory
1518 (when 'swapfile' has been reset there is never a swap
1519 file).
1520 nofile only: The buffer name is fixed, it is not handled like a
1521 file name. It is not modified in response to a |:cd|
1522 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001523 both: When using ":e bufname" and already editing "bufname"
1524 the buffer is made empty and autocommands are
1525 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001526 *E676*
1527 "acwrite" implies that the buffer name is not related to a file, like
1528 "nofile", but it will be written. Thus, in contrast to "nofile" and
1529 "nowrite", ":w" does work and a modified buffer can't be abandoned
1530 without saving. For writing there must be matching |BufWriteCmd|,
1531 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532
1533 *'casemap'* *'cmp'*
1534'casemap' 'cmp' string (default: "internal,keepascii")
1535 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 Specifies details about changing the case of letters. It may contain
1537 these words, separated by a comma:
1538 internal Use internal case mapping functions, the current
1539 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001540 matters when 'encoding' is a Unicode encoding,
1541 "latin1" or "iso-8859-15". When "internal" is
1542 omitted, the towupper() and towlower() system library
1543 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1545 case mapping, the current locale is not effective.
1546 This probably only matters for Turkish.
1547
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001548 *'cdhome'* *'cdh'*
1549'cdhome' 'cdh' boolean (default: off)
1550 global
1551 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1552 current working directory to the |$HOME| directory like in Unix.
1553 When off, those commands just print the current directory name.
1554 On Unix this option has no effect.
1555 NOTE: This option is reset when 'compatible' is set.
1556
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 *'cdpath'* *'cd'* *E344* *E346*
1558'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1559 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001561 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1562 searched for has a relative path, not an absolute part starting with
1563 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001564 The 'cdpath' option's value has the same form and semantics as
1565 |'path'|. Also see |file-searching|.
1566 The default value is taken from $CDPATH, with a "," prepended to look
1567 in the current directory first.
1568 If the default value taken from $CDPATH is not what you want, include
1569 a modified version of the following command in your vimrc file to
1570 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001571 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001572< This option cannot be set from a |modeline| or in the |sandbox|, for
1573 security reasons.
1574 (parts of 'cdpath' can be passed to the shell to expand file names).
1575
1576 *'cedit'*
1577'cedit' string (Vi default: "", Vim default: CTRL-F)
1578 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001579 The key used in Command-line Mode to open the command-line window.
1580 The default is CTRL-F when 'compatible' is off.
1581 Only non-printable keys are allowed.
1582 The key can be specified as a single character, but it is difficult to
1583 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001584 :exe "set cedit=\<C-Y>"
1585 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001586< |Nvi| also has this option, but it only uses the first character.
1587 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001588 NOTE: This option is set to the Vim default value when 'compatible'
1589 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590
1591 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1592'charconvert' 'ccv' string (default "")
1593 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001594 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595 An expression that is used for character encoding conversion. It is
1596 evaluated when a file that is to be read or has been written has a
1597 different encoding from what is desired.
1598 'charconvert' is not used when the internal iconv() function is
1599 supported and is able to do the conversion. Using iconv() is
1600 preferred, because it is much faster.
1601 'charconvert' is not used when reading stdin |--|, because there is no
1602 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001603 The expression must return zero, false or an empty string for success,
1604 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 The possible encoding names encountered are in 'encoding'.
1606 Additionally, names given in 'fileencodings' and 'fileencoding' are
1607 used.
1608 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1609 is done internally by Vim, 'charconvert' is not used for this.
1610 'charconvert' is also used to convert the viminfo file, if the 'c'
1611 flag is present in 'viminfo'. Also used for Unicode conversion.
1612 Example: >
1613 set charconvert=CharConvert()
1614 fun CharConvert()
1615 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001616 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1617 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618 return v:shell_error
1619 endfun
1620< The related Vim variables are:
1621 v:charconvert_from name of the current encoding
1622 v:charconvert_to name of the desired encoding
1623 v:fname_in name of the input file
1624 v:fname_out name of the output file
1625 Note that v:fname_in and v:fname_out will never be the same.
1626 Note that v:charconvert_from and v:charconvert_to may be different
1627 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001628
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629 Encryption is not done by Vim when using 'charconvert'. If you want
1630 to encrypt the file after conversion, 'charconvert' should take care
1631 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001632
1633 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1634 replaced with the script ID (|local-function|). Example: >
1635 set charconvert=s:MyConvert()
1636 set charconvert=<SID>SomeConvert()
1637< Otherwise the expression is evaluated in the context of the script
1638 where the option was set, thus script-local items are available.
1639
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640 This option cannot be set from a |modeline| or in the |sandbox|, for
1641 security reasons.
1642
1643 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1644'cindent' 'cin' boolean (default off)
1645 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001646 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647 that trigger reindenting in insert mode and 'cinoptions' to set your
1648 preferred indent style.
1649 If 'indentexpr' is not empty, it overrules 'cindent'.
1650 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1651 the "=" operator indents using this algorithm rather than calling an
1652 external program.
1653 See |C-indenting|.
1654 When you don't like the way 'cindent' works, try the 'smartindent'
1655 option or 'indentexpr'.
1656 This option is not used when 'paste' is set.
1657 NOTE: This option is reset when 'compatible' is set.
1658
1659 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001660'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001661 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001662 A list of keys that, when typed in Insert mode, cause reindenting of
1663 the current line. Only used if 'cindent' is on and 'indentexpr' is
1664 empty.
1665 For the format of this option see |cinkeys-format|.
1666 See |C-indenting|.
1667
1668 *'cinoptions'* *'cino'*
1669'cinoptions' 'cino' string (default "")
1670 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1672 program. See |cinoptions-values| for the values of this option, and
1673 |C-indenting| for info on C indenting in general.
1674
1675
1676 *'cinwords'* *'cinw'*
1677'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1678 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 These keywords start an extra indent in the next line when
1680 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1681 an appropriate place (inside {}).
1682 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1683 matter, include the keyword both the uppercase and lowercase:
1684 "if,If,IF".
1685
Tom Praschan3506cf32022-04-07 12:39:08 +01001686 *'cinscopedecls'* *'cinsd'*
1687'cinscopedecls' 'cinsd' string (default "public,protected,private")
1688 local to buffer
Tom Praschan3506cf32022-04-07 12:39:08 +01001689 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1690 Useful e.g. for working with the Qt framework that defines additional
1691 scope declarations "signals", "public slots" and "private slots": >
1692 set cinscopedecls+=signals,public\ slots,private\ slots
1693
1694< *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1696 for X-windows, "" otherwise)
1697 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001698 {only in GUI versions or when the |+xterm_clipboard|
1699 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001700 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001701 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001702 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001703 prepend, e.g.: >
1704 set clipboard^=unnamed
1705< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001707 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 unnamed When included, Vim will use the clipboard register '*'
1709 for all yank, delete, change and put operations which
1710 would normally go to the unnamed register. When a
1711 register is explicitly specified, it will always be
1712 used regardless of whether "unnamed" is in 'clipboard'
1713 or not. The clipboard register can always be
1714 explicitly accessed using the "* notation. Also see
1715 |gui-clipboard|.
1716
Bram Moolenaar30b65812012-07-12 22:01:11 +02001717 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001718 unnamedplus A variant of the "unnamed" flag which uses the
1719 clipboard register '+' (|quoteplus|) instead of
1720 register '*' for all yank, delete, change and put
1721 operations which would normally go to the unnamed
1722 register. When "unnamed" is also included to the
1723 option, yank operations (but not delete, change or
1724 put) will additionally copy the text into register
1725 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001726 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001727 Availability can be checked with: >
1728 if has('unnamedplus')
1729<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001730 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 autoselect Works like the 'a' flag in 'guioptions': If present,
1732 then whenever Visual mode is started, or the Visual
1733 area extended, Vim tries to become the owner of the
1734 windowing system's global selection or put the
1735 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001736 register "*. See |'go-a'| and |quotestar| for details.
1737 When the GUI is active, the 'a' flag in 'guioptions'
1738 is used, when the GUI is not active, this "autoselect"
1739 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740 Also applies to the modeless selection.
1741
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001742 *clipboard-autoselectplus*
1743 autoselectplus Like "autoselect" but using the + register instead of
1744 the * register. Compare to the 'P' flag in
1745 'guioptions'.
1746
1747 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748 autoselectml Like "autoselect", but for the modeless selection
1749 only. Compare to the 'A' flag in 'guioptions'.
1750
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001751 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001752 html When the clipboard contains HTML, use this when
1753 pasting. When putting text on the clipboard, mark it
1754 as HTML. This works to copy rendered HTML from
1755 Firefox, paste it as raw HTML in Vim, select the HTML
1756 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001757 You probably want to add this only temporarily,
1758 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001759 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001760
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001761 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762 exclude:{pattern}
1763 Defines a pattern that is matched against the name of
1764 the terminal 'term'. If there is a match, no
1765 connection will be made to the X server. This is
1766 useful in this situation:
1767 - Running Vim in a console.
1768 - $DISPLAY is set to start applications on another
1769 display.
1770 - You do not want to connect to the X server in the
1771 console, but do want this in a terminal emulator.
1772 To never connect to the X server use: >
1773 exclude:.*
1774< This has the same effect as using the |-X| argument.
1775 Note that when there is no connection to the X server
1776 the window title won't be restored and the clipboard
1777 cannot be accessed.
1778 The value of 'magic' is ignored, {pattern} is
1779 interpreted as if 'magic' was on.
1780 The rest of the option value will be used for
1781 {pattern}, this must be the last entry.
1782
1783 *'cmdheight'* *'ch'*
1784'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001785 global or local to tab page
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786 Number of screen lines to use for the command-line. Helps avoiding
1787 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001788 The value of this option is stored with the tab page, so that each tab
1789 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001791 When 'cmdheight' is zero, there is no command-line unless it is being
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01001792 used. Some informative messages will not be displayed, any other
Bram Moolenaare1f3fd12022-08-15 18:51:32 +01001793 messages will cause the |hit-enter| prompt. Expect some other
1794 unexpected behavior too.
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001795
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 *'cmdwinheight'* *'cwh'*
1797'cmdwinheight' 'cwh' number (default 7)
1798 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 Number of screen lines to use for the command-line window. |cmdwin|
1800
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001801 *'colorcolumn'* *'cc'*
1802'colorcolumn' 'cc' string (default "")
1803 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001804 {not available when compiled without the |+syntax|
1805 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001806 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001807 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1808 text. Will make screen redrawing slower.
1809 The screen column can be an absolute number, or a number preceded with
1810 '+' or '-', which is added to or subtracted from 'textwidth'. >
1811
1812 :set cc=+1 " highlight column after 'textwidth'
1813 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1814 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1815<
1816 When 'textwidth' is zero then the items with '-' and '+' are not used.
1817 A maximum of 256 columns are highlighted.
1818
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 *'columns'* *'co'* *E594*
1820'columns' 'co' number (default 80 or terminal width)
1821 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001823 initialization and does not have to be set by hand. Also see
1824 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 When Vim is running in the GUI or in a resizable window, setting this
1826 option will cause the window size to be changed. When you only want
1827 to use the size for the GUI, put the command in your |gvimrc| file.
1828 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001829 number of columns of the display, the display may be messed up. For
1830 the GUI it is always possible and Vim limits the number of columns to
1831 what fits on the screen. You can use this command to get the widest
1832 window possible: >
1833 :set columns=9999
1834< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835
1836 *'comments'* *'com'* *E524* *E525*
1837'comments' 'com' string (default
1838 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1839 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001840 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 |format-comments|. See |option-backslash| about using backslashes to
1842 insert a space.
1843
1844 *'commentstring'* *'cms'* *E537*
1845'commentstring' 'cms' string (default "/*%s*/")
1846 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001847 {not available when compiled without the |+folding|
1848 feature}
1849 A template for a comment. The "%s" in the value is replaced with the
1850 comment text. Currently only used to add markers for folding, see
1851 |fold-marker|.
1852
1853 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001854'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001855 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857 This option has the effect of making Vim either more Vi-compatible, or
1858 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001859
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001861 other options are also changed as a side effect.
1862 NOTE: Setting or resetting this option can have a lot of unexpected
1863 effects: Mappings are interpreted in another way, undo behaves
1864 differently, etc. If you set this option in your vimrc file, you
1865 should probably put it at the very start.
1866
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867 By default this option is on and the Vi defaults are used for the
1868 options. This default was chosen for those people who want to use Vim
1869 just like Vi, and don't even (want to) know about the 'compatible'
1870 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001871 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001872 this option is switched off, and all options that have not been
1873 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001874 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001875 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001876 happen for the system-wide vimrc or gvimrc file, nor for a file given
1877 with the |-u| argument). Also see |compatible-default| and
1878 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001879 You can also set this option with the "-C" argument, and reset it with
1880 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001881 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001882
Bram Moolenaar214641f2017-03-05 17:04:09 +01001883 When this option is set, numerous other options are set to make Vim as
1884 Vi-compatible as possible. When this option is unset, various options
1885 are set to make Vim more useful. The table below lists all the
1886 options affected.
1887 The {?} column indicates when the options are affected:
1888 + Means that the option is set to the value given in {set value} when
1889 'compatible' is set.
1890 & Means that the option is set to the value given in {set value} when
1891 'compatible' is set AND is set to its Vim default value when
1892 'compatible' is unset.
1893 - Means the option is NOT changed when setting 'compatible' but IS
1894 set to its Vim default when 'compatible' is unset.
1895 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896
Bram Moolenaar036986f2017-03-16 17:41:02 +01001897 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001898
1899 'allowrevins' + off no CTRL-_ command
1900 'antialias' + off don't use antialiased fonts
1901 'arabic' + off reset arabic-related options
1902 'arabicshape' + on correct character shapes
1903 'backspace' + "" normal backspace
1904 'backup' + off no backup file
1905 'backupcopy' & Unix: "yes" backup file is a copy
1906 else: "auto" copy or rename backup file
1907 'balloonexpr' + "" text to show in evaluation balloon
1908 'breakindent' + off don't indent when wrapping lines
1909 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001910 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001911 'cindent' + off no C code indentation
1912 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1913 'copyindent' + off don't copy indent structure
1914 'cpoptions' & (all flags) Vi-compatible flags
1915 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001916 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001917 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001918 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001919 'cscopeverbose' + off see |cscopeverbose|
1920 'delcombine' + off unicode: delete whole char combination
1921 'digraph' + off no digraphs
1922 'esckeys' & off no <Esc>-keys in Insert mode
1923 'expandtab' + off tabs not expanded to spaces
1924 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001925 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001926 'formatexpr' + "" use 'formatprg' for auto-formatting
1927 'formatoptions' & "vt" Vi compatible formatting
1928 'gdefault' + off no default 'g' flag for ":s"
1929 'history' & 0 no commandline history
1930 'hkmap' + off no Hebrew keyboard mapping
1931 'hkmapp' + off no phonetic Hebrew keyboard mapping
1932 'hlsearch' + off no highlighting of search matches
1933 'incsearch' + off no incremental searching
1934 'indentexpr' + "" no indenting by expression
1935 'insertmode' + off do not start in Insert mode
1936 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001938 'joinspaces' + on insert 2 spaces after period
1939 'modeline' & off no modelines
1940 'more' & off no pauses in listings
1941 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1942 'numberwidth' & 8 min number of columns for line number
1943 'preserveindent'+ off don't preserve current indent structure
1944 when changing it
1945 'revins' + off no reverse insert
1946 'ruler' + off no ruler
1947 'scrolljump' + 1 no jump scroll
1948 'scrolloff' + 0 no scroll offset
1949 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1950 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001951 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001952 'showcmd' & off command characters not shown
1953 'showmode' & off current mode not shown
1954 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1955 'smartcase' + off no automatic ignore case switch
1956 'smartindent' + off no smart indentation
1957 'smarttab' + off no smart tab size
1958 'softtabstop' + 0 tabs are always 'tabstop' positions
1959 'startofline' + on goto startofline with some commands
1960 'tagcase' & "followic" 'ignorecase' when searching tags file
1961 'tagrelative' & off tag file names are not relative
1962 'termguicolors' + off don't use highlight-(guifg|guibg)
1963 'textauto' & off no automatic textmode detection
1964 'textwidth' + 0 no automatic line wrap
1965 'tildeop' + off tilde is not an operator
1966 'ttimeout' + off no terminal timeout
1967 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001968 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001969 'virtualedit' + "" cursor can only be placed on characters
1970 'whichwrap' & "" left-right movements don't wrap
1971 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001972 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001973 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974
1975 *'complete'* *'cpt'* *E535*
1976'complete' 'cpt' string (default: ".,w,b,u,t,i")
1977 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001978 This option specifies how keyword completion |ins-completion| works
1979 when CTRL-P or CTRL-N are used. It is also used for whole-line
1980 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001981 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001982 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001983 w scan buffers from other windows
1984 b scan other loaded buffers that are in the buffer list
1985 u scan the unloaded buffers that are in the buffer list
1986 U scan the buffers that are not in the buffer list
1987 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001988 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001989 k{dict} scan the file {dict}. Several "k" flags can be given,
1990 patterns are valid too. For example: >
1991 :set cpt=k/usr/dict/*,k~/spanish
1992< s scan the files given with the 'thesaurus' option
1993 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1994 are valid too.
1995 i scan current and included files
1996 d scan current and included files for defined name or macro
1997 |i_CTRL-X_CTRL-D|
1998 ] tag completion
1999 t same as "]"
2000
2001 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2002 not executed, this may lead to unexpected completions from some files
2003 (gzipped files for example). Unloaded buffers are not scanned for
2004 whole-line completion.
2005
2006 The default is ".,w,b,u,t,i", which means to scan:
2007 1. the current buffer
2008 2. buffers in other windows
2009 3. other loaded buffers
2010 4. unloaded buffers
2011 5. tags
2012 6. included files
2013
2014 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002015 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2016 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002017
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002018 *'completefunc'* *'cfu'*
2019'completefunc' 'cfu' string (default: empty)
2020 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002021 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002022 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002023 This option specifies a function to be used for Insert mode completion
2024 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002025 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002026 invoked and what it should return. The value can be the name of a
2027 function, a |lambda| or a |Funcref|. See |option-value-function| for
2028 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002029 This option cannot be set from a |modeline| or in the |sandbox|, for
2030 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002031
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002032 *'completeslash'* *'csl'*
2033'completeslash' 'csl' string (default: "")
2034 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002035 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002036 When this option is set it overrules 'shellslash' for completion:
2037 - When this option is set to "slash", a forward slash is used for path
2038 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002039 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002040 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002041 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002042 - When this option is empty, same character is used as for
2043 'shellslash'.
2044 For Insert mode completion the buffer-local value is used. For
2045 command line completion the global value is used.
2046
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002047 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002048'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002049 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002050 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002051 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002052
2053 menu Use a popup menu to show the possible completions. The
2054 menu is only shown when there is more than one match and
2055 sufficient colors are available. |ins-completion-menu|
2056
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002057 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002058 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002059 match, e.g., what file it comes from.
2060
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002061 longest Only insert the longest common text of the matches. If
2062 the menu is displayed you can use CTRL-L to add more
2063 characters. Whether case is ignored depends on the kind
2064 of completion. For buffer text the 'ignorecase' option is
2065 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002066
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002067 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002068 completion in the preview window. Only works in
2069 combination with "menu" or "menuone".
2070
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002071 popup Show extra information about the currently selected
2072 completion in a popup window. Only works in combination
2073 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002074 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002075 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002076
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002077 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002078 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002079 |CompleteChanged| autocommand to fetch the info and call
2080 |popup_show()| once the popup has been filled.
2081 See the example at |complete-popuphidden|.
2082 {only works when compiled with the |+textprop| feature}
2083
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002084 noinsert Do not insert any text for a match until the user selects
2085 a match from the menu. Only works in combination with
2086 "menu" or "menuone". No effect if "longest" is present.
2087
2088 noselect Do not select a match in the menu, force the user to
2089 select one from the menu. Only works in combination with
2090 "menu" or "menuone".
2091
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002092
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002093 *'completepopup'* *'cpp'*
2094'completepopup' 'cpp' string (default empty)
2095 global
2096 {not available when compiled without the |+textprop|
2097 or |+quickfix| feature}
2098 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002099 properties of the info popup when it is created. If an info popup
2100 window already exists it is closed, so that the option value is
2101 applied when it is created again.
2102 You can also use |popup_findinfo()| and then set properties for an
2103 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002104
2105
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002106 *'concealcursor'* *'cocu'*
2107'concealcursor' 'cocu' string (default: "")
2108 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002109 {not available when compiled without the |+conceal|
2110 feature}
2111 Sets the modes in which text in the cursor line can also be concealed.
2112 When the current mode is listed then concealing happens just like in
2113 other lines.
2114 n Normal mode
2115 v Visual mode
2116 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002117 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002118
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002119 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002120 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002121 are moving around text is concealed, but when starting to insert text
2122 or selecting a Visual area the concealed text is displayed, so that
2123 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002124 Keep in mind that the cursor position is not always where it's
2125 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002126
2127
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002128 *'conceallevel'* *'cole'*
2129'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002130 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002131 {not available when compiled without the |+conceal|
2132 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002133 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2134 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002135
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002136 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002137 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002138 1 Each block of concealed text is replaced with one
2139 character. If the syntax item does not have a custom
2140 replacement character defined (see |:syn-cchar|) the
2141 character defined in 'listchars' is used (default is a
2142 space).
2143 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002144 2 Concealed text is completely hidden unless it has a
2145 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002146 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002147 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002148
Bram Moolenaara7781e02010-07-19 20:13:22 +02002149 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002150 edit and copy the text. This can be changed with the 'concealcursor'
2151 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002152
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2154'confirm' 'cf' boolean (default off)
2155 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 When 'confirm' is on, certain operations that would normally
2157 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2158 instead raise a |dialog| asking if you wish to save the current
2159 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2160 If 'confirm' is off you can still activate confirmation for one
2161 command only (this is most useful in mappings) with the |:confirm|
2162 command.
2163 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2164
2165 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2166'conskey' 'consk' boolean (default off)
2167 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002168 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002169
2170 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2171'copyindent' 'ci' boolean (default off)
2172 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002173 Copy the structure of the existing lines indent when autoindenting a
2174 new line. Normally the new indent is reconstructed by a series of
2175 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2176 in which case only spaces are used). Enabling this option makes the
2177 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002178 existing line. 'expandtab' has no effect on these characters, a Tab
2179 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002181 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182 Also see 'preserveindent'.
2183
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002184 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185'cpoptions' 'cpo' string (Vim default: "aABceFs",
2186 Vi default: all flags)
2187 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002188 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002189 this indicates Vi-compatible behavior. This is used for things where
2190 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191 'cpoptions' stands for "compatible-options".
2192 Commas can be added for readability.
2193 To avoid problems with flags that are added in the future, use the
2194 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002195
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196 NOTE: This option is set to the Vi default value when 'compatible' is
2197 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002198
2199 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2200 is saved, 'cpoptions' is set to the Vim default, and the saved value
2201 is restored at the end of the script. Changes to the value of
2202 'cpoptions' will be applied to the saved value, but keep in mind that
2203 removing a flag that is not present when 'cpoptions' is changed has no
2204 effect. In the |.vimrc| file the value is not restored, thus using
2205 `vim9script` in the |.vimrc| file results in using the Vim default.
2206
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002207 NOTE: This option is set to the POSIX default value at startup when
2208 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002209 variable exists |posix|. This means Vim tries to behave like the
2210 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211
2212 contains behavior ~
2213 *cpo-a*
2214 a When included, a ":read" command with a file name
2215 argument will set the alternate file name for the
2216 current window.
2217 *cpo-A*
2218 A When included, a ":write" command with a file name
2219 argument will set the alternate file name for the
2220 current window.
2221 *cpo-b*
2222 b "\|" in a ":map" command is recognized as the end of
2223 the map command. The '\' is included in the mapping,
2224 the text after the '|' is interpreted as the next
2225 command. Use a CTRL-V instead of a backslash to
2226 include the '|' in the mapping. Applies to all
2227 mapping, abbreviation, menu and autocmd commands.
2228 See also |map_bar|.
2229 *cpo-B*
2230 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002231 abbreviations, user commands and the "to" part of the
2232 menu commands. Remove this flag to be able to use a
2233 backslash like a CTRL-V. For example, the command
2234 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002235 'B' included: "\^[" (^[ is a real <Esc>)
2236 'B' excluded: "<Esc>" (5 characters)
2237 ('<' excluded in both cases)
2238 *cpo-c*
2239 c Searching continues at the end of any match at the
2240 cursor position, but not further than the start of the
2241 next line. When not present searching continues
2242 one character from the cursor position. With 'c'
2243 "abababababab" only gets three matches when repeating
2244 "/abab", without 'c' there are five matches.
2245 *cpo-C*
2246 C Do not concatenate sourced lines that start with a
2247 backslash. See |line-continuation|.
2248 *cpo-d*
2249 d Using "./" in the 'tags' option doesn't mean to use
2250 the tags file relative to the current file, but the
2251 tags file in the current directory.
2252 *cpo-D*
2253 D Can't use CTRL-K to enter a digraph after Normal mode
2254 commands with a character argument, like |r|, |f| and
2255 |t|.
2256 *cpo-e*
2257 e When executing a register with ":@r", always add a
2258 <CR> to the last line, also when the register is not
2259 linewise. If this flag is not present, the register
2260 is not linewise and the last line does not end in a
2261 <CR>, then the last line is put on the command-line
2262 and can be edited before hitting <CR>.
2263 *cpo-E*
2264 E It is an error when using "y", "d", "c", "g~", "gu" or
2265 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002266 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267 This makes "y0" fail in the first column.
2268 *cpo-f*
2269 f When included, a ":read" command with a file name
2270 argument will set the file name for the current buffer,
2271 if the current buffer doesn't have a file name yet.
2272 *cpo-F*
2273 F When included, a ":write" command with a file name
2274 argument will set the file name for the current
2275 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002276 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002277 *cpo-g*
2278 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002279 *cpo-H*
2280 H When using "I" on a line with only blanks, insert
2281 before the last blank. Without this flag insert after
2282 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002283 *cpo-i*
2284 i When included, interrupting the reading of a file will
2285 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002286 *cpo-I*
2287 I When moving the cursor up or down just after inserting
2288 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289 *cpo-j*
2290 j When joining lines, only add two spaces after a '.',
2291 not after '!' or '?'. Also see 'joinspaces'.
2292 *cpo-J*
2293 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002294 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002295 white space.
2296 *cpo-k*
2297 k Disable the recognition of raw key codes in
2298 mappings, abbreviations, and the "to" part of menu
2299 commands. For example, if <Key> sends ^[OA (where ^[
2300 is <Esc>), the command ":map X ^[OA" results in X
2301 being mapped to:
2302 'k' included: "^[OA" (3 characters)
2303 'k' excluded: "<Key>" (one key code)
2304 Also see the '<' flag below.
2305 *cpo-K*
2306 K Don't wait for a key code to complete when it is
2307 halfway a mapping. This breaks mapping <F1><F1> when
2308 only part of the second <F1> has been read. It
2309 enables cancelling the mapping by typing <F1><Esc>.
2310 *cpo-l*
2311 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002312 literally, only "\]", "\^", "\-" and "\\" are special.
2313 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2315 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002316 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317 *cpo-L*
2318 L When the 'list' option is set, 'wrapmargin',
2319 'textwidth', 'softtabstop' and Virtual Replace mode
2320 (see |gR|) count a <Tab> as two characters, instead of
2321 the normal behavior of a <Tab>.
2322 *cpo-m*
2323 m When included, a showmatch will always wait half a
2324 second. When not included, a showmatch will wait half
2325 a second or until a character is typed. |'showmatch'|
2326 *cpo-M*
2327 M When excluded, "%" matching will take backslashes into
2328 account. Thus in "( \( )" and "\( ( \)" the outer
2329 parenthesis match. When included "%" ignores
2330 backslashes, which is Vi compatible.
2331 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002332 n When included, the column used for 'number' and
2333 'relativenumber' will also be used for text of wrapped
2334 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002335 *cpo-o*
2336 o Line offset to search command is not remembered for
2337 next search.
2338 *cpo-O*
2339 O Don't complain if a file is being overwritten, even
2340 when it didn't exist when editing it. This is a
2341 protection against a file unexpectedly created by
2342 someone else. Vi didn't complain about this.
2343 *cpo-p*
2344 p Vi compatible Lisp indenting. When not present, a
2345 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002346 *cpo-P*
2347 P When included, a ":write" command that appends to a
2348 file will set the file name for the current buffer, if
2349 the current buffer doesn't have a file name yet and
2350 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002351 *cpo-q*
2352 q When joining multiple lines leave the cursor at the
2353 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354 *cpo-r*
2355 r Redo ("." command) uses "/" to repeat a search
2356 command, instead of the actually used search string.
2357 *cpo-R*
2358 R Remove marks from filtered lines. Without this flag
2359 marks are kept like |:keepmarks| was used.
2360 *cpo-s*
2361 s Set buffer options when entering the buffer for the
2362 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002363 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364 set when the buffer is created.
2365 *cpo-S*
2366 S Set buffer options always when entering a buffer
2367 (except 'readonly', 'fileformat', 'filetype' and
2368 'syntax'). This is the (most) Vi compatible setting.
2369 The options are set to the values in the current
2370 buffer. When you change an option and go to another
2371 buffer, the value is copied. Effectively makes the
2372 buffer options global to all buffers.
2373
2374 's' 'S' copy buffer options
2375 no no when buffer created
2376 yes no when buffer first entered (default)
2377 X yes each time when buffer entered (vi comp.)
2378 *cpo-t*
2379 t Search pattern for the tag command is remembered for
2380 "n" command. Otherwise Vim only puts the pattern in
2381 the history for search pattern, but doesn't change the
2382 last used search pattern.
2383 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002384 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385 *cpo-v*
2386 v Backspaced characters remain visible on the screen in
2387 Insert mode. Without this flag the characters are
2388 erased from the screen right away. With this flag the
2389 screen newly typed text overwrites backspaced
2390 characters.
2391 *cpo-w*
2392 w When using "cw" on a blank character, only change one
2393 character and not all blanks until the start of the
2394 next word.
2395 *cpo-W*
2396 W Don't overwrite a readonly file. When omitted, ":w!"
2397 overwrites a readonly file, if possible.
2398 *cpo-x*
2399 x <Esc> on the command-line executes the command-line.
2400 The default in Vim is to abandon the command-line,
2401 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002402 *cpo-X*
2403 X When using a count with "R" the replaced text is
2404 deleted only once. Also when repeating "R" with "."
2405 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002407 y A yank command can be redone with ".". Think twice if
2408 you really want to use this, it may break some
2409 plugins, since most people expect "." to only repeat a
2410 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002411 *cpo-Z*
2412 Z When using "w!" while the 'readonly' option is set,
2413 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002414 *cpo-!*
2415 ! When redoing a filter command, use the last used
2416 external command, whatever it was. Otherwise the last
2417 used -filter- command is used.
2418 *cpo-$*
2419 $ When making a change to one line, don't redisplay the
2420 line, but put a '$' at the end of the changed text.
2421 The changed text will be overwritten when you type the
2422 new text. The line is redisplayed if you type any
2423 command that moves the cursor from the insertion
2424 point.
2425 *cpo-%*
2426 % Vi-compatible matching is done for the "%" command.
2427 Does not recognize "#if", "#endif", etc.
2428 Does not recognize "/*" and "*/".
2429 Parens inside single and double quotes are also
2430 counted, causing a string that contains a paren to
2431 disturb the matching. For example, in a line like
2432 "if (strcmp("foo(", s))" the first paren does not
2433 match the last one. When this flag is not included,
2434 parens inside single and double quotes are treated
2435 specially. When matching a paren outside of quotes,
2436 everything inside quotes is ignored. When matching a
2437 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002438 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002439 This flag is also used for other features, such as
2440 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002441 *cpo--*
2442 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002443 it would go above the first line or below the last
2444 line. Without it the cursor moves to the first or
2445 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002446 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002447 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002448 *cpo-+*
2449 + When included, a ":write file" command will reset the
2450 'modified' flag of the buffer, even though the buffer
2451 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002452 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002453 * Use ":*" in the same way as ":@". When not included,
2454 ":*" is an alias for ":'<,'>", select the Visual area.
2455 *cpo-<*
2456 < Disable the recognition of special key codes in |<>|
2457 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002458 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459 ":map X <Tab>" results in X being mapped to:
2460 '<' included: "<Tab>" (5 characters)
2461 '<' excluded: "^I" (^I is a real <Tab>)
2462 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002463 *cpo->*
2464 > When appending to a register, put a line break before
2465 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002466 *cpo-;*
2467 ; When using |,| or |;| to repeat the last |t| search
2468 and the cursor is right in front of the searched
2469 character, the cursor won't move. When not included,
2470 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002471 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002472
2473 POSIX flags. These are not included in the Vi default value, except
2474 when $VIM_POSIX was set on startup. |posix|
2475
2476 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002477 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002478 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002479 *cpo-&*
2480 & When ":preserve" was used keep the swap file when
2481 exiting normally while this buffer is still loaded.
2482 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002483 *cpo-\*
2484 \ Backslash in a [] range in a search pattern is taken
2485 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002486 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2487 '\' excluded: "/[ \-]" finds <Space> and '-'
2488 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002489 *cpo-/*
2490 / When "%" is used as the replacement string in a |:s|
2491 command, use the previous replacement string. |:s%|
2492 *cpo-{*
2493 { The |{| and |}| commands also stop at a "{" character
2494 at the start of a line.
2495 *cpo-.*
2496 . The ":chdir" and ":cd" commands fail if the current
2497 buffer is modified, unless ! is used. Vim doesn't
2498 need this, since it remembers the full path of an
2499 opened file.
2500 *cpo-bar*
2501 | The value of the $LINES and $COLUMNS environment
2502 variables overrule the terminal size values obtained
2503 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002504
Bram Moolenaar071d4272004-06-13 20:20:40 +00002505
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002506 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002507'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002508 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002509 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002510 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002511 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002512 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002513 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002514 blowfish Blowfish method. Medium strong encryption but it has
2515 an implementation flaw. Requires Vim 7.3 or later,
2516 files can NOT be read by Vim 7.2 and older. This adds
2517 a "seed" to the file, every time you write the file
2518 the encrypted bytes will be different.
2519 *blowfish2*
2520 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002521 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002522 and older. This adds a "seed" to the file, every time
2523 you write the file the encrypted bytes will be
2524 different. The whole undo file is encrypted, not just
2525 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002526 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002527 *E1197* *E1198* *E1199* *E1200* *E1201*
2528 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2529 Code. Medium strong till strong encryption.
2530 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002531 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002532 It adds a seed and a message authentication code (MAC)
2533 to the file. This needs at least a Vim 8.2.3022 to
2534 read the encrypted file.
2535 Encryption of swap files is not supported, therefore
2536 no swap file will be used when xchacha20 encryption is
2537 enabled.
2538 Encryption of undo files is not yet supported,
2539 therefore no undo file will currently be written.
2540 CURRENTLY EXPERIMENTAL: Files written with this method
2541 might have to be read back with the same version of
2542 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002543
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002544 You should use "blowfish2", also to re-encrypt older files.
2545
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002546 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002547 to the detected method of the file being read. Thus if you write it
2548 without changing 'cryptmethod' the same method will be used.
2549 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002550 explicitly write it, you don't get a warning unless there are other
2551 modifications. Also see |:X|.
2552
2553 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002554 the value "blowfish2". When setting the local value to an empty
2555 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002556
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002557 When a new encryption method is added in a later version of Vim, and
2558 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002559 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002560
2561
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562 *'cscopepathcomp'* *'cspc'*
2563'cscopepathcomp' 'cspc' number (default 0)
2564 global
2565 {not available when compiled without the |+cscope|
2566 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567 Determines how many components of the path to show in a list of tags.
2568 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002569 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570
2571 *'cscopeprg'* *'csprg'*
2572'cscopeprg' 'csprg' string (default "cscope")
2573 global
2574 {not available when compiled without the |+cscope|
2575 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 Specifies the command to execute cscope. See |cscopeprg|.
2577 This option cannot be set from a |modeline| or in the |sandbox|, for
2578 security reasons.
2579
2580 *'cscopequickfix'* *'csqf'*
2581'cscopequickfix' 'csqf' string (default "")
2582 global
2583 {not available when compiled without the |+cscope|
2584 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585 Specifies whether to use quickfix window to show cscope results.
2586 See |cscopequickfix|.
2587
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002588 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002589'cscoperelative' 'csre' boolean (default off)
2590 global
2591 {not available when compiled without the |+cscope|
2592 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002593 In the absence of a prefix (-P) for cscope. setting this option enables
2594 to use the basename of cscope.out path as the prefix.
2595 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002596 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002597
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2599'cscopetag' 'cst' boolean (default off)
2600 global
2601 {not available when compiled without the |+cscope|
2602 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002603 Use cscope for tag commands. See |cscope-options|.
2604 NOTE: This option is reset when 'compatible' is set.
2605
2606 *'cscopetagorder'* *'csto'*
2607'cscopetagorder' 'csto' number (default 0)
2608 global
2609 {not available when compiled without the |+cscope|
2610 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 Determines the order in which ":cstag" performs a search. See
2612 |cscopetagorder|.
2613 NOTE: This option is set to 0 when 'compatible' is set.
2614
2615 *'cscopeverbose'* *'csverb'*
2616 *'nocscopeverbose'* *'nocsverb'*
2617'cscopeverbose' 'csverb' boolean (default off)
2618 global
2619 {not available when compiled without the |+cscope|
2620 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002621 Give messages when adding a cscope database. See |cscopeverbose|.
2622 NOTE: This option is reset when 'compatible' is set.
2623
Bram Moolenaar860cae12010-06-05 23:22:07 +02002624 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2625'cursorbind' 'crb' boolean (default off)
2626 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002627 When this option is set, as the cursor in the current
2628 window moves other cursorbound windows (windows that also have
2629 this option set) move their cursors to the corresponding line and
2630 column. This option is useful for viewing the
2631 differences between two versions of a file (see 'diff'); in diff mode,
2632 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002633 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002634
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002635
2636 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2637'cursorcolumn' 'cuc' boolean (default off)
2638 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002639 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002640 feature}
2641 Highlight the screen column of the cursor with CursorColumn
2642 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2643 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002644 If you only want the highlighting in the current window you can use
2645 these autocommands: >
2646 au WinLeave * set nocursorline nocursorcolumn
2647 au WinEnter * set cursorline cursorcolumn
2648<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002649
2650 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2651'cursorline' 'cul' boolean (default off)
2652 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002653 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002654 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002655 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2656 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002657 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002658 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002659
2660
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002661 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002662'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002663 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002664 {not available when compiled without the |+syntax|
2665 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002666 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002667 Valid values:
2668 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002669 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002670 "screenline" Highlight only the screen line of the cursor with
2671 CursorLine |hl-CursorLine|.
2672 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002673 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002674
2675 Special value:
2676 "both" Alias for the values "line,number".
2677
2678 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002679
2680
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 *'debug'*
2682'debug' string (default "")
2683 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002684 These values can be used:
2685 msg Error messages that would otherwise be omitted will be given
2686 anyway.
2687 throw Error messages that would otherwise be omitted will be given
2688 anyway and also throw an exception and set |v:errmsg|.
2689 beep A message will be given when otherwise only a beep would be
2690 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002691 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002692 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2693 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694
2695 *'define'* *'def'*
2696'define' 'def' string (default "^\s*#\s*define")
2697 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002698 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002699 pattern, just like for the "/" command. This option is used for the
2700 commands like "[i" and "[d" |include-search|. The 'isident' option is
2701 used to recognize the defined name after the match:
2702 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2703 See |option-backslash| about inserting backslashes to include a space
2704 or backslash.
2705 The default value is for C programs. For C++ this value would be
2706 useful, to include const type declarations: >
2707 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002708< You can also use "\ze" just before the name and continue the pattern
2709 to check what is following. E.g. for Javascript, if a function is
2710 defined with "func_name = function(args)": >
2711 ^\s*\ze\i\+\s*=\s*function(
2712< If the function is defined with "func_name : function() {...": >
2713 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002715 To avoid that use `:let` with a single quote string: >
2716 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002717<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718
2719 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2720'delcombine' 'deco' boolean (default off)
2721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722 If editing Unicode and this option is set, backspace and Normal mode
2723 "x" delete each combining character on its own. When it is off (the
2724 default) the character along with its combining characters are
2725 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002726 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727
2728 This is useful for Arabic, Hebrew and many other languages where one
2729 may have combining characters overtop of base characters, and want
2730 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002731 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732
2733 *'dictionary'* *'dict'*
2734'dictionary' 'dict' string (default "")
2735 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 List of file names, separated by commas, that are used to lookup words
2737 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2738 contain a list of words. This can be one word per line, or several
2739 words per line, separated by non-keyword characters (white space is
2740 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002741
2742 When this option is empty or an entry "spell" is present, and spell
2743 checking is enabled, words in the word lists for the currently active
2744 'spelllang' are used. See |spell|.
2745
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002746 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002747 after a comma are ignored, otherwise spaces are included in the file
2748 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002749 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 Where to find a list of words?
2751 - On FreeBSD, there is the file "/usr/share/dict/words".
2752 - In the Simtel archive, look in the "msdos/linguist" directory.
2753 - In "miscfiles" of the GNU collection.
2754 The use of |:set+=| and |:set-=| is preferred when adding or removing
2755 directories from the list. This avoids problems when a future version
2756 uses another default.
2757 Backticks cannot be used in this option for security reasons.
2758
2759 *'diff'* *'nodiff'*
2760'diff' boolean (default off)
2761 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 {not available when compiled without the |+diff|
2763 feature}
2764 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002765 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766
2767 *'dex'* *'diffexpr'*
2768'diffexpr' 'dex' string (default "")
2769 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 {not available when compiled without the |+diff|
2771 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002772 Expression which is evaluated to obtain a diff file (either ed-style
2773 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 This option cannot be set from a |modeline| or in the |sandbox|, for
2775 security reasons.
2776
2777 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002778'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 {not available when compiled without the |+diff|
2781 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002782 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 All are optional. Items must be separated by a comma.
2784
2785 filler Show filler lines, to keep the text
2786 synchronized with a window that has inserted
2787 lines at the same position. Mostly useful
2788 when windows are side-by-side and 'scrollbind'
2789 is set.
2790
2791 context:{n} Use a context of {n} lines between a change
2792 and a fold that contains unchanged lines.
2793 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002794 When using zero the context is actually one,
2795 since folds require a line in between, also
2796 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 See |fold-diff|.
2798
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002799 iblank Ignore changes where lines are all blank. Adds
2800 the "-B" flag to the "diff" command if
2801 'diffexpr' is empty. Check the documentation
2802 of the "diff" command for what this does
2803 exactly.
2804 NOTE: the diff windows will get out of sync,
2805 because no differences between blank lines are
2806 taken into account.
2807
Bram Moolenaar071d4272004-06-13 20:20:40 +00002808 icase Ignore changes in case of text. "a" and "A"
2809 are considered the same. Adds the "-i" flag
2810 to the "diff" command if 'diffexpr' is empty.
2811
2812 iwhite Ignore changes in amount of white space. Adds
2813 the "-b" flag to the "diff" command if
2814 'diffexpr' is empty. Check the documentation
2815 of the "diff" command for what this does
2816 exactly. It should ignore adding trailing
2817 white space, but not leading white space.
2818
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002819 iwhiteall Ignore all white space changes. Adds
2820 the "-w" flag to the "diff" command if
2821 'diffexpr' is empty. Check the documentation
2822 of the "diff" command for what this does
2823 exactly.
2824
2825 iwhiteeol Ignore white space changes at end of line.
2826 Adds the "-Z" flag to the "diff" command if
2827 'diffexpr' is empty. Check the documentation
2828 of the "diff" command for what this does
2829 exactly.
2830
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002831 horizontal Start diff mode with horizontal splits (unless
2832 explicitly specified otherwise).
2833
2834 vertical Start diff mode with vertical splits (unless
2835 explicitly specified otherwise).
2836
Bram Moolenaarc8234772019-11-10 21:00:27 +01002837 closeoff When a window is closed where 'diff' is set
2838 and there is only one window remaining in the
2839 same tab page with 'diff' set, execute
2840 `:diffoff` in that window. This undoes a
2841 `:diffsplit` command.
2842
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002843 hiddenoff Do not use diff mode for a buffer when it
2844 becomes hidden.
2845
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002846 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2847 starting diff mode. Without this 2 is used.
2848
Bram Moolenaar4223d432021-02-10 13:18:17 +01002849 followwrap Follow the 'wrap' option and leave as it is.
2850
Bram Moolenaare828b762018-09-10 17:51:58 +02002851 internal Use the internal diff library. This is
2852 ignored when 'diffexpr' is set. *E960*
2853 When running out of memory when writing a
2854 buffer this item will be ignored for diffs
2855 involving that buffer. Set the 'verbose'
2856 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857
Bram Moolenaare828b762018-09-10 17:51:58 +02002858 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002859 Use the indent heuristic for the internal
2860 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002861
2862 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002863 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002864 algorithms are:
2865 myers the default algorithm
2866 minimal spend extra time to generate the
2867 smallest possible diff
2868 patience patience diff algorithm
2869 histogram histogram diff algorithm
2870
2871 Examples: >
2872 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002874 :set diffopt=internal,filler,foldcolumn:3
2875 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876<
2877 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2878'digraph' 'dg' boolean (default off)
2879 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 {not available when compiled without the |+digraphs|
2881 feature}
2882 Enable the entering of digraphs in Insert mode with {char1} <BS>
2883 {char2}. See |digraphs|.
2884 NOTE: This option is reset when 'compatible' is set.
2885
2886 *'directory'* *'dir'*
2887'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002888 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 for Unix: ".,~/tmp,/var/tmp,/tmp")
2890 global
2891 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002892 Recommended value: ".,~/vimswap//" - this will put the swap file next
2893 to the edited file if possible, and in your personal swap directory
2894 otherwise. Make sure "~/vimswap//" is only readable for you.
2895
2896 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897 - The swap file will be created in the first directory where this is
2898 possible.
2899 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002900 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 - A directory "." means to put the swap file in the same directory as
2902 the edited file. On Unix, a dot is prepended to the file name, so
2903 it doesn't show in a directory listing. On MS-Windows the "hidden"
2904 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002905 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2906 the swap file relative to where the edited file is. The leading "."
2907 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002908 - For Unix and Win32, if a directory ends in two path separators "//",
2909 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002910 with all path separators replaced by percent '%' signs (including
2911 the colon following the drive letter on Win32). This will ensure
2912 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002913 On Win32, it is also possible to end with "\\". However, When a
2914 separating comma is following, you must use "//", since "\\" will
2915 include the comma in the file name. Therefore it is recommended to
2916 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917 - Spaces after the comma are ignored, other spaces are considered part
2918 of the directory name. To have a space at the start of a directory
2919 name, precede it with a backslash.
2920 - To include a comma in a directory name precede it with a backslash.
2921 - A directory name may end in an ':' or '/'.
2922 - Environment variables are expanded |:set_env|.
2923 - Careful with '\' characters, type one before a space, type two to
2924 get one in the option (see |option-backslash|), for example: >
2925 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2926< - For backwards compatibility with Vim version 3.0 a '>' at the start
2927 of the option is removed.
2928 Using "." first in the list is recommended. This means that editing
2929 the same file twice will result in a warning. Using "/tmp" on Unix is
2930 discouraged: When the system crashes you lose the swap file.
2931 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002932 choice than "/tmp". But others on the computer may be able to see the
2933 files, and it can contain a lot of files, your swap files get lost in
2934 the crowd. That is why a "tmp" directory in your home directory is
2935 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 The use of |:set+=| and |:set-=| is preferred when adding or removing
2937 directories from the list. This avoids problems when a future version
2938 uses another default.
2939 This option cannot be set from a |modeline| or in the |sandbox|, for
2940 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941
2942 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002943'display' 'dy' string (default "", set to "truncate" in
2944 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002946 Change the way text is displayed. This is comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 flags:
2948 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002949 in a window will be displayed. "@@@" is put in the
2950 last columns of the last screen line to indicate the
2951 rest of the line is not displayed.
2952 truncate Like "lastline", but "@@@" is displayed in the first
2953 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 uhex Show unprintable characters hexadecimal as <xx>
2955 instead of using ^C and ~C.
2956
Bram Moolenaard0796902016-09-16 20:02:31 +02002957 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002958 doesn't fit is replaced with "@" lines.
2959
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 *'eadirection'* *'ead'*
2961'eadirection' 'ead' string (default "both")
2962 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 Tells when the 'equalalways' option applies:
2964 ver vertically, width of windows is not affected
2965 hor horizontally, height of windows is not affected
2966 both width and height of windows is affected
2967
2968 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2969'edcompatible' 'ed' boolean (default off)
2970 global
2971 Makes the 'g' and 'c' flags of the ":substitute" command to be
2972 toggled each time the flag is given. See |complex-change|. See
2973 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002974 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002975 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976
Bram Moolenaar03413f42016-04-12 21:07:15 +02002977 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002978'emoji' 'emo' boolean (default: on)
2979 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002980 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002981 This excludes "text emoji" characters, which are normally displayed as
2982 single width. Unfortunately there is no good specification for this
2983 and it has been determined on trial-and-error basis. Use the
2984 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002985
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002987'encoding' 'enc' string (default for MS-Windows: "utf-8",
2988 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 Sets the character encoding used inside Vim. It applies to text in
2991 the buffers, registers, Strings in expressions, text stored in the
2992 viminfo file, etc. It sets the kind of characters which Vim can work
2993 with. See |encoding-names| for the possible values.
2994
2995 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002996 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002998 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999
Bram Moolenaar865242e2010-07-14 21:12:05 +02003000 This option cannot be set from a |modeline|. It would most likely
3001 corrupt the text.
3002
Bram Moolenaar3df01732017-02-17 22:47:16 +01003003 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3004 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 'encoding', "utf-8" is the natural choice for the environment and
3006 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003007 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 versions, and to avoid changing the encoding of newly created files
3009 without your knowledge (in case 'fileencodings' is empty).
3010
3011 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003012 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 iconv() or as specified with 'charconvert'.
3014
Bram Moolenaar207f0092020-08-30 17:20:20 +02003015 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003016 can use: >
3017 if has("multi_byte_encoding")
3018<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 Normally 'encoding' will be equal to your current locale. This will
3020 be the default if Vim recognizes your environment settings. If
3021 'encoding' is not set to the current locale, 'termencoding' must be
3022 set to convert typed and displayed text. See |encoding-table|.
3023
3024 When you set this option, it fires the |EncodingChanged| autocommand
3025 event so that you can set up fonts if necessary.
3026
3027 When the option is set, the value is converted to lowercase. Thus
3028 you can set it with uppercase values too. Underscores are translated
3029 to '-' signs.
3030 When the encoding is recognized, it is changed to the standard name.
3031 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3032 "iso-8859-2" and "utf8" becomes "utf-8".
3033
3034 Note: "latin1" is also used when the encoding could not be detected.
3035 This only works when editing files in the same encoding! When the
3036 actual character set is not latin1, make sure 'fileencoding' and
3037 'fileencodings' are empty. When conversion is needed, switch to using
3038 utf-8.
3039
3040 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3041 You don't notice this while editing, but it does matter for the
3042 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3043 setting 'encoding' to one of these values instead of utf-8 only has
3044 effect for encoding used for files when 'fileencoding' is empty.
3045
Bram Moolenaar661b1822005-07-28 22:36:45 +00003046 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3047 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048
3049 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3050'endofline' 'eol' boolean (default on)
3051 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003053 is on, or 'fixeol' option is off, no <EOL> will be written for the
3054 last line in the file. This option is automatically set or reset when
3055 starting to edit a new file, depending on whether file has an <EOL>
3056 for the last line in the file. Normally you don't have to set or
3057 reset this option.
3058 When 'binary' is off and 'fixeol' is on the value is not used when
3059 writing the file. When 'binary' is on or 'fixeol' is off it is used
3060 to remember the presence of a <EOL> for the last line in the file, so
3061 that when you write the file the situation from the original file can
3062 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063
3064 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3065'equalalways' 'ea' boolean (default on)
3066 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003068 splitting or closing a window. This also happens the moment the
3069 option is switched on. When off, splitting a window will reduce the
3070 size of the current window and leave the other windows the same. When
3071 closing a window the extra lines are given to the window next to it
3072 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 When mixing vertically and horizontally split windows, a minimal size
3074 is computed and some windows may be larger if there is room. The
3075 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003076 Changing the height and width of a window can be avoided by setting
3077 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003078 If a window size is specified when creating a new window sizes are
3079 currently not equalized (it's complicated, but may be implemented in
3080 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081
3082 *'equalprg'* *'ep'*
3083'equalprg' 'ep' string (default "")
3084 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003086 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003087 or 'indentexpr'. When Vim was compiled without internal formatting,
3088 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003089 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 about including spaces and backslashes.
3091 This option cannot be set from a |modeline| or in the |sandbox|, for
3092 security reasons.
3093
3094 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3095'errorbells' 'eb' boolean (default off)
3096 global
3097 Ring the bell (beep or screen flash) for error messages. This only
3098 makes a difference for error messages, the bell will be used always
3099 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003100 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003101 screen flash or do nothing. See 'belloff' to finetune when to ring the
3102 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103
3104 *'errorfile'* *'ef'*
3105'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3106 others: "errors.err")
3107 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 {not available when compiled without the |+quickfix|
3109 feature}
3110 Name of the errorfile for the QuickFix mode (see |:cf|).
3111 When the "-q" command-line argument is used, 'errorfile' is set to the
3112 following argument. See |-q|.
3113 NOT used for the ":make" command. See 'makeef' for that.
3114 Environment variables are expanded |:set_env|.
3115 See |option-backslash| about including spaces and backslashes.
3116 This option cannot be set from a |modeline| or in the |sandbox|, for
3117 security reasons.
3118
3119 *'errorformat'* *'efm'*
3120'errorformat' 'efm' string (default is very long)
3121 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 {not available when compiled without the |+quickfix|
3123 feature}
3124 Scanf-like description of the format for the lines in the error file
3125 (see |errorformat|).
3126
3127 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3128'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3129 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 Function keys that start with an <Esc> are recognized in Insert
3131 mode. When this option is off, the cursor and function keys cannot be
3132 used in Insert mode if they start with an <Esc>. The advantage of
3133 this is that the single <Esc> is recognized immediately, instead of
3134 after one second. Instead of resetting this option, you might want to
3135 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3136 when 'esckeys' is off, you can still map anything, but the cursor keys
3137 won't work by default.
3138 NOTE: This option is set to the Vi default value when 'compatible' is
3139 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003140 NOTE: when this option is off then the |modifyOtherKeys| functionality
3141 is disabled while in Insert mode to avoid ending Insert mode with any
3142 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143
3144 *'eventignore'* *'ei'*
3145'eventignore' 'ei' string (default "")
3146 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003148 When set to "all" or when "all" is one of the items, all autocommand
3149 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003150 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151 :set ei=WinEnter,WinLeave
3152<
3153 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3154'expandtab' 'et' boolean (default off)
3155 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003157 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3159 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003160 This option is reset when the 'paste' option is set and restored when
3161 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 NOTE: This option is reset when 'compatible' is set.
3163
3164 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3165'exrc' 'ex' boolean (default off)
3166 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003168 directory.
3169
3170 Setting this option is a potential security leak. E.g., consider
3171 unpacking a package or fetching files from github, a .vimrc in there
3172 might be a trojan horse. BETTER NOT SET THIS OPTION!
3173 Instead, define an autocommand in your .vimrc to set options for a
3174 matching directory.
3175
3176 If you do switch this option on you should also consider setting the
3177 'secure' option (see |initialization|).
3178 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 This option cannot be set from a |modeline| or in the |sandbox|, for
3180 security reasons.
3181
3182 *'fileencoding'* *'fenc'* *E213*
3183'fileencoding' 'fenc' string (default: "")
3184 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003186
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003188 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 When 'fileencoding' is empty, the same value as 'encoding' will be
3190 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003191 No error will be given when the value is set, only when it is used,
3192 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003193 Conversion will also be done when 'encoding' and 'fileencoding' are
3194 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3195 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003197 'encoding' is "utf-8" or another Unicode encoding, conversion
3198 is most likely done in a way that the reverse conversion
3199 results in the same text. When 'encoding' is not "utf-8" some
3200 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003201
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 See 'encoding' for the possible values. Additionally, values may be
3203 specified that can be handled by the converter, see
3204 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003205
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 When reading a file 'fileencoding' will be set from 'fileencodings'.
3207 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003208 'fileencoding', use the |++enc| argument. One exception: when
3209 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003210 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003211
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3213 When the option is set, the value is converted to lowercase. Thus
3214 you can set it with uppercase values too. '_' characters are
3215 replaced with '-'. If a name is recognized from the list for
3216 'encoding', it is replaced by the standard name. For example
3217 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003218
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 When this option is set, after starting to edit a file, the 'modified'
3220 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003221
3222 Keep in mind that changing 'fenc' from a modeline happens
3223 AFTER the text has been read, thus it applies to when the file will be
3224 written. If you do set 'fenc' in a modeline, you might want to set
3225 'nomodified' to avoid not being able to ":q".
3226
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 This option can not be changed when 'modifiable' is off.
3228
3229 *'fe'*
3230 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003231 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 old short name was 'fe', which is no longer used.
3233
3234 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003235'fileencodings' 'fencs' string (default: "ucs-bom",
3236 "ucs-bom,utf-8,default,latin1" when
3237 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 This is a list of character encodings considered when starting to edit
3240 an existing file. When a file is read, Vim tries to use the first
3241 mentioned character encoding. If an error is detected, the next one
3242 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003243 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 an empty string, which means the value of 'encoding' is used.
3245 WARNING: Conversion can cause loss of information! When
3246 'encoding' is "utf-8" (or one of the other Unicode variants)
3247 conversion is most likely done in a way that the reverse
3248 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003249 "utf-8" some non-ASCII characters may be lost! You can use
3250 the |++bad| argument to specify what is done with characters
3251 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 For an empty file or a file with only ASCII characters most encodings
3253 will work and the first entry of 'fileencodings' will be used (except
3254 "ucs-bom", which requires the BOM to be present). If you prefer
3255 another encoding use an BufReadPost autocommand event to test if your
3256 preferred encoding is to be used. Example: >
3257 au BufReadPost * if search('\S', 'w') == 0 |
3258 \ set fenc=iso-2022-jp | endif
3259< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3260 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003261 When the |++enc| argument is used then the value of 'fileencodings' is
3262 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003263 Note that 'fileencodings' is not used for a new file, the global value
3264 of 'fileencoding' is used instead. You can set it with: >
3265 :setglobal fenc=iso-8859-2
3266< This means that a non-existing file may get a different encoding than
3267 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 The special value "ucs-bom" can be used to check for a Unicode BOM
3269 (Byte Order Mark) at the start of the file. It must not be preceded
3270 by "utf-8" or another Unicode encoding for this to work properly.
3271 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3272 because Vim cannot detect an error, thus the encoding is always
3273 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003274 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003275 environment. On MS-Windows this is the system encoding. Otherwise
3276 this is the default value for 'encoding'. It is useful when
3277 'encoding' is set to "utf-8" and your environment uses a non-latin1
3278 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003279 When 'encoding' is "utf-8" and a file contains an illegal byte
3280 sequence it won't be recognized as UTF-8. You can use the |8g8|
3281 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 WRONG VALUES: WHAT'S WRONG:
3283 latin1,utf-8 "latin1" will always be used
3284 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3285 file
3286 cp1250,latin1 "cp1250" will always be used
3287 If 'fileencodings' is empty, 'fileencoding' is not modified.
3288 See 'fileencoding' for the possible values.
3289 Setting this option does not have an effect until the next time a file
3290 is read.
3291
3292 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003293'fileformat' 'ff' string (MS-Windows default: "dos",
3294 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 This gives the <EOL> of the current buffer, which is used for
3297 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003298 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 unix <NL>
3300 mac <CR>
3301 When "dos" is used, CTRL-Z at the end of a file is ignored.
3302 See |file-formats| and |file-read|.
3303 For the character encoding of the file see 'fileencoding'.
3304 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003305 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306 This option is set automatically when starting to edit a file and
3307 'fileformats' is not empty and 'binary' is off.
3308 When this option is set, after starting to edit a file, the 'modified'
3309 option is set, because the file would be different when written.
3310 This option can not be changed when 'modifiable' is off.
3311 For backwards compatibility: When this option is set to "dos",
3312 'textmode' is set, otherwise 'textmode' is reset.
3313
3314 *'fileformats'* *'ffs'*
3315'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003316 Vim+Vi MS-Windows: "dos,unix",
3317 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 Vi Cygwin: "unix,dos",
3319 Vi others: "")
3320 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 This gives the end-of-line (<EOL>) formats that will be tried when
3322 starting to edit a new buffer and when reading a file into an existing
3323 buffer:
3324 - When empty, the format defined with 'fileformat' will be used
3325 always. It is not set automatically.
3326 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003327 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 'fileformats' name will be used when a file is read into an existing
3329 buffer, no matter what 'fileformat' for that buffer is set to.
3330 - When more than one name is present, separated by commas, automatic
3331 <EOL> detection will be done when reading a file. When starting to
3332 edit a file, a check is done for the <EOL>:
3333 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3334 'fileformat' is set to "dos".
3335 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003336 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003338 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3339 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003340 This means that "mac" is only chosen when:
3341 "unix" is not present or no <NL> is found in the file, and
3342 "dos" is not present or no <CR><NL> is found in the file.
3343 Except: if "unix" was chosen, but there is a <CR> before
3344 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003345 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346 4. If 'fileformat' is still not set, the first name from
3347 'fileformats' is used.
3348 When reading a file into an existing buffer, the same is done, but
3349 this happens like 'fileformat' has been set appropriately for that
3350 file only, the option is not changed.
3351 When 'binary' is set, the value of 'fileformats' is not used.
3352
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003353 When Vim starts up with an empty buffer the first item is used. You
3354 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003355
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3357 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3358 done:
3359 - When 'fileformats' is empty, there is no automatic detection. Dos
3360 format will be used.
3361 - When 'fileformats' is set to one or more names, automatic detection
3362 is done. This is based on the first <NL> in the file: If there is a
3363 <CR> in front of it, Dos format is used, otherwise Unix format is
3364 used.
3365 Also see |file-formats|.
3366 For backwards compatibility: When this option is set to an empty
3367 string or one format (no comma is included), 'textauto' is reset,
3368 otherwise 'textauto' is set.
3369 NOTE: This option is set to the Vi default value when 'compatible' is
3370 set and to the Vim default value when 'compatible' is reset.
3371
Bram Moolenaarbf884932013-04-05 22:26:15 +02003372 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3373'fileignorecase' 'fic' boolean (default on for systems where case in file
3374 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003375 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003376 When set case is ignored when using file names and directories.
3377 See 'wildignorecase' for only ignoring case when doing completion.
3378
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 *'filetype'* *'ft'*
3380'filetype' 'ft' string (default: "")
3381 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 When this option is set, the FileType autocommand event is triggered.
3383 All autocommands that match with the value of this option will be
3384 executed. Thus the value of 'filetype' is used in place of the file
3385 name.
3386 Otherwise this option does not always reflect the current file type.
3387 This option is normally set when the file type is detected. To enable
3388 this use the ":filetype on" command. |:filetype|
3389 Setting this option to a different value is most useful in a modeline,
3390 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003391 Example, for in an IDL file:
3392 /* vim: set filetype=idl : */ ~
3393 |FileType| |filetypes|
3394 When a dot appears in the value then this separates two filetype
3395 names. Example:
3396 /* vim: set filetype=c.doxygen : */ ~
3397 This will use the "c" filetype first, then the "doxygen" filetype.
3398 This works both for filetype plugins and for syntax files. More than
3399 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 This option is not copied to another buffer, independent of the 's' or
3401 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003402 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403
3404 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003405'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003406 global or local to window |global-local|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003407 {not available when compiled without the |+folding|
3408 feature}
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003409 Characters to fill the statuslines, vertical separators and special
3410 lines in the window.
3411 It is a comma-separated list of items. Each item has a name, a colon
3412 and the value of that item:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003414 item name default Used for ~
3415 stl ' ' or '^' statusline of the current window
3416 stlnc ' ' or '=' statusline of the non-current windows
3417 vert '|' vertical separators |:vsplit|
3418 fold '-' filling 'foldtext'
3419 foldopen '-' mark the beginning of a fold
3420 foldclose '+' show a closed fold
3421 foldsep '|' open fold middle character
3422 diff '-' deleted lines of the 'diff' option
3423 eob '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003425 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003426 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 otherwise.
3428
3429 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003430 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431< This is similar to the default, except that these characters will also
3432 be used when there is highlighting.
3433
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003434 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3435 single-byte and multibyte characters are supported. But double-width
3436 characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003437
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003439 item name highlight group ~
3440 stl StatusLine |hl-StatusLine|
3441 stlnc StatusLineNC |hl-StatusLineNC|
3442 vert VertSplit |hl-VertSplit|
3443 fold Folded |hl-Folded|
3444 diff DiffDelete |hl-DiffDelete|
3445 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003446
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003447 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3448'fixendofline' 'fixeol' boolean (default on)
3449 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003450 When writing a file and this option is on, <EOL> at the end of file
3451 will be restored if missing. Turn this option off if you want to
3452 preserve the situation from the original file.
3453 When the 'binary' option is set the value of this option doesn't
3454 matter.
3455 See the 'endofline' option.
3456
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003458'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460 {only available when compiled with the |+rightleft|
3461 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003462 This option was for using Farsi, which has been removed. See
3463 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464
3465 *'foldclose'* *'fcl'*
3466'foldclose' 'fcl' string (default "")
3467 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 {not available when compiled without the |+folding|
3469 feature}
3470 When set to "all", a fold is closed when the cursor isn't in it and
3471 its level is higher than 'foldlevel'. Useful if you want folds to
3472 automatically close when moving out of them.
3473
3474 *'foldcolumn'* *'fdc'*
3475'foldcolumn' 'fdc' number (default 0)
3476 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477 {not available when compiled without the |+folding|
3478 feature}
3479 When non-zero, a column with the specified width is shown at the side
3480 of the window which indicates open and closed folds. The maximum
3481 value is 12.
3482 See |folding|.
3483
3484 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3485'foldenable' 'fen' boolean (default on)
3486 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487 {not available when compiled without the |+folding|
3488 feature}
3489 When off, all folds are open. This option can be used to quickly
3490 switch between showing all text unfolded and viewing the text with
3491 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003492 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 'foldenable' is off.
3494 This option is set by commands that create a new fold or close a fold.
3495 See |folding|.
3496
3497 *'foldexpr'* *'fde'*
3498'foldexpr' 'fde' string (default: "0")
3499 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003501 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003503 for each line to obtain its fold level. The context is set to the
3504 script where 'foldexpr' was set, script-local items can be accessed.
3505 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003506
Bram Moolenaar30b65812012-07-12 22:01:11 +02003507 The expression will be evaluated in the |sandbox| if set from a
3508 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003509 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003510 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003511
3512 It is not allowed to change text or jump to another window while
3513 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514
3515 *'foldignore'* *'fdi'*
3516'foldignore' 'fdi' string (default: "#")
3517 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 {not available when compiled without the |+folding|
3519 feature}
3520 Used only when 'foldmethod' is "indent". Lines starting with
3521 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003522 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523 The default "#" works well for C programs. See |fold-indent|.
3524
3525 *'foldlevel'* *'fdl'*
3526'foldlevel' 'fdl' number (default: 0)
3527 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528 {not available when compiled without the |+folding|
3529 feature}
3530 Sets the fold level: Folds with a higher level will be closed.
3531 Setting this option to zero will close all folds. Higher numbers will
3532 close fewer folds.
3533 This option is set by commands like |zm|, |zM| and |zR|.
3534 See |fold-foldlevel|.
3535
3536 *'foldlevelstart'* *'fdls'*
3537'foldlevelstart' 'fdls' number (default: -1)
3538 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 {not available when compiled without the |+folding|
3540 feature}
3541 Sets 'foldlevel' when starting to edit another buffer in a window.
3542 Useful to always start editing with all folds closed (value zero),
3543 some folds closed (one) or no folds closed (99).
3544 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003545 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 ignores this option and closes all folds.
3547 It is also done before BufReadPre autocommands, to allow an autocmd to
3548 overrule the 'foldlevel' value for specific files.
3549 When the value is negative, it is not used.
3550
3551 *'foldmarker'* *'fmr'* *E536*
3552'foldmarker' 'fmr' string (default: "{{{,}}}")
3553 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554 {not available when compiled without the |+folding|
3555 feature}
3556 The start and end marker used when 'foldmethod' is "marker". There
3557 must be one comma, which separates the start and end marker. The
3558 marker is a literal string (a regular expression would be too slow).
3559 See |fold-marker|.
3560
3561 *'foldmethod'* *'fdm'*
3562'foldmethod' 'fdm' string (default: "manual")
3563 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564 {not available when compiled without the |+folding|
3565 feature}
3566 The kind of folding used for the current window. Possible values:
3567 |fold-manual| manual Folds are created manually.
3568 |fold-indent| indent Lines with equal indent form a fold.
3569 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3570 |fold-marker| marker Markers are used to specify folds.
3571 |fold-syntax| syntax Syntax highlighting items specify folds.
3572 |fold-diff| diff Fold text that is not changed.
3573
3574 *'foldminlines'* *'fml'*
3575'foldminlines' 'fml' number (default: 1)
3576 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 {not available when compiled without the |+folding|
3578 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003579 Sets the number of screen lines above which a fold can be displayed
3580 closed. Also for manually closed folds. With the default value of
3581 one a fold can only be closed if it takes up two or more screen lines.
3582 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003583 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 "zc" to close a fold, which is displayed open because it's smaller
3585 than 'foldminlines', a following "zc" may close a containing fold.
3586
3587 *'foldnestmax'* *'fdn'*
3588'foldnestmax' 'fdn' number (default: 20)
3589 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590 {not available when compiled without the |+folding|
3591 feature}
3592 Sets the maximum nesting of folds for the "indent" and "syntax"
3593 methods. This avoids that too many folds will be created. Using more
3594 than 20 doesn't work, because the internal limit is 20.
3595
3596 *'foldopen'* *'fdo'*
3597'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3598 search,tag,undo")
3599 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 {not available when compiled without the |+folding|
3601 feature}
3602 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003603 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003605 NOTE: When the command is part of a mapping this option is not used.
3606 Add the |zv| command to the mapping to get the same effect.
3607 (rationale: the mapping may want to control opening folds itself)
3608
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609 item commands ~
3610 all any
3611 block "(", "{", "[[", "[{", etc.
3612 hor horizontal movements: "l", "w", "fx", etc.
3613 insert any command in Insert mode
3614 jump far jumps: "G", "gg", etc.
3615 mark jumping to a mark: "'m", CTRL-O, etc.
3616 percent "%"
3617 quickfix ":cn", ":crew", ":make", etc.
3618 search search for a pattern: "/", "n", "*", "gd", etc.
3619 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003620 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 tag jumping to a tag: ":ta", CTRL-T, etc.
3622 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003623 When a movement command is used for an operator (e.g., "dl" or "y%")
3624 this option is not used. This means the operator will include the
3625 whole closed fold.
3626 Note that vertical movements are not here, because it would make it
3627 very difficult to move onto a closed fold.
3628 In insert mode the folds containing the cursor will always be open
3629 when text is inserted.
3630 To close folds you can re-apply 'foldlevel' with the |zx| command or
3631 set the 'foldclose' option to "all".
3632
3633 *'foldtext'* *'fdt'*
3634'foldtext' 'fdt' string (default: "foldtext()")
3635 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636 {not available when compiled without the |+folding|
3637 feature}
3638 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003639 fold. The context is set to the script where 'foldexpr' was set,
3640 script-local items can be accessed. See |fold-foldtext| for the
3641 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642
Bram Moolenaar30b65812012-07-12 22:01:11 +02003643 The expression will be evaluated in the |sandbox| if set from a
3644 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003645 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003646
3647 It is not allowed to change text or jump to another window while
3648 evaluating 'foldtext' |textlock|.
3649
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003650 *'formatexpr'* *'fex'*
3651'formatexpr' 'fex' string (default "")
3652 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003653 {not available when compiled without the |+eval|
3654 feature}
3655 Expression which is evaluated to format a range of lines for the |gq|
3656 operator or automatic formatting (see 'formatoptions'). When this
3657 option is empty 'formatprg' is used.
3658
3659 The |v:lnum| variable holds the first line to be formatted.
3660 The |v:count| variable holds the number of lines to be formatted.
3661 The |v:char| variable holds the character that is going to be
3662 inserted if the expression is being evaluated due to
3663 automatic formatting. This can be empty. Don't insert
3664 it yet!
3665
3666 Example: >
3667 :set formatexpr=mylang#Format()
3668< This will invoke the mylang#Format() function in the
3669 autoload/mylang.vim file in 'runtimepath'. |autoload|
3670
3671 The expression is also evaluated when 'textwidth' is set and adding
3672 text beyond that limit. This happens under the same conditions as
3673 when internal formatting is used. Make sure the cursor is kept in the
3674 same spot relative to the text then! The |mode()| function will
3675 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003676
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003677 When the expression evaluates to non-zero Vim will fall back to using
3678 the internal format mechanism.
3679
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003680 If the expression starts with s: or |<SID>|, then it is replaced with
3681 the script ID (|local-function|). Example: >
3682 set formatexpr=s:MyFormatExpr()
3683 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003684< Otherwise, the expression is evaluated in the context of the script
3685 where the option was set, thus script-local items are available.
3686
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003687 The expression will be evaluated in the |sandbox| when set from a
3688 modeline, see |sandbox-option|. That stops the option from working,
3689 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003690 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003691 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003692
Bram Moolenaar86b68352004-12-27 21:59:20 +00003693 *'formatlistpat'* *'flp'*
3694'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3695 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003696 A pattern that is used to recognize a list header. This is used for
3697 the "n" flag in 'formatoptions'.
3698 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003699 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003700 while still checking more characters. There must be a character
3701 following the pattern, when it matches the whole line it is handled
3702 like there is no match.
3703 The default recognizes a number, followed by an optional punctuation
3704 character and white space.
3705
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003706 *'formatoptions'* *'fo'*
3707'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3708 local to buffer
3709 This is a sequence of letters which describes how automatic
3710 formatting is to be done. See |fo-table|. When the 'paste' option is
3711 on, no formatting is done (like 'formatoptions' is empty). Commas can
3712 be inserted for readability.
3713 To avoid problems with flags that are added in the future, use the
3714 "+=" and "-=" feature of ":set" |add-option-flags|.
3715 NOTE: This option is set to the Vi default value when 'compatible' is
3716 set and to the Vim default value when 'compatible' is reset.
3717
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718 *'formatprg'* *'fp'*
3719'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003720 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003722 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003724 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003725 If the 'formatexpr' option is not empty it will be used instead.
3726 Otherwise, if 'formatprg' option is an empty string, the internal
3727 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003728 Environment variables are expanded |:set_env|. See |option-backslash|
3729 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003730 This option cannot be set from a |modeline| or in the |sandbox|, for
3731 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732
Bram Moolenaard94464e2015-11-02 15:28:18 +01003733 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003734'fsync' 'fs' boolean (default on)
3735 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003736 When on, the library function fsync() will be called after writing a
3737 file. This will flush a file to disk, ensuring that it is safely
3738 written even on filesystems which do metadata-only journaling. This
3739 will force the harddrive to spin up on Linux systems running in laptop
3740 mode, so it may be undesirable in some situations. Be warned that
3741 turning this off increases the chances of data loss after a crash. On
3742 systems without an fsync() implementation, this variable is always
3743 off.
3744 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003745 'fsync' also applies to |writefile()| (unless a flag is used to
3746 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003747 This option cannot be set from a |modeline| or in the |sandbox|, for
3748 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003749
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3751'gdefault' 'gd' boolean (default off)
3752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 When on, the ":substitute" flag 'g' is default on. This means that
3754 all matches in a line are substituted instead of one. When a 'g' flag
3755 is given to a ":substitute" command, this will toggle the substitution
3756 of all or one match. See |complex-change|.
3757
3758 command 'gdefault' on 'gdefault' off ~
3759 :s/// subst. all subst. one
3760 :s///g subst. one subst. all
3761 :s///gg subst. all subst. one
3762
3763 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003764 DEPRECATED: Setting this option may break plugins that are not aware
3765 of this option. Also, many users get confused that adding the /g flag
3766 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003767 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768
3769 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003770'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 Format to recognize for the ":grep" command output.
3773 This is a scanf-like string that uses the same format as the
3774 'errorformat' option: see |errorformat|.
3775
3776 *'grepprg'* *'gp'*
3777'grepprg' 'gp' string (default "grep -n ",
3778 Unix: "grep -n $* /dev/null",
3779 Win32: "findstr /n" or "grep -n",
3780 VMS: "SEARCH/NUMBERS ")
3781 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003782 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 and '#' characters, which are expanded like when used in a command-
3784 line. The placeholder "$*" is allowed to specify where the arguments
3785 will be included. Environment variables are expanded |:set_env|. See
3786 |option-backslash| about including spaces and backslashes.
3787 When your "grep" accepts the "-H" argument, use this to make ":grep"
3788 also work well with a single file: >
3789 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003790< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003791 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3792 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003793 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 apply equally to 'grepprg'.
3795 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3796 otherwise it's "grep -n".
3797 This option cannot be set from a |modeline| or in the |sandbox|, for
3798 security reasons.
3799
3800 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3801'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3802 ve:ver35-Cursor,
3803 o:hor50-Cursor,
3804 i-ci:ver25-Cursor/lCursor,
3805 r-cr:hor20-Cursor/lCursor,
3806 sm:block-Cursor
3807 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003808 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 "n-v-c:block,o:hor50,i-ci:hor15,
3810 r-cr:hor30,sm:block")
3811 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003813 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003815 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003816 height of the cursor can be changed. This can be done by specifying a
3817 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003818 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3819 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003821 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 mode-list and an argument-list:
3823 mode-list:argument-list,mode-list:argument-list,..
3824 The mode-list is a dash separated list of these modes:
3825 n Normal mode
3826 v Visual mode
3827 ve Visual mode with 'selection' "exclusive" (same as 'v',
3828 if not specified)
3829 o Operator-pending mode
3830 i Insert mode
3831 r Replace mode
3832 c Command-line Normal (append) mode
3833 ci Command-line Insert mode
3834 cr Command-line Replace mode
3835 sm showmatch in Insert mode
3836 a all modes
3837 The argument-list is a dash separated list of these arguments:
3838 hor{N} horizontal bar, {N} percent of the character height
3839 ver{N} vertical bar, {N} percent of the character width
3840 block block cursor, fills the whole character
3841 [only one of the above three should be present]
3842 blinkwait{N} *cursor-blinking*
3843 blinkon{N}
3844 blinkoff{N}
3845 blink times for cursor: blinkwait is the delay before
3846 the cursor starts blinking, blinkon is the time that
3847 the cursor is shown and blinkoff is the time that the
3848 cursor is not shown. The times are in msec. When one
3849 of the numbers is zero, there is no blinking. The
3850 default is: "blinkwait700-blinkon400-blinkoff250".
3851 These numbers are used for a missing entry. This
3852 means that blinking is enabled by default. To switch
3853 blinking off you can use "blinkon0". The cursor only
3854 blinks when Vim is waiting for input, not while
3855 executing a command.
3856 To make the cursor blink in an xterm, see
3857 |xterm-blink|.
3858 {group-name}
3859 a highlight group name, that sets the color and font
3860 for the cursor
3861 {group-name}/{group-name}
3862 Two highlight group names, the first is used when
3863 no language mappings are used, the other when they
3864 are. |language-mapping|
3865
3866 Examples of parts:
3867 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3868 block cursor with colors from the "nCursor"
3869 highlight group
3870 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3871 In Insert and Command-line Insert mode, use a
3872 30% vertical bar cursor with colors from the
3873 "iCursor" highlight group. Blink a bit
3874 faster.
3875
3876 The 'a' mode is different. It will set the given argument-list for
3877 all modes. It does not reset anything to defaults. This can be used
3878 to do a common setting for all modes. For example, to switch off
3879 blinking: "a:blinkon0"
3880
3881 Examples of cursor highlighting: >
3882 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3883 :highlight Cursor gui=NONE guifg=bg guibg=fg
3884<
3885 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003886 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887'guifont' 'gfn' string (default "")
3888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 {only available when compiled with GUI enabled}
3890 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003891 In its simplest form the value is just one font name.
3892 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893
3894 *'guifontset'* *'gfs'*
3895 *E250* *E252* *E234* *E597* *E598*
3896'guifontset' 'gfs' string (default "")
3897 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 {only available when compiled with GUI enabled and
3899 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003900 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 When not empty, specifies two (or more) fonts to be used. The first
3902 one for normal English, the second one for your special language. See
3903 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003904
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3906'guifontwide' 'gfw' string (default "")
3907 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 {only available when compiled with GUI enabled}
3909 When not empty, specifies a comma-separated list of fonts to be used
3910 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003911 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003912
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 *'guiheadroom'* *'ghr'*
3914'guiheadroom' 'ghr' number (default 50)
3915 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003916 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 The number of pixels subtracted from the screen height when fitting
3918 the GUI window on the screen. Set this before the GUI is started,
3919 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003920 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 lines will be left for window decorations and other items on the
3922 screen. Set it to a negative value to allow windows taller than the
3923 screen.
3924
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003925 *'guiligatures'* *'gli'* *E1243*
3926'guiligatures' 'gli' string (default "")
3927 global
3928 {only for GTK GUI}
3929 List of ASCII characters that, when combined together, can create more
3930 complex shapes. Each character must be a printable ASCII character
3931 with a value in the 32-127 range.
3932 Example: >
3933 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3934< Changing this option updates screen output immediately. Set it to an
3935 empty string to disable ligatures.
3936
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003938'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3939 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003940 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003941 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003944 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 sequence of letters which describes what components and options of the
3946 GUI should be used.
3947 To avoid problems with flags that are added in the future, use the
3948 "+=" and "-=" feature of ":set" |add-option-flags|.
3949
Bram Moolenaar13568252018-03-16 20:46:58 +01003950 Valid characters are as follows:
3951 *'go-!'*
3952 '!' External commands are executed in a terminal window. Without
3953 this flag the MS-Windows GUI will open a console window to
3954 execute the command. The Unix GUI will simulate a dumb
3955 terminal to list the command output.
3956 The terminal window will be positioned at the bottom, and grow
3957 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003958 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 'a' Autoselect: If present, then whenever VISUAL mode is started,
3960 or the Visual area extended, Vim tries to become the owner of
3961 the windowing system's global selection. This means that the
3962 Visually highlighted text is available for pasting into other
3963 applications as well as into Vim itself. When the Visual mode
3964 ends, possibly due to an operation on the text, or when an
3965 application wants to paste the selection, the highlighted text
3966 is automatically yanked into the "* selection register.
3967 Thus the selection is still available for pasting into other
3968 applications after the VISUAL mode has ended.
3969 If not present, then Vim won't become the owner of the
3970 windowing system's global selection unless explicitly told to
3971 by a yank or delete operation for the "* register.
3972 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003973 *'go-P'*
3974 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003975 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003976 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003977 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 applies to the modeless selection.
3979
3980 'guioptions' autoselect Visual autoselect modeless ~
3981 "" - -
3982 "a" yes yes
3983 "A" - yes
3984 "aA" yes yes
3985
Bram Moolenaar02467872007-05-06 13:22:01 +00003986 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 'c' Use console dialogs instead of popup dialogs for simple
3988 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003989 *'go-d'*
3990 'd' Use dark theme variant if available. Currently only works for
3991 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003992 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003993 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003994 'guitablabel' can be used to change the text in the labels.
3995 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003996 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003997 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003998 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 'f' Foreground: Don't use fork() to detach the GUI from the shell
4000 where it was started. Use this for programs that wait for the
4001 editor to finish (e.g., an e-mail program). Alternatively you
4002 can use "gvim -f" or ":gui -f" to start the GUI in the
4003 foreground. |gui-fork|
4004 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004005 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004006 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4008 corner of the window. It's black&white on non-GTK, because of
4009 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004010 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004012 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004013 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004015 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004017 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004018 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 'g' Grey menu items: Make menu items that are not active grey. If
4020 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004021 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 't' Include tearoff menu items. Currently only works for Win32,
4023 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004024 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004025 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4026 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004027 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004029 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 'R' Right-hand scrollbar is present when there is a vertically
4031 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004032 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004034 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 'L' Left-hand scrollbar is present when there is a vertically
4036 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004037 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4039 the longest visible line, or on the cursor line if the 'h'
4040 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004041 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 'h' Limit horizontal scrollbar size to the length of the cursor
4043 line. Reduces computations. |gui-horiz-scroll|
4044
4045 And yes, you may even have scrollbars on the left AND the right if
4046 you really want to :-). See |gui-scrollbars| for more information.
4047
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004048 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004049 'v' Use a vertical button layout for dialogs. When not included,
4050 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004051 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004052 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 'p' Use Pointer callbacks for X11 GUI. This is required for some
4054 window managers. If the cursor is not blinking or hollow at
4055 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004056 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004058 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004059 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004060 *'go-k'*
4061 'k' Keep the GUI window size when adding/removing a scrollbar, or
4062 toolbar, tabline, etc. Instead, the behavior is similar to
4063 when the window is maximized and will adjust 'lines' and
4064 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004065 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004066 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004067
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068 *'guipty'* *'noguipty'*
4069'guipty' boolean (default on)
4070 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 {only available when compiled with GUI enabled}
4072 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4073 I/O to/from shell commands. See |gui-pty|.
4074
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004075 *'guitablabel'* *'gtl'*
4076'guitablabel' 'gtl' string (default empty)
4077 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004078 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004079 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004080 pages line. When empty and when the result is empty Vim will use a
4081 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004082
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004083 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004084 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004085 The expression will be evaluated in the |sandbox| when set from a
4086 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004087 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004088
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004089 Only used when the GUI tab pages line is displayed. 'e' must be
4090 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4091 used.
4092
Bram Moolenaar57657d82006-04-21 22:12:41 +00004093 *'guitabtooltip'* *'gtt'*
4094'guitabtooltip' 'gtt' string (default empty)
4095 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004096 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004097 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004098 pages line. When empty Vim will use a default tooltip.
4099 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004100 You can include a line break. Simplest method is to use |:let|: >
4101 :let &guitabtooltip = "line one\nline two"
4102<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004103
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004105'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 (others) "$VIMRUNTIME/doc/help.txt")
4107 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004108 Name of the main help file. All distributed help files should be
4109 placed together in one directory. Additionally, all "doc" directories
4110 in 'runtimepath' will be used.
4111 Environment variables are expanded |:set_env|. For example:
4112 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004113 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 spaces and backslashes.
4115 This option cannot be set from a |modeline| or in the |sandbox|, for
4116 security reasons.
4117
4118 *'helpheight'* *'hh'*
4119'helpheight' 'hh' number (default 20)
4120 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 Minimal initial height of the help window when it is opened with the
4122 ":help" command. The initial height of the help window is half of the
4123 current window, or (when the 'ea' option is on) the same as other
4124 windows. When the height is less than 'helpheight', the height is
4125 set to 'helpheight'. Set to zero to disable.
4126
4127 *'helplang'* *'hlg'*
4128'helplang' 'hlg' string (default: messages language or empty)
4129 global
4130 {only available when compiled with the |+multi_lang|
4131 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004132 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 for which the desired help can be found. The English help will always
4134 be used as a last resort. You can add "en" to prefer English over
4135 another language, but that will only find tags that exist in that
4136 language and not in the English help.
4137 Example: >
4138 :set helplang=de,it
4139< This will first search German, then Italian and finally English help
4140 files.
4141 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4142 try to find the tag in the current language before using this option.
4143 See |help-translated|.
4144
4145 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4146'hidden' 'hid' boolean (default off)
4147 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 When off a buffer is unloaded when it is |abandon|ed. When on a
4149 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4150 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004151
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004153 hidden even if the 'hidden' option is off when these three are true:
4154 - the buffer is modified
4155 - 'autowrite' is off or writing is not possible
4156 - the '!' flag was used
4157 Also see |windows.txt|.
4158
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004159 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160 This option is set for one command with ":hide {command}" |:hide|.
4161 WARNING: It's easy to forget that you have changes in hidden buffers.
4162 Think twice when using ":q!" or ":qa!".
4163
4164 *'highlight'* *'hl'*
4165'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004166 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4167 d:Directory,e:ErrorMsg,i:IncSearch,
4168 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004169 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004170 N:CursorLineNr,r:Question,s:StatusLine,
4171 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004172 v:Visual,V:VisualNOS,w:WarningMsg,
4173 W:WildMenu,f:Folded,F:FoldColumn,
4174 A:DiffAdd,C:DiffChange,D:DiffDelete,
4175 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004176 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004177 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004178 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4179 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004180 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004181 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004184 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004186 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004188 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4189 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190 characters from 'showbreak'
4191 |hl-Directory| d directories in CTRL-D listing and other special
4192 things in listings
4193 |hl-ErrorMsg| e error messages
4194 h (obsolete, ignored)
4195 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004196 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4198 |hl-MoreMsg| m |more-prompt|
4199 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004200 |hl-LineNr| n line number for ":number" and ":#" commands, and
4201 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004202 |hl-LineNrAbove| a line number above the cursor for when the
4203 'relativenumber' option is set.
4204 |hl-LineNrBelow| b line number below the cursor for when the
4205 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004206 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4207 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 |hl-Question| r |hit-enter| prompt and yes/no questions
4209 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004210 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4212 |hl-VertSplit| c column used to separate vertically split windows
4213 |hl-Visual| v Visual mode
4214 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4215 Selection" Only X11 Gui's |gui-x11| and
4216 |xterm-clipboard|.
4217 |hl-WarningMsg| w warning messages
4218 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4219 |hl-Folded| f line used for closed folds
4220 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004221 |hl-DiffAdd| A added line in diff mode
4222 |hl-DiffChange| C changed line in diff mode
4223 |hl-DiffDelete| D deleted line in diff mode
4224 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004226 |hl-Conceal| - the placeholders used for concealed characters
4227 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004228 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004229 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004230 |hl-SpellRare| R rare word |spell|
4231 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004232 |hl-Pmenu| + popup menu normal line
4233 |hl-PmenuSel| = popup menu selected line
4234 |hl-PmenuSbar| x popup menu scrollbar
4235 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236
4237 The display modes are:
4238 r reverse (termcap entry "mr" and "me")
4239 i italic (termcap entry "ZH" and "ZR")
4240 b bold (termcap entry "md" and "me")
4241 s standout (termcap entry "so" and "se")
4242 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004243 c undercurl (termcap entry "Us" and "Ce")
4244 2 double underline (termcap entry "Ds" and "Ce")
4245 d dotted underline (termcap entry "ds" and "Ce")
4246 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004247 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 n no highlighting
4249 - no highlighting
4250 : use a highlight group
4251 The default is used for occasions that are not included.
4252 If you want to change what the display modes do, see |dos-colors|
4253 for an example.
4254 When using the ':' display mode, this must be followed by the name of
4255 a highlight group. A highlight group can be used to define any type
4256 of highlighting, including using color. See |:highlight| on how to
4257 define one. The default uses a different group for each occasion.
4258 See |highlight-default| for the default highlight groups.
4259
Bram Moolenaar071d4272004-06-13 20:20:40 +00004260 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004261'history' 'hi' number (Vim default: 50, Vi default: 0,
4262 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004265 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004267 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268 NOTE: This option is set to the Vi default value when 'compatible' is
4269 set and to the Vim default value when 'compatible' is reset.
4270
4271 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4272'hkmap' 'hk' boolean (default off)
4273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 {only available when compiled with the |+rightleft|
4275 feature}
4276 When on, the keyboard is mapped for the Hebrew character set.
4277 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4278 toggle this option. See |rileft.txt|.
4279 NOTE: This option is reset when 'compatible' is set.
4280
4281 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4282'hkmapp' 'hkp' boolean (default off)
4283 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284 {only available when compiled with the |+rightleft|
4285 feature}
4286 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4287 This is useful if you have a non-Hebrew keyboard.
4288 See |rileft.txt|.
4289 NOTE: This option is reset when 'compatible' is set.
4290
Bram Moolenaar036986f2017-03-16 17:41:02 +01004291 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4292'hlsearch' 'hls' boolean (default off)
4293 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004294 {not available when compiled without the
4295 |+extra_search| feature}
4296 When there is a previous search pattern, highlight all its matches.
4297 The type of highlighting used can be set with the 'l' occasion in the
4298 'highlight' option. This uses the "Search" highlight group by
4299 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004300 are not applied. If the "CurSearch" highlight group is set then the
4301 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004302 See also: 'incsearch' and |:match|.
4303 When you get bored looking at the highlighted matches, you can turn it
4304 off with |:nohlsearch|. This does not change the option value, as
4305 soon as you use a search command, the highlighting comes back.
4306 'redrawtime' specifies the maximum time spent on finding matches.
4307 When the search pattern can match an end-of-line, Vim will try to
4308 highlight all of the matched text. However, this depends on where the
4309 search starts. This will be the first line in the window or the first
4310 line below a closed fold. A match in a previous line which is not
4311 drawn may not continue in a newly drawn line.
4312 You can specify whether the highlight status is restored on startup
4313 with the 'h' flag in 'viminfo' |viminfo-h|.
4314 NOTE: This option is reset when 'compatible' is set.
4315
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 *'icon'* *'noicon'*
4317'icon' boolean (default off, on when title can be restored)
4318 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319 When on, the icon text of the window will be set to the value of
4320 'iconstring' (if it is not empty), or to the name of the file
4321 currently being edited. Only the last part of the name is used.
4322 Overridden by the 'iconstring' option.
4323 Only works if the terminal supports setting window icons (currently
4324 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4325 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4326 builtin termcap).
4327 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004328 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004330 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004331
4332 *'iconstring'*
4333'iconstring' string (default "")
4334 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 When this option is not empty, it will be used for the icon text of
4336 the window. This happens only when the 'icon' option is on.
4337 Only works if the terminal supports setting window icon text
4338 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004339 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340 When Vim was compiled with HAVE_X11 defined, the original icon will be
4341 restored if possible |X11|.
4342 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004343 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004345 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 {not available when compiled without the |+statusline| feature}
4347
4348 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4349'ignorecase' 'ic' boolean (default off)
4350 global
4351 Ignore case in search patterns. Also used when searching in the tags
4352 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004353 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354 Can be overruled by using "\c" or "\C" in the pattern, see
4355 |/ignorecase|.
4356
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004357 *'imactivatefunc'* *'imaf'*
4358'imactivatefunc' 'imaf' string (default "")
4359 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004360 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004361 activate or deactivate the Input Method. The value can be the name of
4362 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4363 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004364 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004365 The expression will be evaluated in the |sandbox| when set from a
4366 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004367
4368 Example: >
4369 function ImActivateFunc(active)
4370 if a:active
4371 ... do something
4372 else
4373 ... do something
4374 endif
4375 " return value is not used
4376 endfunction
4377 set imactivatefunc=ImActivateFunc
4378<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 *'imactivatekey'* *'imak'*
4380'imactivatekey' 'imak' string (default "")
4381 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004383 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 Specifies the key that your Input Method in X-Windows uses for
4385 activation. When this is specified correctly, vim can fully control
4386 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4387 You can't use this option to change the activation key, the option
4388 tells Vim what the key is.
4389 Format:
4390 [MODIFIER_FLAG-]KEY_STRING
4391
4392 These characters can be used for MODIFIER_FLAG (case is ignored):
4393 S Shift key
4394 L Lock key
4395 C Control key
4396 1 Mod1 key
4397 2 Mod2 key
4398 3 Mod3 key
4399 4 Mod4 key
4400 5 Mod5 key
4401 Combinations are allowed, for example "S-C-space" or "SC-space" are
4402 both shift+ctrl+space.
4403 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4404
4405 Example: >
4406 :set imactivatekey=S-space
4407< "S-space" means shift+space. This is the activation key for kinput2 +
4408 canna (Japanese), and ami (Korean).
4409
4410 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4411'imcmdline' 'imc' boolean (default off)
4412 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413 When set the Input Method is always on when starting to edit a command
4414 line, unless entering a search pattern (see 'imsearch' for that).
4415 Setting this option is useful when your input method allows entering
4416 English characters directly, e.g., when it's used to type accented
4417 characters with dead keys.
4418
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004419 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4421 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 When set the Input Method is never used. This is useful to disable
4423 the IM when it doesn't work properly.
4424 Currently this option is on by default for SGI/IRIX machines. This
4425 may change in later releases.
4426
4427 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004428'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004429 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430 Specifies whether :lmap or an Input Method (IM) is to be used in
4431 Insert mode. Valid values:
4432 0 :lmap is off and IM is off
4433 1 :lmap is ON and IM is off
4434 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 To always reset the option to zero when leaving Insert mode with <Esc>
4436 this can be used: >
4437 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4438< This makes :lmap and IM turn off automatically when leaving Insert
4439 mode.
4440 Note that this option changes when using CTRL-^ in Insert mode
4441 |i_CTRL-^|.
4442 The value is set to 1 when setting 'keymap' to a valid keymap name.
4443 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004444 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445 methods. Use 'imdisable' to disable XIM then.
4446
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004447 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004448 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004449 |+multi_byte_ime| or |global-ime|.
4450
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004452'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004453 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 Specifies whether :lmap or an Input Method (IM) is to be used when
4455 entering a search pattern. Valid values:
4456 -1 the value of 'iminsert' is used, makes it look like
4457 'iminsert' is also used when typing a search pattern
4458 0 :lmap is off and IM is off
4459 1 :lmap is ON and IM is off
4460 2 :lmap is off and IM is ON
4461 Note that this option changes when using CTRL-^ in Command-line mode
4462 |c_CTRL-^|.
4463 The value is set to 1 when it is not -1 and setting the 'keymap'
4464 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004465 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 methods. Use 'imdisable' to disable XIM then.
4467
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004468 *'imstatusfunc'* *'imsf'*
4469'imstatusfunc' 'imsf' string (default "")
4470 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004471 This option specifies a function that is called to obtain the status
4472 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004473 The value can be the name of a function, a |lambda| or a |Funcref|.
4474 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004475 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004476
4477 Example: >
4478 function ImStatusFunc()
4479 let is_active = ...do something
4480 return is_active ? 1 : 0
4481 endfunction
4482 set imstatusfunc=ImStatusFunc
4483<
4484 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004485 The expression will be evaluated in the |sandbox| when set from a
4486 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004487
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004488 *'imstyle'* *'imst'*
4489'imstyle' 'imst' number (default 1)
4490 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004491 {only available when compiled with |+xim| and
4492 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004493 This option specifies the input style of Input Method:
4494 0 use on-the-spot style
4495 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004496 See: |xim-input-style|
4497
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004498 For a long time on-the-spot style had been used in the GTK version of
4499 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004500 |single-repeat|, etc. Therefore over-the-spot style becomes the
4501 default now. This should work fine for most people, however if you
4502 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004503 The expression will be evaluated in the |sandbox| when set from a
4504 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004505
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 *'include'* *'inc'*
4507'include' 'inc' string (default "^\s*#\s*include")
4508 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 {not available when compiled without the
4510 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004511 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004512 pattern, just like for the "/" command (See |pattern|). The default
4513 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004514 "]I", "[d", etc.
4515 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004516 comes after the matched pattern. But if "\zs" appears in the pattern
4517 then the text matched from "\zs" to the end, or until "\ze" if it
4518 appears, is used as the file name. Use this to include characters
4519 that are not in 'isfname', such as a space. You can then use
4520 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004521 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522
4523 *'includeexpr'* *'inex'*
4524'includeexpr' 'inex' string (default "")
4525 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004527 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004529 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 :set includeexpr=substitute(v:fname,'\\.','/','g')
4531< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004532
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004534 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535 Also used for |<cfile>|.
4536
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004537 If the expression starts with s: or |<SID>|, then it is replaced with
4538 the script ID (|local-function|). Example: >
4539 set includeexpr=s:MyIncludeExpr(v:fname)
4540 set includeexpr=<SID>SomeIncludeExpr(v:fname)
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004541< Otherwise, the expression is evaluated in the context of the script
4542 where the option was set, thus script-local items are available.
4543
Bram Moolenaar30b65812012-07-12 22:01:11 +02004544 The expression will be evaluated in the |sandbox| when set from a
4545 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004546 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004547
4548 It is not allowed to change text or jump to another window while
4549 evaluating 'includeexpr' |textlock|.
4550
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004552'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004553 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004556 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004557 While typing a search command, show where the pattern, as it was typed
4558 so far, matches. The matched string is highlighted. If the pattern
4559 is invalid or not found, nothing is shown. The screen will be updated
4560 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004561 Also applies to the pattern in commands: >
4562 :global
4563 :lvimgrep
4564 :lvimgrepadd
4565 :smagic
4566 :snomagic
4567 :sort
4568 :substitute
4569 :vglobal
4570 :vimgrep
4571 :vimgrepadd
4572< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004573 original position when no match is found and when pressing <Esc>. You
4574 still need to finish the search command with <Enter> to move the
4575 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004576 You can use the CTRL-G and CTRL-T keys to move to the next and
4577 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004578 When compiled with the |+reltime| feature Vim only searches for about
4579 half a second. With a complicated pattern and/or a lot of text the
4580 match may not be found. This is to avoid that Vim hangs while you
4581 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004582 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004583 When 'hlsearch' is on, all matched strings are highlighted too while
4584 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004585 If you don't want to turn 'hlsearch' on, but want to highlight all
4586 matches while searching, you can turn on and off 'hlsearch' with
4587 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004588 augroup vimrc-incsearch-highlight
4589 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004590 autocmd CmdlineEnter /,\? :set hlsearch
4591 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004592 augroup END
4593<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004594 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004595 to the command line. If 'ignorecase' and 'smartcase' are set and the
4596 command line has no uppercase characters, the added character is
4597 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004598 CTRL-R CTRL-W can be used to add the word at the end of the current
4599 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004600 NOTE: This option is reset when 'compatible' is set.
4601
4602 *'indentexpr'* *'inde'*
4603'indentexpr' 'inde' string (default "")
4604 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004605 {not available when compiled without the |+eval|
4606 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 Expression which is evaluated to obtain the proper indent for a line.
4608 It is used when a new line is created, for the |=| operator and
4609 in Insert mode as specified with the 'indentkeys' option.
4610 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004611 'smartindent' indenting. When 'lisp' is set, this option is
4612 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 When 'paste' is set this option is not used for indenting.
4614 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004615 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004617
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004618 If the expression starts with s: or |<SID>|, then it is replaced with
4619 the script ID (|local-function|). Example: >
4620 set indentexpr=s:MyIndentExpr()
4621 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004622< Otherwise, the expression is evaluated in the context of the script
4623 where the option was set, thus script-local items are available.
4624
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 The expression must return the number of spaces worth of indent. It
4626 can return "-1" to keep the current indent (this means 'autoindent' is
4627 used for the indent).
4628 Functions useful for computing the indent are |indent()|, |cindent()|
4629 and |lispindent()|.
4630 The evaluation of the expression must not have side effects! It must
4631 not change the text, jump to another window, etc. Afterwards the
4632 cursor position is always restored, thus the cursor may be moved.
4633 Normally this option would be set to call a function: >
4634 :set indentexpr=GetMyIndent()
4635< Error messages will be suppressed, unless the 'debug' option contains
4636 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004637 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004638 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639
Bram Moolenaar30b65812012-07-12 22:01:11 +02004640 The expression will be evaluated in the |sandbox| when set from a
4641 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004642 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004643
4644 It is not allowed to change text or jump to another window while
4645 evaluating 'indentexpr' |textlock|.
4646
4647
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004649'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 A list of keys that, when typed in Insert mode, cause reindenting of
4652 the current line. Only happens if 'indentexpr' isn't empty.
4653 The format is identical to 'cinkeys', see |indentkeys-format|.
4654 See |C-indenting| and |indent-expression|.
4655
4656 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4657'infercase' 'inf' boolean (default off)
4658 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004660 'ignorecase' is also on, the case of the match is adjusted depending
4661 on the typed text. If the typed text contains a lowercase letter
4662 where the match has an upper case letter, the completed part is made
4663 lowercase. If the typed text has no lowercase letters and the match
4664 has a lowercase letter where the typed text has an uppercase letter,
4665 and there is a letter before it, the completed part is made uppercase.
4666 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667
4668 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4669'insertmode' 'im' boolean (default off)
4670 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 Makes Vim work in a way that Insert mode is the default mode. Useful
4672 if you want to use Vim as a modeless editor. Used for |evim|.
4673 These Insert mode commands will be useful:
4674 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004675 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676 this is a mapping, it is executed as if 'insertmode' was off.
4677 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004679 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4680 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681
4682 These items change when 'insertmode' is set:
4683 - when starting to edit of a file, Vim goes to Insert mode.
4684 - <Esc> in Insert mode is a no-op and beeps.
4685 - <Esc> in Normal mode makes Vim go to Insert mode.
4686 - CTRL-L in Insert mode is a command, it is not inserted.
4687 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4688 However, when <Esc> is used inside a mapping, it behaves like
4689 'insertmode' was not set. This was done to be able to use the same
4690 mappings with 'insertmode' set or not set.
4691 When executing commands with |:normal| 'insertmode' is not used.
4692
4693 NOTE: This option is reset when 'compatible' is set.
4694
4695 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004696'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4698 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4699 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4700 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4701 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4702 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 The characters specified by this option are included in file names and
4704 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004705 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004706 Multi-byte characters 256 and above are always included, only the
4707 characters up to 255 are specified with this option.
4708 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004709 Think twice before adding white space to this option. Although a
4710 space may appear inside a file name, the effect will be that Vim
4711 doesn't know where a file name starts or ends when doing completion.
4712 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004713
4714 Note that on systems using a backslash as path separator, Vim tries to
4715 do its best to make it work as you would expect. That is a bit
4716 tricky, since Vi originally used the backslash to escape special
4717 characters. Vim will not remove a backslash in front of a normal file
4718 name character on these systems, but it will on Unix and alikes. The
4719 '&' and '^' are not included by default, because these are special for
4720 cmd.exe.
4721
4722 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004723 Each part can be a single character number or a range. A range is two
4724 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 decimal number between 0 and 255 or the ASCII character itself (does
4726 not work for digits). Example:
4727 "_,-,128-140,#-43" (include '_' and '-' and the range
4728 128 to 140 and '#' to 43)
4729 If a part starts with '^', the following character number or range
4730 will be excluded from the option. The option is interpreted from left
4731 to right. Put the excluded character after the range where it is
4732 included. To include '^' itself use it as the last character of the
4733 option or the end of a range. Example:
4734 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4735 If the character is '@', all characters where isalpha() returns TRUE
4736 are included. Normally these are the characters a to z and A to Z,
4737 plus accented characters. To include '@' itself use "@-@". Examples:
4738 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004739 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004740 "a-z,A-Z,@-@" All letters plus the '@' character.
4741 A comma can be included by using it where a character number is
4742 expected. Example:
4743 "48-57,,,_" Digits, comma and underscore.
4744 A comma can be excluded by prepending a '^'. Example:
4745 " -~,^,,9" All characters from space to '~', excluding
4746 comma, plus <Tab>.
4747 See |option-backslash| about including spaces and backslashes.
4748
4749 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004750'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751 "@,48-57,_,128-167,224-235"
4752 otherwise: "@,48-57,_,192-255")
4753 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 The characters given by this option are included in identifiers.
4755 Identifiers are used in recognizing environment variables and after a
4756 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004757 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004758 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004760 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4762
4763 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004764'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 "@,48-57,_,128-167,224-235"
4766 otherwise: "@,48-57,_,192-255"
4767 Vi default: "@,48-57,_")
4768 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004770 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004771 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004772 characters above 255 check the "word" character class (any character
4773 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004774 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 For a help file it is set to all non-blank printable characters except
4776 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4777 command).
4778 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004779 This option also influences syntax highlighting, unless the syntax
4780 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781 NOTE: This option is set to the Vi default value when 'compatible' is
4782 set and to the Vim default value when 'compatible' is reset.
4783
4784 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004785'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786 "@,~-255"; otherwise: "@,161-255")
4787 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 The characters given by this option are displayed directly on the
4789 screen. It is also used for "\p" in a |pattern|. The characters from
4790 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4791 even when they are not included in 'isprint' or excluded. See
4792 'isfname' for a description of the format of this option.
4793
4794 Non-printable characters are displayed with two characters:
4795 0 - 31 "^@" - "^_"
4796 32 - 126 always single characters
4797 127 "^?"
4798 128 - 159 "~@" - "~_"
4799 160 - 254 "| " - "|~"
4800 255 "~?"
4801 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4802 displayed as <xx>, with the hexadecimal value of the byte.
4803 When 'display' contains "uhex" all unprintable characters are
4804 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004805 The SpecialKey highlighting will be used for unprintable characters.
4806 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004807
4808 Multi-byte characters 256 and above are always included, only the
4809 characters up to 255 are specified with this option. When a character
4810 is printable but it is not available in the current font, a
4811 replacement character will be shown.
4812 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4813 There is no option to specify these characters.
4814
4815 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4816'joinspaces' 'js' boolean (default on)
4817 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004818 Insert two spaces after a '.', '?' and '!' with a join command.
4819 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4820 Otherwise only one space is inserted.
4821 NOTE: This option is set when 'compatible' is set.
4822
4823 *'key'*
4824'key' string (default "")
4825 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004826 {only available when compiled with the |+cryptv|
4827 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004829 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830 Careful: Do not set the key value by hand, someone might see the typed
4831 key. Use the |:X| command. But you can make 'key' empty: >
4832 :set key=
4833< It is not possible to get the value of this option with ":set key" or
4834 "echo &key". This is to avoid showing it to someone who shouldn't
4835 know. It also means you cannot see it yourself once you have set it,
4836 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004837 You can use "&key" in an expression to detect whether encryption is
4838 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839
4840 *'keymap'* *'kmp'* *E544*
4841'keymap' 'kmp' string (default "")
4842 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843 {only available when compiled with the |+keymap|
4844 feature}
4845 Name of a keyboard mapping. See |mbyte-keymap|.
4846 Setting this option to a valid keymap name has the side effect of
4847 setting 'iminsert' to one, so that the keymap becomes effective.
4848 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004849 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850
4851 *'keymodel'* *'km'*
4852'keymodel' 'km' string (default "")
4853 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004854 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855 can do. These values can be used:
4856 startsel Using a shifted special key starts selection (either
4857 Select mode or Visual mode, depending on "key" being
4858 present in 'selectmode').
4859 stopsel Using a not-shifted special key stops selection.
4860 Special keys in this context are the cursor keys, <End>, <Home>,
4861 <PageUp> and <PageDown>.
4862 The 'keymodel' option is set by the |:behave| command.
4863
4864 *'keywordprg'* *'kp'*
4865'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004866 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868 Program to use for the |K| command. Environment variables are
4869 expanded |:set_env|. ":help" may be used to access the Vim internal
4870 help. (Note that previously setting the global option to the empty
4871 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004872 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01004873 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004874 When "man", "man -s" or an Ex command is used, Vim will automatically
4875 translate a count for the "K" command and pass it as the first
4876 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 See |option-backslash| about including spaces and backslashes.
4878 Example: >
4879 :set keywordprg=man\ -s
4880< This option cannot be set from a |modeline| or in the |sandbox|, for
4881 security reasons.
4882
4883 *'langmap'* *'lmap'* *E357* *E358*
4884'langmap' 'lmap' string (default "")
4885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 {only available when compiled with the |+langmap|
4887 feature}
4888 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004889 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004890 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 care of translating these special characters to the original meaning
4892 of the key. This means you don't have to change the keyboard mode to
4893 be able to execute Normal mode commands.
4894 This is the opposite of the 'keymap' option, where characters are
4895 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004896 Also consider setting 'langremap' to off, to prevent 'langmap' from
4897 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004898 This option cannot be set from a |modeline| or in the |sandbox|, for
4899 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004901 Example (for Greek, in UTF-8): *greek* >
4902 :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 +00004903< Example (exchanges meaning of z and y for commands): >
4904 :set langmap=zy,yz,ZY,YZ
4905<
4906 The 'langmap' option is a list of parts, separated with commas. Each
4907 part can be in one of two forms:
4908 1. A list of pairs. Each pair is a "from" character immediately
4909 followed by the "to" character. Examples: "aA", "aAbBcC".
4910 2. A list of "from" characters, a semi-colon and a list of "to"
4911 characters. Example: "abc;ABC"
4912 Example: "aA,fgh;FGH,cCdDeE"
4913 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004914 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004915
4916 This will allow you to activate vim actions without having to switch
4917 back and forth between the languages. Your language characters will
4918 be understood as normal vim English characters (according to the
4919 langmap mappings) in the following cases:
4920 o Normal/Visual mode (commands, buffer/register names, user mappings)
4921 o Insert/Replace Mode: Register names after CTRL-R
4922 o Insert/Replace Mode: Mappings
4923 Characters entered in Command-line mode will NOT be affected by
4924 this option. Note that this option can be changed at any time
4925 allowing to switch between mappings for different languages/encodings.
4926 Use a mapping to avoid having to type it each time!
4927
4928 *'langmenu'* *'lm'*
4929'langmenu' 'lm' string (default "")
4930 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 {only available when compiled with the |+menu| and
4932 |+multi_lang| features}
4933 Language to use for menu translation. Tells which file is loaded
4934 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004935 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004936< (without the spaces). For example, to always use the Dutch menus, no
4937 matter what $LANG is set to: >
4938 :set langmenu=nl_NL.ISO_8859-1
4939< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004940 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941 If your $LANG is set to a non-English language but you do want to use
4942 the English menus: >
4943 :set langmenu=none
4944< This option must be set before loading menus, switching on filetype
4945 detection or syntax highlighting. Once the menus are defined setting
4946 this option has no effect. But you could do this: >
4947 :source $VIMRUNTIME/delmenu.vim
4948 :set langmenu=de_DE.ISO_8859-1
4949 :source $VIMRUNTIME/menu.vim
4950< Warning: This deletes all menus that you defined yourself!
4951
Bram Moolenaard94464e2015-11-02 15:28:18 +01004952 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004953'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004954 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004955 {only available when compiled with the |+langmap|
4956 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004957 This is just like 'langremap' but with the value inverted. It only
4958 exists for backwards compatibility. When setting 'langremap' then
4959 'langnoremap' is set to the inverted value, and the other way around.
4960
4961 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004962'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004963 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004964 {only available when compiled with the |+langmap|
4965 feature}
4966 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004967 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004968 'langmap' disables some of your mappings, try resetting this option.
4969 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004970 that works for you to avoid mappings to break.
4971
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972 *'laststatus'* *'ls'*
4973'laststatus' 'ls' number (default 1)
4974 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 The value of this option influences when the last window will have a
4976 status line:
4977 0: never
4978 1: only if there are at least two windows
4979 2: always
4980 The screen looks nicer with a status line if you have several
4981 windows, but it takes another screen line. |status-line|
4982
4983 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4984'lazyredraw' 'lz' boolean (default off)
4985 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986 When this option is set, the screen will not be redrawn while
4987 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004988 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01004990 This may occasionally cause display errors. It is only meant to be set
4991 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01004992 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993
4994 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4995'linebreak' 'lbr' boolean (default off)
4996 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004997 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004999 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000 than at the last character that fits on the screen. Unlike
5001 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005002 it only affects the way the file is displayed, not its contents.
5003 If 'breakindent' is set, line is visually indented. Then, the value
5004 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005005 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006 Note that <Tab> characters after an <EOL> are mostly not displayed
5007 with the right amount of white space.
5008
5009 *'lines'* *E593*
5010'lines' number (default 24 or terminal height)
5011 global
5012 Number of lines of the Vim window.
5013 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005014 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015 When Vim is running in the GUI or in a resizable window, setting this
5016 option will cause the window size to be changed. When you only want
5017 to use the size for the GUI, put the command in your |gvimrc| file.
5018 Vim limits the number of lines to what fits on the screen. You can
5019 use this command to get the tallest window possible: >
5020 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005021< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005022 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005023 When you set this option and Vim is unable to change the physical
5024 number of lines of the display, the display may be messed up.
5025
5026 *'linespace'* *'lsp'*
5027'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5028 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005029 {only in the GUI}
5030 Number of pixel lines inserted between characters. Useful if the font
5031 uses the full character cell height, making lines touch each other.
5032 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005033 With some fonts there can be too much room between lines (to have
5034 space for ascents and descents). Then it makes sense to set
5035 'linespace' to a negative value. This may cause display problems
5036 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005037
5038 *'lisp'* *'nolisp'*
5039'lisp' boolean (default off)
5040 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005041 Lisp mode: When <Enter> is typed in insert mode set the indent for
5042 the next line to Lisp standards (well, sort of). Also happens with
5043 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5044 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5045 better. Also see 'lispwords'.
5046 The '-' character is included in keyword characters. Redefines the
5047 "=" operator to use this same indentation algorithm rather than
5048 calling an external program if 'equalprg' is empty.
5049 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005050
5051 *'lispwords'* *'lw'*
5052'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005053 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005054 Comma-separated list of words that influence the Lisp indenting when
5055 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056
5057 *'list'* *'nolist'*
5058'list' boolean (default off)
5059 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005060 List mode: By default show tabs as CTRL-I is displayed, display $
5061 after end of line. Useful to see the difference between tabs and
5062 spaces and for trailing blanks. Further changed by the 'listchars'
5063 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005064
5065 The cursor is displayed at the start of the space a Tab character
5066 occupies, not at the end as usual in Normal mode. To get this cursor
5067 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005068 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005069<
5070 Note that list mode will also affect formatting (set with 'textwidth'
5071 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072 changing the way tabs are displayed.
5073
5074 *'listchars'* *'lcs'*
5075'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005076 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005077 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005078 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005079 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005080 eol:c Character to show at the end of each line. When
5081 omitted, there is no extra character at the end of the
5082 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005083 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005084 tab:xy[z] Two or three characters to be used to show a tab.
5085 The third character is optional.
5086
5087 tab:xy The 'x' is always used, then 'y' as many times as will
5088 fit. Thus "tab:>-" displays:
5089 >
5090 >-
5091 >--
5092 etc.
5093
5094 tab:xyz The 'z' is always used, then 'x' is prepended, and
5095 then 'y' is used as many times as will fit. Thus
5096 "tab:<->" displays:
5097 >
5098 <>
5099 <->
5100 <-->
5101 etc.
5102
5103 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005104 *lcs-space*
5105 space:c Character to show for a space. When omitted, spaces
5106 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005107 *lcs-multispace*
5108 multispace:c...
5109 One or more characters to use cyclically to show for
5110 multiple consecutive spaces. Overrides the "space"
5111 setting, except for single spaces. When omitted, the
5112 "space" setting is used. For example,
5113 `:set listchars=multispace:---+` shows ten consecutive
5114 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005115 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005116 *lcs-lead*
5117 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005118 leading spaces are blank. Overrides the "space" and
5119 "multispace" settings for leading spaces. You can
5120 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005121 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005122< *lcs-leadmultispace*
5123 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005124 Like the |lcs-multispace| value, but for leading
5125 spaces only. Also overrides |lcs-lead| for leading
5126 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005127 `:set listchars=leadmultispace:---+` shows ten
5128 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005129 ---+---+--XXX ~
5130 Where "XXX" denotes the first non-blank characters in
5131 the line.
5132 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005133 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005134 trailing spaces are blank. Overrides the "space" and
5135 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005136 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005137 extends:c Character to show in the last column, when 'wrap' is
5138 off and the line continues beyond the right of the
5139 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005140 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005141 precedes:c Character to show in the first visible column of the
5142 physical line, when there is text preceding the
5143 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005144 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005145 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005146 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005147 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005148 nbsp:c Character to show for a non-breakable space character
5149 (0xA0 (160 decimal) and U+202F). Left blank when
5150 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005152 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005154 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005156 Each character can be specified as hex: >
5157 set listchars=eol:\\x24
5158 set listchars=eol:\\u21b5
5159 set listchars=eol:\\U000021b5
5160< Note that a double backslash is used. The number of hex characters
5161 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5162
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163 Examples: >
5164 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005165 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005166 :set lcs=extends:>,precedes:<
5167< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005168 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5169 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005170 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171
5172 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5173'loadplugins' 'lpl' boolean (default on)
5174 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175 When on the plugin scripts are loaded when starting up |load-plugins|.
5176 This option can be reset in your |vimrc| file to disable the loading
5177 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005178 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5179 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180
Bram Moolenaard94464e2015-11-02 15:28:18 +01005181 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005182'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005183 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005184 {only available when compiled with the |+lua/dyn|
5185 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005186 Specifies the name of the Lua shared library. The default is
5187 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005188 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005189 This option cannot be set from a |modeline| or in the |sandbox|, for
5190 security reasons.
5191
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005192 *'macatsui'* *'nomacatsui'*
5193'macatsui' boolean (default on)
5194 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005195 {not supported}
5196 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005197
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 *'magic'* *'nomagic'*
5199'magic' boolean (default on)
5200 global
5201 Changes the special characters that can be used in search patterns.
5202 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005203 WARNING: Switching this option off most likely breaks plugins! That
5204 is because many patterns assume it's on and will fail when it's off.
5205 Only switch it off when working with old Vi scripts. In any other
5206 situation write patterns that work when 'magic' is on. Include "\M"
5207 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005208 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5209 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210
5211 *'makeef'* *'mef'*
5212'makeef' 'mef' string (default: "")
5213 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214 {not available when compiled without the |+quickfix|
5215 feature}
5216 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5217 and the |:grep| command.
5218 When it is empty, an internally generated temp file will be used.
5219 When "##" is included, it is replaced by a number to make the name
5220 unique. This makes sure that the ":make" command doesn't overwrite an
5221 existing file.
5222 NOT used for the ":cf" command. See 'errorfile' for that.
5223 Environment variables are expanded |:set_env|.
5224 See |option-backslash| about including spaces and backslashes.
5225 This option cannot be set from a |modeline| or in the |sandbox|, for
5226 security reasons.
5227
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005228 *'makeencoding'* *'menc'*
5229'makeencoding' 'menc' string (default "")
5230 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005231 Encoding used for reading the output of external commands. When empty,
5232 encoding is not converted.
5233 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5234 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5235 and `:laddfile`.
5236
5237 This would be mostly useful when you use MS-Windows and set 'encoding'
5238 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5239 'makeencoding' to "char" has the same effect as setting to the system
5240 locale encoding. Example: >
5241 :set encoding=utf-8
5242 :set makeencoding=char " system locale is used
5243<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244 *'makeprg'* *'mp'*
5245'makeprg' 'mp' string (default "make", VMS: "MMS")
5246 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005247 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005248 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5249 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005250 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005251 Environment variables are expanded |:set_env|. See |option-backslash|
5252 about including spaces and backslashes.
5253 Note that a '|' must be escaped twice: once for ":set" and once for
5254 the interpretation of a command. When you use a filter called
5255 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005256 :set makeprg=gmake\ \\\|\ myfilter
5257< The placeholder "$*" can be given (even multiple times) to specify
5258 where the arguments will be included, for example: >
5259 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5260< This option cannot be set from a |modeline| or in the |sandbox|, for
5261 security reasons.
5262
5263 *'matchpairs'* *'mps'*
5264'matchpairs' 'mps' string (default "(:),{:},[:]")
5265 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005267 other.
5268 Only character pairs are allowed that are different, thus you cannot
5269 jump between two double quotes.
5270 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005271 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005272 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005273 :set mps+=<:>
5274
5275< A more exotic example, to jump between the '=' and ';' in an
5276 assignment, useful for languages like C and Java: >
5277 :au FileType c,cpp,java set mps+==:;
5278
5279< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005280 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281
5282 *'matchtime'* *'mat'*
5283'matchtime' 'mat' number (default 5)
5284 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 Tenths of a second to show the matching paren, when 'showmatch' is
5286 set. Note that this is not in milliseconds, like other options that
5287 set a time. This is to be compatible with Nvi.
5288
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005289 *'maxcombine'* *'mco'*
5290'maxcombine' 'mco' number (default 2)
5291 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005292 The maximum number of combining characters supported for displaying.
5293 Only used when 'encoding' is "utf-8".
5294 The default is OK for most languages. Hebrew may require 4.
5295 Maximum value is 6.
5296 Even when this option is set to 2 you can still edit text with more
5297 combining characters, you just can't see them. Use |g8| or |ga|.
5298 See |mbyte-combining|.
5299
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 *'maxfuncdepth'* *'mfd'*
5301'maxfuncdepth' 'mfd' number (default 100)
5302 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005303 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005304 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305 Maximum depth of function calls for user functions. This normally
5306 catches endless recursion. When using a recursive function with
5307 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5308 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005309 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005310 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 See also |:function|.
5312
5313 *'maxmapdepth'* *'mmd'* *E223*
5314'maxmapdepth' 'mmd' number (default 1000)
5315 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316 Maximum number of times a mapping is done without resulting in a
5317 character to be used. This normally catches endless mappings, like
5318 ":map x y" with ":map y x". It still does not catch ":map g wg",
5319 because the 'w' is used before the next mapping is done. See also
5320 |key-mapping|.
5321
5322 *'maxmem'* *'mm'*
5323'maxmem' 'mm' number (default between 256 to 5120 (system
5324 dependent) or half the amount of memory
5325 available)
5326 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5328 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005329 other memory to be freed.
5330 The maximum usable value is about 2000000. Use this to work without a
5331 limit.
5332 The value is ignored when 'swapfile' is off.
5333 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005335 *'maxmempattern'* *'mmp'*
5336'maxmempattern' 'mmp' number (default 1000)
5337 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005338 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005339 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005340 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005341 When Vim runs into the limit it gives an error message and mostly
5342 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005343 Running into the limit often means that the pattern is very
5344 inefficient or too complex. This may already happen with the pattern
5345 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005346 Might also happen on redraw, when syntax rules try to match a complex
5347 text structure.
5348 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5349 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005350
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351 *'maxmemtot'* *'mmt'*
5352'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5353 dependent) or half the amount of memory
5354 available)
5355 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005356 Maximum amount of memory in Kbyte to use for all buffers together.
5357 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005358 without a limit.
5359 On 64 bit machines higher values might work. But hey, do you really
5360 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005361 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005362 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005363 Buffers with 'swapfile' off still count to the total amount of memory
5364 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005365 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005366
5367 *'menuitems'* *'mis'*
5368'menuitems' 'mis' number (default 25)
5369 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370 {not available when compiled without the |+menu|
5371 feature}
5372 Maximum number of items to use in a menu. Used for menus that are
5373 generated from a list of items, e.g., the Buffers menu. Changing this
5374 option has no direct effect, the menu must be refreshed first.
5375
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005376 *'mkspellmem'* *'msm'*
5377'mkspellmem' 'msm' string (default "460000,2000,500")
5378 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005379 {not available when compiled without the |+syntax|
5380 feature}
5381 Parameters for |:mkspell|. This tunes when to start compressing the
5382 word tree. Compression can be slow when there are many words, but
5383 it's needed to avoid running out of memory. The amount of memory used
5384 per word depends very much on how similar the words are, that's why
5385 this tuning is complicated.
5386
5387 There are three numbers, separated by commas:
5388 {start},{inc},{added}
5389
5390 For most languages the uncompressed word tree fits in memory. {start}
5391 gives the amount of memory in Kbyte that can be used before any
5392 compression is done. It should be a bit smaller than the amount of
5393 memory that is available to Vim.
5394
5395 When going over the {start} limit the {inc} number specifies the
5396 amount of memory in Kbyte that can be allocated before another
5397 compression is done. A low number means compression is done after
5398 less words are added, which is slow. A high number means more memory
5399 will be allocated.
5400
5401 After doing compression, {added} times 1024 words can be added before
5402 the {inc} limit is ignored and compression is done when any extra
5403 amount of memory is needed. A low number means there is a smaller
5404 chance of hitting the {inc} limit, less memory is used but it's
5405 slower.
5406
5407 The languages for which these numbers are important are Italian and
5408 Hungarian. The default works for when you have about 512 Mbyte. If
5409 you have 1 Gbyte you could use: >
5410 :set mkspellmem=900000,3000,800
5411< If you have less than 512 Mbyte |:mkspell| may fail for some
5412 languages, no matter what you set 'mkspellmem' to.
5413
Bram Moolenaar07607392019-05-26 19:20:43 +02005414 This option cannot be set from a |modeline| or in the |sandbox|.
5415
Bram Moolenaar071d4272004-06-13 20:20:40 +00005416 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005417'modeline' 'ml' boolean (Vim default: on (off for root),
5418 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005420 If 'modeline' is on 'modelines' gives the number of lines that is
5421 checked for set commands. If 'modeline' is off or 'modelines' is zero
5422 no lines are checked. See |modeline|.
5423
5424 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5425'modelineexpr' 'mle' boolean (default: off)
5426 global
5427 When on allow some options that are an expression to be set in the
5428 modeline. Check the option for whether it is affected by
5429 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005430 This option cannot be set from a |modeline| or in the |sandbox|, for
5431 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005432
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 *'modelines'* *'mls'*
5434'modelines' 'mls' number (default 5)
5435 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 If 'modeline' is on 'modelines' gives the number of lines that is
5437 checked for set commands. If 'modeline' is off or 'modelines' is zero
5438 no lines are checked. See |modeline|.
5439 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5440 set and to the Vim default value when 'compatible' is reset.
5441
5442 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005443 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444'modifiable' 'ma' boolean (default on)
5445 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 When off the buffer contents cannot be changed. The 'fileformat' and
5447 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005448 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005449
5450 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5451'modified' 'mod' boolean (default off)
5452 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 When on, the buffer is considered to be modified. This option is set
5454 when:
5455 1. A change was made to the text since it was last written. Using the
5456 |undo| command to go back to the original text will reset the
5457 option. But undoing changes that were made before writing the
5458 buffer will set the option again, since the text is different from
5459 when it was written.
5460 2. 'fileformat' or 'fileencoding' is different from its original
5461 value. The original value is set when the buffer is read or
5462 written. A ":set nomodified" command also resets the original
5463 values to the current values and the 'modified' option will be
5464 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005465 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005466 This option is not set when a change is made to the buffer as the
5467 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5468 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5469 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5471 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005472 Note that the text may actually be the same, e.g. 'modified' is set
5473 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005474
5475 *'more'* *'nomore'*
5476'more' boolean (Vim default: on, Vi default: off)
5477 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005478 When on, listings pause when the whole screen is filled. You will get
5479 the |more-prompt|. When this option is off there are no pauses, the
5480 listing continues until finished.
5481 NOTE: This option is set to the Vi default value when 'compatible' is
5482 set and to the Vim default value when 'compatible' is reset.
5483
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005484 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005485'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005486 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005488 Enable the use of the mouse. Works for most terminals (xterm, Win32
5489 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5490 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5491 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005492 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493 v Visual mode
5494 i Insert mode
5495 c Command-line mode
5496 h all previous modes when editing a help file
5497 a all previous modes
5498 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005499 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005500 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005501< If your terminal can't overrule the mouse events going to the
5502 application, use: >
5503 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005504< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005505 back to Vim using the mouse events.
5506 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5507 "xterm".
5508
5509 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 modeless selection. This doesn't move the text cursor.
5511
5512 See |mouse-using|. Also see |'clipboard'|.
5513
5514 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005515 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516 the mouse buttons can still be used by keeping the shift key pressed.
5517 Also see the 'clipboard' option.
5518
5519 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5520'mousefocus' 'mousef' boolean (default off)
5521 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522 {only works in the GUI}
5523 The window that the mouse pointer is on is automatically activated.
5524 When changing the window layout or window focus in another way, the
5525 mouse pointer is moved to the window with keyboard focus. Off is the
5526 default because it makes using the pull down menus a little goofy, as
5527 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005528 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005529 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530
5531 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5532'mousehide' 'mh' boolean (default on)
5533 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534 {only works in the GUI}
5535 When on, the mouse pointer is hidden when characters are typed.
5536 The mouse pointer is restored when the mouse is moved.
5537
5538 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005539'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005541 Sets the model to use for the mouse. The name mostly specifies what
5542 the right mouse button is used for:
5543 extend Right mouse button extends a selection. This works
5544 like in an xterm.
5545 popup Right mouse button pops up a menu. The shifted left
5546 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005547 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 popup_setpos Like "popup", but the cursor will be moved to the
5549 position where the mouse was clicked, and thus the
5550 selected operation will act upon the clicked object.
5551 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005552 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005553 course, that right clicking outside a selection will
5554 end Visual mode.
5555 Overview of what button does what for each model:
5556 mouse extend popup(_setpos) ~
5557 left click place cursor place cursor
5558 left drag start selection start selection
5559 shift-left search word extend selection
5560 right click extend selection popup menu (place cursor)
5561 right drag extend selection -
5562 middle click paste paste
5563
5564 In the "popup" model the right mouse button produces a pop-up menu.
5565 You need to define this first, see |popup-menu|.
5566
5567 Note that you can further refine the meaning of buttons with mappings.
5568 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5569 selection (because that's handled in the GUI code directly).
5570
5571 The 'mousemodel' option is set by the |:behave| command.
5572
Ernie Raelc4cb5442022-04-03 15:47:28 +01005573 *'mousemoveevent'* *'mousemev'*
5574'mousemoveevent' 'mousemev' boolean (default off)
5575 global
5576 {only works in the GUI}
5577 When on, mouse move events are delivered to the input queue and are
5578 available for mapping. The default, off, avoids the mouse movement
5579 overhead except when needed. See |gui-mouse-mapping|.
5580 Warning: Setting this option can make pending mappings to be aborted
5581 when the mouse is moved.
5582 Currently only works in the GUI, may be made to work in a terminal
5583 later.
5584
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005586'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5587 vs:leftright,vd:lrsizing,m:no,
5588 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590 {only available when compiled with the |+mouseshape|
5591 feature}
5592 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005593 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 like used for 'guicursor'. Each part consist of a mode/location-list
5595 and an argument-list:
5596 mode-list:shape,mode-list:shape,..
5597 The mode-list is a dash separated list of these modes/locations:
5598 In a normal window: ~
5599 n Normal mode
5600 v Visual mode
5601 ve Visual mode with 'selection' "exclusive" (same as 'v',
5602 if not specified)
5603 o Operator-pending mode
5604 i Insert mode
5605 r Replace mode
5606
5607 Others: ~
5608 c appending to the command-line
5609 ci inserting in the command-line
5610 cr replacing in the command-line
5611 m at the 'Hit ENTER' or 'More' prompts
5612 ml idem, but cursor in the last line
5613 e any mode, pointer below last window
5614 s any mode, pointer on a status line
5615 sd any mode, while dragging a status line
5616 vs any mode, pointer on a vertical separator line
5617 vd any mode, while dragging a vertical separator line
5618 a everywhere
5619
5620 The shape is one of the following:
5621 avail name looks like ~
5622 w x arrow Normal mouse pointer
5623 w x blank no pointer at all (use with care!)
5624 w x beam I-beam
5625 w x updown up-down sizing arrows
5626 w x leftright left-right sizing arrows
5627 w x busy The system's usual busy pointer
5628 w x no The system's usual 'no input' pointer
5629 x udsizing indicates up-down resizing
5630 x lrsizing indicates left-right resizing
5631 x crosshair like a big thin +
5632 x hand1 black hand
5633 x hand2 white hand
5634 x pencil what you write with
5635 x question big ?
5636 x rightup-arrow arrow pointing right-up
5637 w x up-arrow arrow pointing up
5638 x <number> any X11 pointer number (see X11/cursorfont.h)
5639
5640 The "avail" column contains a 'w' if the shape is available for Win32,
5641 x for X11.
5642 Any modes not specified or shapes not available use the normal mouse
5643 pointer.
5644
5645 Example: >
5646 :set mouseshape=s:udsizing,m:no
5647< will make the mouse turn to a sizing arrow over the status lines and
5648 indicate no input when the hit-enter prompt is displayed (since
5649 clicking the mouse has no effect in this state.)
5650
5651 *'mousetime'* *'mouset'*
5652'mousetime' 'mouset' number (default 500)
5653 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005654 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655 time in msec between two mouse clicks for the second click to be
5656 recognized as a multi click.
5657
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005658 *'mzschemedll'*
5659'mzschemedll' string (default depends on the build)
5660 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005661 {only available when compiled with the |+mzscheme/dyn|
5662 feature}
5663 Specifies the name of the MzScheme shared library. The default is
5664 DYNAMIC_MZSCH_DLL which was specified at compile time.
5665 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005666 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005667 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005668 This option cannot be set from a |modeline| or in the |sandbox|, for
5669 security reasons.
5670
5671 *'mzschemegcdll'*
5672'mzschemegcdll' string (default depends on the build)
5673 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005674 {only available when compiled with the |+mzscheme/dyn|
5675 feature}
5676 Specifies the name of the MzScheme GC shared library. The default is
5677 DYNAMIC_MZGC_DLL which was specified at compile time.
5678 The value can be equal to 'mzschemedll' if it includes the GC code.
5679 Environment variables are expanded |:set_env|.
5680 This option cannot be set from a |modeline| or in the |sandbox|, for
5681 security reasons.
5682
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005683 *'mzquantum'* *'mzq'*
5684'mzquantum' 'mzq' number (default 100)
5685 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005686 {not available when compiled without the |+mzscheme|
5687 feature}
5688 The number of milliseconds between polls for MzScheme threads.
5689 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005690 NOTE: This option is set to the Vim default value when 'compatible'
5691 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005692
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005694'nrformats' 'nf' string (default "bin,octal,hex",
5695 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 This defines what bases Vim will consider for numbers when using the
5698 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5699 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005700 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005702 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005703 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005705 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706 considered to be hexadecimal. Example: Using CTRL-X on
5707 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005708 bin If included, numbers starting with "0b" or "0B" will be
5709 considered to be binary. Example: Using CTRL-X on
5710 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005711 unsigned If included, numbers are recognized as unsigned. Thus a
5712 leading dash or negative sign won't be considered as part of
5713 the number. Examples:
5714 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5715 (without "unsigned" it would become "9-2021").
5716 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5717 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005718 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5719 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 Numbers which simply begin with a digit in the range 1-9 are always
5721 considered decimal. This also happens for numbers that are not
5722 recognized as octal or hex.
5723
5724 *'number'* *'nu'* *'nonumber'* *'nonu'*
5725'number' 'nu' boolean (default off)
5726 local to window
5727 Print the line number in front of each line. When the 'n' option is
5728 excluded from 'cpoptions' a wrapped line will not use the column of
5729 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005730 The 'numberwidth' option can be used to set the room used for the line
5731 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732 When a long, wrapped line doesn't start with the first character, '-'
5733 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005734 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5735 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005736 *number_relativenumber*
5737 The 'relativenumber' option changes the displayed number to be
5738 relative to the cursor. Together with 'number' there are these
5739 four combinations (cursor in line 3):
5740
Bram Moolenaar3848e002016-03-19 18:42:29 +01005741 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005742 'nornu' 'nornu' 'rnu' 'rnu'
5743
5744 |apple | 1 apple | 2 apple | 2 apple
5745 |pear | 2 pear | 1 pear | 1 pear
5746 |nobody | 3 nobody | 0 nobody |3 nobody
5747 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005749 *'numberwidth'* *'nuw'*
5750'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5751 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005752 {only available when compiled with the |+linebreak|
5753 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005754 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005755 when the 'number' or 'relativenumber' option is set or printing lines
5756 with a line number. Since one space is always between the number and
5757 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005758 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005759 fit the highest line number in the buffer respectively the number of
5760 rows in the window, depending on whether 'number' or 'relativenumber'
5761 is set. Thus with the Vim default of 4 there is room for a line number
5762 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005763 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005764 NOTE: This option is set to the Vi default value when 'compatible' is
5765 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005766
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005767 *'omnifunc'* *'ofu'*
5768'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005769 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005770 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005771 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005772 This option specifies a function to be used for Insert mode omni
5773 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005774 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005775 invoked and what it should return. The value can be the name of a
5776 function, a |lambda| or a |Funcref|. See |option-value-function| for
5777 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005778 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005779 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005780 This option cannot be set from a |modeline| or in the |sandbox|, for
5781 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005782
5783
Bram Moolenaar02467872007-05-06 13:22:01 +00005784 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005785'opendevice' 'odev' boolean (default off)
5786 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005787 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005788 Enable reading and writing from devices. This may get Vim stuck on a
5789 device that can be opened but doesn't actually do the I/O. Therefore
5790 it is off by default.
5791 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5792 result in editing a device.
5793
5794
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005795 *'operatorfunc'* *'opfunc'*
5796'operatorfunc' 'opfunc' string (default: empty)
5797 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005798 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005799 See |:map-operator| for more info and an example. The value can be
5800 the name of a function, a |lambda| or a |Funcref|. See
5801 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005802
5803 This option cannot be set from a |modeline| or in the |sandbox|, for
5804 security reasons.
5805
5806
Bram Moolenaar251e1912011-06-19 05:09:16 +02005807 *'osfiletype'* *'oft'*
5808'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005810 This option was supported on RISC OS, which has been removed.
5811
Bram Moolenaar071d4272004-06-13 20:20:40 +00005812
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005813 *'packpath'* *'pp'*
5814'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005815 Directories used to find packages. See |packages|.
5816
5817
Bram Moolenaar071d4272004-06-13 20:20:40 +00005818 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005819'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005820 global
5821 Specifies the nroff macros that separate paragraphs. These are pairs
5822 of two letters (see |object-motions|).
5823
5824 *'paste'* *'nopaste'*
5825'paste' boolean (default off)
5826 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005827 Put Vim in Paste mode. This is useful if you want to cut or copy
5828 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005829 unexpected effects.
5830 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005831 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005832 knows about pasting and will mostly do the right thing without 'paste'
5833 being set. The same is true for a terminal where Vim handles the
5834 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005835 This option is reset when starting the GUI. Thus if you set it in
5836 your .vimrc it will work in a terminal, but not in the GUI. Setting
5837 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5838 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005839 When the 'paste' option is switched on (also when it was already on):
5840 - mapping in Insert mode and Command-line mode is disabled
5841 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005842 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005843 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005844 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005845 - 'revins' is reset
5846 - 'ruler' is reset
5847 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005848 - 'smarttab' is reset
5849 - 'softtabstop' is set to 0
5850 - 'textwidth' is set to 0
5851 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005852 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005853 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005854 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005855 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005856 - 'indentexpr'
5857 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005858 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005859 NOTE: When you start editing another file while the 'paste' option is
5860 on, settings from the modelines or autocommands may change the
5861 settings again, causing trouble when pasting text. You might want to
5862 set the 'paste' option again.
5863 When the 'paste' option is reset the mentioned options are restored to
5864 the value before the moment 'paste' was switched from off to on.
5865 Resetting 'paste' before ever setting it does not have any effect.
5866 Since mapping doesn't work while 'paste' is active, you need to use
5867 the 'pastetoggle' option to toggle the 'paste' option with some key.
5868
5869 *'pastetoggle'* *'pt'*
5870'pastetoggle' 'pt' string (default "")
5871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005872 When non-empty, specifies the key sequence that toggles the 'paste'
5873 option. This is like specifying a mapping: >
5874 :map {keys} :set invpaste<CR>
5875< Where {keys} is the value of 'pastetoggle'.
5876 The difference is that it will work even when 'paste' is set.
5877 'pastetoggle' works in Insert mode and Normal mode, but not in
5878 Command-line mode.
5879 Mappings are checked first, thus overrule 'pastetoggle'. However,
5880 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5881 this: >
5882 :map <F10> :set paste<CR>
5883 :map <F11> :set nopaste<CR>
5884 :imap <F10> <C-O>:set paste<CR>
5885 :imap <F11> <nop>
5886 :set pastetoggle=<F11>
5887< This will make <F10> start paste mode and <F11> stop paste mode.
5888 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5889 mode everything is inserted literally, except the 'pastetoggle' key
5890 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005891 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005892
5893 *'pex'* *'patchexpr'*
5894'patchexpr' 'pex' string (default "")
5895 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 {not available when compiled without the |+diff|
5897 feature}
5898 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005899 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900
Bram Moolenaardbc28022014-07-26 13:40:44 +02005901 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902'patchmode' 'pm' string (default "")
5903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 When non-empty the oldest version of a file is kept. This can be used
5905 to keep the original version of a file if you are changing files in a
5906 source distribution. Only the first time that a file is written a
5907 copy of the original file will be kept. The name of the copy is the
5908 name of the original file with the string in the 'patchmode' option
5909 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005910 ".orig" or ".org". 'backupdir' must not be empty for this to work
5911 (Detail: The backup file is renamed to the patchmode file after the
5912 new file has been successfully written, that's why it must be possible
5913 to write a backup file). If there was no file to be backed up, an
5914 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005915 When the 'backupskip' pattern matches, a patchmode file is not made.
5916 Using 'patchmode' for compressed files appends the extension at the
5917 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5918 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005919 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005921 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005922'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005923 other systems: ".,,")
5924 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005926 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5927 provided that the file being searched for has a relative path (not
5928 starting with "/", "./" or "../"). The directories in the 'path'
5929 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005930 - Use commas to separate directory names: >
5931 :set path=.,/usr/local/include,/usr/include
5932< - Spaces can also be used to separate directory names (for backwards
5933 compatibility with version 3.0). To have a space in a directory
5934 name, precede it with an extra backslash, and escape the space: >
5935 :set path=.,/dir/with\\\ space
5936< - To include a comma in a directory name precede it with an extra
5937 backslash: >
5938 :set path=.,/dir/with\\,comma
5939< - To search relative to the directory of the current file, use: >
5940 :set path=.
5941< - To search in the current directory use an empty string between two
5942 commas: >
5943 :set path=,,
5944< - A directory name may end in a ':' or '/'.
5945 - Environment variables are expanded |:set_env|.
5946 - When using |netrw.vim| URLs can be used. For example, adding
5947 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005948 - Search upwards and downwards in a directory tree using "*", "**" and
5949 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950 - Careful with '\' characters, type two to get one in the option: >
5951 :set path=.,c:\\include
5952< Or just use '/' instead: >
5953 :set path=.,c:/include
5954< Don't forget "." or files won't even be found in the same directory as
5955 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005956 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957 it is something like 256 or 1024 characters.
5958 You can check if all the include files are found, using the value of
5959 'path', see |:checkpath|.
5960 The use of |:set+=| and |:set-=| is preferred when adding or removing
5961 directories from the list. This avoids problems when a future version
5962 uses another default. To remove the current directory use: >
5963 :set path-=
5964< To add the current directory use: >
5965 :set path+=
5966< To use an environment variable, you probably need to replace the
5967 separator. Here is an example to append $INCL, in which directory
5968 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005969 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005970< Replace the ';' with a ':' or whatever separator is used. Note that
5971 this doesn't work when $INCL contains a comma or white space.
5972
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005973 *'perldll'*
5974'perldll' string (default depends on the build)
5975 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005976 {only available when compiled with the |+perl/dyn|
5977 feature}
5978 Specifies the name of the Perl shared library. The default is
5979 DYNAMIC_PERL_DLL, which was specified at compile time.
5980 Environment variables are expanded |:set_env|.
5981 This option cannot be set from a |modeline| or in the |sandbox|, for
5982 security reasons.
5983
Bram Moolenaar071d4272004-06-13 20:20:40 +00005984 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5985'preserveindent' 'pi' boolean (default off)
5986 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005987 When changing the indent of the current line, preserve as much of the
5988 indent structure as possible. Normally the indent is replaced by a
5989 series of tabs followed by spaces as required (unless |'expandtab'| is
5990 enabled, in which case only spaces are used). Enabling this option
5991 means the indent will preserve as many existing characters as possible
5992 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005993 'expandtab' does not apply to the preserved white space, a Tab remains
5994 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005995 NOTE: When using ">>" multiple times the resulting indent is a mix of
5996 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005997 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005998 Also see 'copyindent'.
5999 Use |:retab| to clean up white space.
6000
6001 *'previewheight'* *'pvh'*
6002'previewheight' 'pvh' number (default 12)
6003 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006004 {not available when compiled without the |+quickfix|
6005 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006006 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006007 commands. Used for |CTRL-W_}| when no count is given. Not used when
6008 'previewpopup' is set.
6009
6010 *'previewpopup'* *'pvp'*
6011'previewpopup' 'pvp' string (default empty)
6012 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006013 {not available when compiled without the |+textprop|
6014 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006015 When not empty a popup window is used for commands that would open a
6016 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006017 Not used for the insert completion info, add "popup" to
6018 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006019
6020 *'previewwindow'* *'nopreviewwindow'*
6021 *'pvw'* *'nopvw'* *E590*
6022'previewwindow' 'pvw' boolean (default off)
6023 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006024 {not available when compiled without the |+quickfix|
6025 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006026 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006027 set. It's normally not set directly, but by using one of the commands
6028 |:ptag|, |:pedit|, etc.
6029
6030 *'printdevice'* *'pdev'*
6031'printdevice' 'pdev' string (default empty)
6032 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033 {only available when compiled with the |+printer|
6034 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006035 The name of the printer to be used for |:hardcopy|.
6036 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006037 This option cannot be set from a |modeline| or in the |sandbox|, for
6038 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039
Bram Moolenaar8299df92004-07-10 09:47:34 +00006040 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006041'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006043 {only available when compiled with the |+printer|
6044 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006045 Sets the character encoding used when printing.
6046 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006047
6048 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006049'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051 {only available when compiled with the |+printer|
6052 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006053 Expression used to print the PostScript produced with |:hardcopy|.
6054 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006055 This option cannot be set from a |modeline| or in the |sandbox|, for
6056 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006057
Bram Moolenaar8299df92004-07-10 09:47:34 +00006058 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059'printfont' 'pfn' string (default "courier")
6060 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061 {only available when compiled with the |+printer|
6062 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006063 The name of the font that will be used for |:hardcopy|.
6064 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006065
6066 *'printheader'* *'pheader'*
6067'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6068 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006069 {only available when compiled with the |+printer|
6070 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006071 The format of the header produced in |:hardcopy| output.
6072 See |pheader-option|.
6073
6074 *'printmbcharset'* *'pmbcs'*
6075'printmbcharset' 'pmbcs' string (default "")
6076 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006077 {only available when compiled with the |+printer|
6078 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006079 The CJK character set to be used for CJK output from |:hardcopy|.
6080 See |pmbcs-option|.
6081
6082 *'printmbfont'* *'pmbfn'*
6083'printmbfont' 'pmbfn' string (default "")
6084 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006085 {only available when compiled with the |+printer|
6086 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006087 List of font names to be used for CJK output from |:hardcopy|.
6088 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089
6090 *'printoptions'* *'popt'*
6091'printoptions' 'popt' string (default "")
6092 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006094 List of items that control the format of the output of |:hardcopy|.
6095 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006097 *'prompt'* *'noprompt'*
6098'prompt' boolean (default on)
6099 global
6100 When on a ":" prompt is used in Ex mode.
6101
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006102 *'pumheight'* *'ph'*
6103'pumheight' 'ph' number (default 0)
6104 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006105 Determines the maximum number of items to show in the popup menu for
6106 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006107 |ins-completion-menu|.
6108
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006109 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006110'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006111 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006112 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006113 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006114
Bram Moolenaard94464e2015-11-02 15:28:18 +01006115 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006116'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006117 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006118 {only available when compiled with the |+python/dyn|
6119 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006120 Specifies the name of the Python 2.x shared library. The default is
6121 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006122 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006123 This option cannot be set from a |modeline| or in the |sandbox|, for
6124 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006125
Bram Moolenaar94073162018-01-31 21:49:05 +01006126 *'pythonhome'*
6127'pythonhome' string (default "")
6128 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006129 {only available when compiled with the |+python/dyn|
6130 feature}
6131 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6132 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6133 which was specified at compile time, will be used for the Python 2.x
6134 home directory.
6135 Environment variables are expanded |:set_env|.
6136 This option cannot be set from a |modeline| or in the |sandbox|, for
6137 security reasons.
6138
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006139 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006140'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006141 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006142 {only available when compiled with the |+python3/dyn|
6143 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006144 Specifies the name of the Python 3 shared library. The default is
6145 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006146 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006147 This option cannot be set from a |modeline| or in the |sandbox|, for
6148 security reasons.
6149
Bram Moolenaar94073162018-01-31 21:49:05 +01006150 *'pythonthreehome'*
6151'pythonthreehome' string (default "")
6152 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006153 {only available when compiled with the |+python3/dyn|
6154 feature}
6155 Specifies the name of the Python 3 home directory. When
6156 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6157 PYTHON3_HOME, which was specified at compile time, will be used for
6158 the Python 3 home directory.
6159 Environment variables are expanded |:set_env|.
6160 This option cannot be set from a |modeline| or in the |sandbox|, for
6161 security reasons.
6162
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006163 *'pyxversion'* *'pyx'*
6164'pyxversion' 'pyx' number (default depends on the build)
6165 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006166 {only available when compiled with the |+python| or
6167 the |+python3| feature}
6168 Specifies the python version used for pyx* functions and commands
6169 |python_x|. The default value is as follows:
6170
6171 Compiled with Default ~
6172 |+python| and |+python3| 0
6173 only |+python| 2
6174 only |+python3| 3
6175
6176 Available values are 0, 2 and 3.
6177 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6178 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6179 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6180 to 2 if Python 2 is available.
6181 See also: |has-pythonx|
6182
6183 If Vim is compiled with only |+python| or |+python3| setting
6184 'pyxversion' has no effect. The pyx* functions and commands are
6185 always the same as the compiled version.
6186
6187 This option cannot be set from a |modeline| or in the |sandbox|, for
6188 security reasons.
6189
Bram Moolenaar858ba062020-05-31 23:11:59 +02006190 *'quickfixtextfunc'* *'qftf'*
6191'quickfixtextfunc' 'qftf' string (default "")
6192 global
6193 {only available when compiled with the |+quickfix|
6194 feature}
6195 This option specifies a function to be used to get the text to display
6196 in the quickfix and location list windows. This can be used to
6197 customize the information displayed in the quickfix or location window
6198 for each entry in the corresponding quickfix or location list. See
6199 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006200 function and an example. The value can be the name of a function, a
6201 |lambda| or a |Funcref|. See |option-value-function| for more
6202 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006203
6204 This option cannot be set from a |modeline| or in the |sandbox|, for
6205 security reasons.
6206
Bram Moolenaar677ee682005-01-27 14:41:15 +00006207 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006208'quoteescape' 'qe' string (default "\")
6209 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006210 The characters that are used to escape quotes in a string. Used for
6211 objects like a', a" and a` |a'|.
6212 When one of the characters in this option is found inside a string,
6213 the following character will be skipped. The default value makes the
6214 text "foo\"bar\\" considered to be one string.
6215
Bram Moolenaar071d4272004-06-13 20:20:40 +00006216 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6217'readonly' 'ro' boolean (default off)
6218 local to buffer
6219 If on, writes fail unless you use a '!'. Protects you from
6220 accidentally overwriting a file. Default on when Vim is started
6221 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006222 When using ":w!" the 'readonly' option is reset for the current
6223 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006224 When using the ":view" command the 'readonly' option is set for the
6225 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006226 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006228 *'redrawtime'* *'rdt'*
6229'redrawtime' 'rdt' number (default 2000)
6230 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006231 {only available when compiled with the |+reltime|
6232 feature}
6233 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006234 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006235 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006236 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006237 matches will be highlighted.
6238 For syntax highlighting the time applies per window. When over the
6239 limit syntax highlighting is disabled until |CTRL-L| is used.
6240 This is used to avoid that Vim hangs when using a very complicated
6241 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006242
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006243 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006244'regexpengine' 're' number (default 0)
6245 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006246 This selects the default regexp engine. |two-engines|
6247 The possible values are:
6248 0 automatic selection
6249 1 old engine
6250 2 NFA engine
6251 Note that when using the NFA engine and the pattern contains something
6252 that is not supported the pattern will not match. This is only useful
6253 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006254 Using automatic selection enables Vim to switch the engine, if the
6255 default engine becomes too costly. E.g., when the NFA engine uses too
6256 many states. This should prevent Vim from hanging on a combination of
6257 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006258
Bram Moolenaar64486672010-05-16 15:46:46 +02006259 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6260'relativenumber' 'rnu' boolean (default off)
6261 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006262 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006263 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006264 precede some vertical motion commands (e.g. j k + -) with, without
6265 having to calculate it yourself. Especially useful in combination with
6266 other commands (e.g. y d c < > gq gw =).
6267 When the 'n' option is excluded from 'cpoptions' a wrapped
6268 line will not use the column of line numbers (this is the default when
6269 'compatible' isn't set).
6270 The 'numberwidth' option can be used to set the room used for the line
6271 number.
6272 When a long, wrapped line doesn't start with the first character, '-'
6273 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006274 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6275 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006276
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006277 The number in front of the cursor line also depends on the value of
6278 'number', see |number_relativenumber| for all combinations of the two
6279 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006280
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281 *'remap'* *'noremap'*
6282'remap' boolean (default on)
6283 global
6284 Allows for mappings to work recursively. If you do not want this for
6285 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006286 NOTE: To avoid portability problems with Vim scripts, always keep
6287 this option at the default "on". Only switch it off when working with
6288 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006290 *'renderoptions'* *'rop'*
6291'renderoptions' 'rop' string (default: empty)
6292 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006293 {only available when compiled with GUI and DIRECTX on
6294 MS-Windows}
6295 Select a text renderer and set its options. The options depend on the
6296 renderer.
6297
6298 Syntax: >
6299 set rop=type:{renderer}(,{name}:{value})*
6300<
6301 Currently, only one optional renderer is available.
6302
6303 render behavior ~
6304 directx Vim will draw text using DirectX (DirectWrite). It makes
6305 drawn glyphs more beautiful than default GDI.
6306 It requires 'encoding' is "utf-8", and only works on
6307 MS-Windows Vista or newer version.
6308
6309 Options:
6310 name meaning type value ~
6311 gamma gamma float 1.0 - 2.2 (maybe)
6312 contrast enhancedContrast float (unknown)
6313 level clearTypeLevel float (unknown)
6314 geom pixelGeometry int 0 - 2 (see below)
6315 renmode renderingMode int 0 - 6 (see below)
6316 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006317 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006318
Bram Moolenaar92467d32017-12-05 13:22:16 +01006319 See this URL for detail (except for scrlines):
6320 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006321
6322 For geom: structure of a device pixel.
6323 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6324 1 - DWRITE_PIXEL_GEOMETRY_RGB
6325 2 - DWRITE_PIXEL_GEOMETRY_BGR
6326
6327 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006328 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006329
6330 For renmode: method of rendering glyphs.
6331 0 - DWRITE_RENDERING_MODE_DEFAULT
6332 1 - DWRITE_RENDERING_MODE_ALIASED
6333 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6334 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6335 4 - DWRITE_RENDERING_MODE_NATURAL
6336 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6337 6 - DWRITE_RENDERING_MODE_OUTLINE
6338
6339 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006340 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006341
6342 For taamode: antialiasing mode used for drawing text.
6343 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6344 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6345 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6346 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6347
6348 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006349 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6350
Bram Moolenaara338adc2018-01-31 20:51:47 +01006351 For scrlines:
6352 This was used for optimizing scrolling behavior, however this
6353 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006354
6355 Example: >
6356 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006357 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006358 set rop=type:directx
6359<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006360 If select a raster font (Courier, Terminal or FixedSys which
6361 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006362 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006363
6364 NOTE: It is known that some fonts and options combination
6365 causes trouble on drawing glyphs.
6366
Bram Moolenaar92467d32017-12-05 13:22:16 +01006367 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006368 special made fonts (True-Type fonts which includes only
6369 bitmap glyphs).
6370 - 'taamode:3' will not work with some vector fonts.
6371
6372 NOTE: With this option, you can display colored emoji
6373 (emoticon) in Windows 8.1 or later. To display colored emoji,
6374 there are some conditions which you should notice.
6375
6376 - If your font includes non-colored emoji already, it will
6377 be used.
6378 - If your font doesn't have emoji, the system chooses an
6379 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6380 will be used.
6381 - When this alternative font didn't have fixed width glyph,
6382 emoji might be rendered beyond the bounding box of drawing
6383 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006384
6385 Other render types are currently not supported.
6386
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 *'report'*
6388'report' number (default 2)
6389 global
6390 Threshold for reporting number of lines changed. When the number of
6391 changed lines is more than 'report' a message will be given for most
6392 ":" commands. If you want it always, set 'report' to 0.
6393 For the ":substitute" command the number of substitutions is used
6394 instead of the number of lines.
6395
6396 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6397'restorescreen' 'rs' boolean (default on)
6398 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006399 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006400 When set, the screen contents is restored when exiting Vim. This also
6401 happens when executing external commands.
6402
6403 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6404 options in your .vimrc. To disable restoring:
6405 set t_ti= t_te=
6406 To enable restoring (for an xterm):
6407 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6408 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6409
6410 *'revins'* *'ri'* *'norevins'* *'nori'*
6411'revins' 'ri' boolean (default off)
6412 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006413 {only available when compiled with the |+rightleft|
6414 feature}
6415 Inserting characters in Insert mode will work backwards. See "typing
6416 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6417 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006418 NOTE: This option is reset when 'compatible' is set.
6419 This option is reset when 'paste' is set and restored when 'paste' is
6420 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006421
6422 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6423'rightleft' 'rl' boolean (default off)
6424 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425 {only available when compiled with the |+rightleft|
6426 feature}
6427 When on, display orientation becomes right-to-left, i.e., characters
6428 that are stored in the file appear from the right to the left.
6429 Using this option, it is possible to edit files for languages that
6430 are written from the right to the left such as Hebrew and Arabic.
6431 This option is per window, so it is possible to edit mixed files
6432 simultaneously, or to view the same file in both ways (this is
6433 useful whenever you have a mixed text file with both right-to-left
6434 and left-to-right strings so that both sets are displayed properly
6435 in different windows). Also see |rileft.txt|.
6436
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006437 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006438'rightleftcmd' 'rlc' string (default "search")
6439 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 {only available when compiled with the |+rightleft|
6441 feature}
6442 Each word in this option enables the command line editing to work in
6443 right-to-left mode for a group of commands:
6444
6445 search "/" and "?" commands
6446
6447 This is useful for languages such as Hebrew, Arabic and Farsi.
6448 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6449
Bram Moolenaard94464e2015-11-02 15:28:18 +01006450 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006451'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006452 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006453 {only available when compiled with the |+ruby/dyn|
6454 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006455 Specifies the name of the Ruby shared library. The default is
6456 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006457 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006458 This option cannot be set from a |modeline| or in the |sandbox|, for
6459 security reasons.
6460
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006462'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464 {not available when compiled without the
6465 |+cmdline_info| feature}
6466 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006467 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 text in the file is shown on the far right:
6469 Top first line is visible
6470 Bot last line is visible
6471 All first and last line are visible
6472 45% relative position in the file
6473 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006474 Each window has its own ruler. If a window has a status line, the
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01006475 ruler is shown there. If a window doesn't have a status line and
6476 'cmdheight' is zero, the ruler is not shown. Otherwise it is shown in
6477 the last line of the screen. If the statusline is given by
6478 'statusline' (i.e. not empty), this option takes precedence over
zeertzjq75020942022-07-31 11:37:20 +01006479 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006481 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006482 the text column (byte number) and the screen column are shown,
6483 separated with a dash.
6484 For an empty line "0-1" is shown.
6485 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006486 This option is reset when 'paste' is set and restored when 'paste' is
6487 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 If you don't want to see the ruler all the time but want to know where
6489 you are, use "g CTRL-G" |g_CTRL-G|.
6490 NOTE: This option is reset when 'compatible' is set.
6491
6492 *'rulerformat'* *'ruf'*
6493'rulerformat' 'ruf' string (default empty)
6494 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 {not available when compiled without the |+statusline|
6496 feature}
6497 When this option is not empty, it determines the content of the ruler
6498 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006499 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006500 This option cannot be set in a modeline when 'modelineexpr' is off.
6501
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502 The default ruler width is 17 characters. To make the ruler 15
6503 characters wide, put "%15(" at the start and "%)" at the end.
6504 Example: >
6505 :set rulerformat=%15(%c%V\ %p%%%)
6506<
6507 *'runtimepath'* *'rtp'* *vimfiles*
6508'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006509 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006510 $VIM/vimfiles,
6511 $VIMRUNTIME,
6512 $VIM/vimfiles/after,
6513 $HOME/.vim/after"
6514 Amiga: "home:vimfiles,
6515 $VIM/vimfiles,
6516 $VIMRUNTIME,
6517 $VIM/vimfiles/after,
6518 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006519 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 $VIM/vimfiles,
6521 $VIMRUNTIME,
6522 $VIM/vimfiles/after,
6523 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006524 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 $VIMRUNTIME,
6526 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006527 Haiku: "$BE_USER_SETTINGS/vim,
6528 $VIM/vimfiles,
6529 $VIMRUNTIME,
6530 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006531 $BE_USER_SETTINGS/vim/after"
6532 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533 $VIM/vimfiles,
6534 $VIMRUNTIME,
6535 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006536 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 This is a list of directories which will be searched for runtime
6539 files:
6540 filetype.vim filetypes by file name |new-filetype|
6541 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006542 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543 colors/ color scheme files |:colorscheme|
6544 compiler/ compiler files |:compiler|
6545 doc/ documentation |write-local-help|
6546 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006547 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 indent/ indent scripts |indent-expression|
6549 keymap/ key mapping files |mbyte-keymap|
6550 lang/ menu translations |:menutrans|
6551 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006552 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 plugin/ plugin scripts |write-plugin|
6554 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006555 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556 syntax/ syntax files |mysyntaxfile|
6557 tutor/ files for vimtutor |tutor|
6558
6559 And any other file searched for with the |:runtime| command.
6560
6561 The defaults for most systems are setup to search five locations:
6562 1. In your home directory, for your personal preferences.
6563 2. In a system-wide Vim directory, for preferences from the system
6564 administrator.
6565 3. In $VIMRUNTIME, for files distributed with Vim.
6566 *after-directory*
6567 4. In the "after" directory in the system-wide Vim directory. This is
6568 for the system administrator to overrule or add to the distributed
6569 defaults (rarely needed)
6570 5. In the "after" directory in your home directory. This is for
6571 personal preferences to overrule or add to the distributed defaults
6572 or system-wide settings (rarely needed).
6573
Bram Moolenaard0796902016-09-16 20:02:31 +02006574 More entries are added when using |packages|. If it gets very long
6575 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6576 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006577
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6579 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006580 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 wildcards.
6582 See |:runtime|.
6583 Example: >
6584 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6585< This will use the directory "~/vimruntime" first (containing your
6586 personal Vim runtime files), then "/mygroup/vim" (shared between a
6587 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6588 files).
6589 You probably should always include $VIMRUNTIME somewhere, to use the
6590 distributed runtime files. You can put a directory before $VIMRUNTIME
6591 to find files which replace a distributed runtime files. You can put
6592 a directory after $VIMRUNTIME to find files which add to distributed
6593 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006594 When Vim is started with |--clean| the home directory entries are not
6595 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596 This option cannot be set from a |modeline| or in the |sandbox|, for
6597 security reasons.
6598
6599 *'scroll'* *'scr'*
6600'scroll' 'scr' number (default: half the window height)
6601 local to window
6602 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6603 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006604 changes. This may happen when enabling the |status-line| or
6605 'tabline' option after setting the 'scroll' option.
6606 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006607 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006608 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006609
6610 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6611'scrollbind' 'scb' boolean (default off)
6612 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613 See also |scroll-binding|. When this option is set, the current
6614 window scrolls as other scrollbind windows (windows that also have
6615 this option set) scroll. This option is useful for viewing the
6616 differences between two versions of a file, see 'diff'.
6617 See |'scrollopt'| for options that determine how this option should be
6618 interpreted.
6619 This option is mostly reset when splitting a window to edit another
6620 file. This means that ":split | edit file" results in two windows
6621 with scroll-binding, but ":split file" does not.
6622
Bram Moolenaarae20f342019-11-05 21:09:23 +01006623 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6624'scrollfocus' 'scf' boolean (default off)
6625 global
6626 {only for MS-Windows GUI}
6627 When using the scroll wheel and this option is set, the window under
6628 the mouse pointer is scrolled. With this option off the current
6629 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006630 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006631
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 *'scrolljump'* *'sj'*
6633'scrolljump' 'sj' number (default 1)
6634 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 Minimal number of lines to scroll when the cursor gets off the
6636 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6637 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006638 When set to a negative number from -1 to -100 this is used as the
6639 percentage of the window height. Thus -50 scrolls half the window
6640 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006641 NOTE: This option is set to 1 when 'compatible' is set.
6642
6643 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006644'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006645 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006646 Minimal number of screen lines to keep above and below the cursor.
6647 This will make some context visible around where you are working. If
6648 you set it to a very large value (999) the cursor line will always be
6649 in the middle of the window (except at the start or end of the file or
6650 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006651 After using the local value, go back the global value with one of
6652 these two: >
6653 setlocal scrolloff<
6654 setlocal scrolloff=-1
6655< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 NOTE: This option is set to 0 when 'compatible' is set.
6657
6658 *'scrollopt'* *'sbo'*
6659'scrollopt' 'sbo' string (default "ver,jump")
6660 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006662 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6663 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 The following words are available:
6665 ver Bind vertical scrolling for 'scrollbind' windows
6666 hor Bind horizontal scrolling for 'scrollbind' windows
6667 jump Applies to the offset between two windows for vertical
6668 scrolling. This offset is the difference in the first
6669 displayed line of the bound windows. When moving
6670 around in a window, another 'scrollbind' window may
6671 reach a position before the start or after the end of
6672 the buffer. The offset is not changed though, when
6673 moving back the 'scrollbind' window will try to scroll
6674 to the desired position when possible.
6675 When now making that window the current one, two
6676 things can be done with the relative offset:
6677 1. When "jump" is not included, the relative offset is
6678 adjusted for the scroll position in the new current
6679 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006680 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681 2. When "jump" is included, the other windows are
6682 scrolled to keep the same relative offset. When
6683 going back to the other window, it still uses the
6684 same relative offset.
6685 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006686 When 'diff' mode is active there always is vertical scroll binding,
6687 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688
6689 *'sections'* *'sect'*
6690'sections' 'sect' string (default "SHNHH HUnhsh")
6691 global
6692 Specifies the nroff macros that separate sections. These are pairs of
6693 two letters (See |object-motions|). The default makes a section start
6694 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6695
6696 *'secure'* *'nosecure'* *E523*
6697'secure' boolean (default off)
6698 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006699 When on, ":autocmd", shell and write commands are not allowed in
6700 ".vimrc" and ".exrc" in the current directory and map commands are
6701 displayed. Switch it off only if you know that you will not run into
6702 problems, or when the 'exrc' option is off. On Unix this option is
6703 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006704 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 'secure' at the end of your ~/.vimrc then.
6706 This option cannot be set from a |modeline| or in the |sandbox|, for
6707 security reasons.
6708
6709 *'selection'* *'sel'*
6710'selection' 'sel' string (default "inclusive")
6711 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712 This option defines the behavior of the selection. It is only used
6713 in Visual and Select mode.
6714 Possible values:
6715 value past line inclusive ~
6716 old no yes
6717 inclusive yes yes
6718 exclusive yes no
6719 "past line" means that the cursor is allowed to be positioned one
6720 character past the line.
6721 "inclusive" means that the last character of the selection is included
6722 in an operation. For example, when "x" is used to delete the
6723 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006724 When "old" is used and 'virtualedit' allows the cursor to move past
6725 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726 Note that when "exclusive" is used and selecting from the end
6727 backwards, you cannot include the last character of a line, when
6728 starting in Normal mode and 'virtualedit' empty.
6729
6730 The 'selection' option is set by the |:behave| command.
6731
6732 *'selectmode'* *'slm'*
6733'selectmode' 'slm' string (default "")
6734 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006735 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006736 Select mode instead of Visual mode, when a selection is started.
6737 Possible values:
6738 mouse when using the mouse
6739 key when using shifted special keys
6740 cmd when using "v", "V" or CTRL-V
6741 See |Select-mode|.
6742 The 'selectmode' option is set by the |:behave| command.
6743
6744 *'sessionoptions'* *'ssop'*
6745'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006746 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006748 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006749 feature}
6750 Changes the effect of the |:mksession| command. It is a comma
6751 separated list of words. Each word enables saving and restoring
6752 something:
6753 word save and restore ~
6754 blank empty windows
6755 buffers hidden and unloaded buffers, not just those in windows
6756 curdir the current directory
6757 folds manually created folds, opened/closed folds and local
6758 fold options
6759 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006760 and contain at least one lowercase letter. Only
6761 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 help the help window
6763 localoptions options and mappings local to a window or buffer (not
6764 global values for local options)
6765 options all options and mappings (also global values for local
6766 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006767 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768 resize size of the Vim window: 'lines' and 'columns'
6769 sesdir the directory in which the session file is located
6770 will become the current directory (useful with
6771 projects accessed over a network from different
6772 systems)
6773 slash backslashes in file names replaced with forward
6774 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006775 tabpages all tab pages; without this only the current tab page
6776 is restored, so that you can make a session for each
6777 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006778 terminal include terminal windows where the command can be
6779 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006780 unix with Unix end-of-line format (single <NL>), even when
6781 on Windows or DOS
6782 winpos position of the whole Vim window
6783 winsize window sizes
6784
6785 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006786 When neither "curdir" nor "sesdir" is included, file names are stored
6787 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006788 If you leave out "options" many things won't work well after restoring
6789 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790 "slash" and "unix" are useful on Windows when sharing session files
6791 with Unix. The Unix version of Vim cannot source dos format scripts,
6792 but the Windows version of Vim can source unix format scripts.
6793
6794 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006795'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796 global
6797 Name of the shell to use for ! and :! commands. When changing the
6798 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6799 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006800 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 See |option-backslash| about including spaces and backslashes.
6802 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006803
Bram Moolenaara2baa732022-02-04 16:09:54 +00006804 In |restricted-mode| shell commands will not be possible. This mode
6805 is used if the value of $SHELL ends in "false" or "nologin".
6806
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006807 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006808 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6810< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006811 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006813 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006815 Example with escaped space (Vim will do this when initializing the
6816 option from $SHELL): >
6817 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006818< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006819 backslashes are consumed by `:set`.
6820
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 Under MS-Windows, when the executable ends in ".com" it must be
6822 included. Thus setting the shell to "command.com" or "4dos.com"
6823 works, but "command" and "4dos" do not work for all commands (e.g.,
6824 filtering).
6825 For unknown reasons, when using "4dos.com" the current directory is
6826 changed to "C:\". To avoid this set 'shell' like this: >
6827 :set shell=command.com\ /c\ 4dos
6828< This option cannot be set from a |modeline| or in the |sandbox|, for
6829 security reasons.
6830
6831 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006832'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006833 Win32, when 'shell' contains "powershell":
6834 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006835 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006838 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6839 For MS-Windows, the default is set according to the value of 'shell',
6840 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006841 On Unix it can have more than one flag. Each white space separated
6842 part is passed as an argument to the shell command.
6843 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006844 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845 This option cannot be set from a |modeline| or in the |sandbox|, for
6846 security reasons.
6847
6848 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006849'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6850 "2>&1| tee", or
6851 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853 {not available when compiled without the |+quickfix|
6854 feature}
6855 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006856 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006857 including spaces and backslashes.
6858 The name of the temporary file can be represented by "%s" if necessary
6859 (the file name is appended automatically if no %s appears in the value
6860 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006861 For the Amiga the default is ">". For MS-Windows using powershell the
6862 default is "2>&1 | Out-File -Encoding default", otherwise the default
6863 is ">%s 2>&1". The output is directly saved in a file and not echoed
6864 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006865 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 in a file and echoed to the screen. If the 'shell' option is "csh" or
6867 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006868 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006869 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6870 means that stderr is also included. Before using the 'shell' option a
6871 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006872 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6873 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874 The initialization of this option is done after reading the ".vimrc"
6875 and the other initializations, so that when the 'shell' option is set
6876 there, the 'shellpipe' option changes automatically, unless it was
6877 explicitly set before.
6878 When 'shellpipe' is set to an empty string, no redirection of the
6879 ":make" output will be done. This is useful if you use a 'makeprg'
6880 that writes to 'makeef' by itself. If you want no piping, but do
6881 want to include the 'makeef', set 'shellpipe' to a single space.
6882 Don't forget to precede the space with a backslash: ":set sp=\ ".
6883 In the future pipes may be used for filtering and this option will
6884 become obsolete (at least for Unix).
6885 This option cannot be set from a |modeline| or in the |sandbox|, for
6886 security reasons.
6887
6888 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006889'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 Quoting character(s), put around the command passed to the shell, for
6892 the "!" and ":!" commands. The redirection is kept outside of the
6893 quoting. See 'shellxquote' to include the redirection. It's
6894 probably not useful to set both options.
6895 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006896 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006897 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898 This option cannot be set from a |modeline| or in the |sandbox|, for
6899 security reasons.
6900
6901 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006902'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6903 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905 String to be used to put the output of a filter command in a temporary
6906 file. See also |:!|. See |option-backslash| about including spaces
6907 and backslashes.
6908 The name of the temporary file can be represented by "%s" if necessary
6909 (the file name is appended automatically if no %s appears in the value
6910 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006911 The default is ">". For Unix, if the 'shell' option is "csh" or
6912 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006913 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006914 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6915 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006916 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6917 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006918 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6919 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920 The initialization of this option is done after reading the ".vimrc"
6921 and the other initializations, so that when the 'shell' option is set
6922 there, the 'shellredir' option changes automatically unless it was
6923 explicitly set before.
6924 In the future pipes may be used for filtering and this option will
6925 become obsolete (at least for Unix).
6926 This option cannot be set from a |modeline| or in the |sandbox|, for
6927 security reasons.
6928
6929 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6930'shellslash' 'ssl' boolean (default off)
6931 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006932 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006934 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006935 powershell.exe. Backward slashes can still be typed, but they are
6936 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937 Note that setting or resetting this option has no effect for some
6938 existing file names, thus this option needs to be set before opening
6939 any file for best results. This might change in the future.
6940 'shellslash' only works when a backslash can be used as a path
6941 separator. To test if this is so use: >
6942 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006943< Also see 'completeslash'.
6944
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006945 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6946'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6947 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006948 When on, use temp files for shell commands. When off use a pipe.
6949 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006950 Currently a pipe is only supported on Unix and MS-Windows 2K and
6951 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006952 :if has("filterpipe")
6953< The advantage of using a pipe is that nobody can read the temp file
6954 and the 'shell' command does not need to support redirection.
6955 The advantage of using a temp file is that the file type and encoding
6956 can be detected.
6957 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6958 |FilterWritePost| autocommands event are not triggered when
6959 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006960 The `system()` function does not respect this option and always uses
6961 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006962 NOTE: This option is set to the Vim default value when 'compatible'
6963 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006964
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965 *'shelltype'* *'st'*
6966'shelltype' 'st' number (default 0)
6967 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006968 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 On the Amiga this option influences the way how the commands work
6970 which use a shell.
6971 0 and 1: always use the shell
6972 2 and 3: use the shell only to filter lines
6973 4 and 5: use shell only for ':sh' command
6974 When not using the shell, the command is executed directly.
6975
6976 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6977 1 and 3: use "shell cmd" to start external commands
6978
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006979 *'shellxescape'* *'sxe'*
6980'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006981 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006982 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006983 When 'shellxquote' is set to "(" then the characters listed in this
6984 option will be escaped with a '^' character. This makes it possible
6985 to execute most external commands with cmd.exe.
6986
Bram Moolenaar071d4272004-06-13 20:20:40 +00006987 *'shellxquote'* *'sxq'*
6988'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006989 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006990 for Win32, when 'shell' is
6991 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006992 for Win32, when 'shell' contains "sh"
6993 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006994 for Unix, when using system(): "\"")
6995 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006996 Quoting character(s), put around the command passed to the shell, for
6997 the "!" and ":!" commands. Includes the redirection. See
6998 'shellquote' to exclude the redirection. It's probably not useful
6999 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007000 When the value is '(' then ')' is appended. When the value is '"('
7001 then ')"' is appended.
7002 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007003 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007004 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7005 pwsh.exe which automatically strips off the first and last quote on a
7006 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7007 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007008 'shell', to reduce the need to set this option by the user. See
7009 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007010 This option cannot be set from a |modeline| or in the |sandbox|, for
7011 security reasons.
7012
7013 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7014'shiftround' 'sr' boolean (default off)
7015 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 Round indent to multiple of 'shiftwidth'. Applies to > and <
7017 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7018 a multiple of 'shiftwidth' (this is Vi compatible).
7019 NOTE: This option is reset when 'compatible' is set.
7020
7021 *'shiftwidth'* *'sw'*
7022'shiftwidth' 'sw' number (default 8)
7023 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007024 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007025 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007026 When zero the 'ts' value will be used. Use the |shiftwidth()|
7027 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028
7029 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007030'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7031 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007033 This option helps to avoid all the |hit-enter| prompts caused by file
7034 messages, for example with CTRL-G, and to avoid some other messages.
7035 It is a list of flags:
7036 flag meaning when present ~
7037 f use "(3 of 5)" instead of "(file 3 of 5)"
7038 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02007039 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040 m use "[+]" instead of "[Modified]"
7041 n use "[New]" instead of "[New File]"
7042 r use "[RO]" instead of "[readonly]"
7043 w use "[w]" instead of "written" for file write message
7044 and "[a]" instead of "appended" for ':w >> file' command
7045 x use "[dos]" instead of "[dos format]", "[unix]" instead of
7046 "[unix format]" and "[mac]" instead of "[mac format]".
7047 a all of the above abbreviations
7048
7049 o overwrite message for writing a file with subsequent message
7050 for reading a file (useful for ":wn" or when 'autowrite' on)
7051 O message for reading a file overwrites any previous message.
7052 Also for quickfix message (e.g., ":cn").
7053 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02007054 hit TOP, continuing at BOTTOM" messages; when using the search
7055 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007056 t truncate file message at the start if it is too long to fit
7057 on the command-line, "<" will appear in the left most column.
7058 Ignored in Ex mode.
7059 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00007060 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061 Ignored in Ex mode.
7062 W don't give "written" or "[w]" when writing a file
7063 A don't give the "ATTENTION" message when an existing swap file
7064 is found.
7065 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02007066 c don't give |ins-completion-menu| messages. For example,
7067 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
7068 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01007069 q use "recording" instead of "recording @a"
7070 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02007071 was used for the command; note that this also affects messages
7072 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007073 S do not show search count message when searching, e.g.
7074 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007075
7076 This gives you the opportunity to avoid that a change between buffers
7077 requires you to hit <Enter>, but still gives as useful a message as
7078 possible for the space available. To get the whole message that you
7079 would have got with 'shm' empty, use ":file!"
7080 Useful values:
7081 shm= No abbreviation of message.
7082 shm=a Abbreviation, but no loss of information.
7083 shm=at Abbreviation, and truncate message when necessary.
7084
7085 NOTE: This option is set to the Vi default value when 'compatible' is
7086 set and to the Vim default value when 'compatible' is reset.
7087
7088 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7089'shortname' 'sn' boolean (default off)
7090 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007091 Filenames are assumed to be 8 characters plus one extension of 3
7092 characters. Multiple dots in file names are not allowed. When this
7093 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007094 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007096 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097
7098 *'showbreak'* *'sbr'* *E595*
7099'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007100 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007101 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102 feature}
7103 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007104 values are "> " or "+++ ": >
7105 :set showbreak=>\
7106< Note the backslash to escape the trailing space. It's easier like
7107 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007108 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007109< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 comma (in a future version the comma might be used to separate the
7111 part that is shown at the end and at the start of a line).
7112 The characters are highlighted according to the '@' flag in
7113 'highlight'.
7114 Note that tabs after the showbreak will be displayed differently.
7115 If you want the 'showbreak' to appear in between line numbers, add the
7116 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007117 A window-local value overrules a global value. If the global value is
7118 set and you want no value in the current window use NONE: >
7119 :setlocal showbreak=NONE
7120<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007122'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7123 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 {not available when compiled without the
7126 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007127 Show (partial) command in the last line of the screen. Set this
7128 option off if your terminal is slow.
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01007129 The option has no effect when 'cmdheight' is zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 In Visual mode the size of the selected area is shown:
7131 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007132 If the number of bytes is different it is also displayed: "2-6"
7133 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007135 - When selecting a block, the size in screen characters:
7136 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137 NOTE: This option is set to the Vi default value when 'compatible' is
7138 set and to the Vim default value when 'compatible' is reset.
7139
7140 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7141'showfulltag' 'sft' boolean (default off)
7142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 When completing a word in insert mode (see |ins-completion|) from the
7144 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007145 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 matched a C function, you can see a template for what arguments are
7147 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007148 Note that this doesn't work well together with having "longest" in
7149 'completeopt', because the completion from the search pattern may not
7150 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007151
7152 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7153'showmatch' 'sm' boolean (default off)
7154 global
7155 When a bracket is inserted, briefly jump to the matching one. The
7156 jump is only done if the match can be seen on the screen. The time to
7157 show the match can be set with 'matchtime'.
7158 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007159 seen or not).
7160 This option is reset when 'paste' is set and restored when 'paste' is
7161 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 When the 'm' flag is not included in 'cpoptions', typing a character
7163 will immediately move the cursor back to where it belongs.
7164 See the "sm" field in 'guicursor' for setting the cursor shape and
7165 blinking when showing the match.
7166 The 'matchpairs' option can be used to specify the characters to show
7167 matches for. 'rightleft' and 'revins' are used to look for opposite
7168 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007169 Also see the matchparen plugin for highlighting the match when moving
7170 around |pi_paren.txt|.
7171 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172
7173 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7174'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7175 global
7176 If in Insert, Replace or Visual mode put a message on the last line.
7177 Use the 'M' flag in 'highlight' to set the type of highlighting for
7178 this message.
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01007179 The option has no effect when 'cmdheight' is zero.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007180 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007181 doesn't mean XIM is really active, especially when 'imactivatekey' is
7182 not set.
7183 NOTE: This option is set to the Vi default value when 'compatible' is
7184 set and to the Vim default value when 'compatible' is reset.
7185
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007186 *'showtabline'* *'stal'*
7187'showtabline' 'stal' number (default 1)
7188 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007189 The value of this option specifies when the line with tab page labels
7190 will be displayed:
7191 0: never
7192 1: only if there are at least two tab pages
7193 2: always
7194 This is both for the GUI and non-GUI implementation of the tab pages
7195 line.
7196 See |tab-page| for more information about tab pages.
7197
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 *'sidescroll'* *'ss'*
7199'sidescroll' 'ss' number (default 0)
7200 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007201 The minimal number of columns to scroll horizontally. Used only when
7202 the 'wrap' option is off and the cursor is moved off of the screen.
7203 When it is zero the cursor will be put in the middle of the screen.
7204 When using a slow terminal set it to a large number or 0. When using
7205 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7206 commands.
7207
7208 *'sidescrolloff'* *'siso'*
7209'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007210 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007212 right of the cursor if 'nowrap' is set. Setting this option to a
7213 value greater than 0 while having |'sidescroll'| also at a non-zero
7214 value makes some context visible in the line you are scrolling in
7215 horizontally (except at beginning of the line). Setting this option
7216 to a large value (like 999) has the effect of keeping the cursor
7217 horizontally centered in the window, as long as one does not come too
7218 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007219 After using the local value, go back the global value with one of
7220 these two: >
7221 setlocal sidescrolloff<
7222 setlocal sidescrolloff=-1
7223< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224
7225 Example: Try this together with 'sidescroll' and 'listchars' as
7226 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007227 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228
7229 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7230 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007231<
7232 *'signcolumn'* *'scl'*
7233'signcolumn' 'scl' string (default "auto")
7234 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007235 {not available when compiled without the |+signs|
7236 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007237 Whether or not to draw the signcolumn. Valid values are:
7238 "auto" only when there is a sign to display
7239 "no" never
7240 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007241 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007242 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243
7244
7245 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7246'smartcase' 'scs' boolean (default off)
7247 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 Override the 'ignorecase' option if the search pattern contains upper
7249 case characters. Only used when the search pattern is typed and
7250 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007251 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7253 recalling the search pattern from history and hitting <Enter>.
7254 NOTE: This option is reset when 'compatible' is set.
7255
7256 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7257'smartindent' 'si' boolean (default off)
7258 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007259 Do smart autoindenting when starting a new line. Works for C-like
7260 programs, but can also be used for other languages. 'cindent' does
7261 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007262 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007263 setting 'si' has no effect. 'indentexpr' is a more advanced
7264 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265 Normally 'autoindent' should also be on when using 'smartindent'.
7266 An indent is automatically inserted:
7267 - After a line ending in '{'.
7268 - After a line starting with a keyword from 'cinwords'.
7269 - Before a line starting with '}' (only with the "O" command).
7270 When typing '}' as the first character in a new line, that line is
7271 given the same indent as the matching '{'.
7272 When typing '#' as the first character in a new line, the indent for
7273 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007274 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7276 When using the ">>" command, lines starting with '#' are not shifted
7277 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007278 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007279 This option is reset when 'paste' is set and restored when 'paste' is
7280 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281
7282 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7283'smarttab' 'sta' boolean (default off)
7284 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007286 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7287 <BS> will delete a 'shiftwidth' worth of space at the start of the
7288 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007289 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007290 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7291 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007292 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007293 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007294 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007295 This option is reset when 'paste' is set and restored when 'paste' is
7296 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297 NOTE: This option is reset when 'compatible' is set.
7298
7299 *'softtabstop'* *'sts'*
7300'softtabstop' 'sts' number (default 0)
7301 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007302 Number of spaces that a <Tab> counts for while performing editing
7303 operations, like inserting a <Tab> or using <BS>. It "feels" like
7304 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7305 used. This is useful to keep the 'ts' setting at its standard value
7306 of 8, while being able to edit like it is set to 'sts'. However,
7307 commands like "x" still work on the actual characters.
7308 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007309 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007310 'softtabstop' is set to 0 when the 'paste' option is set and restored
7311 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007312 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7313 spaces is minimized by using <Tab>s.
7314 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7315 set.
7316 NOTE: This option is set to 0 when 'compatible' is set.
7317
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007318 If Vim is compiled with the |+vartabs| feature then the value of
7319 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7320 anything other than an empty string.
7321
Bram Moolenaar217ad922005-03-20 22:37:15 +00007322 *'spell'* *'nospell'*
7323'spell' boolean (default off)
7324 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007325 {not available when compiled without the |+syntax|
7326 feature}
7327 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007328 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007329
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007330 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007331'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007332 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007333 {not available when compiled without the |+syntax|
7334 feature}
7335 Pattern to locate the end of a sentence. The following word will be
7336 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007337 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007338 When this check is not wanted make this option empty.
7339 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007340 Be careful with special characters, see |option-backslash| about
7341 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007342 To set this option automatically depending on the language, see
7343 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007344
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007345 *'spellfile'* *'spf'*
7346'spellfile' 'spf' string (default empty)
7347 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007348 {not available when compiled without the |+syntax|
7349 feature}
7350 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007351 commands. It must end in ".{encoding}.add". You need to include the
7352 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007353 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007354 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007355 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007356 |zg| and |zw| commands can be used to access each. This allows using
7357 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007358 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007359 you: Using the first directory in 'runtimepath' that is writable. If
7360 there is no "spell" directory yet it will be created. For the file
7361 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007362 ignoring the region.
7363 The resulting ".spl" file will be used for spell checking, it does not
7364 have to appear in 'spelllang'.
7365 Normally one file is used for all regions, but you can add the region
7366 name if you want to. However, it will then only be used when
7367 'spellfile' is set to it, for entries in 'spelllang' only files
7368 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007369 This option cannot be set from a |modeline| or in the |sandbox|, for
7370 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007371
Bram Moolenaar217ad922005-03-20 22:37:15 +00007372 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007373'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007374 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007375 {not available when compiled without the |+syntax|
7376 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007377 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007378 on spellchecking will be done for these languages. Example: >
7379 set spelllang=en_us,nl,medical
7380< This means US English, Dutch and medical words are recognized. Words
7381 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007382 The word list name must consist of alphanumeric characters, a dash or
7383 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007384 recommended to separate the two letter language name from a
7385 specification. Thus "en-rare" is used for rare English words.
7386 A region name must come last and have the form "_xx", where "xx" is
7387 the two-letter, lower case region name. You can use more than one
7388 region by listing them: "en_us,en_ca" supports both US and Canadian
7389 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007390 Britain. (Note: currently en_au and en_nz dictionaries are older than
7391 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007392 If the name "cjk" is included East Asian characters are excluded from
7393 spell checking. This is useful when editing text that also has Asian
7394 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007395 Note that the "medical" dictionary does not exist, it is just an
7396 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007397 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007398 As a special case the name of a .spl file can be given as-is. The
7399 first "_xx" in the name is removed and used as the region name
7400 (_xx is an underscore, two letters and followed by a non-letter).
7401 This is mainly for testing purposes. You must make sure the correct
7402 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007403 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007404 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7405 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007406 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007407
Bram Moolenaar98692072006-02-04 00:57:42 +00007408 If the |spellfile.vim| plugin is active and you use a language name
7409 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7410 will ask you if you want to download the file.
7411
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007412 After this option has been set successfully, Vim will source the files
7413 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007414 up to the first character that is not an ASCII letter or number and
7415 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007416
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007417 *'spelloptions'* *'spo'*
7418'spelloptions' 'spo' string (default "")
7419 local to buffer
7420 {not available when compiled without the |+syntax|
7421 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007422 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007423 camel When a word is CamelCased, assume "Cased" is a
7424 separate word: every upper-case character in a word
7425 that comes after a lower case character indicates the
7426 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007427
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007428 *'spellsuggest'* *'sps'*
7429'spellsuggest' 'sps' string (default "best")
7430 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007431 {not available when compiled without the |+syntax|
7432 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007433 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007434 the |spellsuggest()| function. This is a comma-separated list of
7435 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007436
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007437 best Internal method that works best for English. Finds
7438 changes like "fast" and uses a bit of sound-a-like
7439 scoring to improve the ordering.
7440
7441 double Internal method that uses two methods and mixes the
7442 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007443 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007444 word. That only works when the language specifies
7445 sound folding. Can be slow and doesn't always give
7446 better results.
7447
7448 fast Internal method that only checks for simple changes:
7449 character inserts/deletes/swaps. Works well for
7450 simple typing mistakes.
7451
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007452 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007453 Not used for |spellsuggest()|. The number of
7454 suggestions is never more than the value of 'lines'
7455 minus two.
7456
Bram Moolenaar585ee072022-01-29 11:22:17 +00007457 timeout:{millisec} Limit the time searching for suggestions to
7458 {millisec} milli seconds. Applies to the following
7459 methods. When omitted the limit is 5000. When
7460 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007461 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007462
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007463 file:{filename} Read file {filename}, which must have two columns,
7464 separated by a slash. The first column contains the
7465 bad word, the second column the suggested good word.
7466 Example:
7467 theribal/terrible ~
7468 Use this for common mistakes that do not appear at the
7469 top of the suggestion list with the internal methods.
7470 Lines without a slash are ignored, use this for
7471 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007472 The word in the second column must be correct,
7473 otherwise it will not be used. Add the word to an
7474 ".add" file if it is currently flagged as a spelling
7475 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007476 The file is used for all languages.
7477
7478 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7479 trouble with spaces. |v:val| holds the badly spelled
7480 word. The expression must evaluate to a List of
7481 Lists, each with a suggestion and a score.
7482 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007483 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007484 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007485 internal methods use. A lower score is better.
7486 This may invoke |spellsuggest()| if you temporarily
7487 set 'spellsuggest' to exclude the "expr:" part.
7488 Errors are silently ignored, unless you set the
7489 'verbose' option to a non-zero value.
7490
7491 Only one of "best", "double" or "fast" may be used. The others may
7492 appear several times in any order. Example: >
7493 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7494<
7495 This option cannot be set from a |modeline| or in the |sandbox|, for
7496 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007497
7498
Bram Moolenaar071d4272004-06-13 20:20:40 +00007499 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7500'splitbelow' 'sb' boolean (default off)
7501 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007502 When on, splitting a window will put the new window below the current
7503 one. |:split|
7504
7505 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7506'splitright' 'spr' boolean (default off)
7507 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 When on, splitting a window will put the new window right of the
7509 current one. |:vsplit|
7510
7511 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7512'startofline' 'sol' boolean (default on)
7513 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007515 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007516 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007517 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518 with a linewise operator, with "%" with a count and to buffer changing
7519 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7520 only has a line number, e.g., ":25" or ":+".
7521 In case of buffer changing commands the cursor is placed at the column
7522 where it was the last time the buffer was edited.
7523 NOTE: This option is set when 'compatible' is set.
7524
Bram Moolenaar00654022011-02-25 14:42:19 +01007525 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007527 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 {not available when compiled without the |+statusline|
7529 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007530 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 Also see |status-line|.
7532
7533 The option consists of printf style '%' items interspersed with
7534 normal text. Each status line item is of the form:
7535 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007536 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007537 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538
Bram Moolenaar238a5642006-02-21 22:12:05 +00007539 When the option starts with "%!" then it is used as an expression,
7540 evaluated and the result is used as the option value. Example: >
7541 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007542< The *g:statusline_winid* variable will be set to the |window-ID| of the
7543 window that the status line belongs to.
7544 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007545 Note that the "%!" expression is evaluated in the context of the
7546 current window and buffer, while %{} items are evaluated in the
7547 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007548
7549 When there is error while evaluating the option then it will be made
7550 empty to avoid further errors. Otherwise screen updating would loop.
7551
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 Note that the only effect of 'ruler' when this option is set (and
7553 'laststatus' is 2) is controlling the output of |CTRL-G|.
7554
7555 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007556 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007558 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007559 minwid Minimum width of the item, padding as set by '-' & '0'.
7560 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007561 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 on the left for text items. Numeric items will be
7563 shifted down to maxwid-2 digits followed by '>'number
7564 where number is the amount of missing digits, much like
7565 an exponential notation.
7566 item A one letter code as described below.
7567
7568 Following is a description of the possible statusline items. The
7569 second character in "item" is the type:
7570 N for number
7571 S for string
7572 F for flags as described below
7573 - not applicable
7574
7575 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007576 f S Path to the file in the buffer, as typed or relative to current
7577 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 F S Full path to the file in the buffer.
7579 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007580 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007582 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007583 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007584 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007585 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007586 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007588 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007590 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7592 being used: "<keymap>"
7593 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007594 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595 B N As above, in hexadecimal.
7596 o N Byte number in file of byte under cursor, first byte is 1.
7597 Mnemonic: Offset from start of file (with one added)
7598 {not available when compiled without |+byte_offset| feature}
7599 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007600 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007601 l N Line number.
7602 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007603 c N Column number (byte index).
7604 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007605 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007606 p N Percentage through file in lines as in |CTRL-G|.
7607 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007608 percentage described for 'ruler'. Always 3 in length, unless
7609 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007610 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007611 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007612 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007613 Note that there is no '%' before the closing '}'. The
7614 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007615 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007616 {% - This is almost same as { except the result of the expression is
7617 re-evaluated as a statusline format string. Thus if the
7618 return value of expr contains % items they will get expanded.
7619 The expression can contain the } character, the end of
7620 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007621 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007622 func! Stl_filename() abort
7623 return "%t"
7624 endfunc
7625< `stl=%{Stl_filename()}` results in `"%t"`
7626 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007627 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007628 ( - Start of item group. Can be used for setting the width and
7629 alignment of a section. Must be followed by %) somewhere.
7630 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007631 T N For 'tabline': start of tab page N label. Use %T after the last
7632 label. This information is used for mouse clicks.
7633 X N For 'tabline': start of close tab N label. Use %X after the
7634 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7635 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636 < - Where to truncate line if too long. Default is at the start.
7637 No width fields allowed.
7638 = - Separation point between left and right aligned items.
7639 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007640 # - Set highlight group. The name must follow and then a # again.
7641 Thus use %#HLname# for highlight group HLname. The same
7642 highlighting is used, also for the statusline of non-current
7643 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007645 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 The difference between User{N} and StatusLine will be applied
7647 to StatusLineNC for the statusline of non-current windows.
7648 The number N must be between 1 and 9. See |hl-User1..9|
7649
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007650 When displaying a flag, Vim removes the leading comma, if any, when
7651 that flag comes right after plaintext. This will make a nice display
7652 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007653
Bram Moolenaar582fd852005-03-28 20:58:01 +00007654 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655 not set) and a minwid is not set for the group, the whole group will
7656 become empty. This will make a group like the following disappear
7657 completely from the statusline when none of the flags are set. >
7658 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007659< Beware that an expression is evaluated each and every time the status
7660 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007661 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007662 While evaluating %{} the current buffer and current window will be set
7663 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007664 currently being drawn. The expression will evaluate in this context.
7665 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7666 real current buffer and "g:actual_curwin" to the |window-ID| of the
7667 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007668
Bram Moolenaar30b65812012-07-12 22:01:11 +02007669 The 'statusline' option will be evaluated in the |sandbox| if set from
7670 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007671 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007672
7673 It is not allowed to change text or jump to another window while
7674 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007675
7676 If the statusline is not updated when you want it (e.g., after setting
7677 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007678 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007679
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007680 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007681 Otherwise the result is taken as flag text and applied to the rules
7682 described above.
7683
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007684 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007685 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007686 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007687
7688 Examples:
7689 Emulate standard status line with 'ruler' set >
7690 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7691< Similar, but add ASCII value of char under the cursor (like "ga") >
7692 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7693< Display byte count and byte value, modified flag in red. >
7694 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7695 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7696< Display a ,GZ flag if a compressed file is loaded >
7697 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7698< In the |:autocmd|'s: >
7699 :let b:gzflag = 1
7700< And: >
7701 :unlet b:gzflag
7702< And define this function: >
7703 :function VarExists(var, val)
7704 : if exists(a:var) | return a:val | else | return '' | endif
7705 :endfunction
7706<
7707 *'suffixes'* *'su'*
7708'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710 Files with these suffixes get a lower priority when multiple files
7711 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007712 suffixes. Spaces after the comma are ignored. A dot is also seen as
7713 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007714 separator, precede it with a backslash (see |option-backslash| about
7715 including spaces and backslashes).
7716 See 'wildignore' for completely ignoring files.
7717 The use of |:set+=| and |:set-=| is preferred when adding or removing
7718 suffixes from the list. This avoids problems when a future version
7719 uses another default.
7720
7721 *'suffixesadd'* *'sua'*
7722'suffixesadd' 'sua' string (default "")
7723 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007724 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 file for the "gf", "[I", etc. commands. Example: >
7726 :set suffixesadd=.java
7727<
7728 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7729'swapfile' 'swf' boolean (default on)
7730 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007731 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007732 swapfile is not wanted for a specific buffer. For example, with
7733 confidential information that even root must not be able to access.
7734 Careful: All text will be in memory:
7735 - Don't use this for big files.
7736 - Recovery will be impossible!
7737 A swapfile will only be present when |'updatecount'| is non-zero and
7738 'swapfile' is set.
7739 When 'swapfile' is reset, the swap file for the current buffer is
7740 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7741 non-zero, a swap file is immediately created.
7742 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007743 If you want to open a new buffer without creating a swap file for it,
7744 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007745 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007746
7747 This option is used together with 'bufhidden' and 'buftype' to
7748 specify special kinds of buffers. See |special-buffers|.
7749
7750 *'swapsync'* *'sws'*
7751'swapsync' 'sws' string (default "fsync")
7752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007754 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755 When this option is empty parts of the swap file may be in memory and
7756 not written to disk. When the system crashes you may lose more work.
7757 On Unix the system does a sync now and then without Vim asking for it,
7758 so the disadvantage of setting this option off is small. On some
7759 systems the swap file will not be written at all. For a unix system
7760 setting it to "sync" will use the sync() call instead of the default
7761 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007762 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007763
7764 *'switchbuf'* *'swb'*
7765'switchbuf' 'swb' string (default "")
7766 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007767 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007768 Mostly for |quickfix| commands some values are also used for other
7769 commands, as mentioned below.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007770 Possible values (comma-separated list):
Bram Moolenaar071d4272004-06-13 20:20:40 +00007771 useopen If included, jump to the first open window that
7772 contains the specified buffer (if there is one).
7773 Otherwise: Do not examine other windows.
7774 This setting is checked with |quickfix| commands, when
7775 jumping to errors (":cc", ":cn", "cp", etc.). It is
7776 also used in all buffer related split commands, for
7777 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007778 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007779 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007780 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007781 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007782 Otherwise: do not split, use current window (when used
7783 in the quickfix window: the previously used window or
7784 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007785 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007786 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007787 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007788 uselast If included, jump to the previously used window when
7789 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007790
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007791 *'synmaxcol'* *'smc'*
7792'synmaxcol' 'smc' number (default 3000)
7793 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007794 {not available when compiled without the |+syntax|
7795 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007796 Maximum column in which to search for syntax items. In long lines the
7797 text after this column is not highlighted and following lines may not
7798 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007799 This helps to avoid very slow redrawing for an XML file that is one
7800 long line.
7801 Set to zero to remove the limit.
7802
Bram Moolenaar071d4272004-06-13 20:20:40 +00007803 *'syntax'* *'syn'*
7804'syntax' 'syn' string (default empty)
7805 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007806 {not available when compiled without the |+syntax|
7807 feature}
7808 When this option is set, the syntax with this name is loaded, unless
7809 syntax highlighting has been switched off with ":syntax off".
7810 Otherwise this option does not always reflect the current syntax (the
7811 b:current_syntax variable does).
7812 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007813 not automatically recognized. Example, in an IDL file:
7814 /* vim: set syntax=idl : */ ~
7815 When a dot appears in the value then this separates two filetype
7816 names. Example:
7817 /* vim: set syntax=c.doxygen : */ ~
7818 This will use the "c" syntax first, then the "doxygen" syntax.
7819 Note that the second one must be prepared to be loaded as an addition,
7820 otherwise it will be skipped. More than one dot may appear.
7821 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007822 :set syntax=OFF
7823< To switch syntax highlighting on according to the current value of the
7824 'filetype' option: >
7825 :set syntax=ON
7826< What actually happens when setting the 'syntax' option is that the
7827 Syntax autocommand event is triggered with the value as argument.
7828 This option is not copied to another buffer, independent of the 's' or
7829 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007830 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007831
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007832 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007833'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007834 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00007835 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007836 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007837 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007838
7839 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007840 option and only when there is no GUI tab line. When 'e' is in
7841 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007842 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007843
7844 The value is evaluated like with 'statusline'. You can use
7845 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007846 the text to be displayed. Use "%1T" for the first label, "%2T" for
7847 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007848
Bram Moolenaare12bab32019-01-08 22:02:56 +01007849 When changing something that is used in 'tabline' that does not
7850 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007851 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007852
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007853 Keep in mind that only one of the tab pages is the current one, others
7854 are invisible and you can't jump to their windows.
7855
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007856
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007857 *'tabpagemax'* *'tpm'*
7858'tabpagemax' 'tpm' number (default 10)
7859 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007860 Maximum number of tab pages to be opened by the |-p| command line
7861 argument or the ":tab all" command. |tabpage|
7862
7863
7864 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865'tabstop' 'ts' number (default 8)
7866 local to buffer
7867 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007868 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007869
7870 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007871 appear wrong in many places, e.g., when printing it.
7872 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873
7874 There are four main ways to use tabs in Vim:
7875 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7876 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007877 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 behave like a tab appears every 4 (or 3) characters.
7879 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7880 'expandtab'. This way you will always insert spaces. The
7881 formatting will never be messed up when 'tabstop' is changed.
7882 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007883 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 works when using Vim to edit the file.
7885 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7886 'noexpandtab'. This should then work (for initial indents only)
7887 for any tabstop setting that people use. It might be nice to have
7888 tabs after the first non-blank inserted as spaces if you do this
7889 though. Otherwise aligned comments will be wrong when 'tabstop' is
7890 changed.
7891
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007892 If Vim is compiled with the |+vartabs| feature then the value of
7893 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7894 than an empty string.
7895
Bram Moolenaar071d4272004-06-13 20:20:40 +00007896 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7897'tagbsearch' 'tbs' boolean (default on)
7898 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007900 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007901 searching makes searching for a tag a LOT faster, but a linear search
7902 will find more tags if the tags file wasn't properly sorted.
7903 Vim normally assumes that your tags files are sorted, or indicate that
7904 they are not sorted. Only when this is not the case does the
7905 'tagbsearch' option need to be switched off.
7906
7907 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007908 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909 certain files, or retry all files with a linear search. When
7910 'tagbsearch' is off, only a linear search is done.
7911
7912 Linear searching is done anyway, for one file, when Vim finds a line
7913 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007914 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915< [The whitespace before and after the '0' must be a single <Tab>]
7916
7917 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007918 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007919 instead of a normal tag name, a retry is done with a linear search.
7920 Tags in unsorted tags files, and matches with different case will only
7921 be found in the retry.
7922
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007923 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007924 linear search can be avoided when case is ignored. Use a value of '2'
7925 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7926 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00007927 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
7928 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
7929 used for this as well. Note that case must be folded to uppercase for
7930 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007931
7932 By default, tag searches are case-sensitive. Case is ignored when
7933 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7934 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007935 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7936 'tagcase' is "smart", and the pattern contains only lowercase
7937 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938
7939 When 'tagbsearch' is off, tags searching is slower when a full match
7940 exists, but faster when no full match exists. Tags in unsorted tags
7941 files may only be found with 'tagbsearch' off.
7942 When the tags file is not sorted, or sorted in a wrong way (not on
7943 ASCII byte value), 'tagbsearch' should be off, or the line given above
7944 must be included in the tags file.
7945 This option doesn't affect commands that find all matching tags (e.g.,
7946 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007947
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007948 *'tagcase'* *'tc'*
7949'tagcase' 'tc' string (default "followic")
7950 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007951 This option specifies how case is handled when searching the tags
7952 file:
7953 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007954 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007955 ignore Ignore case
7956 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007957 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007958 NOTE: This option is set to the Vi default value when 'compatible' is
7959 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007960
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007961 *'tagfunc'* *'tfu'*
7962'tagfunc' 'tfu' string (default: empty)
7963 local to buffer
7964 {not available when compiled without the |+eval|
7965 feature}
7966 This option specifies a function to be used to perform tag searches.
7967 The function gets the tag pattern and should return a List of matching
7968 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007969 function and an example. The value can be the name of a function, a
7970 |lambda| or a |Funcref|. See |option-value-function| for more
7971 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007972
Bram Moolenaar071d4272004-06-13 20:20:40 +00007973 *'taglength'* *'tl'*
7974'taglength' 'tl' number (default 0)
7975 global
7976 If non-zero, tags are significant up to this number of characters.
7977
7978 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7979'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7980 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007981 If on and using a tags file in another directory, file names in that
7982 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007983 NOTE: This option is set to the Vi default value when 'compatible' is
7984 set and to the Vim default value when 'compatible' is reset.
7985
7986 *'tags'* *'tag'* *E433*
7987'tags' 'tag' string (default "./tags,tags", when compiled with
7988 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7989 global or local to buffer |global-local|
7990 Filenames for the tag command, separated by spaces or commas. To
7991 include a space or comma in a file name, precede it with a backslash
7992 (see |option-backslash| about including spaces and backslashes).
7993 When a file name starts with "./", the '.' is replaced with the path
7994 of the current file. But only when the 'd' flag is not included in
7995 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7996 |tags-option|.
7997 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007998 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7999 find all files named "tags" below "/lib". The filename itself cannot
8000 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008001 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008002 The |tagfiles()| function can be used to get a list of the file names
8003 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008004 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8005 files are also supported. They are automatically recognized. The
8006 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8007 differences are ignored (MS-Windows). |emacs-tags|
8008 The use of |:set+=| and |:set-=| is preferred when adding or removing
8009 file names from the list. This avoids problems when a future version
8010 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011
8012 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8013'tagstack' 'tgst' boolean (default on)
8014 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 When on, the |tagstack| is used normally. When off, a ":tag" or
8016 ":tselect" command with an argument will not push the tag onto the
8017 tagstack. A following ":tag" without an argument, a ":pop" command or
8018 any other command that uses the tagstack will use the unmodified
8019 tagstack, but does change the pointer to the active entry.
8020 Resetting this option is useful when using a ":tag" command in a
8021 mapping which should not change the tagstack.
8022
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008023 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008024'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008025 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008026 {only available when compiled with the |+tcl/dyn|
8027 feature}
8028 Specifies the name of the Tcl shared library. The default is
8029 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008030 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008031 This option cannot be set from a |modeline| or in the |sandbox|, for
8032 security reasons.
8033
Bram Moolenaar071d4272004-06-13 20:20:40 +00008034 *'term'* *E529* *E530* *E531*
8035'term' string (default is $TERM, if that fails:
8036 in the GUI: "builtin_gui"
8037 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008038 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008040 on Unix: "ansi"
8041 on VMS: "ansi"
8042 on Win 32: "win32")
8043 global
8044 Name of the terminal. Used for choosing the terminal control
8045 characters. Environment variables are expanded |:set_env|.
8046 For example: >
8047 :set term=$TERM
8048< See |termcap|.
8049
8050 *'termbidi'* *'tbidi'*
8051 *'notermbidi'* *'notbidi'*
8052'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8053 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008054 {only available when compiled with the |+arabic|
8055 feature}
8056 The terminal is in charge of Bi-directionality of text (as specified
8057 by Unicode). The terminal is also expected to do the required shaping
8058 that some languages (such as Arabic) require.
8059 Setting this option implies that 'rightleft' will not be set when
8060 'arabic' is set and the value of 'arabicshape' will be ignored.
8061 Note that setting 'termbidi' has the immediate effect that
8062 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8063 This option is reset when the GUI is started.
8064 For further details see |arabic.txt|.
8065
8066 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008067'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008068 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008069 Encoding used for the terminal. This specifies what character
8070 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008071 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008072 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008073 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008074 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008075 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8076 Any attempts to set a different value will be rejected, and an error
8077 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008078 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008079 because the Win32 system always passes Unicode characters.
8080 When empty, the same encoding is used as for the 'encoding' option.
8081 This is the normal value.
8082 Not all combinations for 'termencoding' and 'encoding' are valid. See
8083 |encoding-table|.
8084 The value for this option must be supported by internal conversions or
8085 iconv(). When this is not possible no conversion will be done and you
8086 will probably experience problems with non-ASCII characters.
8087 Example: You are working with the locale set to euc-jp (Japanese) and
8088 want to edit a UTF-8 file: >
8089 :let &termencoding = &encoding
8090 :set encoding=utf-8
8091< You need to do this when your system has no locale support for UTF-8.
8092
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008093 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008094'termguicolors' 'tgc' boolean (default off)
8095 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008096 {not available when compiled without the
8097 |+termguicolors| feature}
8098 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008099 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008100
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008101 Requires a ISO-8613-3 compatible terminal. If setting this option
8102 does not work (produces a colorless UI) reading |xterm-true-color|
8103 might help.
8104
8105 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8106 is required. Use this check to find out: >
8107 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008108< This requires Vim to be built with the |+vtp| feature.
8109
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008110 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008111
8112 When using Vim with Windows Terminal, the background of Windows
8113 Terminal is normally filled with the Vim background color. Setting
8114 'termguicolors' and the guibg of the Normal highlight group to NONE
8115 will make the background transparent: >
8116 :hi Normal guibg=NONE
8117<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008118 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008119
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008120 *'termwinkey'* *'twk'*
8121'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008122 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008123 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008124 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008125 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008126 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008127< The string must be one key stroke but can be multiple bytes.
8128 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008129 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008130 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008131
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008132 *'termwinscroll'* *'twsl'*
8133'termwinscroll' 'twsl' number (default 10000)
8134 local to buffer
8135 {not available when compiled without the
8136 |+terminal| feature}
8137 Number of scrollback lines to keep. When going over this limit the
8138 first 10% of the scrollback lines are deleted. This is just to reduce
8139 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008140 Also used as a limit for text sent to the terminal in one write,
8141 multiplied by the number of columns times 3 (average number of bytes
8142 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008143
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008144 *'termwinsize'* *'tws'*
8145'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008146 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008147 Size used when opening the |terminal| window. Format:
8148 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008149 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008150 - When set with a "x" (e.g., "24x80") the terminal size is not
8151 adjusted to the window size. If the window is smaller only the
8152 top-left part is displayed.
8153 - When set with a "*" (e.g., "10*50") the terminal size follows the
8154 window size, but will not be smaller than the specified rows and/or
8155 columns.
8156 - When rows is zero then use the height of the window.
8157 - When columns is zero then use the width of the window.
8158 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008159 - Can be overruled in the |term_start()| options with "term_rows" and
8160 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008161
8162 Examples:
8163 "30x0" uses 30 rows and the current window width.
8164 "20*0" uses at least 20 rows and the current window width.
8165 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008166 Note that the command running in the terminal window may still change
8167 the size of the terminal. In that case the Vim window will be
8168 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008169
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008170 *'termwintype'* *'twt'*
8171'termwintype' 'twt' string (default "")
8172 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008173 {only available when compiled with the |terminal|
8174 feature on MS-Windows}
8175 Specify the virtual console (pty) used when opening the terminal
8176 window.
8177
8178 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008179 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008180 "winpty" use winpty, fail if not supported
8181 "conpty" use |ConPTY|, fail if not supported
8182
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008183 |ConPTY| support depends on the platform. Windows 10 October 2018
8184 Update is the first version that supports ConPTY, however it is still
8185 considered unstable. ConPTY might become stable in the next release
8186 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008187 supported then you cannot open a terminal window.
8188
Bram Moolenaar071d4272004-06-13 20:20:40 +00008189 *'terse'* *'noterse'*
8190'terse' boolean (default off)
8191 global
8192 When set: Add 's' flag to 'shortmess' option (this makes the message
8193 for a search that hits the start or end of the file not being
8194 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8195 shortens a lot of messages}
8196
8197 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8198'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8199 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008200 This option is obsolete. Use 'fileformats'.
8201 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8202 set to the default value for the current system. When 'textauto' is
8203 reset, 'fileformats' is made empty.
8204 NOTE: This option is set to the Vi default value when 'compatible' is
8205 set and to the Vim default value when 'compatible' is reset.
8206
8207 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008208'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008209 others: default off)
8210 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211 This option is obsolete. Use 'fileformat'.
8212 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8213 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8214 "unix".
8215
8216 *'textwidth'* *'tw'*
8217'textwidth' 'tw' number (default 0)
8218 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008219 Maximum width of text that is being inserted. A longer line will be
8220 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008221 this.
8222 'textwidth' is set to 0 when the 'paste' option is set and restored
8223 when 'paste' is reset.
8224 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008225 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008226 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227 NOTE: This option is set to 0 when 'compatible' is set.
8228
8229 *'thesaurus'* *'tsr'*
8230'thesaurus' 'tsr' string (default "")
8231 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008232 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008233 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8234 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008235
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008236 This option is not used if 'thesaurusfunc' is set, either for the
8237 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008238
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008239 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008240 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008241 name. See |option-backslash| about using backslashes. The use of
8242 |:set+=| and |:set-=| is preferred when adding or removing directories
8243 from the list. This avoids problems when a future version uses
8244 another default. Backticks cannot be used in this option for security
8245 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008246
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008247 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008248'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008249 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008250 {not available when compiled without the |+eval|
8251 feature}
8252 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008253 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008254 The value can be the name of a function, a |lambda| or a |Funcref|.
8255 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008256
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008257 This option cannot be set from a |modeline| or in the |sandbox|, for
8258 security reasons.
8259
Bram Moolenaar071d4272004-06-13 20:20:40 +00008260 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8261'tildeop' 'top' boolean (default off)
8262 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008263 When on: The tilde command "~" behaves like an operator.
8264 NOTE: This option is reset when 'compatible' is set.
8265
8266 *'timeout'* *'to'* *'notimeout'* *'noto'*
8267'timeout' 'to' boolean (default on)
8268 global
8269 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008270'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008271 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008272 These two options together determine the behavior when part of a
8273 mapped key sequence or keyboard code has been received:
8274
8275 'timeout' 'ttimeout' action ~
8276 off off do not time out
8277 on on or off time out on :mappings and key codes
8278 off on time out on key codes
8279
8280 If both options are off, Vim will wait until either the complete
8281 mapping or key sequence has been received, or it is clear that there
8282 is no mapping or key sequence for the received characters. For
8283 example: if you have mapped "vl" and Vim has received 'v', the next
8284 character is needed to see if the 'v' is followed by an 'l'.
8285 When one of the options is on, Vim will wait for about 1 second for
8286 the next character to arrive. After that the already received
8287 characters are interpreted as single characters. The waiting time can
8288 be changed with the 'timeoutlen' option.
8289 On slow terminals or very busy systems timing out may cause
8290 malfunctioning cursor keys. If both options are off, Vim waits
8291 forever after an entered <Esc> if there are key codes that start
8292 with <Esc>. You will have to type <Esc> twice. If you do not have
8293 problems with key codes, but would like to have :mapped key
8294 sequences not timing out in 1 second, set the 'ttimeout' option and
8295 reset the 'timeout' option.
8296
8297 NOTE: 'ttimeout' is reset when 'compatible' is set.
8298
8299 *'timeoutlen'* *'tm'*
8300'timeoutlen' 'tm' number (default 1000)
8301 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008302
Bram Moolenaar071d4272004-06-13 20:20:40 +00008303 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008304'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008305 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306 The time in milliseconds that is waited for a key code or mapped key
8307 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8308 when part of a command has been typed.
8309 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8310 different timeout value for key codes is desired set 'ttimeoutlen' to
8311 a non-negative number.
8312
8313 ttimeoutlen mapping delay key code delay ~
8314 < 0 'timeoutlen' 'timeoutlen'
8315 >= 0 'timeoutlen' 'ttimeoutlen'
8316
8317 The timeout only happens when the 'timeout' and 'ttimeout' options
8318 tell so. A useful setting would be >
8319 :set timeout timeoutlen=3000 ttimeoutlen=100
8320< (time out on mapping after three seconds, time out on key codes after
8321 a tenth of a second).
8322
8323 *'title'* *'notitle'*
8324'title' boolean (default off, on when title can be restored)
8325 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008326 When on, the title of the window will be set to the value of
8327 'titlestring' (if it is not empty), or to:
8328 filename [+=-] (path) - VIM
8329 Where:
8330 filename the name of the file being edited
8331 - indicates the file cannot be modified, 'ma' off
8332 + indicates the file was modified
8333 = indicates the file is read-only
8334 =+ indicates the file is read-only and modified
8335 (path) is the path of the file being edited
8336 - VIM the server name |v:servername| or "VIM"
8337 Only works if the terminal supports setting window titles
8338 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008339 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008340 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8341 *X11*
8342 When Vim was compiled with HAVE_X11 defined, the original title will
8343 be restored if possible. The output of ":version" will include "+X11"
8344 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8345 works for the icon name |'icon'|.
8346 But: When Vim was started with the |-X| argument, restoring the title
8347 will not work (except in the GUI).
8348 If the title cannot be restored, it is set to the value of 'titleold'.
8349 You might want to restore the title outside of Vim then.
8350 When using an xterm from a remote machine you can use this command:
8351 rsh machine_name xterm -display $DISPLAY &
8352 then the WINDOWID environment variable should be inherited and the
8353 title of the window should change back to what it should be after
8354 exiting Vim.
8355
8356 *'titlelen'*
8357'titlelen' number (default 85)
8358 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008359 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008360 title. When the title is longer, only the end of the path name is
8361 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362 Using a percentage makes this adapt to the width of the window. But
8363 it won't work perfectly, because the actual number of characters
8364 available also depends on the font used and other things in the title
8365 bar. When 'titlelen' is zero the full path is used. Otherwise,
8366 values from 1 to 30000 percent can be used.
8367 'titlelen' is also used for the 'titlestring' option.
8368
8369 *'titleold'*
8370'titleold' string (default "Thanks for flying Vim")
8371 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 This option will be used for the window title when exiting Vim if the
8373 original title cannot be restored. Only happens if 'title' is on or
8374 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008375 This option cannot be set from a |modeline| or in the |sandbox|, for
8376 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008377 *'titlestring'*
8378'titlestring' string (default "")
8379 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008380 When this option is not empty, it will be used for the title of the
8381 window. This happens only when the 'title' option is on.
8382 Only works if the terminal supports setting window titles (currently
8383 Amiga console, Win32 console, all GUI versions and terminals with a
8384 non-empty 't_ts' option).
8385 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008386 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008387
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388 When this option contains printf-style '%' items, they will be
8389 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008390 This option cannot be set in a modeline when 'modelineexpr' is off.
8391
Bram Moolenaar071d4272004-06-13 20:20:40 +00008392 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008393 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008394 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8395< The value of 'titlelen' is used to align items in the middle or right
8396 of the available space.
8397 Some people prefer to have the file name first: >
8398 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8399< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008400 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008401 separating space only when needed.
8402 NOTE: Use of special characters in 'titlestring' may cause the display
8403 to be garbled (e.g., when it contains a CR or NL character).
8404 {not available when compiled without the |+statusline| feature}
8405
8406 *'toolbar'* *'tb'*
8407'toolbar' 'tb' string (default "icons,tooltips")
8408 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008409 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008410 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411 possible values are:
8412 icons Toolbar buttons are shown with icons.
8413 text Toolbar buttons shown with text.
8414 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008415 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416 tooltips Tooltips are active for toolbar buttons.
8417 Tooltips refer to the popup help text which appears after the mouse
8418 cursor is placed over a toolbar button for a brief moment.
8419
8420 If you want the toolbar to be shown with icons as well as text, do the
8421 following: >
8422 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008423< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008424 will show icons if both are requested.
8425
8426 If none of the strings specified in 'toolbar' are valid or if
8427 'toolbar' is empty, this option is ignored. If you want to disable
8428 the toolbar, you need to set the 'guioptions' option. For example: >
8429 :set guioptions-=T
8430< Also see |gui-toolbar|.
8431
8432 *'toolbariconsize'* *'tbis'*
8433'toolbariconsize' 'tbis' string (default "small")
8434 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008435 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008436 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008437 tiny Use tiny icons.
8438 small Use small icons (default).
8439 medium Use medium-sized icons.
8440 large Use large icons.
8441 huge Use even larger icons.
8442 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008443 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008444 the current theme. Common dimensions are giant=48x48, huge=32x32,
8445 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008446
8447 If 'toolbariconsize' is empty, the global default size as determined
8448 by user preferences or the current theme is used.
8449
8450 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8451'ttybuiltin' 'tbi' boolean (default on)
8452 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008453 When on, the builtin termcaps are searched before the external ones.
8454 When off the builtin termcaps are searched after the external ones.
8455 When this option is changed, you should set the 'term' option next for
8456 the change to take effect, for example: >
8457 :set notbi term=$TERM
8458< See also |termcap|.
8459 Rationale: The default for this option is "on", because the builtin
8460 termcap entries are generally better (many systems contain faulty
8461 xterm entries...).
8462
8463 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8464'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8465 sun-cmd, screen, rxvt, dtterm or
8466 iris-ansi; also on when running Vim in
8467 a DOS console)
8468 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008469 Indicates a fast terminal connection. More characters will be sent to
8470 the screen for redrawing, instead of using insert/delete line
8471 commands. Improves smoothness of redrawing when there are multiple
8472 windows and the terminal does not support a scrolling region.
8473 Also enables the extra writing of characters at the end of each screen
8474 line for lines that wrap. This helps when using copy/paste with the
8475 mouse in an xterm and other terminals.
8476
8477 *'ttymouse'* *'ttym'*
8478'ttymouse' 'ttym' string (default depends on 'term')
8479 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008480 {only in Unix and VMS, doesn't work in the GUI; not
8481 available when compiled without |+mouse|}
8482 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008483 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008484 *xterm-mouse*
8485 xterm xterm-like mouse handling. The mouse generates
8486 "<Esc>[Mscr", where "scr" is three bytes:
8487 "s" = button state
8488 "c" = column plus 33
8489 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008490 This only works up to 223 columns! See "dec",
8491 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008492 xterm2 Works like "xterm", but with the xterm reporting the
8493 mouse position while the mouse is dragged. This works
8494 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008495 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496 work. See below for how Vim detects this
8497 automatically.
8498 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008499 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008500 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008501 for the row and column. No other mouse events are
8502 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008503 *dec-mouse*
8504 dec DEC terminal mouse handling. The mouse generates a
8505 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008506 This is also available for an Xterm, if it was
8507 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008508 *jsbterm-mouse*
8509 jsbterm JSB term mouse handling.
8510 *pterm-mouse*
8511 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008512 *urxvt-mouse*
8513 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008514 The mouse works only if the terminal supports this
8515 encoding style, but it does not have 223 columns limit
8516 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008517 *sgr-mouse*
8518 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008519 mouse reporting. The mouse works even in columns
8520 beyond 223. This option is backward compatible with
8521 "xterm2" because it can also decode "xterm2" style
8522 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008523
8524 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008525 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8526 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008527 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8528 recognized, if enabled at compile time. DEC terminal mouse codes
8529 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008530 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8531 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008532 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008533 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8534 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8535 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008536 Additionally, if vim is compiled with the |+termresponse| feature and
8537 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008538 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008539 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008540 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8541 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8542 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008543 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8544 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 :set t_RV=
8546<
8547 *'ttyscroll'* *'tsl'*
8548'ttyscroll' 'tsl' number (default 999)
8549 global
8550 Maximum number of lines to scroll the screen. If there are more lines
8551 to scroll the window is redrawn. For terminals where scrolling is
8552 very slow and redrawing is not slow this can be set to a small number,
8553 e.g., 3, to speed up displaying.
8554
8555 *'ttytype'* *'tty'*
8556'ttytype' 'tty' string (default from $TERM)
8557 global
8558 Alias for 'term', see above.
8559
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008560 *'undodir'* *'udir'*
8561'undodir' 'udir' string (default ".")
8562 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008563 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008564 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008565 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008566 "." means using the directory of the file. The undo file name for
8567 "file.txt" is ".file.txt.un~".
8568 For other directories the file name is the full path of the edited
8569 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008570 When writing: The first directory that exists is used. "." always
8571 works, no directories after "." will be used for writing.
8572 When reading all entries are tried to find an undo file. The first
8573 undo file that exists is used. When it cannot be read an error is
8574 given, no further entry is used.
8575 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008576 This option cannot be set from a |modeline| or in the |sandbox|, for
8577 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008578
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008579 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008580'undofile' 'udf' boolean (default off)
8581 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008582 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008583 When on, Vim automatically saves undo history to an undo file when
8584 writing a buffer to a file, and restores undo history from the same
8585 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008586 The directory where the undo file is stored is specified by 'undodir'.
8587 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008588 The undo file is not read when 'undoreload' causes the buffer from
8589 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008590 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008591 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008592
Bram Moolenaar071d4272004-06-13 20:20:40 +00008593 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008594'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008595 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008596 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008597 is kept in memory, higher numbers will cause more memory to be used.
8598 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008599 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8600 itself: >
8601 set ul=0
8602< But you can also get Vi compatibility by including the 'u' flag in
8603 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008604 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008605 Set to -1 for no undo at all. You might want to do this only for the
8606 current buffer: >
8607 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008608< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008609
8610 The local value is set to -123456 when the global value is to be used.
8611
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008612 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008613
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008614 *'undoreload'* *'ur'*
8615'undoreload' 'ur' number (default 10000)
8616 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008617 Save the whole buffer for undo when reloading it. This applies to the
8618 ":e!" command and reloading for when the buffer changed outside of
8619 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008620 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008621 of lines is smaller than the value of this option.
8622 Set this option to zero to disable undo for a reload.
8623
8624 When saving undo for a reload, any undo file is not read.
8625
8626 Note that this causes the whole buffer to be stored in memory. Set
8627 this option to a lower value if you run out of memory.
8628
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629 *'updatecount'* *'uc'*
8630'updatecount' 'uc' number (default: 200)
8631 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008632 After typing this many characters the swap file will be written to
8633 disk. When zero, no swap file will be created at all (see chapter on
8634 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8635 Vim with the "-n" option, see |startup|. When editing in readonly
8636 mode this option will be initialized to 10000.
8637 The swapfile can be disabled per buffer with |'swapfile'|.
8638 When 'updatecount' is set from zero to non-zero, swap files are
8639 created for all buffers that have 'swapfile' set. When 'updatecount'
8640 is set to zero, existing swap files are not deleted.
8641 Also see |'swapsync'|.
8642 This option has no meaning in buffers where |'buftype'| is "nofile"
8643 or "nowrite".
8644
8645 *'updatetime'* *'ut'*
8646'updatetime' 'ut' number (default 4000)
8647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008648 If this many milliseconds nothing is typed the swap file will be
8649 written to disk (see |crash-recovery|). Also used for the
8650 |CursorHold| autocommand event.
8651
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008652 *'varsofttabstop'* *'vsts'*
8653'varsofttabstop' 'vsts' string (default "")
8654 local to buffer
8655 {only available when compiled with the |+vartabs|
8656 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008657 A list of the number of spaces that a <Tab> counts for while editing,
8658 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8659 width <Tab>s are being inserted, while in fact a mixture of spaces
8660 and <Tab>s is used. Tab widths are separated with commas, with the
8661 final value applying to all subsequent tabs.
8662
8663 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008664 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008665 to use the following: >
8666 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008667< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8668 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008669
8670 Note that the value of |'softtabstop'| will be ignored while
8671 'varsofttabstop' is set.
8672
8673 *'vartabstop'* *'vts'*
8674'vartabstop' 'vts' string (default "")
8675 local to buffer
8676 {only available when compiled with the |+vartabs|
8677 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008678 A list of the number of spaces that a <Tab> in the file counts for,
8679 separated by commas. Each value corresponds to one tab, with the
8680 final value applying to all subsequent tabs. For example: >
8681 :set vartabstop=4,20,10,8
8682< This will make the first tab 4 spaces wide, the second 20 spaces,
8683 the third 10 spaces, and all following tabs 8 spaces.
8684
8685 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8686 is set.
8687
Bram Moolenaar071d4272004-06-13 20:20:40 +00008688 *'verbose'* *'vbs'*
8689'verbose' 'vbs' number (default 0)
8690 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008691 When bigger than zero, Vim will give messages about what it is doing.
8692 Currently, these messages are given:
8693 >= 1 When the viminfo file is read or written.
8694 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008695 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008696 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697 >= 8 Files for which a group of autocommands is executed.
8698 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008699 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008700 >= 12 Every executed function.
8701 >= 13 When an exception is thrown, caught, finished, or discarded.
8702 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008703 >= 15 Every executed Ex command from a script (truncated at 200
8704 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008705 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008706
8707 This option can also be set with the "-V" argument. See |-V|.
8708 This option is also set by the |:verbose| command.
8709
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008710 When the 'verbosefile' option is set then the verbose messages are not
8711 displayed.
8712
8713 *'verbosefile'* *'vfile'*
8714'verbosefile' 'vfile' string (default empty)
8715 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008716 When not empty all messages are written in a file with this name.
8717 When the file exists messages are appended.
8718 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008719 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008720 Setting 'verbosefile' to a new value is like making it empty first.
8721 The difference with |:redir| is that verbose messages are not
8722 displayed when 'verbosefile' is set.
8723
Bram Moolenaar071d4272004-06-13 20:20:40 +00008724 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008725'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008726 "$VIM/vimfiles/view",
8727 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008728 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008729 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008730 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008731 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 feature}
8733 Name of the directory where to store files for |:mkview|.
8734 This option cannot be set from a |modeline| or in the |sandbox|, for
8735 security reasons.
8736
8737 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008738'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008739 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008740 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008741 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008742 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008743 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008744 word save and restore ~
8745 cursor cursor position in file and in window
8746 folds manually created folds, opened/closed folds and local
8747 fold options
8748 options options and mappings local to a window or buffer (not
8749 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008750 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751 slash backslashes in file names replaced with forward
8752 slashes
8753 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008754 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008755 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008756
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008757 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008758 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008759 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760
8761 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008762'viminfo' 'vi' string (Vi default: "", Vim default for
8763 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008764 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8765 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008766 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008767 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008768 feature}
8769 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008770 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8771 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008772 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008773 consisting of a single character identifying the particular parameter,
8774 followed by a number or string which specifies the value of that
8775 parameter. If a particular character is left out, then the default
8776 value is used for that parameter. The following is a list of the
8777 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008778 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008779 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008780 ! When included, save and restore global variables that start
8781 with an uppercase letter, and don't contain a lowercase
8782 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008783 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008784 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008785 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008786 " Maximum number of lines saved for each register. Old name of
8787 the '<' item, with the disadvantage that you need to put a
8788 backslash before the ", otherwise it will be recognized as the
8789 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008790 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008791 % When included, save and restore the buffer list. If Vim is
8792 started with a file name argument, the buffer list is not
8793 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008794 buffer list is restored from the viminfo file. Quickfix
8795 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8796 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008797 When followed by a number, the number specifies the maximum
8798 number of buffers that are stored. Without a number all
8799 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008800 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008801 ' Maximum number of previously edited files for which the marks
8802 are remembered. This parameter must always be included when
8803 'viminfo' is non-empty.
8804 Including this item also means that the |jumplist| and the
8805 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008806 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008807 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008808 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008809 patterns are also saved. When not included, the value of
8810 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008811 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008812 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008813 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008814 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008815 < Maximum number of lines saved for each register. If zero then
8816 registers are not saved. When not included, all lines are
8817 saved. '"' is the old name for this item.
8818 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008819 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008820 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008821 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008822 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008823 c When included, convert the text in the viminfo file from the
8824 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008825 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008826 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008827 f Whether file marks need to be stored. If zero, file marks ('0
8828 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008829 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008830 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008831 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008832 h Disable the effect of 'hlsearch' when loading the viminfo
8833 file. When not included, it depends on whether ":nohlsearch"
8834 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008835 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008836 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008837 the 'n'. Must be at the end of the option! If the
8838 'viminfofile' option is set, that file name overrides the one
8839 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008840 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008841 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008842 r Removable media. The argument is a string (up to the next
8843 ','). This parameter can be given several times. Each
8844 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008845 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008846 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8847 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8848 ignored. Maximum length of each 'r' argument is 50
8849 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008850 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008851 s Maximum size of an item in Kbyte. If zero then registers are
8852 not saved. Currently only applies to registers. The default
8853 "s10" will exclude registers with more than 10 Kbyte of text.
8854 Also see the '<' item above: line count limit.
8855
8856 Example: >
8857 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8858<
8859 '50 Marks will be remembered for the last 50 files you
8860 edited.
8861 <1000 Contents of registers (up to 1000 lines each) will be
8862 remembered.
8863 s100 Registers with more than 100 Kbyte text are skipped.
8864 :0 Command-line history will not be saved.
8865 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8866 no / Since '/' is not specified, the default will be used,
8867 that is, save all of the search history, and also the
8868 previous search and substitute patterns.
8869 no % The buffer list will not be saved nor read back.
8870 no h 'hlsearch' highlighting will be restored.
8871
8872 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8873 load the contents of the file, this is not done automatically.
8874
8875 This option cannot be set from a |modeline| or in the |sandbox|, for
8876 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008877 NOTE: This option is set to the Vim default value when 'compatible'
8878 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008879
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008880 *'viminfofile'* *'vif'*
8881'viminfofile' 'vif' string (default: "")
8882 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008883 {not available when compiled without the |+viminfo|
8884 feature}
8885 When non-empty, overrides the file name used for viminfo.
8886 When equal to "NONE" no viminfo file will be read or written.
8887 This option can be set with the |-i| command line flag. The |--clean|
8888 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008889 This option cannot be set from a |modeline| or in the |sandbox|, for
8890 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008891
Bram Moolenaar071d4272004-06-13 20:20:40 +00008892 *'virtualedit'* *'ve'*
8893'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008894 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008895 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008896 block Allow virtual editing in Visual block mode.
8897 insert Allow virtual editing in Insert mode.
8898 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008899 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008900 none When used as the local value, do not allow virtual
8901 editing even when the global value is set. When used
8902 as the global value, "none" is the same as "".
8903 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008904
Bram Moolenaar071d4272004-06-13 20:20:40 +00008905 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008906 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008907 of the line. Useful for selecting a rectangle in Visual mode and
8908 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008909 "onemore" is not the same, it will only allow moving the cursor just
8910 after the last character of the line. This makes some commands more
8911 consistent. Previously the cursor was always past the end of the line
8912 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008913 break some plugins or Vim scripts. For example because |l| can move
8914 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008915 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008916 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008917 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008918 It doesn't make sense to combine "all" with "onemore", but you will
8919 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008920 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008921 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008922
8923 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8924'visualbell' 'vb' boolean (default off)
8925 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008926 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008927 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008928 use: >
8929 :set vb t_vb=
8930< If you want a short flash, you can use this on many terminals: >
8931 :set vb t_vb=[?5h$<100>[?5l
8932< Here $<100> specifies the time, you can use a smaller or bigger value
8933 to get a shorter or longer flash.
8934
8935 Note: Vim will limit the bell to once per half a second. This avoids
8936 having to wait for the flashing to finish when there are lots of
8937 bells, e.g. on key repeat. This also happens without 'visualbell'
8938 set.
8939
Bram Moolenaar071d4272004-06-13 20:20:40 +00008940 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8941 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8942 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008943
8944 Note: When the GUI starts, 't_vb' is reset to its default value. You
8945 might want to set it again in your |gvimrc|.
8946
Bram Moolenaar071d4272004-06-13 20:20:40 +00008947 Does not work on the Amiga, you always get a screen flash.
8948 Also see 'errorbells'.
8949
8950 *'warn'* *'nowarn'*
8951'warn' boolean (default on)
8952 global
8953 Give a warning message when a shell command is used while the buffer
8954 has been changed.
8955
8956 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8957'weirdinvert' 'wiv' boolean (default off)
8958 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008959 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008960 It is provided for backwards compatibility with version 4.x.
8961 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8962 vice versa. Has no effect when the GUI is running.
8963
8964 *'whichwrap'* *'ww'*
8965'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8966 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008967 Allow specified keys that move the cursor left/right to move to the
8968 previous/next line when the cursor is on the first/last character in
8969 the line. Concatenate characters to allow this for these keys:
8970 char key mode ~
8971 b <BS> Normal and Visual
8972 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008973 h "h" Normal and Visual (not recommended)
8974 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008975 < <Left> Normal and Visual
8976 > <Right> Normal and Visual
8977 ~ "~" Normal
8978 [ <Left> Insert and Replace
8979 ] <Right> Insert and Replace
8980 For example: >
8981 :set ww=<,>,[,]
8982< allows wrap only when cursor keys are used.
8983 When the movement keys are used in combination with a delete or change
8984 operator, the <EOL> also counts for a character. This makes "3h"
8985 different from "3dh" when the cursor crosses the end of a line. This
8986 is also true for "x" and "X", because they do the same as "dl" and
8987 "dh". If you use this, you may also want to use the mapping
8988 ":map <BS> X" to make backspace delete the character in front of the
8989 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008990 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008991 line (not an empty line) then it will not move to the next line. This
8992 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008993 NOTE: This option is set to the Vi default value when 'compatible' is
8994 set and to the Vim default value when 'compatible' is reset.
8995
8996 *'wildchar'* *'wc'*
8997'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8998 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008999 Character you have to type to start wildcard expansion in the
9000 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009001 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009002 The character is not recognized when used inside a macro. See
9003 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009004 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009006 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009007< NOTE: This option is set to the Vi default value when 'compatible' is
9008 set and to the Vim default value when 'compatible' is reset.
9009
9010 *'wildcharm'* *'wcm'*
9011'wildcharm' 'wcm' number (default: none (0))
9012 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009014 recognized when used inside a macro. You can find "spare" command-line
9015 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016 you'll never actually type 'wildcharm', just use it in mappings that
9017 automatically invoke completion mode, e.g.: >
9018 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009019 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009020< Then after typing :ss you can use CTRL-P & CTRL-N.
9021
9022 *'wildignore'* *'wig'*
9023'wildignore' 'wig' string (default "")
9024 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009025 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009026 patterns is ignored when expanding |wildcards|, completing file or
9027 directory names, and influences the result of |expand()|, |glob()| and
9028 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009029 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9030 Also see 'suffixes'.
9031 Example: >
9032 :set wildignore=*.o,*.obj
9033< The use of |:set+=| and |:set-=| is preferred when adding or removing
9034 a pattern from the list. This avoids problems when a future version
9035 uses another default.
9036
Bram Moolenaar94950a92010-12-02 16:01:29 +01009037
Bram Moolenaar81af9252010-12-10 20:35:50 +01009038 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009039'wildignorecase' 'wic' boolean (default off)
9040 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009041 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009042 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009043 Does not apply when the shell is used to expand wildcards, which
9044 happens when there are special characters.
9045
9046
Bram Moolenaar071d4272004-06-13 20:20:40 +00009047 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009048'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009050 When 'wildmenu' is on, command-line completion operates in an enhanced
9051 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009052 the possible matches are shown.
9053 When 'wildoptions' contains "pum", then the completion matches are
9054 shown in a popup menu. Otherwise they are displayed just above the
9055 command line, with the first match highlighted (overwriting the status
9056 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009057 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009058 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9059 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9060 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009061 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009062 If there are more matches than can fit in the line, a ">" is shown on
9063 the right and/or a "<" is shown on the left. The status line scrolls
9064 as needed.
9065 The "wildmenu" mode is abandoned when a key is hit that is not used
9066 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009067 While the "wildmenu" is active, not using the popup menu, the
9068 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009069
9070 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9071 <Down> - in filename/menu name completion: move into a
9072 subdirectory or submenu.
9073 <CR> - in menu completion, when the cursor is just after a
9074 dot: move into a submenu.
9075 <Up> - in filename/menu name completion: move up into
9076 parent directory or parent menu.
9077
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009078 When using the popup menu for command line completion, the following
9079 keys have special meanings:
9080 <Down> - select next match (like CTRL-N)
9081 <Left> - in filename/menu name completion: move up into
9082 parent directory or parent menu.
9083 <Right> - in filename/menu name completion: move into a
9084 subdirectory or submenu.
9085 <Up> - select previous match (like CTRL-P)
9086 CTRL-E - end completion, go back to what was there before
9087 selecting a match.
9088 CTRL-N - go to the next entry
9089 CTRL-P - go to the previous entry
9090 CTRL-Y - accept the currently selected match and stop
9091 completion.
9092
Bram Moolenaar071d4272004-06-13 20:20:40 +00009093 This makes the menus accessible from the console |console-menus|.
9094
9095 If you prefer the <Left> and <Right> keys to move the cursor instead
9096 of selecting a different match, use this: >
9097 :cnoremap <Left> <Space><BS><Left>
9098 :cnoremap <Right> <Space><BS><Right>
9099<
9100 The "WildMenu" highlighting is used for displaying the current match
9101 |hl-WildMenu|.
9102
9103 *'wildmode'* *'wim'*
9104'wildmode' 'wim' string (Vim default: "full")
9105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009106 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009107 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009108 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009109 first part specifies the behavior for the first use of 'wildchar',
9110 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009111
9112 Each part consists of a colon separated list consisting of the
9113 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009114 "" Complete only the first match.
9115 "full" Complete the next full match. After the last match,
9116 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009117 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009118 "longest" Complete till longest common string. If this doesn't
9119 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009120 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009121 "lastused" When completing buffer names and more than one buffer
9122 matches, sort buffers by time last used (other than
9123 the current buffer).
9124 When there is only a single match, it is fully completed in all cases.
9125
9126 Examples of useful colon-separated values:
9127 "longest:full" Like "longest", but also start 'wildmenu' if it is
9128 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009129 "list:full" When more than one match, list all matches and
9130 complete first match.
9131 "list:longest" When more than one match, list all matches and
9132 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009133 "list:lastused" When more than one buffer matches, list all matches
9134 and sort buffers by time last used (other than the
9135 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009136
9137 Examples: >
9138 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009139< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009140 :set wildmode=longest,full
9141< Complete longest common string, then each full match >
9142 :set wildmode=list:full
9143< List all matches and complete each full match >
9144 :set wildmode=list,full
9145< List all matches without completing, then each full match >
9146 :set wildmode=longest,list
9147< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009148 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009149
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009150 *'wildoptions'* *'wop'*
9151'wildoptions' 'wop' string (default "")
9152 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009153 A list of words that change how |cmdline-completion| is done.
9154 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009155 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009156 this value is specified, wildcard expansion will not
9157 be used for completion. The matches will be sorted by
9158 the "best match" rather than alphabetically sorted.
9159 This will find more matches than the wildcard
9160 expansion. Currently fuzzy matching based completion
9161 is not supported for file and directory names and
9162 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009163 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009164 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009165 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009166 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009167 is displayed per line. Often used tag kinds are:
9168 d #define
9169 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009170
Bram Moolenaar071d4272004-06-13 20:20:40 +00009171 *'winaltkeys'* *'wak'*
9172'winaltkeys' 'wak' string (default "menu")
9173 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009174 {only used in Win32, Motif, GTK and Photon GUI}
9175 Some GUI versions allow the access to menu entries by using the ALT
9176 key in combination with a character that appears underlined in the
9177 menu. This conflicts with the use of the ALT key for mappings and
9178 entering special characters. This option tells what to do:
9179 no Don't use ALT keys for menus. ALT key combinations can be
9180 mapped, but there is no automatic handling. This can then be
9181 done with the |:simalt| command.
9182 yes ALT key handling is done by the windowing system. ALT key
9183 combinations cannot be mapped.
9184 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009185 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009186 keys can be mapped.
9187 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9188 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009189 This option is not used for <F10>; on Win32 and with GTK <F10> will
9190 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009191
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009192 *'wincolor'* *'wcr'*
9193'wincolor' 'wcr' string (default empty)
9194 local to window
9195 Highlight group name to use for this window instead of the Normal
9196 color |hl-Normal|.
9197
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009198 *'window'* *'wi'*
9199'window' 'wi' number (default screen height - 1)
9200 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009201 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9202 window and the value is smaller than 'lines' minus one. The screen
9203 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009204 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9205 in a much smarter way, taking care of wrapping lines.
9206 When resizing the Vim window, the value is smaller than 1 or more than
9207 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009208 Note: Do not confuse this with the height of the Vim window, use
9209 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009210
Bram Moolenaar071d4272004-06-13 20:20:40 +00009211 *'winheight'* *'wh'* *E591*
9212'winheight' 'wh' number (default 1)
9213 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009214 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009215 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009216 focus goes to a window that is smaller, its size is increased, at the
9217 cost of the height of other windows.
9218 Set 'winheight' to a small number for normal editing.
9219 Set it to 999 to make the current window fill most of the screen.
9220 Other windows will be only 'winminheight' high. This has the drawback
9221 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9222 to create only two windows, set the option after startup is done,
9223 using the |VimEnter| event: >
9224 au VimEnter * set winheight=999
9225< Minimum value is 1.
9226 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009227 height of the current window.
9228 'winheight' applies to the current window. Use 'winminheight' to set
9229 the minimal height for other windows.
9230
9231 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9232'winfixheight' 'wfh' boolean (default off)
9233 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009234 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009235 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9236 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009237 The height may be changed anyway when running out of room.
9238
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009239 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9240'winfixwidth' 'wfw' boolean (default off)
9241 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009242 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009243 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009244 The width may be changed anyway when running out of room.
9245
Bram Moolenaar071d4272004-06-13 20:20:40 +00009246 *'winminheight'* *'wmh'*
9247'winminheight' 'wmh' number (default 1)
9248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009249 The minimal height of a window, when it's not the current window.
9250 This is a hard minimum, windows will never become smaller.
9251 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9252 status bar) if necessary. They will return to at least one line when
9253 they become active (since the cursor has to have somewhere to go.)
9254 Use 'winheight' to set the minimal height of the current window.
9255 This option is only checked when making a window smaller. Don't use a
9256 large number, it will cause errors when opening more than a few
9257 windows. A value of 0 to 3 is reasonable.
9258
9259 *'winminwidth'* *'wmw'*
9260'winminwidth' 'wmw' number (default 1)
9261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009262 The minimal width 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 columns (i.e. just
9265 a vertical separator) if necessary. They will return to at least one
9266 line when they become active (since the cursor has to have somewhere
9267 to go.)
9268 Use 'winwidth' to set the minimal width of the current window.
9269 This option is only checked when making a window smaller. Don't use a
9270 large number, it will cause errors when opening more than a few
9271 windows. A value of 0 to 12 is reasonable.
9272
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009273 *'winptydll'*
9274'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9275 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009276 {only available when compiled with the |terminal|
9277 feature on MS-Windows}
9278 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009279 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009280 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009281 a fallback.
9282 Environment variables are expanded |:set_env|.
9283 This option cannot be set from a |modeline| or in the |sandbox|, for
9284 security reasons.
9285
Bram Moolenaar071d4272004-06-13 20:20:40 +00009286 *'winwidth'* *'wiw'* *E592*
9287'winwidth' 'wiw' number (default 20)
9288 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009289 Minimal number of columns for the current window. This is not a hard
9290 minimum, Vim will use fewer columns if there is not enough room. If
9291 the current window is smaller, its size is increased, at the cost of
9292 the width of other windows. Set it to 999 to make the current window
9293 always fill the screen. Set it to a small number for normal editing.
9294 The width is not adjusted after one of the commands to change the
9295 width of the current window.
9296 'winwidth' applies to the current window. Use 'winminwidth' to set
9297 the minimal width for other windows.
9298
9299 *'wrap'* *'nowrap'*
9300'wrap' boolean (default on)
9301 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009302 This option changes how text is displayed. It doesn't change the text
9303 in the buffer, see 'textwidth' for that.
9304 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009305 displaying continues on the next line. When off lines will not wrap
9306 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009307 moved to a part that is not shown, the screen will scroll
9308 horizontally.
9309 The line will be broken in the middle of a word if necessary. See
9310 'linebreak' to get the break at a word boundary.
9311 To make scrolling horizontally a bit more useful, try this: >
9312 :set sidescroll=5
9313 :set listchars+=precedes:<,extends:>
9314< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009315 This option can't be set from a |modeline| when the 'diff' option is
9316 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009317
9318 *'wrapmargin'* *'wm'*
9319'wrapmargin' 'wm' number (default 0)
9320 local to buffer
9321 Number of characters from the right window border where wrapping
9322 starts. When typing text beyond this limit, an <EOL> will be inserted
9323 and inserting continues on the next line.
9324 Options that add a margin, such as 'number' and 'foldcolumn', cause
9325 the text width to be further reduced. This is Vi compatible.
9326 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009327 This option is set to 0 when 'paste' is set and restored when 'paste'
9328 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009329 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009330
9331 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9332'wrapscan' 'ws' boolean (default on) *E384* *E385*
9333 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009334 Searches wrap around the end of the file. Also applies to |]s| and
9335 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009336
9337 *'write'* *'nowrite'*
9338'write' boolean (default on)
9339 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009340 Allows writing files. When not set, writing a file is not allowed.
9341 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009342 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009343 argument. Filtering text is still possible, even though this requires
9344 writing a temporary file.
9345
9346 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9347'writeany' 'wa' boolean (default off)
9348 global
9349 Allows writing to any file with no need for "!" override.
9350
9351 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9352'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9353 otherwise)
9354 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009355 Make a backup before overwriting a file. The backup is removed after
9356 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009357 also on.
9358 WARNING: Switching this option off means that when Vim fails to write
9359 your buffer correctly and then, for whatever reason, Vim exits, you
9360 lose both the original file and what you were writing. Only reset
9361 this option if your file system is almost full and it makes the write
9362 fail (and make sure not to exit Vim until the write was successful).
9363 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009364 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009365 Depending on 'backupcopy' the backup is a new file or the original
9366 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009367 NOTE: This option is set to the default value when 'compatible' is
9368 set.
9369
9370 *'writedelay'* *'wd'*
9371'writedelay' 'wd' number (default 0)
9372 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009373 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009374 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009375 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009376
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009377 *'xtermcodes'* *'noxtermcodes'*
9378'xtermcodes' boolean (default on)
9379 global
9380 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009381 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009382 key codes and number of colors from the terminal. This takes care of
9383 various configuration options of the terminal that cannot be obtained
9384 from the termlib/terminfo entry, see |xterm-codes|.
9385 A side effect may be that t_Co changes and Vim will redraw the
9386 display.
9387
9388
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009389 vim:tw=78:ts=8:noet:ft=help:norl: