blob: 799b856a7b6c4750d691ff7dc21653b79c28f468 [file] [log] [blame]
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01001*options.txt* For Vim version 8.2. Last change: 2022 Jun 02
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
37
Bram Moolenaar47003982021-12-05 21:54:04 +000038:se[t]! termcap Idem, but don't use multiple columns.
39
Bram Moolenaar071d4272004-06-13 20:20:40 +000040 *E518* *E519*
41:se[t] {option}? Show value of {option}.
42
43:se[t] {option} Toggle option: set, switch it on.
44 Number option: show value.
45 String option: show value.
46
47:se[t] no{option} Toggle option: Reset, switch it off.
48
Bram Moolenaar00a927d2010-05-14 23:24:24 +020049 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000050:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020051:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000052
53 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
54:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020055 current value of 'compatible'.
56:se[t] {option}&vi Reset option to its Vi default value.
57:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000058
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010059:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020060 these options are not changed:
61 all terminal options, starting with t_
62 'columns'
63 'cryptmethod'
64 'encoding'
65 'key'
66 'lines'
67 'term'
68 'ttymouse'
69 'ttytype'
70 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000071
72 *:set-args* *E487* *E521*
73:se[t] {option}={value} or
74:se[t] {option}:{value}
75 Set string or number option to {value}.
76 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010077 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000078 The old value can be inserted by typing 'wildchar' (by
79 default this is a <Tab> or CTRL-E if 'compatible' is
80 set). See |cmdline-completion|.
81 White space between {option} and '=' is allowed and
82 will be ignored. White space between '=' and {value}
83 is not allowed.
84 See |option-backslash| for using white space and
85 backslashes in {value}.
86
87:se[t] {option}+={value} *:set+=*
88 Add the {value} to a number option, or append the
89 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010090 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 value was empty.
92 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000093 are removed. When adding a flag that was already
94 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000095 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000096
97:se[t] {option}^={value} *:set^=*
98 Multiply the {value} to a number option, or prepend
99 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100100 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101 value was empty.
102 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103
104:se[t] {option}-={value} *:set-=*
105 Subtract the {value} from a number option, or remove
106 the {value} from a string option, if it is there.
107 If the {value} is not found in a string option, there
108 is no error or warning. When the option is a comma
109 separated list, a comma is deleted, unless the option
110 becomes empty.
111 When the option is a list of flags, {value} must be
112 exactly as they appear in the option. Remove flags
113 one by one to avoid problems.
114 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115
116The {option} arguments to ":set" may be repeated. For example: >
117 :set ai nosi sw=3 ts=3
118If you make an error in one of the arguments, an error message will be given
119and the following arguments will be ignored.
120
121 *:set-verbose*
122When 'verbose' is non-zero, displaying an option value will also tell where it
123was last set. Example: >
124 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200125< shiftwidth=4 ~
126 Last set from modeline line 1 ~
127 cindent ~
128 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000129This is only done when specific option values are requested, not for ":verbose
130set all" or ":verbose set" without an argument.
131When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000132When the option was set while executing a function, user command or
133autocommand, the script in which it was defined is reported.
134Note that an option may also have been set as a side effect of setting
135'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200137 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000138 Option was set in a |modeline|.
139 Last set from --cmd argument ~
140 Option was set with command line argument |--cmd| or +.
141 Last set from -c argument ~
142 Option was set with command line argument |-c|, +, |-S| or
143 |-q|.
144 Last set from environment variable ~
145 Option was set from an environment variable, $VIMINIT,
146 $GVIMINIT or $EXINIT.
147 Last set from error handler ~
148 Option was cleared when evaluating it resulted in an error.
149
Bram Moolenaardb84e452010-08-15 13:50:43 +0200150{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151
152 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000153For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000154override the value from the termcap. You can then use it in a mapping. If
155the "xx" part contains special characters, use the <t_xx> form: >
156 :set <t_#4>=^[Ot
157This can also be used to translate a special code for a normal key. For
158example, if Alt-b produces <Esc>b, use this: >
159 :set <M-b>=^[b
160(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
161The advantage over a mapping is that it works in all situations.
162
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100163You can define any key codes, e.g.: >
164 :set t_xy=^[foo;
165There is no warning for using a name that isn't recognized. You can map these
166codes as you like: >
167 :map <t_xy> something
168< *E846*
169When a key code is not set, it's like it does not exist. Trying to get its
170value will result in an error: >
171 :set t_kb=
172 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000173< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100174
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000175The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
176security reasons.
177
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000179at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180"set all" probably does not fit on the screen, causing Vim to give the
181|more-prompt|.
182
183 *option-backslash*
184To include white space in a string option value it has to be preceded with a
185backslash. To include a backslash you have to use two. Effectively this
186means that the number of backslashes in an option value is halved (rounded
187down).
188A few examples: >
189 :set tags=tags\ /usr/tags results in "tags /usr/tags"
190 :set tags=tags\\,file results in "tags\,file"
191 :set tags=tags\\\ file results in "tags\ file"
192
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000193The "|" character separates a ":set" command from a following command. To
194include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195'titlestring' option to "hi|there": >
196 :set titlestring=hi\|there
197This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
198 :set titlestring=hi|set iconstring=there
199
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200200Similarly, in legacy script the double quote character starts a comment. To
201include the '"' in the option value, use '\"' instead. This example sets the
202'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000203 :set titlestring=hi\ \"there\"
204
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200205In |Vim9| script it's simpler, comments start with a '#' character, and only
206when preceded by white space. A backslash is needed less often: >
207 vim9script
208 set titlestring=hi\ "there"
209 set titlestring=hi#there#
210 set titlestring=hi\ \#there#
211
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100212For Win32 backslashes in file names are mostly not removed. More precise: For
213options that expect a file name (those where environment variables are
214expanded) a backslash before a normal file name character is not removed. But
215a backslash before a special character (space, backslash, comma, etc.) is used
216like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217There is one special situation, when the value starts with "\\": >
218 :set dir=\\machine\path results in "\\machine\path"
219 :set dir=\\\\machine\\path results in "\\machine\path"
220 :set dir=\\path\\file results in "\\path\file" (wrong!)
221For the first one the start is kept, but for the second one the backslashes
222are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000223halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224result which is probably not what you want. Avoid it.
225
226 *add-option-flags* *remove-option-flags*
227 *E539* *E550* *E551* *E552*
228Some options are a list of flags. When you want to add a flag to such an
229option, without changing the existing ones, you can do it like this: >
230 :set guioptions+=a
231Remove a flag from an option like this: >
232 :set guioptions-=a
233This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000234Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
236doesn't appear.
237
238 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000239Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000240environment variable exists the '$' and the following environment variable
241name is replaced with its value. If it does not exist the '$' and the name
242are not modified. Any non-id character (not a letter, digit or '_') may
243follow the environment variable name. That character and what follows is
244appended to the value of the environment variable. Examples: >
245 :set term=$TERM.new
246 :set path=/usr/$INCLUDE,$HOME/include,.
247When adding or removing a string from an option with ":set opt-=val" or ":set
248opt+=val" the expansion is done before the adding or removing.
249
250
251Handling of local options *local-options*
252
253Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100254has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255allows you to set 'list' in one window but not in another. And set
256'shiftwidth' to 3 in one buffer and 4 in another.
257
258The following explains what happens to these local options in specific
259situations. You don't really need to know all of this, since Vim mostly uses
260the option values you would expect. Unfortunately, doing what the user
261expects is a bit complicated...
262
263When splitting a window, the local options are copied to the new window. Thus
264right after the split the contents of the two windows look the same.
265
266When editing a new buffer, its local option values must be initialized. Since
267the local options of the current buffer might be specifically for that buffer,
268these are not used. Instead, for each buffer-local option there also is a
269global value, which is used for new buffers. With ":set" both the local and
270global value is changed. With "setlocal" only the local value is changed,
271thus this value is not used when editing a new buffer.
272
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200273When editing a buffer that has been edited before, the options from the window
274that was last closed are used again. If this buffer has been edited in this
275window, the values from back then are used. Otherwise the values from the
276last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277
278It's possible to set a local window option specifically for a type of buffer.
279When you edit another buffer in the same window, you don't want to keep
280using these local window options. Therefore Vim keeps a global value of the
281local window options, which is used when editing another buffer. Each window
282has its own copy of these values. Thus these are local to the window, but
283global to all buffers in the window. With this you can do: >
284 :e one
285 :set list
286 :e two
287Now the 'list' option will also be set in "two", since with the ":set list"
288command you have also set the global value. >
289 :set nolist
290 :e one
291 :setlocal list
292 :e two
293Now the 'list' option is not set, because ":set nolist" resets the global
294value, ":setlocal list" only changes the local value and ":e two" gets the
295global value. Note that if you do this next: >
296 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200297You will get back the 'list' value as it was the last time you edited "one".
298The options local to a window are remembered for each buffer. This also
299happens when the buffer is not loaded, but they are lost when the buffer is
300wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301
302 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100303:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304 current buffer or window. Not all options have a
305 local value. If the option does not have a local
306 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200307 With the "all" argument: display local values for all
308 local options.
309 Without argument: Display local values for all local
310 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000312 local value. For a global/local boolean option, when
313 the global value is being used, "--" is displayed
314 before the option name.
315 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000318:setl[ocal] {option}< Set the local value of {option} to its global value by
319 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000320
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100321:se[t] {option}< For |global-local| options: Remove the local value of
322 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100325:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 option without changing the local value.
327 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200328 With the "all" argument: display global values for all
329 local options.
330 Without argument: display global values for all local
331 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332
333For buffer-local and window-local options:
334 Command global value local value ~
335 :set option=value set set
336 :setlocal option=value - set
337:setglobal option=value set -
338 :set option? - display
339 :setlocal option? - display
340:setglobal option? display -
341
342
343Global options with a local value *global-local*
344
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000345Options are global when you mostly use one value for all buffers and windows.
346For some global options it's useful to sometimes have a different local value.
347You can set the local value with ":setlocal". That buffer or window will then
348use the local value, while other buffers and windows continue using the global
349value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350
351For example, you have two windows, both on C source code. They use the global
352'makeprg' option. If you do this in one of the two windows: >
353 :set makeprg=gmake
354then the other window will switch to the same value. There is no need to set
355the 'makeprg' option in the other C source window too.
356However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000357another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000358files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359 :setlocal makeprg=perlmake
360You can switch back to using the global value by making the local value empty: >
361 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100362This only works for a string option. For a number or boolean option you need
363to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000364 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100365Note that for non-boolean and non-number options using "<" copies the global
366value to the local value, it doesn't switch back to using the global value
367(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000368 :set path<
369This will make the local value of 'path' empty, so that the global value is
370used. Thus it does the same as: >
371 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000372Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373":setlocal" on a global option might work differently then.
374
375
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000376 *option-value-function*
377Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000378'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000379a function name or a function reference or a lambda function. When using a
380lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000381>
382 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000383 set opfunc=function('MyOpFunc')
384 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000385 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000386
387Set to a script-local function: >
388 set opfunc=s:MyLocalFunc
389 set opfunc=<SID>MyLocalFunc
390In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
391the script: >
392 set opfunc=MyLocalFunc
393
394Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000395 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000396 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000397
398Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000399 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000400
401Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000402 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000403 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000404
405In Vim9 script, in a compiled function, you can use a lambda, but a
406closured does not work, because the function will be called without the
407context of where it was defined.
408
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000409
Bram Moolenaar071d4272004-06-13 20:20:40 +0000410Setting the filetype
411
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200412:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413 Set the 'filetype' option to {filetype}, but only if
414 not done yet in a sequence of (nested) autocommands.
415 This is short for: >
416 :if !did_filetype()
417 : setlocal filetype={filetype}
418 :endif
419< This command is used in a filetype.vim file to avoid
420 setting the 'filetype' option twice, causing different
421 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200422
423 When the optional FALLBACK argument is present, a
424 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100425 'filetype'. This is to be used for filetype
426 detections that are just a guess. |did_filetype()|
427 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200428
Bram Moolenaard58e9292011-02-09 17:07:58 +0100429 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
431:opt[ions] Open a window for viewing and setting all options.
432 Options are grouped by function.
433 Offers short help for each option. Hit <CR> on the
434 short help to open a help window with more help for
435 the option.
436 Modify the value of the option and hit <CR> on the
437 "set" line to set the new value. For window and
438 buffer specific options, the last accessed window is
439 used to set the option value in, unless this is a help
440 window, in which case the window below help window is
441 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100442 {not available when compiled without the |+eval|
443 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000444
445 *$HOME*
446Using "~" is like using "$HOME", but it is only recognized at the start of an
447option and after a space or comma.
448
449On Unix systems "~user" can be used too. It is replaced by the home directory
450of user "user". Example: >
451 :set path=~mool/include,/usr/include,.
452
453On Unix systems the form "${HOME}" can be used too. The name between {} can
454contain non-id characters then. Note that if you want to use this for the
455"gf" command, you need to add the '{' and '}' characters to 'isfname'.
456
457NOTE: expanding environment variables and "~/" is only done with the ":set"
458command, not when assigning a value to an option with ":let".
459
Bram Moolenaarc572da52017-08-27 16:52:01 +0200460 *$HOME-windows*
461On MS-Windows, if $HOME is not defined as an environment variable, then
462at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200463If $HOMEDRIVE is not set then $USERPROFILE is used.
464
465This expanded value is not exported to the environment, this matters when
466running an external command: >
467 :echo system('set | findstr ^HOME=')
468and >
469 :echo luaeval('os.getenv("HOME")')
470should echo nothing (an empty string) despite exists('$HOME') being true.
471When setting $HOME to a non-empty string it will be exported to the
472subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200473
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474
475Note the maximum length of an expanded option is limited. How much depends on
476the system, mostly it is something like 256 or 1024 characters.
477
478 *:fix* *:fixdel*
479:fix[del] Set the value of 't_kD':
480 't_kb' is 't_kD' becomes ~
481 CTRL-? CTRL-H
482 not CTRL-? CTRL-?
483
Bram Moolenaar82be4842021-01-11 19:40:15 +0100484 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000485
486 If your delete key terminal code is wrong, but the
487 code for backspace is alright, you can put this in
488 your .vimrc: >
489 :fixdel
490< This works no matter what the actual code for
491 backspace is.
492
493 If the backspace key terminal code is wrong you can
494 use this: >
495 :if &term == "termname"
496 : set t_kb=^V<BS>
497 : fixdel
498 :endif
499< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000500 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000501 with your terminal name.
502
503 If your <Delete> key sends a strange key sequence (not
504 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
505 :if &term == "termname"
506 : set t_kD=^V<Delete>
507 :endif
508< Where "^V" is CTRL-V and "<Delete>" is the delete key
509 (don't type eight characters!). Replace "termname"
510 with your terminal name.
511
512 *Linux-backspace*
513 Note about Linux: By default the backspace key
514 produces CTRL-?, which is wrong. You can fix it by
515 putting this line in your rc.local: >
516 echo "keycode 14 = BackSpace" | loadkeys
517<
518 *NetBSD-backspace*
519 Note about NetBSD: If your backspace doesn't produce
520 the right code, try this: >
521 xmodmap -e "keycode 22 = BackSpace"
522< If this works, add this in your .Xmodmap file: >
523 keysym 22 = BackSpace
524< You need to restart for this to take effect.
525
526==============================================================================
5272. Automatically setting options *auto-setting*
528
529Besides changing options with the ":set" command, there are three alternatives
530to set options automatically for one or more files:
531
5321. When starting Vim initializations are read from various places. See
533 |initialization|. Most of them are performed for all editing sessions,
534 and some of them depend on the directory where Vim is started.
535 You can create an initialization file with |:mkvimrc|, |:mkview| and
536 |:mksession|.
5372. If you start editing a new file, the automatic commands are executed.
538 This can be used to set options for files matching a particular pattern and
539 many other things. See |autocommand|.
5403. If you start editing a new file, and the 'modeline' option is on, a
541 number of lines at the beginning and end of the file are checked for
542 modelines. This is explained here.
543
544 *modeline* *vim:* *vi:* *ex:* *E520*
545There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100546 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100548[text{white}] empty or any text followed by at least one blank
549 character (<Space> or <Tab>); "ex:" always requires at
550 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200551{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200552[white] optional white space
553{options} a list of option settings, separated with white space
554 or ':', where each part between ':' is the argument
555 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556
Bram Moolenaar14b69452013-06-29 23:05:20 +0200557Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000558 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200559 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560
561The second form (this is compatible with some versions of Vi):
562
Bram Moolenaarade0d392020-01-21 22:33:58 +0100563 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
Bram Moolenaarade0d392020-01-21 22:33:58 +0100565[text{white}] empty or any text followed by at least one blank
566 character (<Space> or <Tab>); "ex:" always requires at
567 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200568{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
569[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200570se[t] the string "set " or "se " (note the space); When
571 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200572{options} a list of options, separated with white space, which
573 is the argument for a ":set" command
574: a colon
575[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576
Bram Moolenaar14b69452013-06-29 23:05:20 +0200577Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000578 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200579 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000580
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200581The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
582chance that a normal word like "lex:" is caught. There is one exception:
583"vi:" and "vim:" can also be at the start of the line (for compatibility with
584version 3.0). Using "ex:" at the start of the line will be ignored (this
585could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586
Hu Jialun9dcd3492021-08-28 20:42:50 +0200587If the modeline is disabled within a modeline, subsequent modelines will be
588ignored. This is to allow turning off modeline on a per-file basis. This is
589useful when a line looks like a modeline but isn't. For example, it would be
590good to start a YAML file containing strings like "vim:" with
591 # vim: nomodeline ~
592so as to avoid modeline misdetection. Following options on the same line
593after modeline deactivation, if any, are still evaluated (but you would
594normally not have any).
595
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596 *modeline-local*
597The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000598buffer and window that contain the file. Although it's possible to set global
599options from a modeline, this is unusual. If you have two windows open and
600the files in it set the same global option to a different value, the result
601depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000602
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000603When editing a file that was already loaded, only the window-local options
604from the modeline are used. Thus if you manually changed a buffer-local
605option after opening the file, it won't be changed if you edit the same buffer
606in another window. But window-local options will be set.
607
Bram Moolenaar071d4272004-06-13 20:20:40 +0000608 *modeline-version*
609If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200610number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 vim{vers}: version {vers} or later
612 vim<{vers}: version before {vers}
613 vim={vers}: version {vers}
614 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100615{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
616For example, to use a modeline only for Vim 7.0:
617 /* vim700: set foldmethod=marker */ ~
618To use a modeline for Vim after version 7.2:
619 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620There can be no blanks between "vim" and the ":".
621
622
623The number of lines that are checked can be set with the 'modelines' option.
624If 'modeline' is off or 'modelines' is 0 no lines are checked.
625
626Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000627like:
628 /* vi:ts=4: */ ~
629will give an error message for the trailing "*/". This line is OK:
630 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631
632If an error is detected the rest of the line is skipped.
633
634If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000635backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100636 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
637This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
638before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200639 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000641might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200642can be set. For some options a flag is set, so that when the value is used
643the |sandbox| is effective. Some options can only be set from the modeline
644when 'modelineexpr' is set (the default is off).
645
646Still, there is always a small risk that a modeline causes trouble. E.g.,
647when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
648So disable modelines before editing untrusted text. The mail ftplugin does
649this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650
651Hint: If you would like to do something else than setting an option, you could
652define an autocommand that checks the file for a specific string. For
653example: >
654 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
655And define a function SetVar() that does something with the line containing
656"VAR".
657
658==============================================================================
6593. Options summary *option-summary*
660
661In the list below all the options are mentioned with their full name and with
662an abbreviation if there is one. Both forms may be used.
663
664In this document when a boolean option is "set" that means that ":set option"
665is entered. When an option is "reset", ":set nooption" is used.
666
667For some options there are two default values: The "Vim default", which is
668used when 'compatible' is not set, and the "Vi default", which is used when
669'compatible' is set.
670
671Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000672are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673different value in each window. For example the 'list' option can be set in
674one window and reset in another for the same text, giving both types of view
675at the same time. There are a few options that are specific to a certain
676file. These can have a different value for each file or buffer. For example
677the 'textwidth' option can be 78 for a normal text file and 0 for a C
678program.
679
680 global one option for all buffers and windows
681 local to window each window has its own copy of this option
682 local to buffer each buffer has its own copy of this option
683
684When creating a new window the option values from the currently active window
685are used as a default value for the window-specific options. For the
686buffer-specific options this depends on the 's' and 'S' flags in the
687'cpoptions' option. If 's' is included (which is the default) the values for
688buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000689first entered. If 'S' is present the options are copied each time the buffer
690is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691present, the options are copied from the currently active buffer when the
692buffer is created.
693
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000694Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000696Not all options are supported in all versions. This depends on the supported
697features and sometimes on the system. A remark about this is in curly braces
698below. When an option is not supported it may still be set without getting an
699error, this is called a hidden option. You can't get the value of a hidden
700option though, it is not stored.
701
702To test if option "foo" can be used with ":set" use something like this: >
703 if exists('&foo')
704This also returns true for a hidden option. To test if option "foo" is really
705supported use something like this: >
706 if exists('+foo')
707<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708 *E355*
709A jump table for the options with a short description can be found at |Q_op|.
710
711 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100712'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714 {only available when compiled with the |+rightleft|
715 feature}
716 The ASCII code for the first letter of the Hebrew alphabet. The
717 routine that maps the keyboard in Hebrew mode, both in Insert mode
718 (when hkmap is set) and on the command-line (when hitting CTRL-_)
719 outputs the Hebrew characters in the range [aleph..aleph+26].
720 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
721 See |rileft.txt|.
722
723 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
724'allowrevins' 'ari' boolean (default off)
725 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726 {only available when compiled with the |+rightleft|
727 feature}
728 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
729 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
730 into reverse Insert mode, and don't know how to get out. See
731 'revins'.
732 NOTE: This option is reset when 'compatible' is set.
733
734 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
735'altkeymap' 'akm' boolean (default off)
736 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737 {only available when compiled with the |+farsi|
738 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100739 This option was for using Farsi, which has been removed. See
740 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741
742 *'ambiwidth'* *'ambw'*
743'ambiwidth' 'ambw' string (default: "single")
744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000745 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
746 Tells Vim what to do with characters with East Asian Width Class
747 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
748 letters, Cyrillic letters).
749
750 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000751 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 expected by most users.
753 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200754 *E834* *E835*
755 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100756 contains a character that would be double width. These errors may
757 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200758
759 The values are overruled for characters specified with
760 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761
762 There are a number of CJK fonts for which the width of glyphs for
763 those characters are solely based on how many octets they take in
764 legacy/traditional CJK encodings. In those encodings, Euro,
765 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000766 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000768 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 Vim is running inside a terminal (emulators) that uses a CJK font
770 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
771 this option should be set to "double" to match the width perceived
772 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100773 to be set to "double" under CJK MS-Windows when the system locale is
774 set to one of CJK locales. See Unicode Standard Annex #11
775 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100777 Vim may set this option automatically at startup time when Vim is
778 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200779 escape sequence to request cursor position report. The response can
780 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100781
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
783'antialias' 'anti' boolean (default: off)
784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200786 on macOS}
787 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
789 which can be easier to read at certain sizes on certain displays.
790 Setting this option can sometimes cause problems if 'guifont' is set
791 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100792 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793
794 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
795'autochdir' 'acd' boolean (default off)
796 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200797 {only available when compiled with it, use
798 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000799 When on, Vim will change the current working directory whenever you
800 open a file, switch buffers, delete a buffer or open/close a window.
801 It will change to the directory containing the file which was opened
802 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000803 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200805 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
806'autoshelldir' 'asd' boolean (default off)
807 global
808 When on, Vim will change the current working directory whenever you
809 change the directory of the shell running in a terminal window. You
810 need proper setting-up, so whenever the shell's pwd changes an OSC 7
811 escape sequence will be emitted. For example, on Linux, you can source
812 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000813 When the parsing of the OSC sequence fails you get *E1179* .
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200814
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
816'arabic' 'arab' boolean (default off)
817 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 {only available when compiled with the |+arabic|
819 feature}
820 This option can be set to start editing Arabic text.
821 Setting this option will:
822 - Set the 'rightleft' option, unless 'termbidi' is set.
823 - Set the 'arabicshape' option, unless 'termbidi' is set.
824 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
825 between typing English and Arabic key mapping.
826 - Set the 'delcombine' option
827 Note that 'encoding' must be "utf-8" for working with Arabic text.
828
829 Resetting this option will:
830 - Reset the 'rightleft' option.
831 - Disable the use of 'keymap' (without changing its value).
832 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200833 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100834 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 Also see |arabic.txt|.
836
837 *'arabicshape'* *'arshape'*
838 *'noarabicshape'* *'noarshape'*
839'arabicshape' 'arshape' boolean (default on)
840 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 {only available when compiled with the |+arabic|
842 feature}
843 When on and 'termbidi' is off, the required visual character
844 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200845 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 one which encompasses:
847 a) the changing/morphing of characters based on their location
848 within a word (initial, medial, final and stand-alone).
849 b) the enabling of the ability to compose characters
850 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100851 When disabled the display shows each character's true stand-alone
852 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 Arabic is a complex language which requires other settings, for
854 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100855 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856
857 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
858'autoindent' 'ai' boolean (default off)
859 local to buffer
860 Copy indent from current line when starting a new line (typing <CR>
861 in Insert mode or when using the "o" or "O" command). If you do not
862 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000863 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
864 to another line has the same effect, unless the 'I' flag is included
865 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000866 When autoindent is on, formatting (with the "gq" command or when you
867 reach 'textwidth' in Insert mode) uses the indentation of the first
868 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 When 'smartindent' or 'cindent' is on the indent is changed in
870 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200871 The 'autoindent' option is reset when the 'paste' option is set and
872 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873
874 *'autoread'* *'ar'* *'noautoread'* *'noar'*
875'autoread' 'ar' boolean (default off)
876 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877 When a file has been detected to have been changed outside of Vim and
878 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200879 When the file has been deleted this is not done, so you have the text
880 from before it was deleted. When it appears again then it is read.
881 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882 If this option has a local value, use this command to switch back to
883 using the global value: >
884 :set autoread<
885<
886 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
887'autowrite' 'aw' boolean (default off)
888 global
889 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000890 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000891 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
892 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000893 to another file.
894 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000895 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896 Note that for some commands the 'autowrite' option is not used, see
897 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200898 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200899 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900
901 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
902'autowriteall' 'awa' boolean (default off)
903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
905 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
906 Setting this option also implies that Vim behaves like 'autowrite' has
907 been set.
908
909 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200910'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912 When set to "dark", Vim will try to use colors that look good on a
913 dark background. When set to "light", Vim will try to use colors that
914 look good on a light background. Any other value is illegal.
915 Vim tries to set the default value according to the terminal used.
916 This will not always be correct.
917 Setting this option does not change the background color, it tells Vim
918 what the background color looks like. For changing the background
919 color, see |:hi-normal|.
920
921 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000922 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000923 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100924 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 setting 'background' will cause the color scheme to be reloaded. If
926 the color scheme adjusts to the value of 'background' this will work.
927 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100928 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929
930 When setting 'background' to the default value with: >
931 :set background&
932< Vim will guess the value. In the GUI this should work correctly,
933 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200934 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200935 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200937 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200938 color from the terminal. If the returned RGB value is dark/light and
939 'background' is not dark/light, 'background' will be set and the
940 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200941 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100942 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200943
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944 When starting the GUI, the default value for 'background' will be
945 "light". When the value is not set in the .gvimrc, and Vim detects
946 that the background is actually quite dark, 'background' is set to
947 "dark". But this happens only AFTER the .gvimrc file has been read
948 (because the window needs to be opened to find the actual background
949 color). To get around this, force the GUI window to be opened by
950 putting a ":gui" command in the .gvimrc file, before where the value
951 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200952
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100953 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200954 For other systems "dark" is used when 'term' is "linux",
955 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
956 background. Otherwise the default is "light".
957
Bram Moolenaarc572da52017-08-27 16:52:01 +0200958 The |:terminal| command and the |term_start()| function use the
959 'background' value to decide whether the terminal window will start
960 with a white or black background.
961
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962 Normally this option would be set in the .vimrc file. Possibly
963 depending on the terminal name. Example: >
964 :if &term == "pcterm"
965 : set background=dark
966 :endif
967< When this option is set, the default settings for the highlight groups
968 will change. To use other settings, place ":highlight" commands AFTER
969 the setting of the 'background' option.
970 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
971 to select the colors for syntax highlighting. After changing this
972 option, you must load syntax.vim again to see the result. This can be
973 done with ":syntax on".
974
975 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200976'backspace' 'bs' string (default "", set to "indent,eol,start"
977 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
980 mode. This is a list of items, separated by commas. Each item allows
981 a way to backspace over something:
982 value effect ~
983 indent allow backspacing over autoindent
984 eol allow backspacing over line breaks (join lines)
985 start allow backspacing over the start of insert; CTRL-W and CTRL-U
986 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200987 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
988 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989
Bram Moolenaar46eea442022-03-30 10:51:39 +0100990 When the value is empty, Vi compatible backspacing is used, none of
991 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992
993 For backwards compatibility with version 5.4 and earlier:
994 value effect ~
995 0 same as ":set backspace=" (Vi compatible)
996 1 same as ":set backspace=indent,eol"
997 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200998 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999
1000 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1001 NOTE: This option is set to "" when 'compatible' is set.
1002
1003 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1004'backup' 'bk' boolean (default off)
1005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006 Make a backup before overwriting a file. Leave it around after the
1007 file has been successfully written. If you do not want to keep the
1008 backup file, but you do want a backup while the file is being
1009 written, reset this option and set the 'writebackup' option (this is
1010 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001011 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 |backup-table| for more explanations.
1013 When the 'backupskip' pattern matches, a backup is not made anyway.
1014 When 'patchmode' is set, the backup may be renamed to become the
1015 oldest version of a file.
1016 NOTE: This option is reset when 'compatible' is set.
1017
1018 *'backupcopy'* *'bkc'*
1019'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001020 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001022 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023
1024 The main values are:
1025 "yes" make a copy of the file and overwrite the original one
1026 "no" rename the file and write a new one
1027 "auto" one of the previous, what works best
1028
1029 Extra values that can be combined with the ones above are:
1030 "breaksymlink" always break symlinks when writing
1031 "breakhardlink" always break hardlinks when writing
1032
1033 Making a copy and overwriting the original file:
1034 - Takes extra time to copy the file.
1035 + When the file has special attributes, is a (hard/symbolic) link or
1036 has a resource fork, all this is preserved.
1037 - When the file is a link the backup will have the name of the link,
1038 not of the real file.
1039
1040 Renaming the file and writing a new one:
1041 + It's fast.
1042 - Sometimes not all attributes of the file can be copied to the new
1043 file.
1044 - When the file is a link the new file will not be a link.
1045
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001046 The "auto" value is the middle way: When Vim sees that renaming the
1047 file is possible without side effects (the attributes can be passed on
1048 and the file is not a link) that is used. When problems are expected,
1049 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050
1051 The "breaksymlink" and "breakhardlink" values can be used in
1052 combination with any of "yes", "no" and "auto". When included, they
1053 force Vim to always break either symbolic or hard links by doing
1054 exactly what the "no" option does, renaming the original file to
1055 become the backup and writing a new file in its place. This can be
1056 useful for example in source trees where all the files are symbolic or
1057 hard links and any changes should stay in the local source tree, not
1058 be propagated back to the original source.
1059 *crontab*
1060 One situation where "no" and "auto" will cause problems: A program
1061 that opens a file, invokes Vim to edit that file, and then tests if
1062 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001063 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001064 example.
1065
1066 When a copy is made, the original file is truncated and then filled
1067 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001068 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001069 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 group of the backup is set to the group of the original file. If this
1071 fails, the protection bits for the group are made the same as for
1072 others.
1073
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001074 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 the same attributes of the original file, and the newly written file
1076 is owned by the current user. When the file was a (hard/symbolic)
1077 link, the new file will not! That's why the "auto" value doesn't
1078 rename when the file is a link. The owner and group of the newly
1079 written file will be set to the same ones as the original file, but
1080 the system may refuse to do this. In that case the "auto" value will
1081 again not rename the file.
1082
Bram Moolenaar036986f2017-03-16 17:41:02 +01001083 NOTE: This option is set to the Vi default value when 'compatible' is
1084 set and to the Vim default value when 'compatible' is reset.
1085
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 *'backupdir'* *'bdir'*
1087'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001088 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089 for Unix: ".,~/tmp,~/")
1090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091 List of directories for the backup file, separated with commas.
1092 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001093 where this is possible. The directory must exist, Vim will not
1094 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001095 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 impossible!). Writing may fail because of this.
1097 - A directory "." means to put the backup file in the same directory
1098 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001099 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1100 the backup file relative to where the edited file is. The leading
1101 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 ("." inside a directory name has no special meaning).
1103 - Spaces after the comma are ignored, other spaces are considered part
1104 of the directory name. To have a space at the start of a directory
1105 name, precede it with a backslash.
1106 - To include a comma in a directory name precede it with a backslash.
1107 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001108 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001109 the backup file name will be built from the complete path to the
1110 file with all path separators changed to percent '%' signs. This
1111 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001112 On Win32, it is also possible to end with "\\". However, When a
1113 separating comma is following, you must use "//", since "\\" will
1114 include the comma in the file name. Therefore it is recommended to
1115 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 - Environment variables are expanded |:set_env|.
1117 - Careful with '\' characters, type one before a space, type two to
1118 get one in the option (see |option-backslash|), for example: >
1119 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1120< - For backwards compatibility with Vim version 3.0 a '>' at the start
1121 of the option is removed.
1122 See also 'backup' and 'writebackup' options.
1123 If you want to hide your backup files on Unix, consider this value: >
1124 :set backupdir=./.backup,~/.backup,.,/tmp
1125< You must create a ".backup" directory in each directory and in your
1126 home directory for this to work properly.
1127 The use of |:set+=| and |:set-=| is preferred when adding or removing
1128 directories from the list. This avoids problems when a future version
1129 uses another default.
1130 This option cannot be set from a |modeline| or in the |sandbox|, for
1131 security reasons.
1132
1133 *'backupext'* *'bex'* *E589*
1134'backupext' 'bex' string (default "~", for VMS: "_")
1135 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136 String which is appended to a file name to make the name of the
1137 backup file. The default is quite unusual, because this avoids
1138 accidentally overwriting existing files with a backup file. You might
1139 prefer using ".bak", but make sure that you don't have files with
1140 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001141 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001143 If you like to keep a lot of backups, you could use a BufWritePre
1144 autocommand to change 'backupext' just before writing the file to
1145 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001146 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001147< Use 'backupdir' to put the backup in a different directory.
1148
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001150'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1151 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1152 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154 {not available when compiled without the |+wildignore|
1155 feature}
1156 A list of file patterns. When one of the patterns matches with the
1157 name of the file which is written, no backup file is created. Both
1158 the specified file name and the full path name of the file are used.
1159 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1160 Watch out for special characters, see |option-backslash|.
1161 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001162 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001163
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001164 WARNING: Not having a backup file means that when Vim fails to write
1165 your buffer correctly and then, for whatever reason, Vim exits, you
1166 lose both the original file and what you were writing. Only disable
1167 backups if you don't care about losing the file.
1168
Bram Moolenaar02467872007-05-06 13:22:01 +00001169 Note that environment variables are not expanded. If you want to use
1170 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001171 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001172
1173< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001174 backup would be made by renaming the original file crontab won't see
1175 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176
1177 *'balloondelay'* *'bdlay'*
1178'balloondelay' 'bdlay' number (default: 600)
1179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 {only available when compiled with the |+balloon_eval|
1181 feature}
1182 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1183
1184 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1185'ballooneval' 'beval' boolean (default off)
1186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001188 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001189 Switch on the |balloon-eval| functionality for the GUI.
1190
1191 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1192 *'nobevalterm'*
1193'balloonevalterm' 'bevalterm' boolean (default off)
1194 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001195 {only available when compiled with the
1196 |+balloon_eval_term| feature}
1197 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001199 *'balloonexpr'* *'bexpr'*
1200'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001201 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001202 {only available when compiled with the |+balloon_eval|
1203 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001204 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001205 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1206 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001207
1208 v:beval_bufnr number of the buffer in which balloon is going to show
1209 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001210 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001211 v:beval_lnum line number
1212 v:beval_col column number (byte index)
1213 v:beval_text word under or after the mouse pointer
1214
Bram Moolenaar54775062019-07-31 21:07:14 +02001215 Instead of showing a balloon, which is limited to plain text, consider
1216 using a popup window, see |popup_beval_example|. A popup window can
1217 use highlighting and show a border.
1218
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001219 The evaluation of the expression must not have side effects!
1220 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001221 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001222 return 'Cursor is at line ' .. v:beval_lnum ..
1223 \ ', column ' .. v:beval_col ..
1224 \ ' of file ' .. bufname(v:beval_bufnr) ..
1225 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001226 endfunction
1227 set bexpr=MyBalloonExpr()
1228 set ballooneval
1229<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001230 Also see |balloon_show()|, it can be used if the content of the balloon
1231 is to be fetched asynchronously. In that case evaluating
1232 'balloonexpr' should result in an empty string. If you get a balloon
1233 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001234
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001235 NOTE: The balloon is displayed only if the cursor is on a text
1236 character. If the result of evaluating 'balloonexpr' is not empty,
1237 Vim does not try to send a message to an external debugger (Netbeans
1238 or Sun Workshop).
1239
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001240 If the expression starts with s: or |<SID>|, then it is replaced with
1241 the script ID (|local-function|). Example: >
1242 set bexpr=s:MyBalloonExpr()
1243 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001244< Otherwise, the expression is evaluated in the context of the script
1245 where the option was set, thus script-local items are available.
1246
Bram Moolenaar30b65812012-07-12 22:01:11 +02001247 The expression will be evaluated in the |sandbox| when set from a
1248 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001249 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001250
1251 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001252 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001253
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001254 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001255 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001256< When they are supported "\n" characters will start a new line. If the
1257 expression evaluates to a |List| this is equal to using each List item
1258 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001259 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001260
Bram Moolenaar165bc692015-07-21 17:53:25 +02001261 *'belloff'* *'bo'*
1262'belloff' 'bo' string (default "")
1263 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001264 Specifies for which events the bell will not be rung. It is a comma
1265 separated list of items. For each item that is present, the bell
1266 will be silenced. This is most useful to specify specific events in
1267 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001268 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001269
1270 item meaning when present ~
1271 all All events.
1272 backspace When hitting <BS> or <Del> and deleting results in an
1273 error.
1274 cursor Fail to move around using the cursor keys or
1275 <PageUp>/<PageDown> in |Insert-mode|.
1276 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1277 |i_CTRL-X_CTRL-T|.
1278 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1279 |i_CTRL-E|.
1280 ctrlg Unknown Char after <C-G> in Insert mode.
1281 error Other Error occurred (e.g. try to join last line)
1282 (mostly used in |Normal-mode| or |Cmdline-mode|).
1283 esc hitting <Esc> in |Normal-mode|.
1284 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001285 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001286 insertmode Pressing <Esc> in 'insertmode'.
1287 lang Calling the beep module for Lua/Mzscheme/TCL.
1288 mess No output available for |g<|.
1289 showmatch Error occurred for 'showmatch' function.
1290 operator Empty region error |cpo-E|.
1291 register Unknown register after <C-R> in |Insert-mode|.
1292 shell Bell from shell output |:!|.
1293 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001294 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001295 wildmode More matches in |cmdline-completion| available
1296 (depends on the 'wildmode' setting).
1297
Bram Moolenaar036986f2017-03-16 17:41:02 +01001298 This is most useful to fine tune when in Insert mode the bell should
1299 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001300 indicate that an error occurred. It can be silenced by adding the
1301 "error" keyword.
1302
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1304'binary' 'bin' boolean (default off)
1305 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306 This option should be set before editing a binary file. You can also
1307 use the |-b| Vim argument. When this option is switched on a few
1308 options will be changed (also when it already was on):
1309 'textwidth' will be set to 0
1310 'wrapmargin' will be set to 0
1311 'modeline' will be off
1312 'expandtab' will be off
1313 Also, 'fileformat' and 'fileformats' options will not be used, the
1314 file is read and written like 'fileformat' was "unix" (a single <NL>
1315 separates lines).
1316 The 'fileencoding' and 'fileencodings' options will not be used, the
1317 file is read without conversion.
1318 NOTE: When you start editing a(nother) file while the 'bin' option is
1319 on, settings from autocommands may change the settings again (e.g.,
1320 'textwidth'), causing trouble when editing. You might want to set
1321 'bin' again when the file has been loaded.
1322 The previous values of these options are remembered and restored when
1323 'bin' is switched from on to off. Each buffer has its own set of
1324 saved option values.
1325 To edit a file with 'binary' set you can use the |++bin| argument.
1326 This avoids you have to do ":set bin", which would have effect for all
1327 files you edit.
1328 When writing a file the <EOL> for the last line is only written if
1329 there was one in the original file (normally Vim appends an <EOL> to
1330 the last line if there is none; this would make the file longer). See
1331 the 'endofline' option.
1332
1333 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1334'bioskey' 'biosk' boolean (default on)
1335 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001336 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001337 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001338
1339 *'bomb'* *'nobomb'*
1340'bomb' boolean (default off)
1341 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 When writing a file and the following conditions are met, a BOM (Byte
1343 Order Mark) is prepended to the file:
1344 - this option is on
1345 - the 'binary' option is off
1346 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1347 endian variants.
1348 Some applications use the BOM to recognize the encoding of the file.
1349 Often used for UCS-2 files on MS-Windows. For other applications it
1350 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001351 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1353 check for the presence of the BOM is done and 'bomb' set accordingly.
1354 Unless 'binary' is set, it is removed from the first line, so that you
1355 don't see it when editing. When you don't change the options, the BOM
1356 will be restored when writing the file.
1357
1358 *'breakat'* *'brk'*
1359'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1360 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001361 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362 feature}
1363 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001364 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1365 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001367 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001368'breakindent' 'bri' boolean (default off)
1369 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001370 {not available when compiled without the |+linebreak|
1371 feature}
1372 Every wrapped line will continue visually indented (same amount of
1373 space as the beginning of that line), thus preserving horizontal blocks
1374 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001375 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001376
1377 *'breakindentopt'* *'briopt'*
1378'breakindentopt' 'briopt' string (default empty)
1379 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001380 {not available when compiled without the |+linebreak|
1381 feature}
1382 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001383 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001384 min:{n} Minimum text width that will be kept after
1385 applying 'breakindent', even if the resulting
1386 text should normally be narrower. This prevents
1387 text indented almost to the right window border
1388 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001389 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001390 shift:{n} After applying 'breakindent', the wrapped line's
1391 beginning will be shifted by the given number of
1392 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001393 indentation (negative) or emphasizing the line
1394 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001395 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001396 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001397 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001398 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001399 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001400 numbered or bulleted list (using the
1401 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001402 list:-1 Uses the length of a match with 'formatlistpat'
1403 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001404 (default: 0)
1405 column:{n} Indent at column {n}. Will overrule the other
1406 sub-options. Note: an additional indent may be
1407 added for the 'showbreak' setting.
1408 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001409
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001411'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001413 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001414 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001415 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001416 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417 buffer Use the directory of the related buffer.
1418 current Use the current directory.
1419 {path} Use the specified directory
1420
1421 *'bufhidden'* *'bh'*
1422'bufhidden' 'bh' string (default: "")
1423 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 This option specifies what happens when a buffer is no longer
1425 displayed in a window:
1426 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001427 hide hide the buffer (don't unload it), even if 'hidden' is
1428 not set
1429 unload unload the buffer, even if 'hidden' is set; the
1430 |:hide| command will also unlod the buffer
1431 delete delete the buffer from the buffer list, even if
1432 'hidden' is set; the |:hide| command will also delete
1433 the buffer, making it behave like |:bdelete|
1434 wipe wipe the buffer from the buffer list, even if
1435 'hidden' is set; the |:hide| command will also wipe
1436 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001438 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001439 are lost without a warning. Also, these values may break autocommands
1440 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441 This option is used together with 'buftype' and 'swapfile' to specify
1442 special kinds of buffers. See |special-buffers|.
1443
1444 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1445'buflisted' 'bl' boolean (default: on)
1446 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 When this option is set, the buffer shows up in the buffer list. If
1448 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1449 This option is reset by Vim for buffers that are only used to remember
1450 a file name or marks. Vim sets it when starting to edit a buffer.
1451 But not when moving to a buffer with ":buffer".
1452
1453 *'buftype'* *'bt'* *E382*
1454'buftype' 'bt' string (default: "")
1455 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456 The value of this option specifies the type of a buffer:
1457 <empty> normal buffer
1458 nofile buffer which is not related to a file and will not be
1459 written
1460 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001461 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001462 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001464 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 help help buffer (you are not supposed to set this
1466 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001467 terminal buffer for a |terminal| (you are not supposed to set
1468 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001469 prompt buffer where only the last line can be edited, meant
1470 to be used by a plugin, see |prompt-buffer|
1471 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001472 popup buffer used in a popup window, see |popup|.
1473 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474
1475 This option is used together with 'bufhidden' and 'swapfile' to
1476 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001477 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001478
1479 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001480 One such effect is that Vim will not check the timestamp of the file,
1481 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001482
Bram Moolenaar280f1262006-01-30 00:14:18 +00001483 A "quickfix" buffer is only used for the error list and the location
1484 list. This value is set by the |:cwindow| and |:lwindow| commands and
1485 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486
1487 "nofile" and "nowrite" buffers are similar:
1488 both: The buffer is not to be written to disk, ":w" doesn't
1489 work (":w filename" does work though).
1490 both: The buffer is never considered to be |'modified'|.
1491 There is no warning when the changes will be lost, for
1492 example when you quit Vim.
1493 both: A swap file is only created when using too much memory
1494 (when 'swapfile' has been reset there is never a swap
1495 file).
1496 nofile only: The buffer name is fixed, it is not handled like a
1497 file name. It is not modified in response to a |:cd|
1498 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001499 both: When using ":e bufname" and already editing "bufname"
1500 the buffer is made empty and autocommands are
1501 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001502 *E676*
1503 "acwrite" implies that the buffer name is not related to a file, like
1504 "nofile", but it will be written. Thus, in contrast to "nofile" and
1505 "nowrite", ":w" does work and a modified buffer can't be abandoned
1506 without saving. For writing there must be matching |BufWriteCmd|,
1507 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508
1509 *'casemap'* *'cmp'*
1510'casemap' 'cmp' string (default: "internal,keepascii")
1511 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512 Specifies details about changing the case of letters. It may contain
1513 these words, separated by a comma:
1514 internal Use internal case mapping functions, the current
1515 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001516 matters when 'encoding' is a Unicode encoding,
1517 "latin1" or "iso-8859-15". When "internal" is
1518 omitted, the towupper() and towlower() system library
1519 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1521 case mapping, the current locale is not effective.
1522 This probably only matters for Turkish.
1523
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001524 *'cdhome'* *'cdh'*
1525'cdhome' 'cdh' boolean (default: off)
1526 global
1527 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1528 current working directory to the |$HOME| directory like in Unix.
1529 When off, those commands just print the current directory name.
1530 On Unix this option has no effect.
1531 NOTE: This option is reset when 'compatible' is set.
1532
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533 *'cdpath'* *'cd'* *E344* *E346*
1534'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1535 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 {not available when compiled without the
1537 |+file_in_path| feature}
1538 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001539 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1540 searched for has a relative path, not an absolute part starting with
1541 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 The 'cdpath' option's value has the same form and semantics as
1543 |'path'|. Also see |file-searching|.
1544 The default value is taken from $CDPATH, with a "," prepended to look
1545 in the current directory first.
1546 If the default value taken from $CDPATH is not what you want, include
1547 a modified version of the following command in your vimrc file to
1548 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001549 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550< This option cannot be set from a |modeline| or in the |sandbox|, for
1551 security reasons.
1552 (parts of 'cdpath' can be passed to the shell to expand file names).
1553
1554 *'cedit'*
1555'cedit' string (Vi default: "", Vim default: CTRL-F)
1556 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 The key used in Command-line Mode to open the command-line window.
1558 The default is CTRL-F when 'compatible' is off.
1559 Only non-printable keys are allowed.
1560 The key can be specified as a single character, but it is difficult to
1561 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001562 :exe "set cedit=\<C-Y>"
1563 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001564< |Nvi| also has this option, but it only uses the first character.
1565 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001566 NOTE: This option is set to the Vim default value when 'compatible'
1567 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568
1569 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1570'charconvert' 'ccv' string (default "")
1571 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001572 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573 An expression that is used for character encoding conversion. It is
1574 evaluated when a file that is to be read or has been written has a
1575 different encoding from what is desired.
1576 'charconvert' is not used when the internal iconv() function is
1577 supported and is able to do the conversion. Using iconv() is
1578 preferred, because it is much faster.
1579 'charconvert' is not used when reading stdin |--|, because there is no
1580 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001581 The expression must return zero, false or an empty string for success,
1582 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583 The possible encoding names encountered are in 'encoding'.
1584 Additionally, names given in 'fileencodings' and 'fileencoding' are
1585 used.
1586 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1587 is done internally by Vim, 'charconvert' is not used for this.
1588 'charconvert' is also used to convert the viminfo file, if the 'c'
1589 flag is present in 'viminfo'. Also used for Unicode conversion.
1590 Example: >
1591 set charconvert=CharConvert()
1592 fun CharConvert()
1593 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001594 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1595 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001596 return v:shell_error
1597 endfun
1598< The related Vim variables are:
1599 v:charconvert_from name of the current encoding
1600 v:charconvert_to name of the desired encoding
1601 v:fname_in name of the input file
1602 v:fname_out name of the output file
1603 Note that v:fname_in and v:fname_out will never be the same.
1604 Note that v:charconvert_from and v:charconvert_to may be different
1605 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001606
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 Encryption is not done by Vim when using 'charconvert'. If you want
1608 to encrypt the file after conversion, 'charconvert' should take care
1609 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001610
1611 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1612 replaced with the script ID (|local-function|). Example: >
1613 set charconvert=s:MyConvert()
1614 set charconvert=<SID>SomeConvert()
1615< Otherwise the expression is evaluated in the context of the script
1616 where the option was set, thus script-local items are available.
1617
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618 This option cannot be set from a |modeline| or in the |sandbox|, for
1619 security reasons.
1620
1621 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1622'cindent' 'cin' boolean (default off)
1623 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001624 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625 that trigger reindenting in insert mode and 'cinoptions' to set your
1626 preferred indent style.
1627 If 'indentexpr' is not empty, it overrules 'cindent'.
1628 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1629 the "=" operator indents using this algorithm rather than calling an
1630 external program.
1631 See |C-indenting|.
1632 When you don't like the way 'cindent' works, try the 'smartindent'
1633 option or 'indentexpr'.
1634 This option is not used when 'paste' is set.
1635 NOTE: This option is reset when 'compatible' is set.
1636
1637 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001638'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640 A list of keys that, when typed in Insert mode, cause reindenting of
1641 the current line. Only used if 'cindent' is on and 'indentexpr' is
1642 empty.
1643 For the format of this option see |cinkeys-format|.
1644 See |C-indenting|.
1645
1646 *'cinoptions'* *'cino'*
1647'cinoptions' 'cino' string (default "")
1648 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1650 program. See |cinoptions-values| for the values of this option, and
1651 |C-indenting| for info on C indenting in general.
1652
1653
1654 *'cinwords'* *'cinw'*
1655'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1656 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657 These keywords start an extra indent in the next line when
1658 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1659 an appropriate place (inside {}).
1660 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1661 matter, include the keyword both the uppercase and lowercase:
1662 "if,If,IF".
1663
Tom Praschan3506cf32022-04-07 12:39:08 +01001664 *'cinscopedecls'* *'cinsd'*
1665'cinscopedecls' 'cinsd' string (default "public,protected,private")
1666 local to buffer
Tom Praschan3506cf32022-04-07 12:39:08 +01001667 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1668 Useful e.g. for working with the Qt framework that defines additional
1669 scope declarations "signals", "public slots" and "private slots": >
1670 set cinscopedecls+=signals,public\ slots,private\ slots
1671
1672< *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1674 for X-windows, "" otherwise)
1675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676 {only in GUI versions or when the |+xterm_clipboard|
1677 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001678 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001679 Note: if one of the items is "exclude:", then you can't add an item
1680 after that. Therefore do append an item with += but use ^= to
1681 prepend, e.g.: >
1682 set clipboard^=unnamed
1683< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001684
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001685 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 unnamed When included, Vim will use the clipboard register '*'
1687 for all yank, delete, change and put operations which
1688 would normally go to the unnamed register. When a
1689 register is explicitly specified, it will always be
1690 used regardless of whether "unnamed" is in 'clipboard'
1691 or not. The clipboard register can always be
1692 explicitly accessed using the "* notation. Also see
1693 |gui-clipboard|.
1694
Bram Moolenaar30b65812012-07-12 22:01:11 +02001695 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001696 unnamedplus A variant of the "unnamed" flag which uses the
1697 clipboard register '+' (|quoteplus|) instead of
1698 register '*' for all yank, delete, change and put
1699 operations which would normally go to the unnamed
1700 register. When "unnamed" is also included to the
1701 option, yank operations (but not delete, change or
1702 put) will additionally copy the text into register
1703 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001704 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001705 Availability can be checked with: >
1706 if has('unnamedplus')
1707<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001708 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 autoselect Works like the 'a' flag in 'guioptions': If present,
1710 then whenever Visual mode is started, or the Visual
1711 area extended, Vim tries to become the owner of the
1712 windowing system's global selection or put the
1713 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001714 register "*. See |'go-a'| and |quotestar| for details.
1715 When the GUI is active, the 'a' flag in 'guioptions'
1716 is used, when the GUI is not active, this "autoselect"
1717 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718 Also applies to the modeless selection.
1719
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001720 *clipboard-autoselectplus*
1721 autoselectplus Like "autoselect" but using the + register instead of
1722 the * register. Compare to the 'P' flag in
1723 'guioptions'.
1724
1725 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726 autoselectml Like "autoselect", but for the modeless selection
1727 only. Compare to the 'A' flag in 'guioptions'.
1728
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001729 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001730 html When the clipboard contains HTML, use this when
1731 pasting. When putting text on the clipboard, mark it
1732 as HTML. This works to copy rendered HTML from
1733 Firefox, paste it as raw HTML in Vim, select the HTML
1734 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001735 You probably want to add this only temporarily,
1736 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001737 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001738
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001739 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740 exclude:{pattern}
1741 Defines a pattern that is matched against the name of
1742 the terminal 'term'. If there is a match, no
1743 connection will be made to the X server. This is
1744 useful in this situation:
1745 - Running Vim in a console.
1746 - $DISPLAY is set to start applications on another
1747 display.
1748 - You do not want to connect to the X server in the
1749 console, but do want this in a terminal emulator.
1750 To never connect to the X server use: >
1751 exclude:.*
1752< This has the same effect as using the |-X| argument.
1753 Note that when there is no connection to the X server
1754 the window title won't be restored and the clipboard
1755 cannot be accessed.
1756 The value of 'magic' is ignored, {pattern} is
1757 interpreted as if 'magic' was on.
1758 The rest of the option value will be used for
1759 {pattern}, this must be the last entry.
1760
1761 *'cmdheight'* *'ch'*
1762'cmdheight' 'ch' number (default 1)
1763 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764 Number of screen lines to use for the command-line. Helps avoiding
1765 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001766 The value of this option is stored with the tab page, so that each tab
1767 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768
1769 *'cmdwinheight'* *'cwh'*
1770'cmdwinheight' 'cwh' number (default 7)
1771 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 Number of screen lines to use for the command-line window. |cmdwin|
1773
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001774 *'colorcolumn'* *'cc'*
1775'colorcolumn' 'cc' string (default "")
1776 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001777 {not available when compiled without the |+syntax|
1778 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001779 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001780 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1781 text. Will make screen redrawing slower.
1782 The screen column can be an absolute number, or a number preceded with
1783 '+' or '-', which is added to or subtracted from 'textwidth'. >
1784
1785 :set cc=+1 " highlight column after 'textwidth'
1786 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1787 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1788<
1789 When 'textwidth' is zero then the items with '-' and '+' are not used.
1790 A maximum of 256 columns are highlighted.
1791
Bram Moolenaar071d4272004-06-13 20:20:40 +00001792 *'columns'* *'co'* *E594*
1793'columns' 'co' number (default 80 or terminal width)
1794 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001795 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001796 initialization and does not have to be set by hand. Also see
1797 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 When Vim is running in the GUI or in a resizable window, setting this
1799 option will cause the window size to be changed. When you only want
1800 to use the size for the GUI, put the command in your |gvimrc| file.
1801 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001802 number of columns of the display, the display may be messed up. For
1803 the GUI it is always possible and Vim limits the number of columns to
1804 what fits on the screen. You can use this command to get the widest
1805 window possible: >
1806 :set columns=9999
1807< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808
1809 *'comments'* *'com'* *E524* *E525*
1810'comments' 'com' string (default
1811 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1812 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001813 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814 |format-comments|. See |option-backslash| about using backslashes to
1815 insert a space.
1816
1817 *'commentstring'* *'cms'* *E537*
1818'commentstring' 'cms' string (default "/*%s*/")
1819 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820 {not available when compiled without the |+folding|
1821 feature}
1822 A template for a comment. The "%s" in the value is replaced with the
1823 comment text. Currently only used to add markers for folding, see
1824 |fold-marker|.
1825
1826 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001827'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001828 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 This option has the effect of making Vim either more Vi-compatible, or
1831 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001832
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001834 other options are also changed as a side effect.
1835 NOTE: Setting or resetting this option can have a lot of unexpected
1836 effects: Mappings are interpreted in another way, undo behaves
1837 differently, etc. If you set this option in your vimrc file, you
1838 should probably put it at the very start.
1839
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 By default this option is on and the Vi defaults are used for the
1841 options. This default was chosen for those people who want to use Vim
1842 just like Vi, and don't even (want to) know about the 'compatible'
1843 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001844 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001845 this option is switched off, and all options that have not been
1846 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001847 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001848 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001849 happen for the system-wide vimrc or gvimrc file, nor for a file given
1850 with the |-u| argument). Also see |compatible-default| and
1851 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852 You can also set this option with the "-C" argument, and reset it with
1853 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001854 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855
Bram Moolenaar214641f2017-03-05 17:04:09 +01001856 When this option is set, numerous other options are set to make Vim as
1857 Vi-compatible as possible. When this option is unset, various options
1858 are set to make Vim more useful. The table below lists all the
1859 options affected.
1860 The {?} column indicates when the options are affected:
1861 + Means that the option is set to the value given in {set value} when
1862 'compatible' is set.
1863 & Means that the option is set to the value given in {set value} when
1864 'compatible' is set AND is set to its Vim default value when
1865 'compatible' is unset.
1866 - Means the option is NOT changed when setting 'compatible' but IS
1867 set to its Vim default when 'compatible' is unset.
1868 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869
Bram Moolenaar036986f2017-03-16 17:41:02 +01001870 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001871
1872 'allowrevins' + off no CTRL-_ command
1873 'antialias' + off don't use antialiased fonts
1874 'arabic' + off reset arabic-related options
1875 'arabicshape' + on correct character shapes
1876 'backspace' + "" normal backspace
1877 'backup' + off no backup file
1878 'backupcopy' & Unix: "yes" backup file is a copy
1879 else: "auto" copy or rename backup file
1880 'balloonexpr' + "" text to show in evaluation balloon
1881 'breakindent' + off don't indent when wrapping lines
1882 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001883 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001884 'cindent' + off no C code indentation
1885 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1886 'copyindent' + off don't copy indent structure
1887 'cpoptions' & (all flags) Vi-compatible flags
1888 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001889 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001890 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001891 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001892 'cscopeverbose' + off see |cscopeverbose|
1893 'delcombine' + off unicode: delete whole char combination
1894 'digraph' + off no digraphs
1895 'esckeys' & off no <Esc>-keys in Insert mode
1896 'expandtab' + off tabs not expanded to spaces
1897 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001898 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001899 'formatexpr' + "" use 'formatprg' for auto-formatting
1900 'formatoptions' & "vt" Vi compatible formatting
1901 'gdefault' + off no default 'g' flag for ":s"
1902 'history' & 0 no commandline history
1903 'hkmap' + off no Hebrew keyboard mapping
1904 'hkmapp' + off no phonetic Hebrew keyboard mapping
1905 'hlsearch' + off no highlighting of search matches
1906 'incsearch' + off no incremental searching
1907 'indentexpr' + "" no indenting by expression
1908 'insertmode' + off do not start in Insert mode
1909 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001910 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001911 'joinspaces' + on insert 2 spaces after period
1912 'modeline' & off no modelines
1913 'more' & off no pauses in listings
1914 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1915 'numberwidth' & 8 min number of columns for line number
1916 'preserveindent'+ off don't preserve current indent structure
1917 when changing it
1918 'revins' + off no reverse insert
1919 'ruler' + off no ruler
1920 'scrolljump' + 1 no jump scroll
1921 'scrolloff' + 0 no scroll offset
1922 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1923 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001924 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001925 'showcmd' & off command characters not shown
1926 'showmode' & off current mode not shown
1927 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1928 'smartcase' + off no automatic ignore case switch
1929 'smartindent' + off no smart indentation
1930 'smarttab' + off no smart tab size
1931 'softtabstop' + 0 tabs are always 'tabstop' positions
1932 'startofline' + on goto startofline with some commands
1933 'tagcase' & "followic" 'ignorecase' when searching tags file
1934 'tagrelative' & off tag file names are not relative
1935 'termguicolors' + off don't use highlight-(guifg|guibg)
1936 'textauto' & off no automatic textmode detection
1937 'textwidth' + 0 no automatic line wrap
1938 'tildeop' + off tilde is not an operator
1939 'ttimeout' + off no terminal timeout
1940 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001941 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001942 'virtualedit' + "" cursor can only be placed on characters
1943 'whichwrap' & "" left-right movements don't wrap
1944 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001945 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001946 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001947
1948 *'complete'* *'cpt'* *E535*
1949'complete' 'cpt' string (default: ".,w,b,u,t,i")
1950 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951 This option specifies how keyword completion |ins-completion| works
1952 when CTRL-P or CTRL-N are used. It is also used for whole-line
1953 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001954 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001955 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956 w scan buffers from other windows
1957 b scan other loaded buffers that are in the buffer list
1958 u scan the unloaded buffers that are in the buffer list
1959 U scan the buffers that are not in the buffer list
1960 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001961 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962 k{dict} scan the file {dict}. Several "k" flags can be given,
1963 patterns are valid too. For example: >
1964 :set cpt=k/usr/dict/*,k~/spanish
1965< s scan the files given with the 'thesaurus' option
1966 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1967 are valid too.
1968 i scan current and included files
1969 d scan current and included files for defined name or macro
1970 |i_CTRL-X_CTRL-D|
1971 ] tag completion
1972 t same as "]"
1973
1974 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1975 not executed, this may lead to unexpected completions from some files
1976 (gzipped files for example). Unloaded buffers are not scanned for
1977 whole-line completion.
1978
1979 The default is ".,w,b,u,t,i", which means to scan:
1980 1. the current buffer
1981 2. buffers in other windows
1982 3. other loaded buffers
1983 4. unloaded buffers
1984 5. tags
1985 6. included files
1986
1987 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001988 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1989 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001991 *'completefunc'* *'cfu'*
1992'completefunc' 'cfu' string (default: empty)
1993 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001994 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001995 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001996 This option specifies a function to be used for Insert mode completion
1997 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001998 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00001999 invoked and what it should return. The value can be the name of a
2000 function, a |lambda| or a |Funcref|. See |option-value-function| for
2001 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002002 This option cannot be set from a |modeline| or in the |sandbox|, for
2003 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002004
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002005 *'completeslash'* *'csl'*
2006'completeslash' 'csl' string (default: "")
2007 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002008 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002009 When this option is set it overrules 'shellslash' for completion:
2010 - When this option is set to "slash", a forward slash is used for path
2011 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002012 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002013 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002014 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002015 - When this option is empty, same character is used as for
2016 'shellslash'.
2017 For Insert mode completion the buffer-local value is used. For
2018 command line completion the global value is used.
2019
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002020 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002021'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002022 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002023 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002024 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002025
2026 menu Use a popup menu to show the possible completions. The
2027 menu is only shown when there is more than one match and
2028 sufficient colors are available. |ins-completion-menu|
2029
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002030 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002031 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002032 match, e.g., what file it comes from.
2033
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002034 longest Only insert the longest common text of the matches. If
2035 the menu is displayed you can use CTRL-L to add more
2036 characters. Whether case is ignored depends on the kind
2037 of completion. For buffer text the 'ignorecase' option is
2038 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002039
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002040 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002041 completion in the preview window. Only works in
2042 combination with "menu" or "menuone".
2043
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002044 popup Show extra information about the currently selected
2045 completion in a popup window. Only works in combination
2046 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002047 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002048 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002049
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002050 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002051 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002052 |CompleteChanged| autocommand to fetch the info and call
2053 |popup_show()| once the popup has been filled.
2054 See the example at |complete-popuphidden|.
2055 {only works when compiled with the |+textprop| feature}
2056
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002057 noinsert Do not insert any text for a match until the user selects
2058 a match from the menu. Only works in combination with
2059 "menu" or "menuone". No effect if "longest" is present.
2060
2061 noselect Do not select a match in the menu, force the user to
2062 select one from the menu. Only works in combination with
2063 "menu" or "menuone".
2064
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002065
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002066 *'completepopup'* *'cpp'*
2067'completepopup' 'cpp' string (default empty)
2068 global
2069 {not available when compiled without the |+textprop|
2070 or |+quickfix| feature}
2071 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002072 properties of the info popup when it is created. If an info popup
2073 window already exists it is closed, so that the option value is
2074 applied when it is created again.
2075 You can also use |popup_findinfo()| and then set properties for an
2076 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002077
2078
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002079 *'concealcursor'* *'cocu'*
2080'concealcursor' 'cocu' string (default: "")
2081 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002082 {not available when compiled without the |+conceal|
2083 feature}
2084 Sets the modes in which text in the cursor line can also be concealed.
2085 When the current mode is listed then concealing happens just like in
2086 other lines.
2087 n Normal mode
2088 v Visual mode
2089 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002090 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002091
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002092 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002093 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002094 are moving around text is concealed, but when starting to insert text
2095 or selecting a Visual area the concealed text is displayed, so that
2096 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002097 Keep in mind that the cursor position is not always where it's
2098 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002099
2100
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002101 *'conceallevel'* *'cole'*
2102'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002103 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002104 {not available when compiled without the |+conceal|
2105 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002106 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2107 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002108
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002109 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002110 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002111 1 Each block of concealed text is replaced with one
2112 character. If the syntax item does not have a custom
2113 replacement character defined (see |:syn-cchar|) the
2114 character defined in 'listchars' is used (default is a
2115 space).
2116 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002117 2 Concealed text is completely hidden unless it has a
2118 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002119 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002120 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002121
Bram Moolenaara7781e02010-07-19 20:13:22 +02002122 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002123 edit and copy the text. This can be changed with the 'concealcursor'
2124 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002125
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2127'confirm' 'cf' boolean (default off)
2128 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129 When 'confirm' is on, certain operations that would normally
2130 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2131 instead raise a |dialog| asking if you wish to save the current
2132 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2133 If 'confirm' is off you can still activate confirmation for one
2134 command only (this is most useful in mappings) with the |:confirm|
2135 command.
2136 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2137
2138 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2139'conskey' 'consk' boolean (default off)
2140 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002141 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142
2143 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2144'copyindent' 'ci' boolean (default off)
2145 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146 Copy the structure of the existing lines indent when autoindenting a
2147 new line. Normally the new indent is reconstructed by a series of
2148 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2149 in which case only spaces are used). Enabling this option makes the
2150 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002151 existing line. 'expandtab' has no effect on these characters, a Tab
2152 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002154 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 Also see 'preserveindent'.
2156
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002157 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158'cpoptions' 'cpo' string (Vim default: "aABceFs",
2159 Vi default: all flags)
2160 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002162 this indicates Vi-compatible behavior. This is used for things where
2163 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 'cpoptions' stands for "compatible-options".
2165 Commas can be added for readability.
2166 To avoid problems with flags that are added in the future, use the
2167 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002168
Bram Moolenaar071d4272004-06-13 20:20:40 +00002169 NOTE: This option is set to the Vi default value when 'compatible' is
2170 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002171
2172 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2173 is saved, 'cpoptions' is set to the Vim default, and the saved value
2174 is restored at the end of the script. Changes to the value of
2175 'cpoptions' will be applied to the saved value, but keep in mind that
2176 removing a flag that is not present when 'cpoptions' is changed has no
2177 effect. In the |.vimrc| file the value is not restored, thus using
2178 `vim9script` in the |.vimrc| file results in using the Vim default.
2179
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002180 NOTE: This option is set to the POSIX default value at startup when
2181 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002182 variable exists |posix|. This means Vim tries to behave like the
2183 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184
2185 contains behavior ~
2186 *cpo-a*
2187 a When included, a ":read" command with a file name
2188 argument will set the alternate file name for the
2189 current window.
2190 *cpo-A*
2191 A When included, a ":write" command with a file name
2192 argument will set the alternate file name for the
2193 current window.
2194 *cpo-b*
2195 b "\|" in a ":map" command is recognized as the end of
2196 the map command. The '\' is included in the mapping,
2197 the text after the '|' is interpreted as the next
2198 command. Use a CTRL-V instead of a backslash to
2199 include the '|' in the mapping. Applies to all
2200 mapping, abbreviation, menu and autocmd commands.
2201 See also |map_bar|.
2202 *cpo-B*
2203 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002204 abbreviations, user commands and the "to" part of the
2205 menu commands. Remove this flag to be able to use a
2206 backslash like a CTRL-V. For example, the command
2207 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208 'B' included: "\^[" (^[ is a real <Esc>)
2209 'B' excluded: "<Esc>" (5 characters)
2210 ('<' excluded in both cases)
2211 *cpo-c*
2212 c Searching continues at the end of any match at the
2213 cursor position, but not further than the start of the
2214 next line. When not present searching continues
2215 one character from the cursor position. With 'c'
2216 "abababababab" only gets three matches when repeating
2217 "/abab", without 'c' there are five matches.
2218 *cpo-C*
2219 C Do not concatenate sourced lines that start with a
2220 backslash. See |line-continuation|.
2221 *cpo-d*
2222 d Using "./" in the 'tags' option doesn't mean to use
2223 the tags file relative to the current file, but the
2224 tags file in the current directory.
2225 *cpo-D*
2226 D Can't use CTRL-K to enter a digraph after Normal mode
2227 commands with a character argument, like |r|, |f| and
2228 |t|.
2229 *cpo-e*
2230 e When executing a register with ":@r", always add a
2231 <CR> to the last line, also when the register is not
2232 linewise. If this flag is not present, the register
2233 is not linewise and the last line does not end in a
2234 <CR>, then the last line is put on the command-line
2235 and can be edited before hitting <CR>.
2236 *cpo-E*
2237 E It is an error when using "y", "d", "c", "g~", "gu" or
2238 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002239 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 This makes "y0" fail in the first column.
2241 *cpo-f*
2242 f When included, a ":read" command with a file name
2243 argument will set the file name for the current buffer,
2244 if the current buffer doesn't have a file name yet.
2245 *cpo-F*
2246 F When included, a ":write" command with a file name
2247 argument will set the file name for the current
2248 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002249 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250 *cpo-g*
2251 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002252 *cpo-H*
2253 H When using "I" on a line with only blanks, insert
2254 before the last blank. Without this flag insert after
2255 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256 *cpo-i*
2257 i When included, interrupting the reading of a file will
2258 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002259 *cpo-I*
2260 I When moving the cursor up or down just after inserting
2261 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262 *cpo-j*
2263 j When joining lines, only add two spaces after a '.',
2264 not after '!' or '?'. Also see 'joinspaces'.
2265 *cpo-J*
2266 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002267 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 white space.
2269 *cpo-k*
2270 k Disable the recognition of raw key codes in
2271 mappings, abbreviations, and the "to" part of menu
2272 commands. For example, if <Key> sends ^[OA (where ^[
2273 is <Esc>), the command ":map X ^[OA" results in X
2274 being mapped to:
2275 'k' included: "^[OA" (3 characters)
2276 'k' excluded: "<Key>" (one key code)
2277 Also see the '<' flag below.
2278 *cpo-K*
2279 K Don't wait for a key code to complete when it is
2280 halfway a mapping. This breaks mapping <F1><F1> when
2281 only part of the second <F1> has been read. It
2282 enables cancelling the mapping by typing <F1><Esc>.
2283 *cpo-l*
2284 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002285 literally, only "\]", "\^", "\-" and "\\" are special.
2286 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2288 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002289 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290 *cpo-L*
2291 L When the 'list' option is set, 'wrapmargin',
2292 'textwidth', 'softtabstop' and Virtual Replace mode
2293 (see |gR|) count a <Tab> as two characters, instead of
2294 the normal behavior of a <Tab>.
2295 *cpo-m*
2296 m When included, a showmatch will always wait half a
2297 second. When not included, a showmatch will wait half
2298 a second or until a character is typed. |'showmatch'|
2299 *cpo-M*
2300 M When excluded, "%" matching will take backslashes into
2301 account. Thus in "( \( )" and "\( ( \)" the outer
2302 parenthesis match. When included "%" ignores
2303 backslashes, which is Vi compatible.
2304 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002305 n When included, the column used for 'number' and
2306 'relativenumber' will also be used for text of wrapped
2307 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002308 *cpo-o*
2309 o Line offset to search command is not remembered for
2310 next search.
2311 *cpo-O*
2312 O Don't complain if a file is being overwritten, even
2313 when it didn't exist when editing it. This is a
2314 protection against a file unexpectedly created by
2315 someone else. Vi didn't complain about this.
2316 *cpo-p*
2317 p Vi compatible Lisp indenting. When not present, a
2318 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002319 *cpo-P*
2320 P When included, a ":write" command that appends to a
2321 file will set the file name for the current buffer, if
2322 the current buffer doesn't have a file name yet and
2323 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002324 *cpo-q*
2325 q When joining multiple lines leave the cursor at the
2326 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002327 *cpo-r*
2328 r Redo ("." command) uses "/" to repeat a search
2329 command, instead of the actually used search string.
2330 *cpo-R*
2331 R Remove marks from filtered lines. Without this flag
2332 marks are kept like |:keepmarks| was used.
2333 *cpo-s*
2334 s Set buffer options when entering the buffer for the
2335 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002336 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337 set when the buffer is created.
2338 *cpo-S*
2339 S Set buffer options always when entering a buffer
2340 (except 'readonly', 'fileformat', 'filetype' and
2341 'syntax'). This is the (most) Vi compatible setting.
2342 The options are set to the values in the current
2343 buffer. When you change an option and go to another
2344 buffer, the value is copied. Effectively makes the
2345 buffer options global to all buffers.
2346
2347 's' 'S' copy buffer options
2348 no no when buffer created
2349 yes no when buffer first entered (default)
2350 X yes each time when buffer entered (vi comp.)
2351 *cpo-t*
2352 t Search pattern for the tag command is remembered for
2353 "n" command. Otherwise Vim only puts the pattern in
2354 the history for search pattern, but doesn't change the
2355 last used search pattern.
2356 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002357 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358 *cpo-v*
2359 v Backspaced characters remain visible on the screen in
2360 Insert mode. Without this flag the characters are
2361 erased from the screen right away. With this flag the
2362 screen newly typed text overwrites backspaced
2363 characters.
2364 *cpo-w*
2365 w When using "cw" on a blank character, only change one
2366 character and not all blanks until the start of the
2367 next word.
2368 *cpo-W*
2369 W Don't overwrite a readonly file. When omitted, ":w!"
2370 overwrites a readonly file, if possible.
2371 *cpo-x*
2372 x <Esc> on the command-line executes the command-line.
2373 The default in Vim is to abandon the command-line,
2374 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002375 *cpo-X*
2376 X When using a count with "R" the replaced text is
2377 deleted only once. Also when repeating "R" with "."
2378 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002380 y A yank command can be redone with ".". Think twice if
2381 you really want to use this, it may break some
2382 plugins, since most people expect "." to only repeat a
2383 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002384 *cpo-Z*
2385 Z When using "w!" while the 'readonly' option is set,
2386 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 *cpo-!*
2388 ! When redoing a filter command, use the last used
2389 external command, whatever it was. Otherwise the last
2390 used -filter- command is used.
2391 *cpo-$*
2392 $ When making a change to one line, don't redisplay the
2393 line, but put a '$' at the end of the changed text.
2394 The changed text will be overwritten when you type the
2395 new text. The line is redisplayed if you type any
2396 command that moves the cursor from the insertion
2397 point.
2398 *cpo-%*
2399 % Vi-compatible matching is done for the "%" command.
2400 Does not recognize "#if", "#endif", etc.
2401 Does not recognize "/*" and "*/".
2402 Parens inside single and double quotes are also
2403 counted, causing a string that contains a paren to
2404 disturb the matching. For example, in a line like
2405 "if (strcmp("foo(", s))" the first paren does not
2406 match the last one. When this flag is not included,
2407 parens inside single and double quotes are treated
2408 specially. When matching a paren outside of quotes,
2409 everything inside quotes is ignored. When matching a
2410 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002411 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002412 This flag is also used for other features, such as
2413 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002414 *cpo--*
2415 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002416 it would go above the first line or below the last
2417 line. Without it the cursor moves to the first or
2418 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002419 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002420 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002421 *cpo-+*
2422 + When included, a ":write file" command will reset the
2423 'modified' flag of the buffer, even though the buffer
2424 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002425 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002426 * Use ":*" in the same way as ":@". When not included,
2427 ":*" is an alias for ":'<,'>", select the Visual area.
2428 *cpo-<*
2429 < Disable the recognition of special key codes in |<>|
2430 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002431 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002432 ":map X <Tab>" results in X being mapped to:
2433 '<' included: "<Tab>" (5 characters)
2434 '<' excluded: "^I" (^I is a real <Tab>)
2435 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002436 *cpo->*
2437 > When appending to a register, put a line break before
2438 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002439 *cpo-;*
2440 ; When using |,| or |;| to repeat the last |t| search
2441 and the cursor is right in front of the searched
2442 character, the cursor won't move. When not included,
2443 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002444 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002445
2446 POSIX flags. These are not included in the Vi default value, except
2447 when $VIM_POSIX was set on startup. |posix|
2448
2449 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002450 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002451 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002452 *cpo-&*
2453 & When ":preserve" was used keep the swap file when
2454 exiting normally while this buffer is still loaded.
2455 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002456 *cpo-\*
2457 \ Backslash in a [] range in a search pattern is taken
2458 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002459 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2460 '\' excluded: "/[ \-]" finds <Space> and '-'
2461 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002462 *cpo-/*
2463 / When "%" is used as the replacement string in a |:s|
2464 command, use the previous replacement string. |:s%|
2465 *cpo-{*
2466 { The |{| and |}| commands also stop at a "{" character
2467 at the start of a line.
2468 *cpo-.*
2469 . The ":chdir" and ":cd" commands fail if the current
2470 buffer is modified, unless ! is used. Vim doesn't
2471 need this, since it remembers the full path of an
2472 opened file.
2473 *cpo-bar*
2474 | The value of the $LINES and $COLUMNS environment
2475 variables overrule the terminal size values obtained
2476 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002477
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002479 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002480'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002481 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002482 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002483 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002484 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002485 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002486 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002487 blowfish Blowfish method. Medium strong encryption but it has
2488 an implementation flaw. Requires Vim 7.3 or later,
2489 files can NOT be read by Vim 7.2 and older. This adds
2490 a "seed" to the file, every time you write the file
2491 the encrypted bytes will be different.
2492 *blowfish2*
2493 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002494 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002495 and older. This adds a "seed" to the file, every time
2496 you write the file the encrypted bytes will be
2497 different. The whole undo file is encrypted, not just
2498 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002499 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002500 *E1197* *E1198* *E1199* *E1200* *E1201*
2501 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2502 Code. Medium strong till strong encryption.
2503 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002504 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002505 It adds a seed and a message authentication code (MAC)
2506 to the file. This needs at least a Vim 8.2.3022 to
2507 read the encrypted file.
2508 Encryption of swap files is not supported, therefore
2509 no swap file will be used when xchacha20 encryption is
2510 enabled.
2511 Encryption of undo files is not yet supported,
2512 therefore no undo file will currently be written.
2513 CURRENTLY EXPERIMENTAL: Files written with this method
2514 might have to be read back with the same version of
2515 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002516
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002517 You should use "blowfish2", also to re-encrypt older files.
2518
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002519 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002520 to the detected method of the file being read. Thus if you write it
2521 without changing 'cryptmethod' the same method will be used.
2522 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002523 explicitly write it, you don't get a warning unless there are other
2524 modifications. Also see |:X|.
2525
2526 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002527 the value "blowfish2". When setting the local value to an empty
2528 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002529
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002530 When a new encryption method is added in a later version of Vim, and
2531 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002532 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002533
2534
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535 *'cscopepathcomp'* *'cspc'*
2536'cscopepathcomp' 'cspc' number (default 0)
2537 global
2538 {not available when compiled without the |+cscope|
2539 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 Determines how many components of the path to show in a list of tags.
2541 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002542 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543
2544 *'cscopeprg'* *'csprg'*
2545'cscopeprg' 'csprg' string (default "cscope")
2546 global
2547 {not available when compiled without the |+cscope|
2548 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 Specifies the command to execute cscope. See |cscopeprg|.
2550 This option cannot be set from a |modeline| or in the |sandbox|, for
2551 security reasons.
2552
2553 *'cscopequickfix'* *'csqf'*
2554'cscopequickfix' 'csqf' string (default "")
2555 global
2556 {not available when compiled without the |+cscope|
2557 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558 Specifies whether to use quickfix window to show cscope results.
2559 See |cscopequickfix|.
2560
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002561 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002562'cscoperelative' 'csre' boolean (default off)
2563 global
2564 {not available when compiled without the |+cscope|
2565 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002566 In the absence of a prefix (-P) for cscope. setting this option enables
2567 to use the basename of cscope.out path as the prefix.
2568 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002569 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002570
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2572'cscopetag' 'cst' boolean (default off)
2573 global
2574 {not available when compiled without the |+cscope|
2575 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 Use cscope for tag commands. See |cscope-options|.
2577 NOTE: This option is reset when 'compatible' is set.
2578
2579 *'cscopetagorder'* *'csto'*
2580'cscopetagorder' 'csto' number (default 0)
2581 global
2582 {not available when compiled without the |+cscope|
2583 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584 Determines the order in which ":cstag" performs a search. See
2585 |cscopetagorder|.
2586 NOTE: This option is set to 0 when 'compatible' is set.
2587
2588 *'cscopeverbose'* *'csverb'*
2589 *'nocscopeverbose'* *'nocsverb'*
2590'cscopeverbose' 'csverb' boolean (default off)
2591 global
2592 {not available when compiled without the |+cscope|
2593 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 Give messages when adding a cscope database. See |cscopeverbose|.
2595 NOTE: This option is reset when 'compatible' is set.
2596
Bram Moolenaar860cae12010-06-05 23:22:07 +02002597 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2598'cursorbind' 'crb' boolean (default off)
2599 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002600 When this option is set, as the cursor in the current
2601 window moves other cursorbound windows (windows that also have
2602 this option set) move their cursors to the corresponding line and
2603 column. This option is useful for viewing the
2604 differences between two versions of a file (see 'diff'); in diff mode,
2605 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002606 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002607
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002608
2609 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2610'cursorcolumn' 'cuc' boolean (default off)
2611 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002612 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002613 feature}
2614 Highlight the screen column of the cursor with CursorColumn
2615 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2616 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002617 If you only want the highlighting in the current window you can use
2618 these autocommands: >
2619 au WinLeave * set nocursorline nocursorcolumn
2620 au WinEnter * set cursorline cursorcolumn
2621<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002622
2623 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2624'cursorline' 'cul' boolean (default off)
2625 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002626 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002627 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002628 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2629 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002630 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002631 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002632
2633
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002634 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002635'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002636 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002637 {not available when compiled without the |+syntax|
2638 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002639 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002640 Valid values:
2641 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002642 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002643 "screenline" Highlight only the screen line of the cursor with
2644 CursorLine |hl-CursorLine|.
2645 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002646 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002647
2648 Special value:
2649 "both" Alias for the values "line,number".
2650
2651 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002652
2653
Bram Moolenaar071d4272004-06-13 20:20:40 +00002654 *'debug'*
2655'debug' string (default "")
2656 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002657 These values can be used:
2658 msg Error messages that would otherwise be omitted will be given
2659 anyway.
2660 throw Error messages that would otherwise be omitted will be given
2661 anyway and also throw an exception and set |v:errmsg|.
2662 beep A message will be given when otherwise only a beep would be
2663 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002664 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002665 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2666 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667
2668 *'define'* *'def'*
2669'define' 'def' string (default "^\s*#\s*define")
2670 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002671 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672 pattern, just like for the "/" command. This option is used for the
2673 commands like "[i" and "[d" |include-search|. The 'isident' option is
2674 used to recognize the defined name after the match:
2675 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2676 See |option-backslash| about inserting backslashes to include a space
2677 or backslash.
2678 The default value is for C programs. For C++ this value would be
2679 useful, to include const type declarations: >
2680 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002681< You can also use "\ze" just before the name and continue the pattern
2682 to check what is following. E.g. for Javascript, if a function is
2683 defined with "func_name = function(args)": >
2684 ^\s*\ze\i\+\s*=\s*function(
2685< If the function is defined with "func_name : function() {...": >
2686 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002688 To avoid that use `:let` with a single quote string: >
2689 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002690<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691
2692 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2693'delcombine' 'deco' boolean (default off)
2694 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 If editing Unicode and this option is set, backspace and Normal mode
2696 "x" delete each combining character on its own. When it is off (the
2697 default) the character along with its combining characters are
2698 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002699 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700
2701 This is useful for Arabic, Hebrew and many other languages where one
2702 may have combining characters overtop of base characters, and want
2703 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002704 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705
2706 *'dictionary'* *'dict'*
2707'dictionary' 'dict' string (default "")
2708 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 List of file names, separated by commas, that are used to lookup words
2710 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2711 contain a list of words. This can be one word per line, or several
2712 words per line, separated by non-keyword characters (white space is
2713 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002714
2715 When this option is empty or an entry "spell" is present, and spell
2716 checking is enabled, words in the word lists for the currently active
2717 'spelllang' are used. See |spell|.
2718
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002719 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720 after a comma are ignored, otherwise spaces are included in the file
2721 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002722 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 Where to find a list of words?
2724 - On FreeBSD, there is the file "/usr/share/dict/words".
2725 - In the Simtel archive, look in the "msdos/linguist" directory.
2726 - In "miscfiles" of the GNU collection.
2727 The use of |:set+=| and |:set-=| is preferred when adding or removing
2728 directories from the list. This avoids problems when a future version
2729 uses another default.
2730 Backticks cannot be used in this option for security reasons.
2731
2732 *'diff'* *'nodiff'*
2733'diff' boolean (default off)
2734 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735 {not available when compiled without the |+diff|
2736 feature}
2737 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002738 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739
2740 *'dex'* *'diffexpr'*
2741'diffexpr' 'dex' string (default "")
2742 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743 {not available when compiled without the |+diff|
2744 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002745 Expression which is evaluated to obtain a diff file (either ed-style
2746 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002747 This option cannot be set from a |modeline| or in the |sandbox|, for
2748 security reasons.
2749
2750 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002751'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 {not available when compiled without the |+diff|
2754 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002755 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756 All are optional. Items must be separated by a comma.
2757
2758 filler Show filler lines, to keep the text
2759 synchronized with a window that has inserted
2760 lines at the same position. Mostly useful
2761 when windows are side-by-side and 'scrollbind'
2762 is set.
2763
2764 context:{n} Use a context of {n} lines between a change
2765 and a fold that contains unchanged lines.
2766 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002767 When using zero the context is actually one,
2768 since folds require a line in between, also
2769 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 See |fold-diff|.
2771
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002772 iblank Ignore changes where lines are all blank. Adds
2773 the "-B" flag to the "diff" command if
2774 'diffexpr' is empty. Check the documentation
2775 of the "diff" command for what this does
2776 exactly.
2777 NOTE: the diff windows will get out of sync,
2778 because no differences between blank lines are
2779 taken into account.
2780
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781 icase Ignore changes in case of text. "a" and "A"
2782 are considered the same. Adds the "-i" flag
2783 to the "diff" command if 'diffexpr' is empty.
2784
2785 iwhite Ignore changes in amount of white space. Adds
2786 the "-b" flag to the "diff" command if
2787 'diffexpr' is empty. Check the documentation
2788 of the "diff" command for what this does
2789 exactly. It should ignore adding trailing
2790 white space, but not leading white space.
2791
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002792 iwhiteall Ignore all white space changes. Adds
2793 the "-w" flag to the "diff" command if
2794 'diffexpr' is empty. Check the documentation
2795 of the "diff" command for what this does
2796 exactly.
2797
2798 iwhiteeol Ignore white space changes at end of line.
2799 Adds the "-Z" flag to the "diff" command if
2800 'diffexpr' is empty. Check the documentation
2801 of the "diff" command for what this does
2802 exactly.
2803
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002804 horizontal Start diff mode with horizontal splits (unless
2805 explicitly specified otherwise).
2806
2807 vertical Start diff mode with vertical splits (unless
2808 explicitly specified otherwise).
2809
Bram Moolenaarc8234772019-11-10 21:00:27 +01002810 closeoff When a window is closed where 'diff' is set
2811 and there is only one window remaining in the
2812 same tab page with 'diff' set, execute
2813 `:diffoff` in that window. This undoes a
2814 `:diffsplit` command.
2815
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002816 hiddenoff Do not use diff mode for a buffer when it
2817 becomes hidden.
2818
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002819 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2820 starting diff mode. Without this 2 is used.
2821
Bram Moolenaar4223d432021-02-10 13:18:17 +01002822 followwrap Follow the 'wrap' option and leave as it is.
2823
Bram Moolenaare828b762018-09-10 17:51:58 +02002824 internal Use the internal diff library. This is
2825 ignored when 'diffexpr' is set. *E960*
2826 When running out of memory when writing a
2827 buffer this item will be ignored for diffs
2828 involving that buffer. Set the 'verbose'
2829 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830
Bram Moolenaare828b762018-09-10 17:51:58 +02002831 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002832 Use the indent heuristic for the internal
2833 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002834
2835 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002836 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002837 algorithms are:
2838 myers the default algorithm
2839 minimal spend extra time to generate the
2840 smallest possible diff
2841 patience patience diff algorithm
2842 histogram histogram diff algorithm
2843
2844 Examples: >
2845 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002847 :set diffopt=internal,filler,foldcolumn:3
2848 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849<
2850 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2851'digraph' 'dg' boolean (default off)
2852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853 {not available when compiled without the |+digraphs|
2854 feature}
2855 Enable the entering of digraphs in Insert mode with {char1} <BS>
2856 {char2}. See |digraphs|.
2857 NOTE: This option is reset when 'compatible' is set.
2858
2859 *'directory'* *'dir'*
2860'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002861 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862 for Unix: ".,~/tmp,/var/tmp,/tmp")
2863 global
2864 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002865 Recommended value: ".,~/vimswap//" - this will put the swap file next
2866 to the edited file if possible, and in your personal swap directory
2867 otherwise. Make sure "~/vimswap//" is only readable for you.
2868
2869 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 - The swap file will be created in the first directory where this is
2871 possible.
2872 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002873 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874 - A directory "." means to put the swap file in the same directory as
2875 the edited file. On Unix, a dot is prepended to the file name, so
2876 it doesn't show in a directory listing. On MS-Windows the "hidden"
2877 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002878 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2879 the swap file relative to where the edited file is. The leading "."
2880 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002881 - For Unix and Win32, if a directory ends in two path separators "//",
2882 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002883 with all path separators replaced by percent '%' signs (including
2884 the colon following the drive letter on Win32). This will ensure
2885 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002886 On Win32, it is also possible to end with "\\". However, When a
2887 separating comma is following, you must use "//", since "\\" will
2888 include the comma in the file name. Therefore it is recommended to
2889 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890 - Spaces after the comma are ignored, other spaces are considered part
2891 of the directory name. To have a space at the start of a directory
2892 name, precede it with a backslash.
2893 - To include a comma in a directory name precede it with a backslash.
2894 - A directory name may end in an ':' or '/'.
2895 - Environment variables are expanded |:set_env|.
2896 - Careful with '\' characters, type one before a space, type two to
2897 get one in the option (see |option-backslash|), for example: >
2898 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2899< - For backwards compatibility with Vim version 3.0 a '>' at the start
2900 of the option is removed.
2901 Using "." first in the list is recommended. This means that editing
2902 the same file twice will result in a warning. Using "/tmp" on Unix is
2903 discouraged: When the system crashes you lose the swap file.
2904 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002905 choice than "/tmp". But others on the computer may be able to see the
2906 files, and it can contain a lot of files, your swap files get lost in
2907 the crowd. That is why a "tmp" directory in your home directory is
2908 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 The use of |:set+=| and |:set-=| is preferred when adding or removing
2910 directories from the list. This avoids problems when a future version
2911 uses another default.
2912 This option cannot be set from a |modeline| or in the |sandbox|, for
2913 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914
2915 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002916'display' 'dy' string (default "", set to "truncate" in
2917 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002919 Change the way text is displayed. This is comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 flags:
2921 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002922 in a window will be displayed. "@@@" is put in the
2923 last columns of the last screen line to indicate the
2924 rest of the line is not displayed.
2925 truncate Like "lastline", but "@@@" is displayed in the first
2926 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927 uhex Show unprintable characters hexadecimal as <xx>
2928 instead of using ^C and ~C.
2929
Bram Moolenaard0796902016-09-16 20:02:31 +02002930 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002931 doesn't fit is replaced with "@" lines.
2932
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 *'eadirection'* *'ead'*
2934'eadirection' 'ead' string (default "both")
2935 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 Tells when the 'equalalways' option applies:
2937 ver vertically, width of windows is not affected
2938 hor horizontally, height of windows is not affected
2939 both width and height of windows is affected
2940
2941 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2942'edcompatible' 'ed' boolean (default off)
2943 global
2944 Makes the 'g' and 'c' flags of the ":substitute" command to be
2945 toggled each time the flag is given. See |complex-change|. See
2946 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002947 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002948 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949
Bram Moolenaar03413f42016-04-12 21:07:15 +02002950 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002951'emoji' 'emo' boolean (default: on)
2952 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002953 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002954 This excludes "text emoji" characters, which are normally displayed as
2955 single width. Unfortunately there is no good specification for this
2956 and it has been determined on trial-and-error basis. Use the
2957 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002958
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002960'encoding' 'enc' string (default for MS-Windows: "utf-8",
2961 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 Sets the character encoding used inside Vim. It applies to text in
2964 the buffers, registers, Strings in expressions, text stored in the
2965 viminfo file, etc. It sets the kind of characters which Vim can work
2966 with. See |encoding-names| for the possible values.
2967
2968 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002969 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002971 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972
Bram Moolenaar865242e2010-07-14 21:12:05 +02002973 This option cannot be set from a |modeline|. It would most likely
2974 corrupt the text.
2975
Bram Moolenaar3df01732017-02-17 22:47:16 +01002976 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2977 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 'encoding', "utf-8" is the natural choice for the environment and
2979 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002980 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 versions, and to avoid changing the encoding of newly created files
2982 without your knowledge (in case 'fileencodings' is empty).
2983
2984 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002985 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 iconv() or as specified with 'charconvert'.
2987
Bram Moolenaar207f0092020-08-30 17:20:20 +02002988 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002989 can use: >
2990 if has("multi_byte_encoding")
2991<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 Normally 'encoding' will be equal to your current locale. This will
2993 be the default if Vim recognizes your environment settings. If
2994 'encoding' is not set to the current locale, 'termencoding' must be
2995 set to convert typed and displayed text. See |encoding-table|.
2996
2997 When you set this option, it fires the |EncodingChanged| autocommand
2998 event so that you can set up fonts if necessary.
2999
3000 When the option is set, the value is converted to lowercase. Thus
3001 you can set it with uppercase values too. Underscores are translated
3002 to '-' signs.
3003 When the encoding is recognized, it is changed to the standard name.
3004 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3005 "iso-8859-2" and "utf8" becomes "utf-8".
3006
3007 Note: "latin1" is also used when the encoding could not be detected.
3008 This only works when editing files in the same encoding! When the
3009 actual character set is not latin1, make sure 'fileencoding' and
3010 'fileencodings' are empty. When conversion is needed, switch to using
3011 utf-8.
3012
3013 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3014 You don't notice this while editing, but it does matter for the
3015 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3016 setting 'encoding' to one of these values instead of utf-8 only has
3017 effect for encoding used for files when 'fileencoding' is empty.
3018
Bram Moolenaar661b1822005-07-28 22:36:45 +00003019 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3020 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021
3022 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3023'endofline' 'eol' boolean (default on)
3024 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003026 is on, or 'fixeol' option is off, no <EOL> will be written for the
3027 last line in the file. This option is automatically set or reset when
3028 starting to edit a new file, depending on whether file has an <EOL>
3029 for the last line in the file. Normally you don't have to set or
3030 reset this option.
3031 When 'binary' is off and 'fixeol' is on the value is not used when
3032 writing the file. When 'binary' is on or 'fixeol' is off it is used
3033 to remember the presence of a <EOL> for the last line in the file, so
3034 that when you write the file the situation from the original file can
3035 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036
3037 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3038'equalalways' 'ea' boolean (default on)
3039 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003041 splitting or closing a window. This also happens the moment the
3042 option is switched on. When off, splitting a window will reduce the
3043 size of the current window and leave the other windows the same. When
3044 closing a window the extra lines are given to the window next to it
3045 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 When mixing vertically and horizontally split windows, a minimal size
3047 is computed and some windows may be larger if there is room. The
3048 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003049 Changing the height and width of a window can be avoided by setting
3050 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003051 If a window size is specified when creating a new window sizes are
3052 currently not equalized (it's complicated, but may be implemented in
3053 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054
3055 *'equalprg'* *'ep'*
3056'equalprg' 'ep' string (default "")
3057 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003059 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003060 or 'indentexpr'. When Vim was compiled without internal formatting,
3061 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003062 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063 about including spaces and backslashes.
3064 This option cannot be set from a |modeline| or in the |sandbox|, for
3065 security reasons.
3066
3067 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3068'errorbells' 'eb' boolean (default off)
3069 global
3070 Ring the bell (beep or screen flash) for error messages. This only
3071 makes a difference for error messages, the bell will be used always
3072 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003073 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003074 screen flash or do nothing. See 'belloff' to finetune when to ring the
3075 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076
3077 *'errorfile'* *'ef'*
3078'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3079 others: "errors.err")
3080 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 {not available when compiled without the |+quickfix|
3082 feature}
3083 Name of the errorfile for the QuickFix mode (see |:cf|).
3084 When the "-q" command-line argument is used, 'errorfile' is set to the
3085 following argument. See |-q|.
3086 NOT used for the ":make" command. See 'makeef' for that.
3087 Environment variables are expanded |:set_env|.
3088 See |option-backslash| about including spaces and backslashes.
3089 This option cannot be set from a |modeline| or in the |sandbox|, for
3090 security reasons.
3091
3092 *'errorformat'* *'efm'*
3093'errorformat' 'efm' string (default is very long)
3094 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 {not available when compiled without the |+quickfix|
3096 feature}
3097 Scanf-like description of the format for the lines in the error file
3098 (see |errorformat|).
3099
3100 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3101'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3102 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 Function keys that start with an <Esc> are recognized in Insert
3104 mode. When this option is off, the cursor and function keys cannot be
3105 used in Insert mode if they start with an <Esc>. The advantage of
3106 this is that the single <Esc> is recognized immediately, instead of
3107 after one second. Instead of resetting this option, you might want to
3108 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3109 when 'esckeys' is off, you can still map anything, but the cursor keys
3110 won't work by default.
3111 NOTE: This option is set to the Vi default value when 'compatible' is
3112 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003113 NOTE: when this option is off then the |modifyOtherKeys| functionality
3114 is disabled while in Insert mode to avoid ending Insert mode with any
3115 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116
3117 *'eventignore'* *'ei'*
3118'eventignore' 'ei' string (default "")
3119 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003121 When set to "all" or when "all" is one of the items, all autocommand
3122 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003123 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124 :set ei=WinEnter,WinLeave
3125<
3126 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3127'expandtab' 'et' boolean (default off)
3128 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003130 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3132 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003133 This option is reset when the 'paste' option is set and restored when
3134 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 NOTE: This option is reset when 'compatible' is set.
3136
3137 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3138'exrc' 'ex' boolean (default off)
3139 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003141 directory.
3142
3143 Setting this option is a potential security leak. E.g., consider
3144 unpacking a package or fetching files from github, a .vimrc in there
3145 might be a trojan horse. BETTER NOT SET THIS OPTION!
3146 Instead, define an autocommand in your .vimrc to set options for a
3147 matching directory.
3148
3149 If you do switch this option on you should also consider setting the
3150 'secure' option (see |initialization|).
3151 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 This option cannot be set from a |modeline| or in the |sandbox|, for
3153 security reasons.
3154
3155 *'fileencoding'* *'fenc'* *E213*
3156'fileencoding' 'fenc' string (default: "")
3157 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003159
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003161 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 When 'fileencoding' is empty, the same value as 'encoding' will be
3163 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003164 No error will be given when the value is set, only when it is used,
3165 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003166 Conversion will also be done when 'encoding' and 'fileencoding' are
3167 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3168 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003170 'encoding' is "utf-8" or another Unicode encoding, conversion
3171 is most likely done in a way that the reverse conversion
3172 results in the same text. When 'encoding' is not "utf-8" some
3173 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003174
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175 See 'encoding' for the possible values. Additionally, values may be
3176 specified that can be handled by the converter, see
3177 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003178
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 When reading a file 'fileencoding' will be set from 'fileencodings'.
3180 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003181 'fileencoding', use the |++enc| argument. One exception: when
3182 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003183 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003184
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3186 When the option is set, the value is converted to lowercase. Thus
3187 you can set it with uppercase values too. '_' characters are
3188 replaced with '-'. If a name is recognized from the list for
3189 'encoding', it is replaced by the standard name. For example
3190 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003191
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 When this option is set, after starting to edit a file, the 'modified'
3193 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003194
3195 Keep in mind that changing 'fenc' from a modeline happens
3196 AFTER the text has been read, thus it applies to when the file will be
3197 written. If you do set 'fenc' in a modeline, you might want to set
3198 'nomodified' to avoid not being able to ":q".
3199
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 This option can not be changed when 'modifiable' is off.
3201
3202 *'fe'*
3203 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003204 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205 old short name was 'fe', which is no longer used.
3206
3207 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003208'fileencodings' 'fencs' string (default: "ucs-bom",
3209 "ucs-bom,utf-8,default,latin1" when
3210 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 This is a list of character encodings considered when starting to edit
3213 an existing file. When a file is read, Vim tries to use the first
3214 mentioned character encoding. If an error is detected, the next one
3215 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003216 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 an empty string, which means the value of 'encoding' is used.
3218 WARNING: Conversion can cause loss of information! When
3219 'encoding' is "utf-8" (or one of the other Unicode variants)
3220 conversion is most likely done in a way that the reverse
3221 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003222 "utf-8" some non-ASCII characters may be lost! You can use
3223 the |++bad| argument to specify what is done with characters
3224 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 For an empty file or a file with only ASCII characters most encodings
3226 will work and the first entry of 'fileencodings' will be used (except
3227 "ucs-bom", which requires the BOM to be present). If you prefer
3228 another encoding use an BufReadPost autocommand event to test if your
3229 preferred encoding is to be used. Example: >
3230 au BufReadPost * if search('\S', 'w') == 0 |
3231 \ set fenc=iso-2022-jp | endif
3232< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3233 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003234 When the |++enc| argument is used then the value of 'fileencodings' is
3235 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003236 Note that 'fileencodings' is not used for a new file, the global value
3237 of 'fileencoding' is used instead. You can set it with: >
3238 :setglobal fenc=iso-8859-2
3239< This means that a non-existing file may get a different encoding than
3240 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 The special value "ucs-bom" can be used to check for a Unicode BOM
3242 (Byte Order Mark) at the start of the file. It must not be preceded
3243 by "utf-8" or another Unicode encoding for this to work properly.
3244 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3245 because Vim cannot detect an error, thus the encoding is always
3246 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003247 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003248 environment. On MS-Windows this is the system encoding. Otherwise
3249 this is the default value for 'encoding'. It is useful when
3250 'encoding' is set to "utf-8" and your environment uses a non-latin1
3251 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003252 When 'encoding' is "utf-8" and a file contains an illegal byte
3253 sequence it won't be recognized as UTF-8. You can use the |8g8|
3254 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 WRONG VALUES: WHAT'S WRONG:
3256 latin1,utf-8 "latin1" will always be used
3257 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3258 file
3259 cp1250,latin1 "cp1250" will always be used
3260 If 'fileencodings' is empty, 'fileencoding' is not modified.
3261 See 'fileencoding' for the possible values.
3262 Setting this option does not have an effect until the next time a file
3263 is read.
3264
3265 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003266'fileformat' 'ff' string (MS-Windows default: "dos",
3267 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 This gives the <EOL> of the current buffer, which is used for
3270 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003271 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 unix <NL>
3273 mac <CR>
3274 When "dos" is used, CTRL-Z at the end of a file is ignored.
3275 See |file-formats| and |file-read|.
3276 For the character encoding of the file see 'fileencoding'.
3277 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003278 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 This option is set automatically when starting to edit a file and
3280 'fileformats' is not empty and 'binary' is off.
3281 When this option is set, after starting to edit a file, the 'modified'
3282 option is set, because the file would be different when written.
3283 This option can not be changed when 'modifiable' is off.
3284 For backwards compatibility: When this option is set to "dos",
3285 'textmode' is set, otherwise 'textmode' is reset.
3286
3287 *'fileformats'* *'ffs'*
3288'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003289 Vim+Vi MS-Windows: "dos,unix",
3290 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 Vi Cygwin: "unix,dos",
3292 Vi others: "")
3293 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 This gives the end-of-line (<EOL>) formats that will be tried when
3295 starting to edit a new buffer and when reading a file into an existing
3296 buffer:
3297 - When empty, the format defined with 'fileformat' will be used
3298 always. It is not set automatically.
3299 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003300 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 'fileformats' name will be used when a file is read into an existing
3302 buffer, no matter what 'fileformat' for that buffer is set to.
3303 - When more than one name is present, separated by commas, automatic
3304 <EOL> detection will be done when reading a file. When starting to
3305 edit a file, a check is done for the <EOL>:
3306 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3307 'fileformat' is set to "dos".
3308 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003309 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003311 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3312 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003313 This means that "mac" is only chosen when:
3314 "unix" is not present or no <NL> is found in the file, and
3315 "dos" is not present or no <CR><NL> is found in the file.
3316 Except: if "unix" was chosen, but there is a <CR> before
3317 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003318 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 4. If 'fileformat' is still not set, the first name from
3320 'fileformats' is used.
3321 When reading a file into an existing buffer, the same is done, but
3322 this happens like 'fileformat' has been set appropriately for that
3323 file only, the option is not changed.
3324 When 'binary' is set, the value of 'fileformats' is not used.
3325
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003326 When Vim starts up with an empty buffer the first item is used. You
3327 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003328
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3330 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3331 done:
3332 - When 'fileformats' is empty, there is no automatic detection. Dos
3333 format will be used.
3334 - When 'fileformats' is set to one or more names, automatic detection
3335 is done. This is based on the first <NL> in the file: If there is a
3336 <CR> in front of it, Dos format is used, otherwise Unix format is
3337 used.
3338 Also see |file-formats|.
3339 For backwards compatibility: When this option is set to an empty
3340 string or one format (no comma is included), 'textauto' is reset,
3341 otherwise 'textauto' is set.
3342 NOTE: This option is set to the Vi default value when 'compatible' is
3343 set and to the Vim default value when 'compatible' is reset.
3344
Bram Moolenaarbf884932013-04-05 22:26:15 +02003345 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3346'fileignorecase' 'fic' boolean (default on for systems where case in file
3347 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003348 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003349 When set case is ignored when using file names and directories.
3350 See 'wildignorecase' for only ignoring case when doing completion.
3351
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 *'filetype'* *'ft'*
3353'filetype' 'ft' string (default: "")
3354 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 When this option is set, the FileType autocommand event is triggered.
3356 All autocommands that match with the value of this option will be
3357 executed. Thus the value of 'filetype' is used in place of the file
3358 name.
3359 Otherwise this option does not always reflect the current file type.
3360 This option is normally set when the file type is detected. To enable
3361 this use the ":filetype on" command. |:filetype|
3362 Setting this option to a different value is most useful in a modeline,
3363 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003364 Example, for in an IDL file:
3365 /* vim: set filetype=idl : */ ~
3366 |FileType| |filetypes|
3367 When a dot appears in the value then this separates two filetype
3368 names. Example:
3369 /* vim: set filetype=c.doxygen : */ ~
3370 This will use the "c" filetype first, then the "doxygen" filetype.
3371 This works both for filetype plugins and for syntax files. More than
3372 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373 This option is not copied to another buffer, independent of the 's' or
3374 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003375 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376
3377 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003378'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003380 {not available when compiled without the |+folding|
3381 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 Characters to fill the statuslines and vertical separators.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003383 It is a comma-separated list of items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384
3385 item default Used for ~
3386 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003387 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 vert:c '|' vertical separators |:vsplit|
3389 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003390 foldopen:c '-' mark the beginning of a fold
3391 foldclose:c '+' show a closed fold
3392 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003394 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003396 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003397 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 otherwise.
3399
3400 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003401 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402< This is similar to the default, except that these characters will also
3403 be used when there is highlighting.
3404
Bram Moolenaar008bff92021-03-04 21:55:58 +01003405 For "stl" and "stlnc" single-byte and multibyte characters are
3406 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003407
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 The highlighting used for these items:
3409 item highlight group ~
3410 stl:c StatusLine |hl-StatusLine|
3411 stlnc:c StatusLineNC |hl-StatusLineNC|
3412 vert:c VertSplit |hl-VertSplit|
3413 fold:c Folded |hl-Folded|
3414 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003415 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003417 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3418'fixendofline' 'fixeol' boolean (default on)
3419 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003420 When writing a file and this option is on, <EOL> at the end of file
3421 will be restored if missing. Turn this option off if you want to
3422 preserve the situation from the original file.
3423 When the 'binary' option is set the value of this option doesn't
3424 matter.
3425 See the 'endofline' option.
3426
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003428'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 {only available when compiled with the |+rightleft|
3431 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003432 This option was for using Farsi, which has been removed. See
3433 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434
3435 *'foldclose'* *'fcl'*
3436'foldclose' 'fcl' string (default "")
3437 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438 {not available when compiled without the |+folding|
3439 feature}
3440 When set to "all", a fold is closed when the cursor isn't in it and
3441 its level is higher than 'foldlevel'. Useful if you want folds to
3442 automatically close when moving out of them.
3443
3444 *'foldcolumn'* *'fdc'*
3445'foldcolumn' 'fdc' number (default 0)
3446 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003447 {not available when compiled without the |+folding|
3448 feature}
3449 When non-zero, a column with the specified width is shown at the side
3450 of the window which indicates open and closed folds. The maximum
3451 value is 12.
3452 See |folding|.
3453
3454 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3455'foldenable' 'fen' boolean (default on)
3456 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457 {not available when compiled without the |+folding|
3458 feature}
3459 When off, all folds are open. This option can be used to quickly
3460 switch between showing all text unfolded and viewing the text with
3461 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003462 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 'foldenable' is off.
3464 This option is set by commands that create a new fold or close a fold.
3465 See |folding|.
3466
3467 *'foldexpr'* *'fde'*
3468'foldexpr' 'fde' string (default: "0")
3469 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003471 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003473 for each line to obtain its fold level. The context is set to the
3474 script where 'foldexpr' was set, script-local items can be accessed.
3475 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003476
Bram Moolenaar30b65812012-07-12 22:01:11 +02003477 The expression will be evaluated in the |sandbox| if set from a
3478 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003479 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003480 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003481
3482 It is not allowed to change text or jump to another window while
3483 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484
3485 *'foldignore'* *'fdi'*
3486'foldignore' 'fdi' string (default: "#")
3487 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 {not available when compiled without the |+folding|
3489 feature}
3490 Used only when 'foldmethod' is "indent". Lines starting with
3491 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003492 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 The default "#" works well for C programs. See |fold-indent|.
3494
3495 *'foldlevel'* *'fdl'*
3496'foldlevel' 'fdl' number (default: 0)
3497 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 {not available when compiled without the |+folding|
3499 feature}
3500 Sets the fold level: Folds with a higher level will be closed.
3501 Setting this option to zero will close all folds. Higher numbers will
3502 close fewer folds.
3503 This option is set by commands like |zm|, |zM| and |zR|.
3504 See |fold-foldlevel|.
3505
3506 *'foldlevelstart'* *'fdls'*
3507'foldlevelstart' 'fdls' number (default: -1)
3508 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509 {not available when compiled without the |+folding|
3510 feature}
3511 Sets 'foldlevel' when starting to edit another buffer in a window.
3512 Useful to always start editing with all folds closed (value zero),
3513 some folds closed (one) or no folds closed (99).
3514 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003515 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 ignores this option and closes all folds.
3517 It is also done before BufReadPre autocommands, to allow an autocmd to
3518 overrule the 'foldlevel' value for specific files.
3519 When the value is negative, it is not used.
3520
3521 *'foldmarker'* *'fmr'* *E536*
3522'foldmarker' 'fmr' string (default: "{{{,}}}")
3523 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524 {not available when compiled without the |+folding|
3525 feature}
3526 The start and end marker used when 'foldmethod' is "marker". There
3527 must be one comma, which separates the start and end marker. The
3528 marker is a literal string (a regular expression would be too slow).
3529 See |fold-marker|.
3530
3531 *'foldmethod'* *'fdm'*
3532'foldmethod' 'fdm' string (default: "manual")
3533 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 {not available when compiled without the |+folding|
3535 feature}
3536 The kind of folding used for the current window. Possible values:
3537 |fold-manual| manual Folds are created manually.
3538 |fold-indent| indent Lines with equal indent form a fold.
3539 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3540 |fold-marker| marker Markers are used to specify folds.
3541 |fold-syntax| syntax Syntax highlighting items specify folds.
3542 |fold-diff| diff Fold text that is not changed.
3543
3544 *'foldminlines'* *'fml'*
3545'foldminlines' 'fml' number (default: 1)
3546 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547 {not available when compiled without the |+folding|
3548 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003549 Sets the number of screen lines above which a fold can be displayed
3550 closed. Also for manually closed folds. With the default value of
3551 one a fold can only be closed if it takes up two or more screen lines.
3552 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003553 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554 "zc" to close a fold, which is displayed open because it's smaller
3555 than 'foldminlines', a following "zc" may close a containing fold.
3556
3557 *'foldnestmax'* *'fdn'*
3558'foldnestmax' 'fdn' number (default: 20)
3559 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 {not available when compiled without the |+folding|
3561 feature}
3562 Sets the maximum nesting of folds for the "indent" and "syntax"
3563 methods. This avoids that too many folds will be created. Using more
3564 than 20 doesn't work, because the internal limit is 20.
3565
3566 *'foldopen'* *'fdo'*
3567'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3568 search,tag,undo")
3569 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 {not available when compiled without the |+folding|
3571 feature}
3572 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003573 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003575 NOTE: When the command is part of a mapping this option is not used.
3576 Add the |zv| command to the mapping to get the same effect.
3577 (rationale: the mapping may want to control opening folds itself)
3578
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579 item commands ~
3580 all any
3581 block "(", "{", "[[", "[{", etc.
3582 hor horizontal movements: "l", "w", "fx", etc.
3583 insert any command in Insert mode
3584 jump far jumps: "G", "gg", etc.
3585 mark jumping to a mark: "'m", CTRL-O, etc.
3586 percent "%"
3587 quickfix ":cn", ":crew", ":make", etc.
3588 search search for a pattern: "/", "n", "*", "gd", etc.
3589 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003590 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003591 tag jumping to a tag: ":ta", CTRL-T, etc.
3592 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593 When a movement command is used for an operator (e.g., "dl" or "y%")
3594 this option is not used. This means the operator will include the
3595 whole closed fold.
3596 Note that vertical movements are not here, because it would make it
3597 very difficult to move onto a closed fold.
3598 In insert mode the folds containing the cursor will always be open
3599 when text is inserted.
3600 To close folds you can re-apply 'foldlevel' with the |zx| command or
3601 set the 'foldclose' option to "all".
3602
3603 *'foldtext'* *'fdt'*
3604'foldtext' 'fdt' string (default: "foldtext()")
3605 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606 {not available when compiled without the |+folding|
3607 feature}
3608 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003609 fold. The context is set to the script where 'foldexpr' was set,
3610 script-local items can be accessed. See |fold-foldtext| for the
3611 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612
Bram Moolenaar30b65812012-07-12 22:01:11 +02003613 The expression will be evaluated in the |sandbox| if set from a
3614 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003615 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003616
3617 It is not allowed to change text or jump to another window while
3618 evaluating 'foldtext' |textlock|.
3619
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003620 *'formatexpr'* *'fex'*
3621'formatexpr' 'fex' string (default "")
3622 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003623 {not available when compiled without the |+eval|
3624 feature}
3625 Expression which is evaluated to format a range of lines for the |gq|
3626 operator or automatic formatting (see 'formatoptions'). When this
3627 option is empty 'formatprg' is used.
3628
3629 The |v:lnum| variable holds the first line to be formatted.
3630 The |v:count| variable holds the number of lines to be formatted.
3631 The |v:char| variable holds the character that is going to be
3632 inserted if the expression is being evaluated due to
3633 automatic formatting. This can be empty. Don't insert
3634 it yet!
3635
3636 Example: >
3637 :set formatexpr=mylang#Format()
3638< This will invoke the mylang#Format() function in the
3639 autoload/mylang.vim file in 'runtimepath'. |autoload|
3640
3641 The expression is also evaluated when 'textwidth' is set and adding
3642 text beyond that limit. This happens under the same conditions as
3643 when internal formatting is used. Make sure the cursor is kept in the
3644 same spot relative to the text then! The |mode()| function will
3645 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003646
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003647 When the expression evaluates to non-zero Vim will fall back to using
3648 the internal format mechanism.
3649
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003650 If the expression starts with s: or |<SID>|, then it is replaced with
3651 the script ID (|local-function|). Example: >
3652 set formatexpr=s:MyFormatExpr()
3653 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003654< Otherwise, the expression is evaluated in the context of the script
3655 where the option was set, thus script-local items are available.
3656
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003657 The expression will be evaluated in the |sandbox| when set from a
3658 modeline, see |sandbox-option|. That stops the option from working,
3659 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003660 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003661 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003662
Bram Moolenaar86b68352004-12-27 21:59:20 +00003663 *'formatlistpat'* *'flp'*
3664'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3665 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003666 A pattern that is used to recognize a list header. This is used for
3667 the "n" flag in 'formatoptions'.
3668 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003669 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003670 while still checking more characters. There must be a character
3671 following the pattern, when it matches the whole line it is handled
3672 like there is no match.
3673 The default recognizes a number, followed by an optional punctuation
3674 character and white space.
3675
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003676 *'formatoptions'* *'fo'*
3677'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3678 local to buffer
3679 This is a sequence of letters which describes how automatic
3680 formatting is to be done. See |fo-table|. When the 'paste' option is
3681 on, no formatting is done (like 'formatoptions' is empty). Commas can
3682 be inserted for readability.
3683 To avoid problems with flags that are added in the future, use the
3684 "+=" and "-=" feature of ":set" |add-option-flags|.
3685 NOTE: This option is set to the Vi default value when 'compatible' is
3686 set and to the Vim default value when 'compatible' is reset.
3687
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688 *'formatprg'* *'fp'*
3689'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003690 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003692 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003694 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003695 If the 'formatexpr' option is not empty it will be used instead.
3696 Otherwise, if 'formatprg' option is an empty string, the internal
3697 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003698 Environment variables are expanded |:set_env|. See |option-backslash|
3699 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003700 This option cannot be set from a |modeline| or in the |sandbox|, for
3701 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702
Bram Moolenaard94464e2015-11-02 15:28:18 +01003703 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003704'fsync' 'fs' boolean (default on)
3705 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003706 When on, the library function fsync() will be called after writing a
3707 file. This will flush a file to disk, ensuring that it is safely
3708 written even on filesystems which do metadata-only journaling. This
3709 will force the harddrive to spin up on Linux systems running in laptop
3710 mode, so it may be undesirable in some situations. Be warned that
3711 turning this off increases the chances of data loss after a crash. On
3712 systems without an fsync() implementation, this variable is always
3713 off.
3714 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003715 'fsync' also applies to |writefile()| (unless a flag is used to
3716 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003717 This option cannot be set from a |modeline| or in the |sandbox|, for
3718 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003719
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3721'gdefault' 'gd' boolean (default off)
3722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 When on, the ":substitute" flag 'g' is default on. This means that
3724 all matches in a line are substituted instead of one. When a 'g' flag
3725 is given to a ":substitute" command, this will toggle the substitution
3726 of all or one match. See |complex-change|.
3727
3728 command 'gdefault' on 'gdefault' off ~
3729 :s/// subst. all subst. one
3730 :s///g subst. one subst. all
3731 :s///gg subst. all subst. one
3732
3733 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003734 DEPRECATED: Setting this option may break plugins that are not aware
3735 of this option. Also, many users get confused that adding the /g flag
3736 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003737 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003738
3739 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003740'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 Format to recognize for the ":grep" command output.
3743 This is a scanf-like string that uses the same format as the
3744 'errorformat' option: see |errorformat|.
3745
3746 *'grepprg'* *'gp'*
3747'grepprg' 'gp' string (default "grep -n ",
3748 Unix: "grep -n $* /dev/null",
3749 Win32: "findstr /n" or "grep -n",
3750 VMS: "SEARCH/NUMBERS ")
3751 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003752 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 and '#' characters, which are expanded like when used in a command-
3754 line. The placeholder "$*" is allowed to specify where the arguments
3755 will be included. Environment variables are expanded |:set_env|. See
3756 |option-backslash| about including spaces and backslashes.
3757 When your "grep" accepts the "-H" argument, use this to make ":grep"
3758 also work well with a single file: >
3759 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003760< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003761 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3762 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003763 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 apply equally to 'grepprg'.
3765 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3766 otherwise it's "grep -n".
3767 This option cannot be set from a |modeline| or in the |sandbox|, for
3768 security reasons.
3769
3770 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3771'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3772 ve:ver35-Cursor,
3773 o:hor50-Cursor,
3774 i-ci:ver25-Cursor/lCursor,
3775 r-cr:hor20-Cursor/lCursor,
3776 sm:block-Cursor
3777 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003778 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 "n-v-c:block,o:hor50,i-ci:hor15,
3780 r-cr:hor30,sm:block")
3781 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003783 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003785 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003786 height of the cursor can be changed. This can be done by specifying a
3787 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003788 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3789 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003791 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 mode-list and an argument-list:
3793 mode-list:argument-list,mode-list:argument-list,..
3794 The mode-list is a dash separated list of these modes:
3795 n Normal mode
3796 v Visual mode
3797 ve Visual mode with 'selection' "exclusive" (same as 'v',
3798 if not specified)
3799 o Operator-pending mode
3800 i Insert mode
3801 r Replace mode
3802 c Command-line Normal (append) mode
3803 ci Command-line Insert mode
3804 cr Command-line Replace mode
3805 sm showmatch in Insert mode
3806 a all modes
3807 The argument-list is a dash separated list of these arguments:
3808 hor{N} horizontal bar, {N} percent of the character height
3809 ver{N} vertical bar, {N} percent of the character width
3810 block block cursor, fills the whole character
3811 [only one of the above three should be present]
3812 blinkwait{N} *cursor-blinking*
3813 blinkon{N}
3814 blinkoff{N}
3815 blink times for cursor: blinkwait is the delay before
3816 the cursor starts blinking, blinkon is the time that
3817 the cursor is shown and blinkoff is the time that the
3818 cursor is not shown. The times are in msec. When one
3819 of the numbers is zero, there is no blinking. The
3820 default is: "blinkwait700-blinkon400-blinkoff250".
3821 These numbers are used for a missing entry. This
3822 means that blinking is enabled by default. To switch
3823 blinking off you can use "blinkon0". The cursor only
3824 blinks when Vim is waiting for input, not while
3825 executing a command.
3826 To make the cursor blink in an xterm, see
3827 |xterm-blink|.
3828 {group-name}
3829 a highlight group name, that sets the color and font
3830 for the cursor
3831 {group-name}/{group-name}
3832 Two highlight group names, the first is used when
3833 no language mappings are used, the other when they
3834 are. |language-mapping|
3835
3836 Examples of parts:
3837 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3838 block cursor with colors from the "nCursor"
3839 highlight group
3840 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3841 In Insert and Command-line Insert mode, use a
3842 30% vertical bar cursor with colors from the
3843 "iCursor" highlight group. Blink a bit
3844 faster.
3845
3846 The 'a' mode is different. It will set the given argument-list for
3847 all modes. It does not reset anything to defaults. This can be used
3848 to do a common setting for all modes. For example, to switch off
3849 blinking: "a:blinkon0"
3850
3851 Examples of cursor highlighting: >
3852 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3853 :highlight Cursor gui=NONE guifg=bg guibg=fg
3854<
3855 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003856 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857'guifont' 'gfn' string (default "")
3858 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 {only available when compiled with GUI enabled}
3860 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003861 In its simplest form the value is just one font name.
3862 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863
3864 *'guifontset'* *'gfs'*
3865 *E250* *E252* *E234* *E597* *E598*
3866'guifontset' 'gfs' string (default "")
3867 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868 {only available when compiled with GUI enabled and
3869 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003870 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 When not empty, specifies two (or more) fonts to be used. The first
3872 one for normal English, the second one for your special language. See
3873 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003874
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3876'guifontwide' 'gfw' string (default "")
3877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 {only available when compiled with GUI enabled}
3879 When not empty, specifies a comma-separated list of fonts to be used
3880 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003881 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003882
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 *'guiheadroom'* *'ghr'*
3884'guiheadroom' 'ghr' number (default 50)
3885 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003886 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887 The number of pixels subtracted from the screen height when fitting
3888 the GUI window on the screen. Set this before the GUI is started,
3889 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003890 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891 lines will be left for window decorations and other items on the
3892 screen. Set it to a negative value to allow windows taller than the
3893 screen.
3894
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003895 *'guiligatures'* *'gli'* *E1243*
3896'guiligatures' 'gli' string (default "")
3897 global
3898 {only for GTK GUI}
3899 List of ASCII characters that, when combined together, can create more
3900 complex shapes. Each character must be a printable ASCII character
3901 with a value in the 32-127 range.
3902 Example: >
3903 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3904< Changing this option updates screen output immediately. Set it to an
3905 empty string to disable ligatures.
3906
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003908'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3909 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003910 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003911 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003914 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 sequence of letters which describes what components and options of the
3916 GUI should be used.
3917 To avoid problems with flags that are added in the future, use the
3918 "+=" and "-=" feature of ":set" |add-option-flags|.
3919
Bram Moolenaar13568252018-03-16 20:46:58 +01003920 Valid characters are as follows:
3921 *'go-!'*
3922 '!' External commands are executed in a terminal window. Without
3923 this flag the MS-Windows GUI will open a console window to
3924 execute the command. The Unix GUI will simulate a dumb
3925 terminal to list the command output.
3926 The terminal window will be positioned at the bottom, and grow
3927 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003928 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 'a' Autoselect: If present, then whenever VISUAL mode is started,
3930 or the Visual area extended, Vim tries to become the owner of
3931 the windowing system's global selection. This means that the
3932 Visually highlighted text is available for pasting into other
3933 applications as well as into Vim itself. When the Visual mode
3934 ends, possibly due to an operation on the text, or when an
3935 application wants to paste the selection, the highlighted text
3936 is automatically yanked into the "* selection register.
3937 Thus the selection is still available for pasting into other
3938 applications after the VISUAL mode has ended.
3939 If not present, then Vim won't become the owner of the
3940 windowing system's global selection unless explicitly told to
3941 by a yank or delete operation for the "* register.
3942 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003943 *'go-P'*
3944 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003945 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003946 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003947 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 applies to the modeless selection.
3949
3950 'guioptions' autoselect Visual autoselect modeless ~
3951 "" - -
3952 "a" yes yes
3953 "A" - yes
3954 "aA" yes yes
3955
Bram Moolenaar02467872007-05-06 13:22:01 +00003956 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 'c' Use console dialogs instead of popup dialogs for simple
3958 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003959 *'go-d'*
3960 'd' Use dark theme variant if available. Currently only works for
3961 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003962 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003963 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003964 'guitablabel' can be used to change the text in the labels.
3965 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003966 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003967 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003968 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 'f' Foreground: Don't use fork() to detach the GUI from the shell
3970 where it was started. Use this for programs that wait for the
3971 editor to finish (e.g., an e-mail program). Alternatively you
3972 can use "gvim -f" or ":gui -f" to start the GUI in the
3973 foreground. |gui-fork|
3974 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003975 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003976 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3978 corner of the window. It's black&white on non-GTK, because of
3979 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003980 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003982 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003983 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003985 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003987 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003988 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989 'g' Grey menu items: Make menu items that are not active grey. If
3990 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00003991 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 't' Include tearoff menu items. Currently only works for Win32,
3993 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003994 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003995 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
3996 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003997 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003999 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 'R' Right-hand scrollbar is present when there is a vertically
4001 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004002 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004004 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 'L' Left-hand scrollbar is present when there is a vertically
4006 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004007 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4009 the longest visible line, or on the cursor line if the 'h'
4010 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004011 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 'h' Limit horizontal scrollbar size to the length of the cursor
4013 line. Reduces computations. |gui-horiz-scroll|
4014
4015 And yes, you may even have scrollbars on the left AND the right if
4016 you really want to :-). See |gui-scrollbars| for more information.
4017
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004018 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 'v' Use a vertical button layout for dialogs. When not included,
4020 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004021 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004022 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023 'p' Use Pointer callbacks for X11 GUI. This is required for some
4024 window managers. If the cursor is not blinking or hollow at
4025 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004026 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004028 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004029 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004030 *'go-k'*
4031 'k' Keep the GUI window size when adding/removing a scrollbar, or
4032 toolbar, tabline, etc. Instead, the behavior is similar to
4033 when the window is maximized and will adjust 'lines' and
4034 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004035 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004036 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004037
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 *'guipty'* *'noguipty'*
4039'guipty' boolean (default on)
4040 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041 {only available when compiled with GUI enabled}
4042 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4043 I/O to/from shell commands. See |gui-pty|.
4044
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004045 *'guitablabel'* *'gtl'*
4046'guitablabel' 'gtl' string (default empty)
4047 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004048 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004049 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004050 pages line. When empty and when the result is empty Vim will use a
4051 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004052
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004053 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004054 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004055 The expression will be evaluated in the |sandbox| when set from a
4056 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004057 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004058
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004059 Only used when the GUI tab pages line is displayed. 'e' must be
4060 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4061 used.
4062
Bram Moolenaar57657d82006-04-21 22:12:41 +00004063 *'guitabtooltip'* *'gtt'*
4064'guitabtooltip' 'gtt' string (default empty)
4065 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004066 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004067 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004068 pages line. When empty Vim will use a default tooltip.
4069 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004070 You can include a line break. Simplest method is to use |:let|: >
4071 :let &guitabtooltip = "line one\nline two"
4072<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004073
Bram Moolenaar071d4272004-06-13 20:20:40 +00004074 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004075'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076 (others) "$VIMRUNTIME/doc/help.txt")
4077 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 Name of the main help file. All distributed help files should be
4079 placed together in one directory. Additionally, all "doc" directories
4080 in 'runtimepath' will be used.
4081 Environment variables are expanded |:set_env|. For example:
4082 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004083 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 spaces and backslashes.
4085 This option cannot be set from a |modeline| or in the |sandbox|, for
4086 security reasons.
4087
4088 *'helpheight'* *'hh'*
4089'helpheight' 'hh' number (default 20)
4090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 Minimal initial height of the help window when it is opened with the
4092 ":help" command. The initial height of the help window is half of the
4093 current window, or (when the 'ea' option is on) the same as other
4094 windows. When the height is less than 'helpheight', the height is
4095 set to 'helpheight'. Set to zero to disable.
4096
4097 *'helplang'* *'hlg'*
4098'helplang' 'hlg' string (default: messages language or empty)
4099 global
4100 {only available when compiled with the |+multi_lang|
4101 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004102 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 for which the desired help can be found. The English help will always
4104 be used as a last resort. You can add "en" to prefer English over
4105 another language, but that will only find tags that exist in that
4106 language and not in the English help.
4107 Example: >
4108 :set helplang=de,it
4109< This will first search German, then Italian and finally English help
4110 files.
4111 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4112 try to find the tag in the current language before using this option.
4113 See |help-translated|.
4114
4115 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4116'hidden' 'hid' boolean (default off)
4117 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 When off a buffer is unloaded when it is |abandon|ed. When on a
4119 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4120 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004121
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004123 hidden even if the 'hidden' option is off when these three are true:
4124 - the buffer is modified
4125 - 'autowrite' is off or writing is not possible
4126 - the '!' flag was used
4127 Also see |windows.txt|.
4128
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004129 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 This option is set for one command with ":hide {command}" |:hide|.
4131 WARNING: It's easy to forget that you have changes in hidden buffers.
4132 Think twice when using ":q!" or ":qa!".
4133
4134 *'highlight'* *'hl'*
4135'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004136 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4137 d:Directory,e:ErrorMsg,i:IncSearch,
4138 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004139 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004140 N:CursorLineNr,r:Question,s:StatusLine,
4141 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004142 v:Visual,V:VisualNOS,w:WarningMsg,
4143 W:WildMenu,f:Folded,F:FoldColumn,
4144 A:DiffAdd,C:DiffChange,D:DiffDelete,
4145 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004146 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004147 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004148 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4149 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004150 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004151 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004154 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004156 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004158 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4159 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160 characters from 'showbreak'
4161 |hl-Directory| d directories in CTRL-D listing and other special
4162 things in listings
4163 |hl-ErrorMsg| e error messages
4164 h (obsolete, ignored)
4165 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004166 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4168 |hl-MoreMsg| m |more-prompt|
4169 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004170 |hl-LineNr| n line number for ":number" and ":#" commands, and
4171 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004172 |hl-LineNrAbove| a line number above the cursor for when the
4173 'relativenumber' option is set.
4174 |hl-LineNrBelow| b line number below the cursor for when the
4175 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004176 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4177 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178 |hl-Question| r |hit-enter| prompt and yes/no questions
4179 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004180 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4182 |hl-VertSplit| c column used to separate vertically split windows
4183 |hl-Visual| v Visual mode
4184 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4185 Selection" Only X11 Gui's |gui-x11| and
4186 |xterm-clipboard|.
4187 |hl-WarningMsg| w warning messages
4188 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4189 |hl-Folded| f line used for closed folds
4190 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004191 |hl-DiffAdd| A added line in diff mode
4192 |hl-DiffChange| C changed line in diff mode
4193 |hl-DiffDelete| D deleted line in diff mode
4194 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004196 |hl-Conceal| - the placeholders used for concealed characters
4197 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004198 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004199 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004200 |hl-SpellRare| R rare word |spell|
4201 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004202 |hl-Pmenu| + popup menu normal line
4203 |hl-PmenuSel| = popup menu selected line
4204 |hl-PmenuSbar| x popup menu scrollbar
4205 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206
4207 The display modes are:
4208 r reverse (termcap entry "mr" and "me")
4209 i italic (termcap entry "ZH" and "ZR")
4210 b bold (termcap entry "md" and "me")
4211 s standout (termcap entry "so" and "se")
4212 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004213 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004214 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 n no highlighting
4216 - no highlighting
4217 : use a highlight group
4218 The default is used for occasions that are not included.
4219 If you want to change what the display modes do, see |dos-colors|
4220 for an example.
4221 When using the ':' display mode, this must be followed by the name of
4222 a highlight group. A highlight group can be used to define any type
4223 of highlighting, including using color. See |:highlight| on how to
4224 define one. The default uses a different group for each occasion.
4225 See |highlight-default| for the default highlight groups.
4226
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004228'history' 'hi' number (Vim default: 50, Vi default: 0,
4229 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004230 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004232 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004234 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 NOTE: This option is set to the Vi default value when 'compatible' is
4236 set and to the Vim default value when 'compatible' is reset.
4237
4238 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4239'hkmap' 'hk' boolean (default off)
4240 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004241 {only available when compiled with the |+rightleft|
4242 feature}
4243 When on, the keyboard is mapped for the Hebrew character set.
4244 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4245 toggle this option. See |rileft.txt|.
4246 NOTE: This option is reset when 'compatible' is set.
4247
4248 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4249'hkmapp' 'hkp' boolean (default off)
4250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251 {only available when compiled with the |+rightleft|
4252 feature}
4253 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4254 This is useful if you have a non-Hebrew keyboard.
4255 See |rileft.txt|.
4256 NOTE: This option is reset when 'compatible' is set.
4257
Bram Moolenaar036986f2017-03-16 17:41:02 +01004258 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4259'hlsearch' 'hls' boolean (default off)
4260 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004261 {not available when compiled without the
4262 |+extra_search| feature}
4263 When there is a previous search pattern, highlight all its matches.
4264 The type of highlighting used can be set with the 'l' occasion in the
4265 'highlight' option. This uses the "Search" highlight group by
4266 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004267 are not applied. If the "CurSearch" highlight group is set then the
4268 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004269 See also: 'incsearch' and |:match|.
4270 When you get bored looking at the highlighted matches, you can turn it
4271 off with |:nohlsearch|. This does not change the option value, as
4272 soon as you use a search command, the highlighting comes back.
4273 'redrawtime' specifies the maximum time spent on finding matches.
4274 When the search pattern can match an end-of-line, Vim will try to
4275 highlight all of the matched text. However, this depends on where the
4276 search starts. This will be the first line in the window or the first
4277 line below a closed fold. A match in a previous line which is not
4278 drawn may not continue in a newly drawn line.
4279 You can specify whether the highlight status is restored on startup
4280 with the 'h' flag in 'viminfo' |viminfo-h|.
4281 NOTE: This option is reset when 'compatible' is set.
4282
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 *'icon'* *'noicon'*
4284'icon' boolean (default off, on when title can be restored)
4285 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286 When on, the icon text of the window will be set to the value of
4287 'iconstring' (if it is not empty), or to the name of the file
4288 currently being edited. Only the last part of the name is used.
4289 Overridden by the 'iconstring' option.
4290 Only works if the terminal supports setting window icons (currently
4291 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4292 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4293 builtin termcap).
4294 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004295 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004297 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298
4299 *'iconstring'*
4300'iconstring' string (default "")
4301 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 When this option is not empty, it will be used for the icon text of
4303 the window. This happens only when the 'icon' option is on.
4304 Only works if the terminal supports setting window icon text
4305 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004306 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307 When Vim was compiled with HAVE_X11 defined, the original icon will be
4308 restored if possible |X11|.
4309 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004310 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004312 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 {not available when compiled without the |+statusline| feature}
4314
4315 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4316'ignorecase' 'ic' boolean (default off)
4317 global
4318 Ignore case in search patterns. Also used when searching in the tags
4319 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004320 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321 Can be overruled by using "\c" or "\C" in the pattern, see
4322 |/ignorecase|.
4323
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004324 *'imactivatefunc'* *'imaf'*
4325'imactivatefunc' 'imaf' string (default "")
4326 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004327 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004328 activate or deactivate the Input Method. The value can be the name of
4329 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4330 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004331 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004332 The expression will be evaluated in the |sandbox| when set from a
4333 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004334
4335 Example: >
4336 function ImActivateFunc(active)
4337 if a:active
4338 ... do something
4339 else
4340 ... do something
4341 endif
4342 " return value is not used
4343 endfunction
4344 set imactivatefunc=ImActivateFunc
4345<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 *'imactivatekey'* *'imak'*
4347'imactivatekey' 'imak' string (default "")
4348 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004350 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351 Specifies the key that your Input Method in X-Windows uses for
4352 activation. When this is specified correctly, vim can fully control
4353 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4354 You can't use this option to change the activation key, the option
4355 tells Vim what the key is.
4356 Format:
4357 [MODIFIER_FLAG-]KEY_STRING
4358
4359 These characters can be used for MODIFIER_FLAG (case is ignored):
4360 S Shift key
4361 L Lock key
4362 C Control key
4363 1 Mod1 key
4364 2 Mod2 key
4365 3 Mod3 key
4366 4 Mod4 key
4367 5 Mod5 key
4368 Combinations are allowed, for example "S-C-space" or "SC-space" are
4369 both shift+ctrl+space.
4370 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4371
4372 Example: >
4373 :set imactivatekey=S-space
4374< "S-space" means shift+space. This is the activation key for kinput2 +
4375 canna (Japanese), and ami (Korean).
4376
4377 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4378'imcmdline' 'imc' boolean (default off)
4379 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 When set the Input Method is always on when starting to edit a command
4381 line, unless entering a search pattern (see 'imsearch' for that).
4382 Setting this option is useful when your input method allows entering
4383 English characters directly, e.g., when it's used to type accented
4384 characters with dead keys.
4385
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004386 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4388 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 When set the Input Method is never used. This is useful to disable
4390 the IM when it doesn't work properly.
4391 Currently this option is on by default for SGI/IRIX machines. This
4392 may change in later releases.
4393
4394 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004395'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 Specifies whether :lmap or an Input Method (IM) is to be used in
4398 Insert mode. Valid values:
4399 0 :lmap is off and IM is off
4400 1 :lmap is ON and IM is off
4401 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 To always reset the option to zero when leaving Insert mode with <Esc>
4403 this can be used: >
4404 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4405< This makes :lmap and IM turn off automatically when leaving Insert
4406 mode.
4407 Note that this option changes when using CTRL-^ in Insert mode
4408 |i_CTRL-^|.
4409 The value is set to 1 when setting 'keymap' to a valid keymap name.
4410 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004411 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412 methods. Use 'imdisable' to disable XIM then.
4413
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004414 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004415 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004416 |+multi_byte_ime| or |global-ime|.
4417
Bram Moolenaar071d4272004-06-13 20:20:40 +00004418 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004419'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 Specifies whether :lmap or an Input Method (IM) is to be used when
4422 entering a search pattern. Valid values:
4423 -1 the value of 'iminsert' is used, makes it look like
4424 'iminsert' is also used when typing a search pattern
4425 0 :lmap is off and IM is off
4426 1 :lmap is ON and IM is off
4427 2 :lmap is off and IM is ON
4428 Note that this option changes when using CTRL-^ in Command-line mode
4429 |c_CTRL-^|.
4430 The value is set to 1 when it is not -1 and setting the 'keymap'
4431 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004432 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 methods. Use 'imdisable' to disable XIM then.
4434
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004435 *'imstatusfunc'* *'imsf'*
4436'imstatusfunc' 'imsf' string (default "")
4437 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004438 This option specifies a function that is called to obtain the status
4439 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004440 The value can be the name of a function, a |lambda| or a |Funcref|.
4441 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004442 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004443
4444 Example: >
4445 function ImStatusFunc()
4446 let is_active = ...do something
4447 return is_active ? 1 : 0
4448 endfunction
4449 set imstatusfunc=ImStatusFunc
4450<
4451 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004452 The expression will be evaluated in the |sandbox| when set from a
4453 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004454
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004455 *'imstyle'* *'imst'*
4456'imstyle' 'imst' number (default 1)
4457 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004458 {only available when compiled with |+xim| and
4459 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004460 This option specifies the input style of Input Method:
4461 0 use on-the-spot style
4462 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004463 See: |xim-input-style|
4464
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004465 For a long time on-the-spot style had been used in the GTK version of
4466 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004467 |single-repeat|, etc. Therefore over-the-spot style becomes the
4468 default now. This should work fine for most people, however if you
4469 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004470 The expression will be evaluated in the |sandbox| when set from a
4471 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004472
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 *'include'* *'inc'*
4474'include' 'inc' string (default "^\s*#\s*include")
4475 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 {not available when compiled without the
4477 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004478 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 pattern, just like for the "/" command (See |pattern|). The default
4480 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004481 "]I", "[d", etc.
4482 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004483 comes after the matched pattern. But if "\zs" appears in the pattern
4484 then the text matched from "\zs" to the end, or until "\ze" if it
4485 appears, is used as the file name. Use this to include characters
4486 that are not in 'isfname', such as a space. You can then use
4487 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004488 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489
4490 *'includeexpr'* *'inex'*
4491'includeexpr' 'inex' string (default "")
4492 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004493 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004494 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004496 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 :set includeexpr=substitute(v:fname,'\\.','/','g')
4498< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004499
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004501 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004502 Also used for |<cfile>|.
4503
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004504 If the expression starts with s: or |<SID>|, then it is replaced with
4505 the script ID (|local-function|). Example: >
4506 set includeexpr=s:MyIncludeExpr(v:fname)
4507 set includeexpr=<SID>SomeIncludeExpr(v:fname)
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004508< Otherwise, the expression is evaluated in the context of the script
4509 where the option was set, thus script-local items are available.
4510
Bram Moolenaar30b65812012-07-12 22:01:11 +02004511 The expression will be evaluated in the |sandbox| when set from a
4512 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004513 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004514
4515 It is not allowed to change text or jump to another window while
4516 evaluating 'includeexpr' |textlock|.
4517
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004519'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4520 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004523 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004524 While typing a search command, show where the pattern, as it was typed
4525 so far, matches. The matched string is highlighted. If the pattern
4526 is invalid or not found, nothing is shown. The screen will be updated
4527 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004528 Also applies to the pattern in commands: >
4529 :global
4530 :lvimgrep
4531 :lvimgrepadd
4532 :smagic
4533 :snomagic
4534 :sort
4535 :substitute
4536 :vglobal
4537 :vimgrep
4538 :vimgrepadd
4539< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004540 original position when no match is found and when pressing <Esc>. You
4541 still need to finish the search command with <Enter> to move the
4542 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004543 You can use the CTRL-G and CTRL-T keys to move to the next and
4544 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004545 When compiled with the |+reltime| feature Vim only searches for about
4546 half a second. With a complicated pattern and/or a lot of text the
4547 match may not be found. This is to avoid that Vim hangs while you
4548 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004549 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004550 When 'hlsearch' is on, all matched strings are highlighted too while
4551 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004552 If you don't want to turn 'hlsearch' on, but want to highlight all
4553 matches while searching, you can turn on and off 'hlsearch' with
4554 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004555 augroup vimrc-incsearch-highlight
4556 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004557 autocmd CmdlineEnter /,\? :set hlsearch
4558 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004559 augroup END
4560<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004561 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004562 to the command line. If 'ignorecase' and 'smartcase' are set and the
4563 command line has no uppercase characters, the added character is
4564 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004565 CTRL-R CTRL-W can be used to add the word at the end of the current
4566 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 NOTE: This option is reset when 'compatible' is set.
4568
4569 *'indentexpr'* *'inde'*
4570'indentexpr' 'inde' string (default "")
4571 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004572 {not available when compiled without the |+eval|
4573 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574 Expression which is evaluated to obtain the proper indent for a line.
4575 It is used when a new line is created, for the |=| operator and
4576 in Insert mode as specified with the 'indentkeys' option.
4577 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004578 'smartindent' indenting. When 'lisp' is set, this option is
4579 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 When 'paste' is set this option is not used for indenting.
4581 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004582 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004584
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004585 If the expression starts with s: or |<SID>|, then it is replaced with
4586 the script ID (|local-function|). Example: >
4587 set indentexpr=s:MyIndentExpr()
4588 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004589< Otherwise, the expression is evaluated in the context of the script
4590 where the option was set, thus script-local items are available.
4591
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 The expression must return the number of spaces worth of indent. It
4593 can return "-1" to keep the current indent (this means 'autoindent' is
4594 used for the indent).
4595 Functions useful for computing the indent are |indent()|, |cindent()|
4596 and |lispindent()|.
4597 The evaluation of the expression must not have side effects! It must
4598 not change the text, jump to another window, etc. Afterwards the
4599 cursor position is always restored, thus the cursor may be moved.
4600 Normally this option would be set to call a function: >
4601 :set indentexpr=GetMyIndent()
4602< Error messages will be suppressed, unless the 'debug' option contains
4603 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004604 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004605 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606
Bram Moolenaar30b65812012-07-12 22:01:11 +02004607 The expression will be evaluated in the |sandbox| when set from a
4608 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004609 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004610
4611 It is not allowed to change text or jump to another window while
4612 evaluating 'indentexpr' |textlock|.
4613
4614
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004616'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 A list of keys that, when typed in Insert mode, cause reindenting of
4619 the current line. Only happens if 'indentexpr' isn't empty.
4620 The format is identical to 'cinkeys', see |indentkeys-format|.
4621 See |C-indenting| and |indent-expression|.
4622
4623 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4624'infercase' 'inf' boolean (default off)
4625 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004627 'ignorecase' is also on, the case of the match is adjusted depending
4628 on the typed text. If the typed text contains a lowercase letter
4629 where the match has an upper case letter, the completed part is made
4630 lowercase. If the typed text has no lowercase letters and the match
4631 has a lowercase letter where the typed text has an uppercase letter,
4632 and there is a letter before it, the completed part is made uppercase.
4633 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634
4635 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4636'insertmode' 'im' boolean (default off)
4637 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 Makes Vim work in a way that Insert mode is the default mode. Useful
4639 if you want to use Vim as a modeless editor. Used for |evim|.
4640 These Insert mode commands will be useful:
4641 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004642 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 this is a mapping, it is executed as if 'insertmode' was off.
4644 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004646 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4647 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648
4649 These items change when 'insertmode' is set:
4650 - when starting to edit of a file, Vim goes to Insert mode.
4651 - <Esc> in Insert mode is a no-op and beeps.
4652 - <Esc> in Normal mode makes Vim go to Insert mode.
4653 - CTRL-L in Insert mode is a command, it is not inserted.
4654 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4655 However, when <Esc> is used inside a mapping, it behaves like
4656 'insertmode' was not set. This was done to be able to use the same
4657 mappings with 'insertmode' set or not set.
4658 When executing commands with |:normal| 'insertmode' is not used.
4659
4660 NOTE: This option is reset when 'compatible' is set.
4661
4662 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004663'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4665 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4666 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4667 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4668 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 The characters specified by this option are included in file names and
4671 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004672 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 Multi-byte characters 256 and above are always included, only the
4674 characters up to 255 are specified with this option.
4675 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004676 Think twice before adding white space to this option. Although a
4677 space may appear inside a file name, the effect will be that Vim
4678 doesn't know where a file name starts or ends when doing completion.
4679 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680
4681 Note that on systems using a backslash as path separator, Vim tries to
4682 do its best to make it work as you would expect. That is a bit
4683 tricky, since Vi originally used the backslash to escape special
4684 characters. Vim will not remove a backslash in front of a normal file
4685 name character on these systems, but it will on Unix and alikes. The
4686 '&' and '^' are not included by default, because these are special for
4687 cmd.exe.
4688
4689 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004690 Each part can be a single character number or a range. A range is two
4691 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692 decimal number between 0 and 255 or the ASCII character itself (does
4693 not work for digits). Example:
4694 "_,-,128-140,#-43" (include '_' and '-' and the range
4695 128 to 140 and '#' to 43)
4696 If a part starts with '^', the following character number or range
4697 will be excluded from the option. The option is interpreted from left
4698 to right. Put the excluded character after the range where it is
4699 included. To include '^' itself use it as the last character of the
4700 option or the end of a range. Example:
4701 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4702 If the character is '@', all characters where isalpha() returns TRUE
4703 are included. Normally these are the characters a to z and A to Z,
4704 plus accented characters. To include '@' itself use "@-@". Examples:
4705 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004706 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 "a-z,A-Z,@-@" All letters plus the '@' character.
4708 A comma can be included by using it where a character number is
4709 expected. Example:
4710 "48-57,,,_" Digits, comma and underscore.
4711 A comma can be excluded by prepending a '^'. Example:
4712 " -~,^,,9" All characters from space to '~', excluding
4713 comma, plus <Tab>.
4714 See |option-backslash| about including spaces and backslashes.
4715
4716 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004717'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718 "@,48-57,_,128-167,224-235"
4719 otherwise: "@,48-57,_,192-255")
4720 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721 The characters given by this option are included in identifiers.
4722 Identifiers are used in recognizing environment variables and after a
4723 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004724 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004725 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004727 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4729
4730 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004731'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 "@,48-57,_,128-167,224-235"
4733 otherwise: "@,48-57,_,192-255"
4734 Vi default: "@,48-57,_")
4735 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004737 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004738 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004739 characters above 255 check the "word" character class (any character
4740 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004741 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742 For a help file it is set to all non-blank printable characters except
4743 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4744 command).
4745 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004746 This option also influences syntax highlighting, unless the syntax
4747 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 NOTE: This option is set to the Vi default value when 'compatible' is
4749 set and to the Vim default value when 'compatible' is reset.
4750
4751 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004752'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 "@,~-255"; otherwise: "@,161-255")
4754 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755 The characters given by this option are displayed directly on the
4756 screen. It is also used for "\p" in a |pattern|. The characters from
4757 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4758 even when they are not included in 'isprint' or excluded. See
4759 'isfname' for a description of the format of this option.
4760
4761 Non-printable characters are displayed with two characters:
4762 0 - 31 "^@" - "^_"
4763 32 - 126 always single characters
4764 127 "^?"
4765 128 - 159 "~@" - "~_"
4766 160 - 254 "| " - "|~"
4767 255 "~?"
4768 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4769 displayed as <xx>, with the hexadecimal value of the byte.
4770 When 'display' contains "uhex" all unprintable characters are
4771 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004772 The SpecialKey highlighting will be used for unprintable characters.
4773 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774
4775 Multi-byte characters 256 and above are always included, only the
4776 characters up to 255 are specified with this option. When a character
4777 is printable but it is not available in the current font, a
4778 replacement character will be shown.
4779 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4780 There is no option to specify these characters.
4781
4782 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4783'joinspaces' 'js' boolean (default on)
4784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004785 Insert two spaces after a '.', '?' and '!' with a join command.
4786 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4787 Otherwise only one space is inserted.
4788 NOTE: This option is set when 'compatible' is set.
4789
4790 *'key'*
4791'key' string (default "")
4792 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004793 {only available when compiled with the |+cryptv|
4794 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004795 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004796 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004797 Careful: Do not set the key value by hand, someone might see the typed
4798 key. Use the |:X| command. But you can make 'key' empty: >
4799 :set key=
4800< It is not possible to get the value of this option with ":set key" or
4801 "echo &key". This is to avoid showing it to someone who shouldn't
4802 know. It also means you cannot see it yourself once you have set it,
4803 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004804 You can use "&key" in an expression to detect whether encryption is
4805 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806
4807 *'keymap'* *'kmp'* *E544*
4808'keymap' 'kmp' string (default "")
4809 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 {only available when compiled with the |+keymap|
4811 feature}
4812 Name of a keyboard mapping. See |mbyte-keymap|.
4813 Setting this option to a valid keymap name has the side effect of
4814 setting 'iminsert' to one, so that the keymap becomes effective.
4815 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004816 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817
4818 *'keymodel'* *'km'*
4819'keymodel' 'km' string (default "")
4820 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004821 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 can do. These values can be used:
4823 startsel Using a shifted special key starts selection (either
4824 Select mode or Visual mode, depending on "key" being
4825 present in 'selectmode').
4826 stopsel Using a not-shifted special key stops selection.
4827 Special keys in this context are the cursor keys, <End>, <Home>,
4828 <PageUp> and <PageDown>.
4829 The 'keymodel' option is set by the |:behave| command.
4830
4831 *'keywordprg'* *'kp'*
4832'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004833 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 Program to use for the |K| command. Environment variables are
4836 expanded |:set_env|. ":help" may be used to access the Vim internal
4837 help. (Note that previously setting the global option to the empty
4838 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004839 When the first character is ":", the command is invoked as a Vim
4840 Ex command prefixed with [count].
4841 When "man", "man -s" or an Ex command is used, Vim will automatically
4842 translate a count for the "K" command and pass it as the first
4843 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844 See |option-backslash| about including spaces and backslashes.
4845 Example: >
4846 :set keywordprg=man\ -s
4847< This option cannot be set from a |modeline| or in the |sandbox|, for
4848 security reasons.
4849
4850 *'langmap'* *'lmap'* *E357* *E358*
4851'langmap' 'lmap' string (default "")
4852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 {only available when compiled with the |+langmap|
4854 feature}
4855 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004856 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004857 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 care of translating these special characters to the original meaning
4859 of the key. This means you don't have to change the keyboard mode to
4860 be able to execute Normal mode commands.
4861 This is the opposite of the 'keymap' option, where characters are
4862 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004863 Also consider setting 'langremap' to off, to prevent 'langmap' from
4864 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004865 This option cannot be set from a |modeline| or in the |sandbox|, for
4866 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004868 Example (for Greek, in UTF-8): *greek* >
4869 :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 +00004870< Example (exchanges meaning of z and y for commands): >
4871 :set langmap=zy,yz,ZY,YZ
4872<
4873 The 'langmap' option is a list of parts, separated with commas. Each
4874 part can be in one of two forms:
4875 1. A list of pairs. Each pair is a "from" character immediately
4876 followed by the "to" character. Examples: "aA", "aAbBcC".
4877 2. A list of "from" characters, a semi-colon and a list of "to"
4878 characters. Example: "abc;ABC"
4879 Example: "aA,fgh;FGH,cCdDeE"
4880 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004881 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882
4883 This will allow you to activate vim actions without having to switch
4884 back and forth between the languages. Your language characters will
4885 be understood as normal vim English characters (according to the
4886 langmap mappings) in the following cases:
4887 o Normal/Visual mode (commands, buffer/register names, user mappings)
4888 o Insert/Replace Mode: Register names after CTRL-R
4889 o Insert/Replace Mode: Mappings
4890 Characters entered in Command-line mode will NOT be affected by
4891 this option. Note that this option can be changed at any time
4892 allowing to switch between mappings for different languages/encodings.
4893 Use a mapping to avoid having to type it each time!
4894
4895 *'langmenu'* *'lm'*
4896'langmenu' 'lm' string (default "")
4897 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898 {only available when compiled with the |+menu| and
4899 |+multi_lang| features}
4900 Language to use for menu translation. Tells which file is loaded
4901 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004902 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903< (without the spaces). For example, to always use the Dutch menus, no
4904 matter what $LANG is set to: >
4905 :set langmenu=nl_NL.ISO_8859-1
4906< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004907 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908 If your $LANG is set to a non-English language but you do want to use
4909 the English menus: >
4910 :set langmenu=none
4911< This option must be set before loading menus, switching on filetype
4912 detection or syntax highlighting. Once the menus are defined setting
4913 this option has no effect. But you could do this: >
4914 :source $VIMRUNTIME/delmenu.vim
4915 :set langmenu=de_DE.ISO_8859-1
4916 :source $VIMRUNTIME/menu.vim
4917< Warning: This deletes all menus that you defined yourself!
4918
Bram Moolenaard94464e2015-11-02 15:28:18 +01004919 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004920'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004921 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004922 {only available when compiled with the |+langmap|
4923 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004924 This is just like 'langremap' but with the value inverted. It only
4925 exists for backwards compatibility. When setting 'langremap' then
4926 'langnoremap' is set to the inverted value, and the other way around.
4927
4928 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004929'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004930 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004931 {only available when compiled with the |+langmap|
4932 feature}
4933 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004934 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004935 'langmap' disables some of your mappings, try resetting this option.
4936 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004937 that works for you to avoid mappings to break.
4938
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 *'laststatus'* *'ls'*
4940'laststatus' 'ls' number (default 1)
4941 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 The value of this option influences when the last window will have a
4943 status line:
4944 0: never
4945 1: only if there are at least two windows
4946 2: always
4947 The screen looks nicer with a status line if you have several
4948 windows, but it takes another screen line. |status-line|
4949
4950 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4951'lazyredraw' 'lz' boolean (default off)
4952 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953 When this option is set, the screen will not be redrawn while
4954 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004955 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956 update use |:redraw|.
4957
4958 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4959'linebreak' 'lbr' boolean (default off)
4960 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004961 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004963 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964 than at the last character that fits on the screen. Unlike
4965 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004966 it only affects the way the file is displayed, not its contents.
4967 If 'breakindent' is set, line is visually indented. Then, the value
4968 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004969 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 Note that <Tab> characters after an <EOL> are mostly not displayed
4971 with the right amount of white space.
4972
4973 *'lines'* *E593*
4974'lines' number (default 24 or terminal height)
4975 global
4976 Number of lines of the Vim window.
4977 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004978 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979 When Vim is running in the GUI or in a resizable window, setting this
4980 option will cause the window size to be changed. When you only want
4981 to use the size for the GUI, put the command in your |gvimrc| file.
4982 Vim limits the number of lines to what fits on the screen. You can
4983 use this command to get the tallest window possible: >
4984 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004985< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004986 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004987 When you set this option and Vim is unable to change the physical
4988 number of lines of the display, the display may be messed up.
4989
4990 *'linespace'* *'lsp'*
4991'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4992 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 {only in the GUI}
4994 Number of pixel lines inserted between characters. Useful if the font
4995 uses the full character cell height, making lines touch each other.
4996 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004997 With some fonts there can be too much room between lines (to have
4998 space for ascents and descents). Then it makes sense to set
4999 'linespace' to a negative value. This may cause display problems
5000 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001
5002 *'lisp'* *'nolisp'*
5003'lisp' boolean (default off)
5004 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005 Lisp mode: When <Enter> is typed in insert mode set the indent for
5006 the next line to Lisp standards (well, sort of). Also happens with
5007 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5008 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5009 better. Also see 'lispwords'.
5010 The '-' character is included in keyword characters. Redefines the
5011 "=" operator to use this same indentation algorithm rather than
5012 calling an external program if 'equalprg' is empty.
5013 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005014
5015 *'lispwords'* *'lw'*
5016'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005017 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005018 Comma-separated list of words that influence the Lisp indenting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 |'lisp'|
5020
5021 *'list'* *'nolist'*
5022'list' boolean (default off)
5023 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005024 List mode: By default show tabs as CTRL-I is displayed, display $
5025 after end of line. Useful to see the difference between tabs and
5026 spaces and for trailing blanks. Further changed by the 'listchars'
5027 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005028
5029 The cursor is displayed at the start of the space a Tab character
5030 occupies, not at the end as usual in Normal mode. To get this cursor
5031 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005032 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005033<
5034 Note that list mode will also affect formatting (set with 'textwidth'
5035 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 changing the way tabs are displayed.
5037
5038 *'listchars'* *'lcs'*
5039'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005040 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005041 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005042 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005043 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044 eol:c Character to show at the end of each line. When
5045 omitted, there is no extra character at the end of the
5046 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005047 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005048 tab:xy[z] Two or three characters to be used to show a tab.
5049 The third character is optional.
5050
5051 tab:xy The 'x' is always used, then 'y' as many times as will
5052 fit. Thus "tab:>-" displays:
5053 >
5054 >-
5055 >--
5056 etc.
5057
5058 tab:xyz The 'z' is always used, then 'x' is prepended, and
5059 then 'y' is used as many times as will fit. Thus
5060 "tab:<->" displays:
5061 >
5062 <>
5063 <->
5064 <-->
5065 etc.
5066
5067 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005068 *lcs-space*
5069 space:c Character to show for a space. When omitted, spaces
5070 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005071 *lcs-multispace*
5072 multispace:c...
5073 One or more characters to use cyclically to show for
5074 multiple consecutive spaces. Overrides the "space"
5075 setting, except for single spaces. When omitted, the
5076 "space" setting is used. For example,
5077 `:set listchars=multispace:---+` shows ten consecutive
5078 spaces as:
5079 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005080 *lcs-lead*
5081 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005082 leading spaces are blank. Overrides the "space" and
5083 "multispace" settings for leading spaces. You can
5084 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005085 :set listchars+=tab:>-,lead:.
5086< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005087 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005088 trailing spaces are blank. Overrides the "space" and
5089 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005090 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091 extends:c Character to show in the last column, when 'wrap' is
5092 off and the line continues beyond the right of the
5093 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005094 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005095 precedes:c Character to show in the first visible column of the
5096 physical line, when there is text preceding the
5097 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005098 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005099 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005100 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005101 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005102 nbsp:c Character to show for a non-breakable space character
5103 (0xA0 (160 decimal) and U+202F). Left blank when
5104 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005106 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005108 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005110 Each character can be specified as hex: >
5111 set listchars=eol:\\x24
5112 set listchars=eol:\\u21b5
5113 set listchars=eol:\\U000021b5
5114< Note that a double backslash is used. The number of hex characters
5115 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5116
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 Examples: >
5118 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005119 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 :set lcs=extends:>,precedes:<
5121< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005122 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5123 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005124 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125
5126 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5127'loadplugins' 'lpl' boolean (default on)
5128 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129 When on the plugin scripts are loaded when starting up |load-plugins|.
5130 This option can be reset in your |vimrc| file to disable the loading
5131 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005132 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5133 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134
Bram Moolenaard94464e2015-11-02 15:28:18 +01005135 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005136'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005137 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005138 {only available when compiled with the |+lua/dyn|
5139 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005140 Specifies the name of the Lua shared library. The default is
5141 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005142 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005143 This option cannot be set from a |modeline| or in the |sandbox|, for
5144 security reasons.
5145
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005146 *'macatsui'* *'nomacatsui'*
5147'macatsui' boolean (default on)
5148 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005149 {not supported}
5150 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005151
Bram Moolenaar071d4272004-06-13 20:20:40 +00005152 *'magic'* *'nomagic'*
5153'magic' boolean (default on)
5154 global
5155 Changes the special characters that can be used in search patterns.
5156 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005157 WARNING: Switching this option off most likely breaks plugins! That
5158 is because many patterns assume it's on and will fail when it's off.
5159 Only switch it off when working with old Vi scripts. In any other
5160 situation write patterns that work when 'magic' is on. Include "\M"
5161 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005162 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5163 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164
5165 *'makeef'* *'mef'*
5166'makeef' 'mef' string (default: "")
5167 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 {not available when compiled without the |+quickfix|
5169 feature}
5170 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5171 and the |:grep| command.
5172 When it is empty, an internally generated temp file will be used.
5173 When "##" is included, it is replaced by a number to make the name
5174 unique. This makes sure that the ":make" command doesn't overwrite an
5175 existing file.
5176 NOT used for the ":cf" command. See 'errorfile' for that.
5177 Environment variables are expanded |:set_env|.
5178 See |option-backslash| about including spaces and backslashes.
5179 This option cannot be set from a |modeline| or in the |sandbox|, for
5180 security reasons.
5181
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005182 *'makeencoding'* *'menc'*
5183'makeencoding' 'menc' string (default "")
5184 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005185 Encoding used for reading the output of external commands. When empty,
5186 encoding is not converted.
5187 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5188 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5189 and `:laddfile`.
5190
5191 This would be mostly useful when you use MS-Windows and set 'encoding'
5192 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5193 'makeencoding' to "char" has the same effect as setting to the system
5194 locale encoding. Example: >
5195 :set encoding=utf-8
5196 :set makeencoding=char " system locale is used
5197<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 *'makeprg'* *'mp'*
5199'makeprg' 'mp' string (default "make", VMS: "MMS")
5200 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005201 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005202 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5203 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005204 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005205 Environment variables are expanded |:set_env|. See |option-backslash|
5206 about including spaces and backslashes.
5207 Note that a '|' must be escaped twice: once for ":set" and once for
5208 the interpretation of a command. When you use a filter called
5209 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210 :set makeprg=gmake\ \\\|\ myfilter
5211< The placeholder "$*" can be given (even multiple times) to specify
5212 where the arguments will be included, for example: >
5213 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5214< This option cannot be set from a |modeline| or in the |sandbox|, for
5215 security reasons.
5216
5217 *'matchpairs'* *'mps'*
5218'matchpairs' 'mps' string (default "(:),{:},[:]")
5219 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005221 other.
5222 Only character pairs are allowed that are different, thus you cannot
5223 jump between two double quotes.
5224 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005225 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005226 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227 :set mps+=<:>
5228
5229< A more exotic example, to jump between the '=' and ';' in an
5230 assignment, useful for languages like C and Java: >
5231 :au FileType c,cpp,java set mps+==:;
5232
5233< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005234 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005235
5236 *'matchtime'* *'mat'*
5237'matchtime' 'mat' number (default 5)
5238 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005239 Tenths of a second to show the matching paren, when 'showmatch' is
5240 set. Note that this is not in milliseconds, like other options that
5241 set a time. This is to be compatible with Nvi.
5242
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005243 *'maxcombine'* *'mco'*
5244'maxcombine' 'mco' number (default 2)
5245 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005246 The maximum number of combining characters supported for displaying.
5247 Only used when 'encoding' is "utf-8".
5248 The default is OK for most languages. Hebrew may require 4.
5249 Maximum value is 6.
5250 Even when this option is set to 2 you can still edit text with more
5251 combining characters, you just can't see them. Use |g8| or |ga|.
5252 See |mbyte-combining|.
5253
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 *'maxfuncdepth'* *'mfd'*
5255'maxfuncdepth' 'mfd' number (default 100)
5256 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005257 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005258 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005259 Maximum depth of function calls for user functions. This normally
5260 catches endless recursion. When using a recursive function with
5261 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5262 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005263 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005264 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005265 See also |:function|.
5266
5267 *'maxmapdepth'* *'mmd'* *E223*
5268'maxmapdepth' 'mmd' number (default 1000)
5269 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270 Maximum number of times a mapping is done without resulting in a
5271 character to be used. This normally catches endless mappings, like
5272 ":map x y" with ":map y x". It still does not catch ":map g wg",
5273 because the 'w' is used before the next mapping is done. See also
5274 |key-mapping|.
5275
5276 *'maxmem'* *'mm'*
5277'maxmem' 'mm' number (default between 256 to 5120 (system
5278 dependent) or half the amount of memory
5279 available)
5280 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5282 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005283 other memory to be freed.
5284 The maximum usable value is about 2000000. Use this to work without a
5285 limit.
5286 The value is ignored when 'swapfile' is off.
5287 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005289 *'maxmempattern'* *'mmp'*
5290'maxmempattern' 'mmp' number (default 1000)
5291 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005292 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005293 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005294 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005295 When Vim runs into the limit it gives an error message and mostly
5296 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005297 Running into the limit often means that the pattern is very
5298 inefficient or too complex. This may already happen with the pattern
5299 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005300 Might also happen on redraw, when syntax rules try to match a complex
5301 text structure.
5302 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5303 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005304
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305 *'maxmemtot'* *'mmt'*
5306'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5307 dependent) or half the amount of memory
5308 available)
5309 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005310 Maximum amount of memory in Kbyte to use for all buffers together.
5311 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005312 without a limit.
5313 On 64 bit machines higher values might work. But hey, do you really
5314 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005315 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005316 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005317 Buffers with 'swapfile' off still count to the total amount of memory
5318 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005319 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320
5321 *'menuitems'* *'mis'*
5322'menuitems' 'mis' number (default 25)
5323 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324 {not available when compiled without the |+menu|
5325 feature}
5326 Maximum number of items to use in a menu. Used for menus that are
5327 generated from a list of items, e.g., the Buffers menu. Changing this
5328 option has no direct effect, the menu must be refreshed first.
5329
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005330 *'mkspellmem'* *'msm'*
5331'mkspellmem' 'msm' string (default "460000,2000,500")
5332 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005333 {not available when compiled without the |+syntax|
5334 feature}
5335 Parameters for |:mkspell|. This tunes when to start compressing the
5336 word tree. Compression can be slow when there are many words, but
5337 it's needed to avoid running out of memory. The amount of memory used
5338 per word depends very much on how similar the words are, that's why
5339 this tuning is complicated.
5340
5341 There are three numbers, separated by commas:
5342 {start},{inc},{added}
5343
5344 For most languages the uncompressed word tree fits in memory. {start}
5345 gives the amount of memory in Kbyte that can be used before any
5346 compression is done. It should be a bit smaller than the amount of
5347 memory that is available to Vim.
5348
5349 When going over the {start} limit the {inc} number specifies the
5350 amount of memory in Kbyte that can be allocated before another
5351 compression is done. A low number means compression is done after
5352 less words are added, which is slow. A high number means more memory
5353 will be allocated.
5354
5355 After doing compression, {added} times 1024 words can be added before
5356 the {inc} limit is ignored and compression is done when any extra
5357 amount of memory is needed. A low number means there is a smaller
5358 chance of hitting the {inc} limit, less memory is used but it's
5359 slower.
5360
5361 The languages for which these numbers are important are Italian and
5362 Hungarian. The default works for when you have about 512 Mbyte. If
5363 you have 1 Gbyte you could use: >
5364 :set mkspellmem=900000,3000,800
5365< If you have less than 512 Mbyte |:mkspell| may fail for some
5366 languages, no matter what you set 'mkspellmem' to.
5367
Bram Moolenaar07607392019-05-26 19:20:43 +02005368 This option cannot be set from a |modeline| or in the |sandbox|.
5369
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005371'modeline' 'ml' boolean (Vim default: on (off for root),
5372 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005374 If 'modeline' is on 'modelines' gives the number of lines that is
5375 checked for set commands. If 'modeline' is off or 'modelines' is zero
5376 no lines are checked. See |modeline|.
5377
5378 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5379'modelineexpr' 'mle' boolean (default: off)
5380 global
5381 When on allow some options that are an expression to be set in the
5382 modeline. Check the option for whether it is affected by
5383 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005384 This option cannot be set from a |modeline| or in the |sandbox|, for
5385 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005386
Bram Moolenaar071d4272004-06-13 20:20:40 +00005387 *'modelines'* *'mls'*
5388'modelines' 'mls' number (default 5)
5389 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390 If 'modeline' is on 'modelines' gives the number of lines that is
5391 checked for set commands. If 'modeline' is off or 'modelines' is zero
5392 no lines are checked. See |modeline|.
5393 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5394 set and to the Vim default value when 'compatible' is reset.
5395
5396 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005397 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398'modifiable' 'ma' boolean (default on)
5399 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005400 When off the buffer contents cannot be changed. The 'fileformat' and
5401 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005402 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005403
5404 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5405'modified' 'mod' boolean (default off)
5406 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407 When on, the buffer is considered to be modified. This option is set
5408 when:
5409 1. A change was made to the text since it was last written. Using the
5410 |undo| command to go back to the original text will reset the
5411 option. But undoing changes that were made before writing the
5412 buffer will set the option again, since the text is different from
5413 when it was written.
5414 2. 'fileformat' or 'fileencoding' is different from its original
5415 value. The original value is set when the buffer is read or
5416 written. A ":set nomodified" command also resets the original
5417 values to the current values and the 'modified' option will be
5418 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005419 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005420 This option is not set when a change is made to the buffer as the
5421 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5422 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5423 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5425 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005426 Note that the text may actually be the same, e.g. 'modified' is set
5427 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005428
5429 *'more'* *'nomore'*
5430'more' boolean (Vim default: on, Vi default: off)
5431 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432 When on, listings pause when the whole screen is filled. You will get
5433 the |more-prompt|. When this option is off there are no pauses, the
5434 listing continues until finished.
5435 NOTE: This option is set to the Vi default value when 'compatible' is
5436 set and to the Vim default value when 'compatible' is reset.
5437
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005438 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005439'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005440 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005442 Enable the use of the mouse. Works for most terminals (xterm, Win32
5443 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5444 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5445 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005446 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 v Visual mode
5448 i Insert mode
5449 c Command-line mode
5450 h all previous modes when editing a help file
5451 a all previous modes
5452 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005453 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005455< If your terminal can't overrule the mouse events going to the
5456 application, use: >
5457 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005458< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005459 back to Vim using the mouse events.
5460 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5461 "xterm".
5462
5463 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005464 modeless selection. This doesn't move the text cursor.
5465
5466 See |mouse-using|. Also see |'clipboard'|.
5467
5468 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005469 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470 the mouse buttons can still be used by keeping the shift key pressed.
5471 Also see the 'clipboard' option.
5472
5473 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5474'mousefocus' 'mousef' boolean (default off)
5475 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 {only works in the GUI}
5477 The window that the mouse pointer is on is automatically activated.
5478 When changing the window layout or window focus in another way, the
5479 mouse pointer is moved to the window with keyboard focus. Off is the
5480 default because it makes using the pull down menus a little goofy, as
5481 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005482 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005483 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484
5485 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5486'mousehide' 'mh' boolean (default on)
5487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488 {only works in the GUI}
5489 When on, the mouse pointer is hidden when characters are typed.
5490 The mouse pointer is restored when the mouse is moved.
5491
5492 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005493'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005494 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495 Sets the model to use for the mouse. The name mostly specifies what
5496 the right mouse button is used for:
5497 extend Right mouse button extends a selection. This works
5498 like in an xterm.
5499 popup Right mouse button pops up a menu. The shifted left
5500 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005501 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005502 popup_setpos Like "popup", but the cursor will be moved to the
5503 position where the mouse was clicked, and thus the
5504 selected operation will act upon the clicked object.
5505 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005506 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507 course, that right clicking outside a selection will
5508 end Visual mode.
5509 Overview of what button does what for each model:
5510 mouse extend popup(_setpos) ~
5511 left click place cursor place cursor
5512 left drag start selection start selection
5513 shift-left search word extend selection
5514 right click extend selection popup menu (place cursor)
5515 right drag extend selection -
5516 middle click paste paste
5517
5518 In the "popup" model the right mouse button produces a pop-up menu.
5519 You need to define this first, see |popup-menu|.
5520
5521 Note that you can further refine the meaning of buttons with mappings.
5522 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5523 selection (because that's handled in the GUI code directly).
5524
5525 The 'mousemodel' option is set by the |:behave| command.
5526
Ernie Raelc4cb5442022-04-03 15:47:28 +01005527 *'mousemoveevent'* *'mousemev'*
5528'mousemoveevent' 'mousemev' boolean (default off)
5529 global
5530 {only works in the GUI}
5531 When on, mouse move events are delivered to the input queue and are
5532 available for mapping. The default, off, avoids the mouse movement
5533 overhead except when needed. See |gui-mouse-mapping|.
5534 Warning: Setting this option can make pending mappings to be aborted
5535 when the mouse is moved.
5536 Currently only works in the GUI, may be made to work in a terminal
5537 later.
5538
Bram Moolenaar071d4272004-06-13 20:20:40 +00005539 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005540'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5541 vs:leftright,vd:lrsizing,m:no,
5542 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 {only available when compiled with the |+mouseshape|
5545 feature}
5546 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005547 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 like used for 'guicursor'. Each part consist of a mode/location-list
5549 and an argument-list:
5550 mode-list:shape,mode-list:shape,..
5551 The mode-list is a dash separated list of these modes/locations:
5552 In a normal window: ~
5553 n Normal mode
5554 v Visual mode
5555 ve Visual mode with 'selection' "exclusive" (same as 'v',
5556 if not specified)
5557 o Operator-pending mode
5558 i Insert mode
5559 r Replace mode
5560
5561 Others: ~
5562 c appending to the command-line
5563 ci inserting in the command-line
5564 cr replacing in the command-line
5565 m at the 'Hit ENTER' or 'More' prompts
5566 ml idem, but cursor in the last line
5567 e any mode, pointer below last window
5568 s any mode, pointer on a status line
5569 sd any mode, while dragging a status line
5570 vs any mode, pointer on a vertical separator line
5571 vd any mode, while dragging a vertical separator line
5572 a everywhere
5573
5574 The shape is one of the following:
5575 avail name looks like ~
5576 w x arrow Normal mouse pointer
5577 w x blank no pointer at all (use with care!)
5578 w x beam I-beam
5579 w x updown up-down sizing arrows
5580 w x leftright left-right sizing arrows
5581 w x busy The system's usual busy pointer
5582 w x no The system's usual 'no input' pointer
5583 x udsizing indicates up-down resizing
5584 x lrsizing indicates left-right resizing
5585 x crosshair like a big thin +
5586 x hand1 black hand
5587 x hand2 white hand
5588 x pencil what you write with
5589 x question big ?
5590 x rightup-arrow arrow pointing right-up
5591 w x up-arrow arrow pointing up
5592 x <number> any X11 pointer number (see X11/cursorfont.h)
5593
5594 The "avail" column contains a 'w' if the shape is available for Win32,
5595 x for X11.
5596 Any modes not specified or shapes not available use the normal mouse
5597 pointer.
5598
5599 Example: >
5600 :set mouseshape=s:udsizing,m:no
5601< will make the mouse turn to a sizing arrow over the status lines and
5602 indicate no input when the hit-enter prompt is displayed (since
5603 clicking the mouse has no effect in this state.)
5604
5605 *'mousetime'* *'mouset'*
5606'mousetime' 'mouset' number (default 500)
5607 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005608 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005609 time in msec between two mouse clicks for the second click to be
5610 recognized as a multi click.
5611
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005612 *'mzschemedll'*
5613'mzschemedll' string (default depends on the build)
5614 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005615 {only available when compiled with the |+mzscheme/dyn|
5616 feature}
5617 Specifies the name of the MzScheme shared library. The default is
5618 DYNAMIC_MZSCH_DLL which was specified at compile time.
5619 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005620 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005621 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005622 This option cannot be set from a |modeline| or in the |sandbox|, for
5623 security reasons.
5624
5625 *'mzschemegcdll'*
5626'mzschemegcdll' string (default depends on the build)
5627 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005628 {only available when compiled with the |+mzscheme/dyn|
5629 feature}
5630 Specifies the name of the MzScheme GC shared library. The default is
5631 DYNAMIC_MZGC_DLL which was specified at compile time.
5632 The value can be equal to 'mzschemedll' if it includes the GC code.
5633 Environment variables are expanded |:set_env|.
5634 This option cannot be set from a |modeline| or in the |sandbox|, for
5635 security reasons.
5636
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005637 *'mzquantum'* *'mzq'*
5638'mzquantum' 'mzq' number (default 100)
5639 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005640 {not available when compiled without the |+mzscheme|
5641 feature}
5642 The number of milliseconds between polls for MzScheme threads.
5643 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005644 NOTE: This option is set to the Vim default value when 'compatible'
5645 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005646
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005648'nrformats' 'nf' string (default "bin,octal,hex",
5649 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005650 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005651 This defines what bases Vim will consider for numbers when using the
5652 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5653 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005654 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005656 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005657 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005658 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005659 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005660 considered to be hexadecimal. Example: Using CTRL-X on
5661 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005662 bin If included, numbers starting with "0b" or "0B" will be
5663 considered to be binary. Example: Using CTRL-X on
5664 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005665 unsigned If included, numbers are recognized as unsigned. Thus a
5666 leading dash or negative sign won't be considered as part of
5667 the number. Examples:
5668 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5669 (without "unsigned" it would become "9-2021").
5670 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5671 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005672 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5673 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674 Numbers which simply begin with a digit in the range 1-9 are always
5675 considered decimal. This also happens for numbers that are not
5676 recognized as octal or hex.
5677
5678 *'number'* *'nu'* *'nonumber'* *'nonu'*
5679'number' 'nu' boolean (default off)
5680 local to window
5681 Print the line number in front of each line. When the 'n' option is
5682 excluded from 'cpoptions' a wrapped line will not use the column of
5683 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005684 The 'numberwidth' option can be used to set the room used for the line
5685 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005686 When a long, wrapped line doesn't start with the first character, '-'
5687 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005688 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5689 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005690 *number_relativenumber*
5691 The 'relativenumber' option changes the displayed number to be
5692 relative to the cursor. Together with 'number' there are these
5693 four combinations (cursor in line 3):
5694
Bram Moolenaar3848e002016-03-19 18:42:29 +01005695 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005696 'nornu' 'nornu' 'rnu' 'rnu'
5697
5698 |apple | 1 apple | 2 apple | 2 apple
5699 |pear | 2 pear | 1 pear | 1 pear
5700 |nobody | 3 nobody | 0 nobody |3 nobody
5701 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005702
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005703 *'numberwidth'* *'nuw'*
5704'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5705 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005706 {only available when compiled with the |+linebreak|
5707 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005708 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005709 when the 'number' or 'relativenumber' option is set or printing lines
5710 with a line number. Since one space is always between the number and
5711 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005712 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005713 fit the highest line number in the buffer respectively the number of
5714 rows in the window, depending on whether 'number' or 'relativenumber'
5715 is set. Thus with the Vim default of 4 there is room for a line number
5716 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005717 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005718 NOTE: This option is set to the Vi default value when 'compatible' is
5719 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005720
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005721 *'omnifunc'* *'ofu'*
5722'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005723 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005724 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005725 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005726 This option specifies a function to be used for Insert mode omni
5727 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005728 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005729 invoked and what it should return. The value can be the name of a
5730 function, a |lambda| or a |Funcref|. See |option-value-function| for
5731 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005732 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005733 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005734 This option cannot be set from a |modeline| or in the |sandbox|, for
5735 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005736
5737
Bram Moolenaar02467872007-05-06 13:22:01 +00005738 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005739'opendevice' 'odev' boolean (default off)
5740 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005741 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005742 Enable reading and writing from devices. This may get Vim stuck on a
5743 device that can be opened but doesn't actually do the I/O. Therefore
5744 it is off by default.
5745 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5746 result in editing a device.
5747
5748
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005749 *'operatorfunc'* *'opfunc'*
5750'operatorfunc' 'opfunc' string (default: empty)
5751 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005752 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005753 See |:map-operator| for more info and an example. The value can be
5754 the name of a function, a |lambda| or a |Funcref|. See
5755 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005756
5757 This option cannot be set from a |modeline| or in the |sandbox|, for
5758 security reasons.
5759
5760
Bram Moolenaar251e1912011-06-19 05:09:16 +02005761 *'osfiletype'* *'oft'*
5762'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005764 This option was supported on RISC OS, which has been removed.
5765
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005767 *'packpath'* *'pp'*
5768'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005769 Directories used to find packages. See |packages|.
5770
5771
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005773'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 global
5775 Specifies the nroff macros that separate paragraphs. These are pairs
5776 of two letters (see |object-motions|).
5777
5778 *'paste'* *'nopaste'*
5779'paste' boolean (default off)
5780 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005781 Put Vim in Paste mode. This is useful if you want to cut or copy
5782 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 unexpected effects.
5784 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005785 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005786 knows about pasting and will mostly do the right thing without 'paste'
5787 being set. The same is true for a terminal where Vim handles the
5788 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005789 This option is reset when starting the GUI. Thus if you set it in
5790 your .vimrc it will work in a terminal, but not in the GUI. Setting
5791 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5792 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 When the 'paste' option is switched on (also when it was already on):
5794 - mapping in Insert mode and Command-line mode is disabled
5795 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005796 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005797 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005798 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005799 - 'revins' is reset
5800 - 'ruler' is reset
5801 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005802 - 'smarttab' is reset
5803 - 'softtabstop' is set to 0
5804 - 'textwidth' is set to 0
5805 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005806 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005808 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005809 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005810 - 'indentexpr'
5811 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005812 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 NOTE: When you start editing another file while the 'paste' option is
5814 on, settings from the modelines or autocommands may change the
5815 settings again, causing trouble when pasting text. You might want to
5816 set the 'paste' option again.
5817 When the 'paste' option is reset the mentioned options are restored to
5818 the value before the moment 'paste' was switched from off to on.
5819 Resetting 'paste' before ever setting it does not have any effect.
5820 Since mapping doesn't work while 'paste' is active, you need to use
5821 the 'pastetoggle' option to toggle the 'paste' option with some key.
5822
5823 *'pastetoggle'* *'pt'*
5824'pastetoggle' 'pt' string (default "")
5825 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826 When non-empty, specifies the key sequence that toggles the 'paste'
5827 option. This is like specifying a mapping: >
5828 :map {keys} :set invpaste<CR>
5829< Where {keys} is the value of 'pastetoggle'.
5830 The difference is that it will work even when 'paste' is set.
5831 'pastetoggle' works in Insert mode and Normal mode, but not in
5832 Command-line mode.
5833 Mappings are checked first, thus overrule 'pastetoggle'. However,
5834 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5835 this: >
5836 :map <F10> :set paste<CR>
5837 :map <F11> :set nopaste<CR>
5838 :imap <F10> <C-O>:set paste<CR>
5839 :imap <F11> <nop>
5840 :set pastetoggle=<F11>
5841< This will make <F10> start paste mode and <F11> stop paste mode.
5842 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5843 mode everything is inserted literally, except the 'pastetoggle' key
5844 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005845 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846
5847 *'pex'* *'patchexpr'*
5848'patchexpr' 'pex' string (default "")
5849 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850 {not available when compiled without the |+diff|
5851 feature}
5852 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005853 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005854
Bram Moolenaardbc28022014-07-26 13:40:44 +02005855 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856'patchmode' 'pm' string (default "")
5857 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005858 When non-empty the oldest version of a file is kept. This can be used
5859 to keep the original version of a file if you are changing files in a
5860 source distribution. Only the first time that a file is written a
5861 copy of the original file will be kept. The name of the copy is the
5862 name of the original file with the string in the 'patchmode' option
5863 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005864 ".orig" or ".org". 'backupdir' must not be empty for this to work
5865 (Detail: The backup file is renamed to the patchmode file after the
5866 new file has been successfully written, that's why it must be possible
5867 to write a backup file). If there was no file to be backed up, an
5868 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005869 When the 'backupskip' pattern matches, a patchmode file is not made.
5870 Using 'patchmode' for compressed files appends the extension at the
5871 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5872 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005873 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005875 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005876'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005877 other systems: ".,,")
5878 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005880 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5881 provided that the file being searched for has a relative path (not
5882 starting with "/", "./" or "../"). The directories in the 'path'
5883 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884 - Use commas to separate directory names: >
5885 :set path=.,/usr/local/include,/usr/include
5886< - Spaces can also be used to separate directory names (for backwards
5887 compatibility with version 3.0). To have a space in a directory
5888 name, precede it with an extra backslash, and escape the space: >
5889 :set path=.,/dir/with\\\ space
5890< - To include a comma in a directory name precede it with an extra
5891 backslash: >
5892 :set path=.,/dir/with\\,comma
5893< - To search relative to the directory of the current file, use: >
5894 :set path=.
5895< - To search in the current directory use an empty string between two
5896 commas: >
5897 :set path=,,
5898< - A directory name may end in a ':' or '/'.
5899 - Environment variables are expanded |:set_env|.
5900 - When using |netrw.vim| URLs can be used. For example, adding
5901 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005902 - Search upwards and downwards in a directory tree using "*", "**" and
5903 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 {not available when compiled without the |+path_extra| feature}
5905 - Careful with '\' characters, type two to get one in the option: >
5906 :set path=.,c:\\include
5907< Or just use '/' instead: >
5908 :set path=.,c:/include
5909< Don't forget "." or files won't even be found in the same directory as
5910 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005911 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005912 it is something like 256 or 1024 characters.
5913 You can check if all the include files are found, using the value of
5914 'path', see |:checkpath|.
5915 The use of |:set+=| and |:set-=| is preferred when adding or removing
5916 directories from the list. This avoids problems when a future version
5917 uses another default. To remove the current directory use: >
5918 :set path-=
5919< To add the current directory use: >
5920 :set path+=
5921< To use an environment variable, you probably need to replace the
5922 separator. Here is an example to append $INCL, in which directory
5923 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005924 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925< Replace the ';' with a ':' or whatever separator is used. Note that
5926 this doesn't work when $INCL contains a comma or white space.
5927
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005928 *'perldll'*
5929'perldll' string (default depends on the build)
5930 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005931 {only available when compiled with the |+perl/dyn|
5932 feature}
5933 Specifies the name of the Perl shared library. The default is
5934 DYNAMIC_PERL_DLL, which was specified at compile time.
5935 Environment variables are expanded |:set_env|.
5936 This option cannot be set from a |modeline| or in the |sandbox|, for
5937 security reasons.
5938
Bram Moolenaar071d4272004-06-13 20:20:40 +00005939 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5940'preserveindent' 'pi' boolean (default off)
5941 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005942 When changing the indent of the current line, preserve as much of the
5943 indent structure as possible. Normally the indent is replaced by a
5944 series of tabs followed by spaces as required (unless |'expandtab'| is
5945 enabled, in which case only spaces are used). Enabling this option
5946 means the indent will preserve as many existing characters as possible
5947 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005948 'expandtab' does not apply to the preserved white space, a Tab remains
5949 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950 NOTE: When using ">>" multiple times the resulting indent is a mix of
5951 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005952 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005953 Also see 'copyindent'.
5954 Use |:retab| to clean up white space.
5955
5956 *'previewheight'* *'pvh'*
5957'previewheight' 'pvh' number (default 12)
5958 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005959 {not available when compiled without the |+quickfix|
5960 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005961 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005962 commands. Used for |CTRL-W_}| when no count is given. Not used when
5963 'previewpopup' is set.
5964
5965 *'previewpopup'* *'pvp'*
5966'previewpopup' 'pvp' string (default empty)
5967 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005968 {not available when compiled without the |+textprop|
5969 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005970 When not empty a popup window is used for commands that would open a
5971 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005972 Not used for the insert completion info, add "popup" to
5973 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005974
5975 *'previewwindow'* *'nopreviewwindow'*
5976 *'pvw'* *'nopvw'* *E590*
5977'previewwindow' 'pvw' boolean (default off)
5978 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005979 {not available when compiled without the |+quickfix|
5980 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005981 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005982 set. It's normally not set directly, but by using one of the commands
5983 |:ptag|, |:pedit|, etc.
5984
5985 *'printdevice'* *'pdev'*
5986'printdevice' 'pdev' string (default empty)
5987 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005988 {only available when compiled with the |+printer|
5989 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005990 The name of the printer to be used for |:hardcopy|.
5991 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005992 This option cannot be set from a |modeline| or in the |sandbox|, for
5993 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005994
Bram Moolenaar8299df92004-07-10 09:47:34 +00005995 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005996'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005997 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005998 {only available when compiled with the |+printer|
5999 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006000 Sets the character encoding used when printing.
6001 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002
6003 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006004'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006006 {only available when compiled with the |+printer|
6007 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006008 Expression used to print the PostScript produced with |:hardcopy|.
6009 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006010 This option cannot be set from a |modeline| or in the |sandbox|, for
6011 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012
Bram Moolenaar8299df92004-07-10 09:47:34 +00006013 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006014'printfont' 'pfn' string (default "courier")
6015 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006016 {only available when compiled with the |+printer|
6017 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006018 The name of the font that will be used for |:hardcopy|.
6019 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020
6021 *'printheader'* *'pheader'*
6022'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006024 {only available when compiled with the |+printer|
6025 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006026 The format of the header produced in |:hardcopy| output.
6027 See |pheader-option|.
6028
6029 *'printmbcharset'* *'pmbcs'*
6030'printmbcharset' 'pmbcs' string (default "")
6031 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006032 {only available when compiled with the |+printer|
6033 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006034 The CJK character set to be used for CJK output from |:hardcopy|.
6035 See |pmbcs-option|.
6036
6037 *'printmbfont'* *'pmbfn'*
6038'printmbfont' 'pmbfn' string (default "")
6039 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006040 {only available when compiled with the |+printer|
6041 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006042 List of font names to be used for CJK output from |:hardcopy|.
6043 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044
6045 *'printoptions'* *'popt'*
6046'printoptions' 'popt' string (default "")
6047 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006048 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006049 List of items that control the format of the output of |:hardcopy|.
6050 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006052 *'prompt'* *'noprompt'*
6053'prompt' boolean (default on)
6054 global
6055 When on a ":" prompt is used in Ex mode.
6056
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006057 *'pumheight'* *'ph'*
6058'pumheight' 'ph' number (default 0)
6059 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006060 Determines the maximum number of items to show in the popup menu for
6061 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006062 |ins-completion-menu|.
6063
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006064 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006065'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006066 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006067 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006068 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006069
Bram Moolenaard94464e2015-11-02 15:28:18 +01006070 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006071'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006072 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006073 {only available when compiled with the |+python/dyn|
6074 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006075 Specifies the name of the Python 2.x shared library. The default is
6076 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006077 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006078 This option cannot be set from a |modeline| or in the |sandbox|, for
6079 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006080
Bram Moolenaar94073162018-01-31 21:49:05 +01006081 *'pythonhome'*
6082'pythonhome' string (default "")
6083 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006084 {only available when compiled with the |+python/dyn|
6085 feature}
6086 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6087 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6088 which was specified at compile time, will be used for the Python 2.x
6089 home directory.
6090 Environment variables are expanded |:set_env|.
6091 This option cannot be set from a |modeline| or in the |sandbox|, for
6092 security reasons.
6093
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006094 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006095'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006096 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006097 {only available when compiled with the |+python3/dyn|
6098 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006099 Specifies the name of the Python 3 shared library. The default is
6100 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006101 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006102 This option cannot be set from a |modeline| or in the |sandbox|, for
6103 security reasons.
6104
Bram Moolenaar94073162018-01-31 21:49:05 +01006105 *'pythonthreehome'*
6106'pythonthreehome' string (default "")
6107 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006108 {only available when compiled with the |+python3/dyn|
6109 feature}
6110 Specifies the name of the Python 3 home directory. When
6111 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6112 PYTHON3_HOME, which was specified at compile time, will be used for
6113 the Python 3 home directory.
6114 Environment variables are expanded |:set_env|.
6115 This option cannot be set from a |modeline| or in the |sandbox|, for
6116 security reasons.
6117
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006118 *'pyxversion'* *'pyx'*
6119'pyxversion' 'pyx' number (default depends on the build)
6120 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006121 {only available when compiled with the |+python| or
6122 the |+python3| feature}
6123 Specifies the python version used for pyx* functions and commands
6124 |python_x|. The default value is as follows:
6125
6126 Compiled with Default ~
6127 |+python| and |+python3| 0
6128 only |+python| 2
6129 only |+python3| 3
6130
6131 Available values are 0, 2 and 3.
6132 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6133 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6134 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6135 to 2 if Python 2 is available.
6136 See also: |has-pythonx|
6137
6138 If Vim is compiled with only |+python| or |+python3| setting
6139 'pyxversion' has no effect. The pyx* functions and commands are
6140 always the same as the compiled version.
6141
6142 This option cannot be set from a |modeline| or in the |sandbox|, for
6143 security reasons.
6144
Bram Moolenaar858ba062020-05-31 23:11:59 +02006145 *'quickfixtextfunc'* *'qftf'*
6146'quickfixtextfunc' 'qftf' string (default "")
6147 global
6148 {only available when compiled with the |+quickfix|
6149 feature}
6150 This option specifies a function to be used to get the text to display
6151 in the quickfix and location list windows. This can be used to
6152 customize the information displayed in the quickfix or location window
6153 for each entry in the corresponding quickfix or location list. See
6154 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006155 function and an example. The value can be the name of a function, a
6156 |lambda| or a |Funcref|. See |option-value-function| for more
6157 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006158
6159 This option cannot be set from a |modeline| or in the |sandbox|, for
6160 security reasons.
6161
Bram Moolenaar677ee682005-01-27 14:41:15 +00006162 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006163'quoteescape' 'qe' string (default "\")
6164 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006165 The characters that are used to escape quotes in a string. Used for
6166 objects like a', a" and a` |a'|.
6167 When one of the characters in this option is found inside a string,
6168 the following character will be skipped. The default value makes the
6169 text "foo\"bar\\" considered to be one string.
6170
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6172'readonly' 'ro' boolean (default off)
6173 local to buffer
6174 If on, writes fail unless you use a '!'. Protects you from
6175 accidentally overwriting a file. Default on when Vim is started
6176 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006177 When using ":w!" the 'readonly' option is reset for the current
6178 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006179 When using the ":view" command the 'readonly' option is set for the
6180 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006181 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006183 *'redrawtime'* *'rdt'*
6184'redrawtime' 'rdt' number (default 2000)
6185 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006186 {only available when compiled with the |+reltime|
6187 feature}
6188 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006189 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006190 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006191 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006192 matches will be highlighted.
6193 For syntax highlighting the time applies per window. When over the
6194 limit syntax highlighting is disabled until |CTRL-L| is used.
6195 This is used to avoid that Vim hangs when using a very complicated
6196 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006197
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006198 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006199'regexpengine' 're' number (default 0)
6200 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006201 This selects the default regexp engine. |two-engines|
6202 The possible values are:
6203 0 automatic selection
6204 1 old engine
6205 2 NFA engine
6206 Note that when using the NFA engine and the pattern contains something
6207 that is not supported the pattern will not match. This is only useful
6208 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006209 Using automatic selection enables Vim to switch the engine, if the
6210 default engine becomes too costly. E.g., when the NFA engine uses too
6211 many states. This should prevent Vim from hanging on a combination of
6212 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006213
Bram Moolenaar64486672010-05-16 15:46:46 +02006214 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6215'relativenumber' 'rnu' boolean (default off)
6216 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006217 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006218 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006219 precede some vertical motion commands (e.g. j k + -) with, without
6220 having to calculate it yourself. Especially useful in combination with
6221 other commands (e.g. y d c < > gq gw =).
6222 When the 'n' option is excluded from 'cpoptions' a wrapped
6223 line will not use the column of line numbers (this is the default when
6224 'compatible' isn't set).
6225 The 'numberwidth' option can be used to set the room used for the line
6226 number.
6227 When a long, wrapped line doesn't start with the first character, '-'
6228 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006229 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6230 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006231
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006232 The number in front of the cursor line also depends on the value of
6233 'number', see |number_relativenumber| for all combinations of the two
6234 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006235
Bram Moolenaar071d4272004-06-13 20:20:40 +00006236 *'remap'* *'noremap'*
6237'remap' boolean (default on)
6238 global
6239 Allows for mappings to work recursively. If you do not want this for
6240 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006241 NOTE: To avoid portability problems with Vim scripts, always keep
6242 this option at the default "on". Only switch it off when working with
6243 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006245 *'renderoptions'* *'rop'*
6246'renderoptions' 'rop' string (default: empty)
6247 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006248 {only available when compiled with GUI and DIRECTX on
6249 MS-Windows}
6250 Select a text renderer and set its options. The options depend on the
6251 renderer.
6252
6253 Syntax: >
6254 set rop=type:{renderer}(,{name}:{value})*
6255<
6256 Currently, only one optional renderer is available.
6257
6258 render behavior ~
6259 directx Vim will draw text using DirectX (DirectWrite). It makes
6260 drawn glyphs more beautiful than default GDI.
6261 It requires 'encoding' is "utf-8", and only works on
6262 MS-Windows Vista or newer version.
6263
6264 Options:
6265 name meaning type value ~
6266 gamma gamma float 1.0 - 2.2 (maybe)
6267 contrast enhancedContrast float (unknown)
6268 level clearTypeLevel float (unknown)
6269 geom pixelGeometry int 0 - 2 (see below)
6270 renmode renderingMode int 0 - 6 (see below)
6271 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006272 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006273
Bram Moolenaar92467d32017-12-05 13:22:16 +01006274 See this URL for detail (except for scrlines):
6275 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006276
6277 For geom: structure of a device pixel.
6278 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6279 1 - DWRITE_PIXEL_GEOMETRY_RGB
6280 2 - DWRITE_PIXEL_GEOMETRY_BGR
6281
6282 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006283 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006284
6285 For renmode: method of rendering glyphs.
6286 0 - DWRITE_RENDERING_MODE_DEFAULT
6287 1 - DWRITE_RENDERING_MODE_ALIASED
6288 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6289 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6290 4 - DWRITE_RENDERING_MODE_NATURAL
6291 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6292 6 - DWRITE_RENDERING_MODE_OUTLINE
6293
6294 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006295 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006296
6297 For taamode: antialiasing mode used for drawing text.
6298 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6299 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6300 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6301 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6302
6303 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006304 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6305
Bram Moolenaara338adc2018-01-31 20:51:47 +01006306 For scrlines:
6307 This was used for optimizing scrolling behavior, however this
6308 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006309
6310 Example: >
6311 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006312 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006313 set rop=type:directx
6314<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006315 If select a raster font (Courier, Terminal or FixedSys which
6316 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006317 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006318
6319 NOTE: It is known that some fonts and options combination
6320 causes trouble on drawing glyphs.
6321
Bram Moolenaar92467d32017-12-05 13:22:16 +01006322 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006323 special made fonts (True-Type fonts which includes only
6324 bitmap glyphs).
6325 - 'taamode:3' will not work with some vector fonts.
6326
6327 NOTE: With this option, you can display colored emoji
6328 (emoticon) in Windows 8.1 or later. To display colored emoji,
6329 there are some conditions which you should notice.
6330
6331 - If your font includes non-colored emoji already, it will
6332 be used.
6333 - If your font doesn't have emoji, the system chooses an
6334 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6335 will be used.
6336 - When this alternative font didn't have fixed width glyph,
6337 emoji might be rendered beyond the bounding box of drawing
6338 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006339
6340 Other render types are currently not supported.
6341
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 *'report'*
6343'report' number (default 2)
6344 global
6345 Threshold for reporting number of lines changed. When the number of
6346 changed lines is more than 'report' a message will be given for most
6347 ":" commands. If you want it always, set 'report' to 0.
6348 For the ":substitute" command the number of substitutions is used
6349 instead of the number of lines.
6350
6351 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6352'restorescreen' 'rs' boolean (default on)
6353 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006354 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355 When set, the screen contents is restored when exiting Vim. This also
6356 happens when executing external commands.
6357
6358 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6359 options in your .vimrc. To disable restoring:
6360 set t_ti= t_te=
6361 To enable restoring (for an xterm):
6362 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6363 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6364
6365 *'revins'* *'ri'* *'norevins'* *'nori'*
6366'revins' 'ri' boolean (default off)
6367 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006368 {only available when compiled with the |+rightleft|
6369 feature}
6370 Inserting characters in Insert mode will work backwards. See "typing
6371 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6372 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006373 NOTE: This option is reset when 'compatible' is set.
6374 This option is reset when 'paste' is set and restored when 'paste' is
6375 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376
6377 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6378'rightleft' 'rl' boolean (default off)
6379 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 {only available when compiled with the |+rightleft|
6381 feature}
6382 When on, display orientation becomes right-to-left, i.e., characters
6383 that are stored in the file appear from the right to the left.
6384 Using this option, it is possible to edit files for languages that
6385 are written from the right to the left such as Hebrew and Arabic.
6386 This option is per window, so it is possible to edit mixed files
6387 simultaneously, or to view the same file in both ways (this is
6388 useful whenever you have a mixed text file with both right-to-left
6389 and left-to-right strings so that both sets are displayed properly
6390 in different windows). Also see |rileft.txt|.
6391
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006392 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393'rightleftcmd' 'rlc' string (default "search")
6394 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395 {only available when compiled with the |+rightleft|
6396 feature}
6397 Each word in this option enables the command line editing to work in
6398 right-to-left mode for a group of commands:
6399
6400 search "/" and "?" commands
6401
6402 This is useful for languages such as Hebrew, Arabic and Farsi.
6403 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6404
Bram Moolenaard94464e2015-11-02 15:28:18 +01006405 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006406'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006407 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006408 {only available when compiled with the |+ruby/dyn|
6409 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006410 Specifies the name of the Ruby shared library. The default is
6411 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006412 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006413 This option cannot be set from a |modeline| or in the |sandbox|, for
6414 security reasons.
6415
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006417'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006419 {not available when compiled without the
6420 |+cmdline_info| feature}
6421 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006422 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006423 text in the file is shown on the far right:
6424 Top first line is visible
6425 Bot last line is visible
6426 All first and last line are visible
6427 45% relative position in the file
6428 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006429 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006431 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432 this option takes precedence over 'ruler' and 'rulerformat'
6433 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006434 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006435 the text column (byte number) and the screen column are shown,
6436 separated with a dash.
6437 For an empty line "0-1" is shown.
6438 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006439 This option is reset when 'paste' is set and restored when 'paste' is
6440 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441 If you don't want to see the ruler all the time but want to know where
6442 you are, use "g CTRL-G" |g_CTRL-G|.
6443 NOTE: This option is reset when 'compatible' is set.
6444
6445 *'rulerformat'* *'ruf'*
6446'rulerformat' 'ruf' string (default empty)
6447 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006448 {not available when compiled without the |+statusline|
6449 feature}
6450 When this option is not empty, it determines the content of the ruler
6451 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006452 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006453 This option cannot be set in a modeline when 'modelineexpr' is off.
6454
Bram Moolenaar071d4272004-06-13 20:20:40 +00006455 The default ruler width is 17 characters. To make the ruler 15
6456 characters wide, put "%15(" at the start and "%)" at the end.
6457 Example: >
6458 :set rulerformat=%15(%c%V\ %p%%%)
6459<
6460 *'runtimepath'* *'rtp'* *vimfiles*
6461'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006462 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463 $VIM/vimfiles,
6464 $VIMRUNTIME,
6465 $VIM/vimfiles/after,
6466 $HOME/.vim/after"
6467 Amiga: "home:vimfiles,
6468 $VIM/vimfiles,
6469 $VIMRUNTIME,
6470 $VIM/vimfiles/after,
6471 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006472 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 $VIM/vimfiles,
6474 $VIMRUNTIME,
6475 $VIM/vimfiles/after,
6476 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006477 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 $VIMRUNTIME,
6479 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006480 Haiku: "$BE_USER_SETTINGS/vim,
6481 $VIM/vimfiles,
6482 $VIMRUNTIME,
6483 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006484 $BE_USER_SETTINGS/vim/after"
6485 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006486 $VIM/vimfiles,
6487 $VIMRUNTIME,
6488 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006489 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491 This is a list of directories which will be searched for runtime
6492 files:
6493 filetype.vim filetypes by file name |new-filetype|
6494 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006495 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496 colors/ color scheme files |:colorscheme|
6497 compiler/ compiler files |:compiler|
6498 doc/ documentation |write-local-help|
6499 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006500 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501 indent/ indent scripts |indent-expression|
6502 keymap/ key mapping files |mbyte-keymap|
6503 lang/ menu translations |:menutrans|
6504 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006505 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 plugin/ plugin scripts |write-plugin|
6507 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006508 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006509 syntax/ syntax files |mysyntaxfile|
6510 tutor/ files for vimtutor |tutor|
6511
6512 And any other file searched for with the |:runtime| command.
6513
6514 The defaults for most systems are setup to search five locations:
6515 1. In your home directory, for your personal preferences.
6516 2. In a system-wide Vim directory, for preferences from the system
6517 administrator.
6518 3. In $VIMRUNTIME, for files distributed with Vim.
6519 *after-directory*
6520 4. In the "after" directory in the system-wide Vim directory. This is
6521 for the system administrator to overrule or add to the distributed
6522 defaults (rarely needed)
6523 5. In the "after" directory in your home directory. This is for
6524 personal preferences to overrule or add to the distributed defaults
6525 or system-wide settings (rarely needed).
6526
Bram Moolenaard0796902016-09-16 20:02:31 +02006527 More entries are added when using |packages|. If it gets very long
6528 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6529 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006530
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6532 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006533 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006534 wildcards.
6535 See |:runtime|.
6536 Example: >
6537 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6538< This will use the directory "~/vimruntime" first (containing your
6539 personal Vim runtime files), then "/mygroup/vim" (shared between a
6540 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6541 files).
6542 You probably should always include $VIMRUNTIME somewhere, to use the
6543 distributed runtime files. You can put a directory before $VIMRUNTIME
6544 to find files which replace a distributed runtime files. You can put
6545 a directory after $VIMRUNTIME to find files which add to distributed
6546 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006547 When Vim is started with |--clean| the home directory entries are not
6548 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 This option cannot be set from a |modeline| or in the |sandbox|, for
6550 security reasons.
6551
6552 *'scroll'* *'scr'*
6553'scroll' 'scr' number (default: half the window height)
6554 local to window
6555 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6556 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006557 changes. This may happen when enabling the |status-line| or
6558 'tabline' option after setting the 'scroll' option.
6559 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006560 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006561 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562
6563 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6564'scrollbind' 'scb' boolean (default off)
6565 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 See also |scroll-binding|. When this option is set, the current
6567 window scrolls as other scrollbind windows (windows that also have
6568 this option set) scroll. This option is useful for viewing the
6569 differences between two versions of a file, see 'diff'.
6570 See |'scrollopt'| for options that determine how this option should be
6571 interpreted.
6572 This option is mostly reset when splitting a window to edit another
6573 file. This means that ":split | edit file" results in two windows
6574 with scroll-binding, but ":split file" does not.
6575
Bram Moolenaarae20f342019-11-05 21:09:23 +01006576 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6577'scrollfocus' 'scf' boolean (default off)
6578 global
6579 {only for MS-Windows GUI}
6580 When using the scroll wheel and this option is set, the window under
6581 the mouse pointer is scrolled. With this option off the current
6582 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006583 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006584
Bram Moolenaar071d4272004-06-13 20:20:40 +00006585 *'scrolljump'* *'sj'*
6586'scrolljump' 'sj' number (default 1)
6587 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 Minimal number of lines to scroll when the cursor gets off the
6589 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6590 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006591 When set to a negative number from -1 to -100 this is used as the
6592 percentage of the window height. Thus -50 scrolls half the window
6593 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 NOTE: This option is set to 1 when 'compatible' is set.
6595
6596 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006597'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006598 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 Minimal number of screen lines to keep above and below the cursor.
6600 This will make some context visible around where you are working. If
6601 you set it to a very large value (999) the cursor line will always be
6602 in the middle of the window (except at the start or end of the file or
6603 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006604 After using the local value, go back the global value with one of
6605 these two: >
6606 setlocal scrolloff<
6607 setlocal scrolloff=-1
6608< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006609 NOTE: This option is set to 0 when 'compatible' is set.
6610
6611 *'scrollopt'* *'sbo'*
6612'scrollopt' 'sbo' string (default "ver,jump")
6613 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006615 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6616 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 The following words are available:
6618 ver Bind vertical scrolling for 'scrollbind' windows
6619 hor Bind horizontal scrolling for 'scrollbind' windows
6620 jump Applies to the offset between two windows for vertical
6621 scrolling. This offset is the difference in the first
6622 displayed line of the bound windows. When moving
6623 around in a window, another 'scrollbind' window may
6624 reach a position before the start or after the end of
6625 the buffer. The offset is not changed though, when
6626 moving back the 'scrollbind' window will try to scroll
6627 to the desired position when possible.
6628 When now making that window the current one, two
6629 things can be done with the relative offset:
6630 1. When "jump" is not included, the relative offset is
6631 adjusted for the scroll position in the new current
6632 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006633 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 2. When "jump" is included, the other windows are
6635 scrolled to keep the same relative offset. When
6636 going back to the other window, it still uses the
6637 same relative offset.
6638 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006639 When 'diff' mode is active there always is vertical scroll binding,
6640 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006641
6642 *'sections'* *'sect'*
6643'sections' 'sect' string (default "SHNHH HUnhsh")
6644 global
6645 Specifies the nroff macros that separate sections. These are pairs of
6646 two letters (See |object-motions|). The default makes a section start
6647 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6648
6649 *'secure'* *'nosecure'* *E523*
6650'secure' boolean (default off)
6651 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 When on, ":autocmd", shell and write commands are not allowed in
6653 ".vimrc" and ".exrc" in the current directory and map commands are
6654 displayed. Switch it off only if you know that you will not run into
6655 problems, or when the 'exrc' option is off. On Unix this option is
6656 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006657 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 'secure' at the end of your ~/.vimrc then.
6659 This option cannot be set from a |modeline| or in the |sandbox|, for
6660 security reasons.
6661
6662 *'selection'* *'sel'*
6663'selection' 'sel' string (default "inclusive")
6664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 This option defines the behavior of the selection. It is only used
6666 in Visual and Select mode.
6667 Possible values:
6668 value past line inclusive ~
6669 old no yes
6670 inclusive yes yes
6671 exclusive yes no
6672 "past line" means that the cursor is allowed to be positioned one
6673 character past the line.
6674 "inclusive" means that the last character of the selection is included
6675 in an operation. For example, when "x" is used to delete the
6676 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006677 When "old" is used and 'virtualedit' allows the cursor to move past
6678 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006679 Note that when "exclusive" is used and selecting from the end
6680 backwards, you cannot include the last character of a line, when
6681 starting in Normal mode and 'virtualedit' empty.
6682
6683 The 'selection' option is set by the |:behave| command.
6684
6685 *'selectmode'* *'slm'*
6686'selectmode' 'slm' string (default "")
6687 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006688 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 Select mode instead of Visual mode, when a selection is started.
6690 Possible values:
6691 mouse when using the mouse
6692 key when using shifted special keys
6693 cmd when using "v", "V" or CTRL-V
6694 See |Select-mode|.
6695 The 'selectmode' option is set by the |:behave| command.
6696
6697 *'sessionoptions'* *'ssop'*
6698'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006699 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006700 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006701 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 feature}
6703 Changes the effect of the |:mksession| command. It is a comma
6704 separated list of words. Each word enables saving and restoring
6705 something:
6706 word save and restore ~
6707 blank empty windows
6708 buffers hidden and unloaded buffers, not just those in windows
6709 curdir the current directory
6710 folds manually created folds, opened/closed folds and local
6711 fold options
6712 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006713 and contain at least one lowercase letter. Only
6714 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 help the help window
6716 localoptions options and mappings local to a window or buffer (not
6717 global values for local options)
6718 options all options and mappings (also global values for local
6719 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006720 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721 resize size of the Vim window: 'lines' and 'columns'
6722 sesdir the directory in which the session file is located
6723 will become the current directory (useful with
6724 projects accessed over a network from different
6725 systems)
6726 slash backslashes in file names replaced with forward
6727 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006728 tabpages all tab pages; without this only the current tab page
6729 is restored, so that you can make a session for each
6730 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006731 terminal include terminal windows where the command can be
6732 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733 unix with Unix end-of-line format (single <NL>), even when
6734 on Windows or DOS
6735 winpos position of the whole Vim window
6736 winsize window sizes
6737
6738 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006739 When neither "curdir" nor "sesdir" is included, file names are stored
6740 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006741 If you leave out "options" many things won't work well after restoring
6742 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 "slash" and "unix" are useful on Windows when sharing session files
6744 with Unix. The Unix version of Vim cannot source dos format scripts,
6745 but the Windows version of Vim can source unix format scripts.
6746
6747 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006748'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006749 global
6750 Name of the shell to use for ! and :! commands. When changing the
6751 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6752 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006753 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 See |option-backslash| about including spaces and backslashes.
6755 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006756
Bram Moolenaara2baa732022-02-04 16:09:54 +00006757 In |restricted-mode| shell commands will not be possible. This mode
6758 is used if the value of $SHELL ends in "false" or "nologin".
6759
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006760 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006761 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6763< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006764 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006765 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006766 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006767 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006768 Example with escaped space (Vim will do this when initializing the
6769 option from $SHELL): >
6770 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006771< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006772 backslashes are consumed by `:set`.
6773
Bram Moolenaar071d4272004-06-13 20:20:40 +00006774 Under MS-Windows, when the executable ends in ".com" it must be
6775 included. Thus setting the shell to "command.com" or "4dos.com"
6776 works, but "command" and "4dos" do not work for all commands (e.g.,
6777 filtering).
6778 For unknown reasons, when using "4dos.com" the current directory is
6779 changed to "C:\". To avoid this set 'shell' like this: >
6780 :set shell=command.com\ /c\ 4dos
6781< This option cannot be set from a |modeline| or in the |sandbox|, for
6782 security reasons.
6783
6784 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006785'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006786 Win32, when 'shell' contains "powershell":
6787 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006788 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006791 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6792 For MS-Windows, the default is set according to the value of 'shell',
6793 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006794 On Unix it can have more than one flag. Each white space separated
6795 part is passed as an argument to the shell command.
6796 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006797 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006798 This option cannot be set from a |modeline| or in the |sandbox|, for
6799 security reasons.
6800
6801 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006802'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6803 "2>&1| tee", or
6804 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 {not available when compiled without the |+quickfix|
6807 feature}
6808 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006809 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006810 including spaces and backslashes.
6811 The name of the temporary file can be represented by "%s" if necessary
6812 (the file name is appended automatically if no %s appears in the value
6813 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006814 For the Amiga the default is ">". For MS-Windows using powershell the
6815 default is "2>&1 | Out-File -Encoding default", otherwise the default
6816 is ">%s 2>&1". The output is directly saved in a file and not echoed
6817 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006818 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 in a file and echoed to the screen. If the 'shell' option is "csh" or
6820 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006821 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006822 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6823 means that stderr is also included. Before using the 'shell' option a
6824 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006825 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6826 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827 The initialization of this option is done after reading the ".vimrc"
6828 and the other initializations, so that when the 'shell' option is set
6829 there, the 'shellpipe' option changes automatically, unless it was
6830 explicitly set before.
6831 When 'shellpipe' is set to an empty string, no redirection of the
6832 ":make" output will be done. This is useful if you use a 'makeprg'
6833 that writes to 'makeef' by itself. If you want no piping, but do
6834 want to include the 'makeef', set 'shellpipe' to a single space.
6835 Don't forget to precede the space with a backslash: ":set sp=\ ".
6836 In the future pipes may be used for filtering and this option will
6837 become obsolete (at least for Unix).
6838 This option cannot be set from a |modeline| or in the |sandbox|, for
6839 security reasons.
6840
6841 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006842'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 Quoting character(s), put around the command passed to the shell, for
6845 the "!" and ":!" commands. The redirection is kept outside of the
6846 quoting. See 'shellxquote' to include the redirection. It's
6847 probably not useful to set both options.
6848 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006849 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006850 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 This option cannot be set from a |modeline| or in the |sandbox|, for
6852 security reasons.
6853
6854 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006855'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6856 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006857 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 String to be used to put the output of a filter command in a temporary
6859 file. See also |:!|. See |option-backslash| about including spaces
6860 and backslashes.
6861 The name of the temporary file can be represented by "%s" if necessary
6862 (the file name is appended automatically if no %s appears in the value
6863 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006864 The default is ">". For Unix, if the 'shell' option is "csh" or
6865 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006866 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006867 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6868 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006869 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6870 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006871 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6872 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006873 The initialization of this option is done after reading the ".vimrc"
6874 and the other initializations, so that when the 'shell' option is set
6875 there, the 'shellredir' option changes automatically unless it was
6876 explicitly set before.
6877 In the future pipes may be used for filtering and this option will
6878 become obsolete (at least for Unix).
6879 This option cannot be set from a |modeline| or in the |sandbox|, for
6880 security reasons.
6881
6882 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6883'shellslash' 'ssl' boolean (default off)
6884 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006885 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006886 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006887 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006888 powershell.exe. Backward slashes can still be typed, but they are
6889 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890 Note that setting or resetting this option has no effect for some
6891 existing file names, thus this option needs to be set before opening
6892 any file for best results. This might change in the future.
6893 'shellslash' only works when a backslash can be used as a path
6894 separator. To test if this is so use: >
6895 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006896< Also see 'completeslash'.
6897
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006898 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6899'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6900 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006901 When on, use temp files for shell commands. When off use a pipe.
6902 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006903 Currently a pipe is only supported on Unix and MS-Windows 2K and
6904 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006905 :if has("filterpipe")
6906< The advantage of using a pipe is that nobody can read the temp file
6907 and the 'shell' command does not need to support redirection.
6908 The advantage of using a temp file is that the file type and encoding
6909 can be detected.
6910 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6911 |FilterWritePost| autocommands event are not triggered when
6912 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006913 The `system()` function does not respect this option and always uses
6914 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006915 NOTE: This option is set to the Vim default value when 'compatible'
6916 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006917
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 *'shelltype'* *'st'*
6919'shelltype' 'st' number (default 0)
6920 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006921 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006922 On the Amiga this option influences the way how the commands work
6923 which use a shell.
6924 0 and 1: always use the shell
6925 2 and 3: use the shell only to filter lines
6926 4 and 5: use shell only for ':sh' command
6927 When not using the shell, the command is executed directly.
6928
6929 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6930 1 and 3: use "shell cmd" to start external commands
6931
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006932 *'shellxescape'* *'sxe'*
6933'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006934 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006935 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006936 When 'shellxquote' is set to "(" then the characters listed in this
6937 option will be escaped with a '^' character. This makes it possible
6938 to execute most external commands with cmd.exe.
6939
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 *'shellxquote'* *'sxq'*
6941'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006942 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006943 for Win32, when 'shell' is
6944 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006945 for Win32, when 'shell' contains "sh"
6946 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947 for Unix, when using system(): "\"")
6948 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 Quoting character(s), put around the command passed to the shell, for
6950 the "!" and ":!" commands. Includes the redirection. See
6951 'shellquote' to exclude the redirection. It's probably not useful
6952 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006953 When the value is '(' then ')' is appended. When the value is '"('
6954 then ')"' is appended.
6955 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006956 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006957 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6958 pwsh.exe which automatically strips off the first and last quote on a
6959 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6960 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006961 'shell', to reduce the need to set this option by the user. See
6962 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006963 This option cannot be set from a |modeline| or in the |sandbox|, for
6964 security reasons.
6965
6966 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6967'shiftround' 'sr' boolean (default off)
6968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 Round indent to multiple of 'shiftwidth'. Applies to > and <
6970 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6971 a multiple of 'shiftwidth' (this is Vi compatible).
6972 NOTE: This option is reset when 'compatible' is set.
6973
6974 *'shiftwidth'* *'sw'*
6975'shiftwidth' 'sw' number (default 8)
6976 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006977 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006979 When zero the 'ts' value will be used. Use the |shiftwidth()|
6980 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981
6982 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006983'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6984 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 This option helps to avoid all the |hit-enter| prompts caused by file
6987 messages, for example with CTRL-G, and to avoid some other messages.
6988 It is a list of flags:
6989 flag meaning when present ~
6990 f use "(3 of 5)" instead of "(file 3 of 5)"
6991 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006992 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 m use "[+]" instead of "[Modified]"
6994 n use "[New]" instead of "[New File]"
6995 r use "[RO]" instead of "[readonly]"
6996 w use "[w]" instead of "written" for file write message
6997 and "[a]" instead of "appended" for ':w >> file' command
6998 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6999 "[unix format]" and "[mac]" instead of "[mac format]".
7000 a all of the above abbreviations
7001
7002 o overwrite message for writing a file with subsequent message
7003 for reading a file (useful for ":wn" or when 'autowrite' on)
7004 O message for reading a file overwrites any previous message.
7005 Also for quickfix message (e.g., ":cn").
7006 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02007007 hit TOP, continuing at BOTTOM" messages; when using the search
7008 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 t truncate file message at the start if it is too long to fit
7010 on the command-line, "<" will appear in the left most column.
7011 Ignored in Ex mode.
7012 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00007013 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 Ignored in Ex mode.
7015 W don't give "written" or "[w]" when writing a file
7016 A don't give the "ATTENTION" message when an existing swap file
7017 is found.
7018 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02007019 c don't give |ins-completion-menu| messages. For example,
7020 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
7021 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01007022 q use "recording" instead of "recording @a"
7023 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02007024 was used for the command; note that this also affects messages
7025 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007026 S do not show search count message when searching, e.g.
7027 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028
7029 This gives you the opportunity to avoid that a change between buffers
7030 requires you to hit <Enter>, but still gives as useful a message as
7031 possible for the space available. To get the whole message that you
7032 would have got with 'shm' empty, use ":file!"
7033 Useful values:
7034 shm= No abbreviation of message.
7035 shm=a Abbreviation, but no loss of information.
7036 shm=at Abbreviation, and truncate message when necessary.
7037
7038 NOTE: This option is set to the Vi default value when 'compatible' is
7039 set and to the Vim default value when 'compatible' is reset.
7040
7041 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7042'shortname' 'sn' boolean (default off)
7043 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 Filenames are assumed to be 8 characters plus one extension of 3
7045 characters. Multiple dots in file names are not allowed. When this
7046 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007047 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007049 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050
7051 *'showbreak'* *'sbr'* *E595*
7052'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007053 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007054 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055 feature}
7056 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007057 values are "> " or "+++ ": >
7058 :set showbreak=>\
7059< Note the backslash to escape the trailing space. It's easier like
7060 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007061 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007062< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 comma (in a future version the comma might be used to separate the
7064 part that is shown at the end and at the start of a line).
7065 The characters are highlighted according to the '@' flag in
7066 'highlight'.
7067 Note that tabs after the showbreak will be displayed differently.
7068 If you want the 'showbreak' to appear in between line numbers, add the
7069 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007070 A window-local value overrules a global value. If the global value is
7071 set and you want no value in the current window use NONE: >
7072 :setlocal showbreak=NONE
7073<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007074 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007075'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7076 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007077 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 {not available when compiled without the
7079 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007080 Show (partial) command in the last line of the screen. Set this
7081 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082 In Visual mode the size of the selected area is shown:
7083 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007084 If the number of bytes is different it is also displayed: "2-6"
7085 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007086 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007087 - When selecting a block, the size in screen characters:
7088 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089 NOTE: This option is set to the Vi default value when 'compatible' is
7090 set and to the Vim default value when 'compatible' is reset.
7091
7092 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7093'showfulltag' 'sft' boolean (default off)
7094 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 When completing a word in insert mode (see |ins-completion|) from the
7096 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007097 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007098 matched a C function, you can see a template for what arguments are
7099 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007100 Note that this doesn't work well together with having "longest" in
7101 'completeopt', because the completion from the search pattern may not
7102 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103
7104 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7105'showmatch' 'sm' boolean (default off)
7106 global
7107 When a bracket is inserted, briefly jump to the matching one. The
7108 jump is only done if the match can be seen on the screen. The time to
7109 show the match can be set with 'matchtime'.
7110 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007111 seen or not).
7112 This option is reset when 'paste' is set and restored when 'paste' is
7113 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 When the 'm' flag is not included in 'cpoptions', typing a character
7115 will immediately move the cursor back to where it belongs.
7116 See the "sm" field in 'guicursor' for setting the cursor shape and
7117 blinking when showing the match.
7118 The 'matchpairs' option can be used to specify the characters to show
7119 matches for. 'rightleft' and 'revins' are used to look for opposite
7120 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007121 Also see the matchparen plugin for highlighting the match when moving
7122 around |pi_paren.txt|.
7123 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124
7125 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7126'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7127 global
7128 If in Insert, Replace or Visual mode put a message on the last line.
7129 Use the 'M' flag in 'highlight' to set the type of highlighting for
7130 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007131 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007132 doesn't mean XIM is really active, especially when 'imactivatekey' is
7133 not set.
7134 NOTE: This option is set to the Vi default value when 'compatible' is
7135 set and to the Vim default value when 'compatible' is reset.
7136
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007137 *'showtabline'* *'stal'*
7138'showtabline' 'stal' number (default 1)
7139 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007140 The value of this option specifies when the line with tab page labels
7141 will be displayed:
7142 0: never
7143 1: only if there are at least two tab pages
7144 2: always
7145 This is both for the GUI and non-GUI implementation of the tab pages
7146 line.
7147 See |tab-page| for more information about tab pages.
7148
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 *'sidescroll'* *'ss'*
7150'sidescroll' 'ss' number (default 0)
7151 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 The minimal number of columns to scroll horizontally. Used only when
7153 the 'wrap' option is off and the cursor is moved off of the screen.
7154 When it is zero the cursor will be put in the middle of the screen.
7155 When using a slow terminal set it to a large number or 0. When using
7156 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7157 commands.
7158
7159 *'sidescrolloff'* *'siso'*
7160'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007161 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007163 right of the cursor if 'nowrap' is set. Setting this option to a
7164 value greater than 0 while having |'sidescroll'| also at a non-zero
7165 value makes some context visible in the line you are scrolling in
7166 horizontally (except at beginning of the line). Setting this option
7167 to a large value (like 999) has the effect of keeping the cursor
7168 horizontally centered in the window, as long as one does not come too
7169 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007170 After using the local value, go back the global value with one of
7171 these two: >
7172 setlocal sidescrolloff<
7173 setlocal sidescrolloff=-1
7174< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175
7176 Example: Try this together with 'sidescroll' and 'listchars' as
7177 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007178 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179
7180 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7181 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007182<
7183 *'signcolumn'* *'scl'*
7184'signcolumn' 'scl' string (default "auto")
7185 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007186 {not available when compiled without the |+signs|
7187 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007188 Whether or not to draw the signcolumn. Valid values are:
7189 "auto" only when there is a sign to display
7190 "no" never
7191 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007192 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007193 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194
7195
7196 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7197'smartcase' 'scs' boolean (default off)
7198 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007199 Override the 'ignorecase' option if the search pattern contains upper
7200 case characters. Only used when the search pattern is typed and
7201 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007202 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7204 recalling the search pattern from history and hitting <Enter>.
7205 NOTE: This option is reset when 'compatible' is set.
7206
7207 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7208'smartindent' 'si' boolean (default off)
7209 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 Do smart autoindenting when starting a new line. Works for C-like
7211 programs, but can also be used for other languages. 'cindent' does
7212 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007213 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007214 setting 'si' has no effect. 'indentexpr' is a more advanced
7215 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216 Normally 'autoindent' should also be on when using 'smartindent'.
7217 An indent is automatically inserted:
7218 - After a line ending in '{'.
7219 - After a line starting with a keyword from 'cinwords'.
7220 - Before a line starting with '}' (only with the "O" command).
7221 When typing '}' as the first character in a new line, that line is
7222 given the same indent as the matching '{'.
7223 When typing '#' as the first character in a new line, the indent for
7224 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007225 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007226 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7227 When using the ">>" command, lines starting with '#' are not shifted
7228 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007229 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007230 This option is reset when 'paste' is set and restored when 'paste' is
7231 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232
7233 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7234'smarttab' 'sta' boolean (default off)
7235 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007237 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7238 <BS> will delete a 'shiftwidth' worth of space at the start of the
7239 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007240 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007241 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7242 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007243 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007244 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007245 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007246 This option is reset when 'paste' is set and restored when 'paste' is
7247 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 NOTE: This option is reset when 'compatible' is set.
7249
7250 *'softtabstop'* *'sts'*
7251'softtabstop' 'sts' number (default 0)
7252 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 Number of spaces that a <Tab> counts for while performing editing
7254 operations, like inserting a <Tab> or using <BS>. It "feels" like
7255 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7256 used. This is useful to keep the 'ts' setting at its standard value
7257 of 8, while being able to edit like it is set to 'sts'. However,
7258 commands like "x" still work on the actual characters.
7259 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007260 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007261 'softtabstop' is set to 0 when the 'paste' option is set and restored
7262 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007263 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7264 spaces is minimized by using <Tab>s.
7265 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7266 set.
7267 NOTE: This option is set to 0 when 'compatible' is set.
7268
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007269 If Vim is compiled with the |+vartabs| feature then the value of
7270 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7271 anything other than an empty string.
7272
Bram Moolenaar217ad922005-03-20 22:37:15 +00007273 *'spell'* *'nospell'*
7274'spell' boolean (default off)
7275 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007276 {not available when compiled without the |+syntax|
7277 feature}
7278 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007279 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007280
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007281 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007282'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007283 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007284 {not available when compiled without the |+syntax|
7285 feature}
7286 Pattern to locate the end of a sentence. The following word will be
7287 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007288 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007289 When this check is not wanted make this option empty.
7290 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007291 Be careful with special characters, see |option-backslash| about
7292 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007293 To set this option automatically depending on the language, see
7294 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007295
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007296 *'spellfile'* *'spf'*
7297'spellfile' 'spf' string (default empty)
7298 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007299 {not available when compiled without the |+syntax|
7300 feature}
7301 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007302 commands. It must end in ".{encoding}.add". You need to include the
7303 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007304 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007305 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007306 |zg| and |zw| commands can be used to access each. This allows using
7307 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007308 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007309 you: Using the first directory in 'runtimepath' that is writable. If
7310 there is no "spell" directory yet it will be created. For the file
7311 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007312 ignoring the region.
7313 The resulting ".spl" file will be used for spell checking, it does not
7314 have to appear in 'spelllang'.
7315 Normally one file is used for all regions, but you can add the region
7316 name if you want to. However, it will then only be used when
7317 'spellfile' is set to it, for entries in 'spelllang' only files
7318 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007319 This option cannot be set from a |modeline| or in the |sandbox|, for
7320 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007321
Bram Moolenaar217ad922005-03-20 22:37:15 +00007322 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007323'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007324 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007325 {not available when compiled without the |+syntax|
7326 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007327 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007328 on spellchecking will be done for these languages. Example: >
7329 set spelllang=en_us,nl,medical
7330< This means US English, Dutch and medical words are recognized. Words
7331 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007332 The word list name must consist of alphanumeric characters, a dash or
7333 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007334 recommended to separate the two letter language name from a
7335 specification. Thus "en-rare" is used for rare English words.
7336 A region name must come last and have the form "_xx", where "xx" is
7337 the two-letter, lower case region name. You can use more than one
7338 region by listing them: "en_us,en_ca" supports both US and Canadian
7339 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007340 Britain. (Note: currently en_au and en_nz dictionaries are older than
7341 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007342 If the name "cjk" is included East Asian characters are excluded from
7343 spell checking. This is useful when editing text that also has Asian
7344 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007345 Note that the "medical" dictionary does not exist, it is just an
7346 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007347 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007348 As a special case the name of a .spl file can be given as-is. The
7349 first "_xx" in the name is removed and used as the region name
7350 (_xx is an underscore, two letters and followed by a non-letter).
7351 This is mainly for testing purposes. You must make sure the correct
7352 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007353 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007354 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7355 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007356 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007357
Bram Moolenaar98692072006-02-04 00:57:42 +00007358 If the |spellfile.vim| plugin is active and you use a language name
7359 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7360 will ask you if you want to download the file.
7361
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007362 After this option has been set successfully, Vim will source the files
7363 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007364 up to the first character that is not an ASCII letter or number and
7365 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007366
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007367 *'spelloptions'* *'spo'*
7368'spelloptions' 'spo' string (default "")
7369 local to buffer
7370 {not available when compiled without the |+syntax|
7371 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007372 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007373 camel When a word is CamelCased, assume "Cased" is a
7374 separate word: every upper-case character in a word
7375 that comes after a lower case character indicates the
7376 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007377
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007378 *'spellsuggest'* *'sps'*
7379'spellsuggest' 'sps' string (default "best")
7380 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007381 {not available when compiled without the |+syntax|
7382 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007383 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007384 the |spellsuggest()| function. This is a comma-separated list of
7385 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007386
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007387 best Internal method that works best for English. Finds
7388 changes like "fast" and uses a bit of sound-a-like
7389 scoring to improve the ordering.
7390
7391 double Internal method that uses two methods and mixes the
7392 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007393 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007394 word. That only works when the language specifies
7395 sound folding. Can be slow and doesn't always give
7396 better results.
7397
7398 fast Internal method that only checks for simple changes:
7399 character inserts/deletes/swaps. Works well for
7400 simple typing mistakes.
7401
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007402 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007403 Not used for |spellsuggest()|. The number of
7404 suggestions is never more than the value of 'lines'
7405 minus two.
7406
Bram Moolenaar585ee072022-01-29 11:22:17 +00007407 timeout:{millisec} Limit the time searching for suggestions to
7408 {millisec} milli seconds. Applies to the following
7409 methods. When omitted the limit is 5000. When
7410 negative there is no limit. {only works when built
7411 with the +reltime feature}
7412
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007413 file:{filename} Read file {filename}, which must have two columns,
7414 separated by a slash. The first column contains the
7415 bad word, the second column the suggested good word.
7416 Example:
7417 theribal/terrible ~
7418 Use this for common mistakes that do not appear at the
7419 top of the suggestion list with the internal methods.
7420 Lines without a slash are ignored, use this for
7421 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007422 The word in the second column must be correct,
7423 otherwise it will not be used. Add the word to an
7424 ".add" file if it is currently flagged as a spelling
7425 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007426 The file is used for all languages.
7427
7428 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7429 trouble with spaces. |v:val| holds the badly spelled
7430 word. The expression must evaluate to a List of
7431 Lists, each with a suggestion and a score.
7432 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007433 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007434 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007435 internal methods use. A lower score is better.
7436 This may invoke |spellsuggest()| if you temporarily
7437 set 'spellsuggest' to exclude the "expr:" part.
7438 Errors are silently ignored, unless you set the
7439 'verbose' option to a non-zero value.
7440
7441 Only one of "best", "double" or "fast" may be used. The others may
7442 appear several times in any order. Example: >
7443 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7444<
7445 This option cannot be set from a |modeline| or in the |sandbox|, for
7446 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007447
7448
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7450'splitbelow' 'sb' boolean (default off)
7451 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452 When on, splitting a window will put the new window below the current
7453 one. |:split|
7454
7455 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7456'splitright' 'spr' boolean (default off)
7457 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 When on, splitting a window will put the new window right of the
7459 current one. |:vsplit|
7460
7461 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7462'startofline' 'sol' boolean (default on)
7463 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007465 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007466 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007467 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 with a linewise operator, with "%" with a count and to buffer changing
7469 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7470 only has a line number, e.g., ":25" or ":+".
7471 In case of buffer changing commands the cursor is placed at the column
7472 where it was the last time the buffer was edited.
7473 NOTE: This option is set when 'compatible' is set.
7474
Bram Moolenaar00654022011-02-25 14:42:19 +01007475 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007477 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 {not available when compiled without the |+statusline|
7479 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007480 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 Also see |status-line|.
7482
7483 The option consists of printf style '%' items interspersed with
7484 normal text. Each status line item is of the form:
7485 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007486 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007487 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488
Bram Moolenaar238a5642006-02-21 22:12:05 +00007489 When the option starts with "%!" then it is used as an expression,
7490 evaluated and the result is used as the option value. Example: >
7491 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007492< The *g:statusline_winid* variable will be set to the |window-ID| of the
7493 window that the status line belongs to.
7494 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007495 Note that the "%!" expression is evaluated in the context of the
7496 current window and buffer, while %{} items are evaluated in the
7497 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007498
7499 When there is error while evaluating the option then it will be made
7500 empty to avoid further errors. Otherwise screen updating would loop.
7501
Bram Moolenaar071d4272004-06-13 20:20:40 +00007502 Note that the only effect of 'ruler' when this option is set (and
7503 'laststatus' is 2) is controlling the output of |CTRL-G|.
7504
7505 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007506 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007508 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509 minwid Minimum width of the item, padding as set by '-' & '0'.
7510 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007511 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007512 on the left for text items. Numeric items will be
7513 shifted down to maxwid-2 digits followed by '>'number
7514 where number is the amount of missing digits, much like
7515 an exponential notation.
7516 item A one letter code as described below.
7517
7518 Following is a description of the possible statusline items. The
7519 second character in "item" is the type:
7520 N for number
7521 S for string
7522 F for flags as described below
7523 - not applicable
7524
7525 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007526 f S Path to the file in the buffer, as typed or relative to current
7527 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 F S Full path to the file in the buffer.
7529 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007530 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007532 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007533 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007534 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007536 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007537 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007538 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007540 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007541 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7542 being used: "<keymap>"
7543 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007544 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545 B N As above, in hexadecimal.
7546 o N Byte number in file of byte under cursor, first byte is 1.
7547 Mnemonic: Offset from start of file (with one added)
7548 {not available when compiled without |+byte_offset| feature}
7549 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007550 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007551 l N Line number.
7552 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007553 c N Column number (byte index).
7554 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007555 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556 p N Percentage through file in lines as in |CTRL-G|.
7557 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007558 percentage described for 'ruler'. Always 3 in length, unless
7559 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007560 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007561 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007562 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007563 Note that there is no '%' before the closing '}'. The
7564 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007565 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007566 {% - This is almost same as { except the result of the expression is
7567 re-evaluated as a statusline format string. Thus if the
7568 return value of expr contains % items they will get expanded.
7569 The expression can contain the } character, the end of
7570 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007571 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007572 func! Stl_filename() abort
7573 return "%t"
7574 endfunc
7575< `stl=%{Stl_filename()}` results in `"%t"`
7576 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007577 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 ( - Start of item group. Can be used for setting the width and
7579 alignment of a section. Must be followed by %) somewhere.
7580 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007581 T N For 'tabline': start of tab page N label. Use %T after the last
7582 label. This information is used for mouse clicks.
7583 X N For 'tabline': start of close tab N label. Use %X after the
7584 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7585 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 < - Where to truncate line if too long. Default is at the start.
7587 No width fields allowed.
7588 = - Separation point between left and right aligned items.
7589 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007590 # - Set highlight group. The name must follow and then a # again.
7591 Thus use %#HLname# for highlight group HLname. The same
7592 highlighting is used, also for the statusline of non-current
7593 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007594 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007595 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007596 The difference between User{N} and StatusLine will be applied
7597 to StatusLineNC for the statusline of non-current windows.
7598 The number N must be between 1 and 9. See |hl-User1..9|
7599
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007600 When displaying a flag, Vim removes the leading comma, if any, when
7601 that flag comes right after plaintext. This will make a nice display
7602 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603
Bram Moolenaar582fd852005-03-28 20:58:01 +00007604 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007605 not set) and a minwid is not set for the group, the whole group will
7606 become empty. This will make a group like the following disappear
7607 completely from the statusline when none of the flags are set. >
7608 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007609< Beware that an expression is evaluated each and every time the status
7610 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007611 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007612 While evaluating %{} the current buffer and current window will be set
7613 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007614 currently being drawn. The expression will evaluate in this context.
7615 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7616 real current buffer and "g:actual_curwin" to the |window-ID| of the
7617 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007618
Bram Moolenaar30b65812012-07-12 22:01:11 +02007619 The 'statusline' option will be evaluated in the |sandbox| if set from
7620 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007621 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007622
7623 It is not allowed to change text or jump to another window while
7624 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007625
7626 If the statusline is not updated when you want it (e.g., after setting
7627 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007628 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007629
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007630 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007631 Otherwise the result is taken as flag text and applied to the rules
7632 described above.
7633
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007634 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007636 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007637
7638 Examples:
7639 Emulate standard status line with 'ruler' set >
7640 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7641< Similar, but add ASCII value of char under the cursor (like "ga") >
7642 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7643< Display byte count and byte value, modified flag in red. >
7644 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7645 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7646< Display a ,GZ flag if a compressed file is loaded >
7647 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7648< In the |:autocmd|'s: >
7649 :let b:gzflag = 1
7650< And: >
7651 :unlet b:gzflag
7652< And define this function: >
7653 :function VarExists(var, val)
7654 : if exists(a:var) | return a:val | else | return '' | endif
7655 :endfunction
7656<
7657 *'suffixes'* *'su'*
7658'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7659 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007660 Files with these suffixes get a lower priority when multiple files
7661 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007662 suffixes. Spaces after the comma are ignored. A dot is also seen as
7663 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 separator, precede it with a backslash (see |option-backslash| about
7665 including spaces and backslashes).
7666 See 'wildignore' for completely ignoring files.
7667 The use of |:set+=| and |:set-=| is preferred when adding or removing
7668 suffixes from the list. This avoids problems when a future version
7669 uses another default.
7670
7671 *'suffixesadd'* *'sua'*
7672'suffixesadd' 'sua' string (default "")
7673 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007674 {not available when compiled without the
7675 |+file_in_path| feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007676 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007677 file for the "gf", "[I", etc. commands. Example: >
7678 :set suffixesadd=.java
7679<
7680 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7681'swapfile' 'swf' boolean (default on)
7682 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007683 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684 swapfile is not wanted for a specific buffer. For example, with
7685 confidential information that even root must not be able to access.
7686 Careful: All text will be in memory:
7687 - Don't use this for big files.
7688 - Recovery will be impossible!
7689 A swapfile will only be present when |'updatecount'| is non-zero and
7690 'swapfile' is set.
7691 When 'swapfile' is reset, the swap file for the current buffer is
7692 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7693 non-zero, a swap file is immediately created.
7694 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007695 If you want to open a new buffer without creating a swap file for it,
7696 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007697 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698
7699 This option is used together with 'bufhidden' and 'buftype' to
7700 specify special kinds of buffers. See |special-buffers|.
7701
7702 *'swapsync'* *'sws'*
7703'swapsync' 'sws' string (default "fsync")
7704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007705 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007706 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007707 When this option is empty parts of the swap file may be in memory and
7708 not written to disk. When the system crashes you may lose more work.
7709 On Unix the system does a sync now and then without Vim asking for it,
7710 so the disadvantage of setting this option off is small. On some
7711 systems the swap file will not be written at all. For a unix system
7712 setting it to "sync" will use the sync() call instead of the default
7713 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007714 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715
7716 *'switchbuf'* *'swb'*
7717'switchbuf' 'swb' string (default "")
7718 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007720 Mostly for |quickfix| commands some values are also used for other
7721 commands, as mentioned below.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007722 Possible values (comma-separated list):
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723 useopen If included, jump to the first open window that
7724 contains the specified buffer (if there is one).
7725 Otherwise: Do not examine other windows.
7726 This setting is checked with |quickfix| commands, when
7727 jumping to errors (":cc", ":cn", "cp", etc.). It is
7728 also used in all buffer related split commands, for
7729 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007730 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007731 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007732 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007733 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007734 Otherwise: do not split, use current window (when used
7735 in the quickfix window: the previously used window or
7736 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007737 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007738 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007739 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007740 uselast If included, jump to the previously used window when
7741 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007743 *'synmaxcol'* *'smc'*
7744'synmaxcol' 'smc' number (default 3000)
7745 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007746 {not available when compiled without the |+syntax|
7747 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007748 Maximum column in which to search for syntax items. In long lines the
7749 text after this column is not highlighted and following lines may not
7750 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007751 This helps to avoid very slow redrawing for an XML file that is one
7752 long line.
7753 Set to zero to remove the limit.
7754
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755 *'syntax'* *'syn'*
7756'syntax' 'syn' string (default empty)
7757 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758 {not available when compiled without the |+syntax|
7759 feature}
7760 When this option is set, the syntax with this name is loaded, unless
7761 syntax highlighting has been switched off with ":syntax off".
7762 Otherwise this option does not always reflect the current syntax (the
7763 b:current_syntax variable does).
7764 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007765 not automatically recognized. Example, in an IDL file:
7766 /* vim: set syntax=idl : */ ~
7767 When a dot appears in the value then this separates two filetype
7768 names. Example:
7769 /* vim: set syntax=c.doxygen : */ ~
7770 This will use the "c" syntax first, then the "doxygen" syntax.
7771 Note that the second one must be prepared to be loaded as an addition,
7772 otherwise it will be skipped. More than one dot may appear.
7773 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007774 :set syntax=OFF
7775< To switch syntax highlighting on according to the current value of the
7776 'filetype' option: >
7777 :set syntax=ON
7778< What actually happens when setting the 'syntax' option is that the
7779 Syntax autocommand event is triggered with the value as argument.
7780 This option is not copied to another buffer, independent of the 's' or
7781 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007782 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007783
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007784 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007785'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007786 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00007787 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007788 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007789 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007790
7791 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007792 option and only when there is no GUI tab line. When 'e' is in
7793 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007794 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007795
7796 The value is evaluated like with 'statusline'. You can use
7797 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007798 the text to be displayed. Use "%1T" for the first label, "%2T" for
7799 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007800
Bram Moolenaare12bab32019-01-08 22:02:56 +01007801 When changing something that is used in 'tabline' that does not
7802 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007803 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007804
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007805 Keep in mind that only one of the tab pages is the current one, others
7806 are invisible and you can't jump to their windows.
7807
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007808
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007809 *'tabpagemax'* *'tpm'*
7810'tabpagemax' 'tpm' number (default 10)
7811 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007812 Maximum number of tab pages to be opened by the |-p| command line
7813 argument or the ":tab all" command. |tabpage|
7814
7815
7816 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007817'tabstop' 'ts' number (default 8)
7818 local to buffer
7819 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007820 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821
7822 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007823 appear wrong in many places, e.g., when printing it.
7824 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007825
7826 There are four main ways to use tabs in Vim:
7827 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7828 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007829 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830 behave like a tab appears every 4 (or 3) characters.
7831 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7832 'expandtab'. This way you will always insert spaces. The
7833 formatting will never be messed up when 'tabstop' is changed.
7834 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007835 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007836 works when using Vim to edit the file.
7837 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7838 'noexpandtab'. This should then work (for initial indents only)
7839 for any tabstop setting that people use. It might be nice to have
7840 tabs after the first non-blank inserted as spaces if you do this
7841 though. Otherwise aligned comments will be wrong when 'tabstop' is
7842 changed.
7843
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007844 If Vim is compiled with the |+vartabs| feature then the value of
7845 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7846 than an empty string.
7847
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7849'tagbsearch' 'tbs' boolean (default on)
7850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007852 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007853 searching makes searching for a tag a LOT faster, but a linear search
7854 will find more tags if the tags file wasn't properly sorted.
7855 Vim normally assumes that your tags files are sorted, or indicate that
7856 they are not sorted. Only when this is not the case does the
7857 'tagbsearch' option need to be switched off.
7858
7859 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007860 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007861 certain files, or retry all files with a linear search. When
7862 'tagbsearch' is off, only a linear search is done.
7863
7864 Linear searching is done anyway, for one file, when Vim finds a line
7865 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007866 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007867< [The whitespace before and after the '0' must be a single <Tab>]
7868
7869 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007870 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007871 instead of a normal tag name, a retry is done with a linear search.
7872 Tags in unsorted tags files, and matches with different case will only
7873 be found in the retry.
7874
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007875 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007876 linear search can be avoided when case is ignored. Use a value of '2'
7877 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7878 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00007879 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
7880 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
7881 used for this as well. Note that case must be folded to uppercase for
7882 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007883
7884 By default, tag searches are case-sensitive. Case is ignored when
7885 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7886 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007887 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7888 'tagcase' is "smart", and the pattern contains only lowercase
7889 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007890
7891 When 'tagbsearch' is off, tags searching is slower when a full match
7892 exists, but faster when no full match exists. Tags in unsorted tags
7893 files may only be found with 'tagbsearch' off.
7894 When the tags file is not sorted, or sorted in a wrong way (not on
7895 ASCII byte value), 'tagbsearch' should be off, or the line given above
7896 must be included in the tags file.
7897 This option doesn't affect commands that find all matching tags (e.g.,
7898 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007900 *'tagcase'* *'tc'*
7901'tagcase' 'tc' string (default "followic")
7902 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007903 This option specifies how case is handled when searching the tags
7904 file:
7905 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007906 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007907 ignore Ignore case
7908 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007909 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007910 NOTE: This option is set to the Vi default value when 'compatible' is
7911 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007912
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007913 *'tagfunc'* *'tfu'*
7914'tagfunc' 'tfu' string (default: empty)
7915 local to buffer
7916 {not available when compiled without the |+eval|
7917 feature}
7918 This option specifies a function to be used to perform tag searches.
7919 The function gets the tag pattern and should return a List of matching
7920 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007921 function and an example. The value can be the name of a function, a
7922 |lambda| or a |Funcref|. See |option-value-function| for more
7923 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007924
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925 *'taglength'* *'tl'*
7926'taglength' 'tl' number (default 0)
7927 global
7928 If non-zero, tags are significant up to this number of characters.
7929
7930 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7931'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7932 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007933 If on and using a tags file in another directory, file names in that
7934 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 NOTE: This option is set to the Vi default value when 'compatible' is
7936 set and to the Vim default value when 'compatible' is reset.
7937
7938 *'tags'* *'tag'* *E433*
7939'tags' 'tag' string (default "./tags,tags", when compiled with
7940 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7941 global or local to buffer |global-local|
7942 Filenames for the tag command, separated by spaces or commas. To
7943 include a space or comma in a file name, precede it with a backslash
7944 (see |option-backslash| about including spaces and backslashes).
7945 When a file name starts with "./", the '.' is replaced with the path
7946 of the current file. But only when the 'd' flag is not included in
7947 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7948 |tags-option|.
7949 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007950 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7951 find all files named "tags" below "/lib". The filename itself cannot
7952 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7953 files called "tags?". {not available when compiled without the
7954 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007955 The |tagfiles()| function can be used to get a list of the file names
7956 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7958 files are also supported. They are automatically recognized. The
7959 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7960 differences are ignored (MS-Windows). |emacs-tags|
7961 The use of |:set+=| and |:set-=| is preferred when adding or removing
7962 file names from the list. This avoids problems when a future version
7963 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964
7965 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7966'tagstack' 'tgst' boolean (default on)
7967 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007968 When on, the |tagstack| is used normally. When off, a ":tag" or
7969 ":tselect" command with an argument will not push the tag onto the
7970 tagstack. A following ":tag" without an argument, a ":pop" command or
7971 any other command that uses the tagstack will use the unmodified
7972 tagstack, but does change the pointer to the active entry.
7973 Resetting this option is useful when using a ":tag" command in a
7974 mapping which should not change the tagstack.
7975
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007976 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007977'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007978 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007979 {only available when compiled with the |+tcl/dyn|
7980 feature}
7981 Specifies the name of the Tcl shared library. The default is
7982 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007983 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007984 This option cannot be set from a |modeline| or in the |sandbox|, for
7985 security reasons.
7986
Bram Moolenaar071d4272004-06-13 20:20:40 +00007987 *'term'* *E529* *E530* *E531*
7988'term' string (default is $TERM, if that fails:
7989 in the GUI: "builtin_gui"
7990 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007991 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007992 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 on Unix: "ansi"
7994 on VMS: "ansi"
7995 on Win 32: "win32")
7996 global
7997 Name of the terminal. Used for choosing the terminal control
7998 characters. Environment variables are expanded |:set_env|.
7999 For example: >
8000 :set term=$TERM
8001< See |termcap|.
8002
8003 *'termbidi'* *'tbidi'*
8004 *'notermbidi'* *'notbidi'*
8005'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8006 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008007 {only available when compiled with the |+arabic|
8008 feature}
8009 The terminal is in charge of Bi-directionality of text (as specified
8010 by Unicode). The terminal is also expected to do the required shaping
8011 that some languages (such as Arabic) require.
8012 Setting this option implies that 'rightleft' will not be set when
8013 'arabic' is set and the value of 'arabicshape' will be ignored.
8014 Note that setting 'termbidi' has the immediate effect that
8015 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8016 This option is reset when the GUI is started.
8017 For further details see |arabic.txt|.
8018
8019 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008020'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008021 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 Encoding used for the terminal. This specifies what character
8023 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008024 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008025 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008026 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008027 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8029 Any attempts to set a different value will be rejected, and an error
8030 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008031 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032 because the Win32 system always passes Unicode characters.
8033 When empty, the same encoding is used as for the 'encoding' option.
8034 This is the normal value.
8035 Not all combinations for 'termencoding' and 'encoding' are valid. See
8036 |encoding-table|.
8037 The value for this option must be supported by internal conversions or
8038 iconv(). When this is not possible no conversion will be done and you
8039 will probably experience problems with non-ASCII characters.
8040 Example: You are working with the locale set to euc-jp (Japanese) and
8041 want to edit a UTF-8 file: >
8042 :let &termencoding = &encoding
8043 :set encoding=utf-8
8044< You need to do this when your system has no locale support for UTF-8.
8045
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008046 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008047'termguicolors' 'tgc' boolean (default off)
8048 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008049 {not available when compiled without the
8050 |+termguicolors| feature}
8051 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008052 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008053
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008054 Requires a ISO-8613-3 compatible terminal. If setting this option
8055 does not work (produces a colorless UI) reading |xterm-true-color|
8056 might help.
8057
8058 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8059 is required. Use this check to find out: >
8060 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008061< This requires Vim to be built with the |+vtp| feature.
8062
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008063 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008064
8065 When using Vim with Windows Terminal, the background of Windows
8066 Terminal is normally filled with the Vim background color. Setting
8067 'termguicolors' and the guibg of the Normal highlight group to NONE
8068 will make the background transparent: >
8069 :hi Normal guibg=NONE
8070<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008071 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008072
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008073 *'termwinkey'* *'twk'*
8074'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008075 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008076 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008077 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008078 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008079 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008080< The string must be one key stroke but can be multiple bytes.
8081 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008082 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008083 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008084
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008085 *'termwinscroll'* *'twsl'*
8086'termwinscroll' 'twsl' number (default 10000)
8087 local to buffer
8088 {not available when compiled without the
8089 |+terminal| feature}
8090 Number of scrollback lines to keep. When going over this limit the
8091 first 10% of the scrollback lines are deleted. This is just to reduce
8092 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008093 Also used as a limit for text sent to the terminal in one write,
8094 multiplied by the number of columns times 3 (average number of bytes
8095 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008096
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008097 *'termwinsize'* *'tws'*
8098'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008099 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008100 Size used when opening the |terminal| window. Format:
8101 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008102 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008103 - When set with a "x" (e.g., "24x80") the terminal size is not
8104 adjusted to the window size. If the window is smaller only the
8105 top-left part is displayed.
8106 - When set with a "*" (e.g., "10*50") the terminal size follows the
8107 window size, but will not be smaller than the specified rows and/or
8108 columns.
8109 - When rows is zero then use the height of the window.
8110 - When columns is zero then use the width of the window.
8111 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008112 - Can be overruled in the |term_start()| options with "term_rows" and
8113 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008114
8115 Examples:
8116 "30x0" uses 30 rows and the current window width.
8117 "20*0" uses at least 20 rows and the current window width.
8118 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008119 Note that the command running in the terminal window may still change
8120 the size of the terminal. In that case the Vim window will be
8121 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008122
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008123 *'termwintype'* *'twt'*
8124'termwintype' 'twt' string (default "")
8125 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008126 {only available when compiled with the |terminal|
8127 feature on MS-Windows}
8128 Specify the virtual console (pty) used when opening the terminal
8129 window.
8130
8131 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008132 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008133 "winpty" use winpty, fail if not supported
8134 "conpty" use |ConPTY|, fail if not supported
8135
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008136 |ConPTY| support depends on the platform. Windows 10 October 2018
8137 Update is the first version that supports ConPTY, however it is still
8138 considered unstable. ConPTY might become stable in the next release
8139 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008140 supported then you cannot open a terminal window.
8141
Bram Moolenaar071d4272004-06-13 20:20:40 +00008142 *'terse'* *'noterse'*
8143'terse' boolean (default off)
8144 global
8145 When set: Add 's' flag to 'shortmess' option (this makes the message
8146 for a search that hits the start or end of the file not being
8147 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8148 shortens a lot of messages}
8149
8150 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8151'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8152 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008153 This option is obsolete. Use 'fileformats'.
8154 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8155 set to the default value for the current system. When 'textauto' is
8156 reset, 'fileformats' is made empty.
8157 NOTE: This option is set to the Vi default value when 'compatible' is
8158 set and to the Vim default value when 'compatible' is reset.
8159
8160 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008161'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008162 others: default off)
8163 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008164 This option is obsolete. Use 'fileformat'.
8165 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8166 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8167 "unix".
8168
8169 *'textwidth'* *'tw'*
8170'textwidth' 'tw' number (default 0)
8171 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008172 Maximum width of text that is being inserted. A longer line will be
8173 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008174 this.
8175 'textwidth' is set to 0 when the 'paste' option is set and restored
8176 when 'paste' is reset.
8177 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008178 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008179 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008180 NOTE: This option is set to 0 when 'compatible' is set.
8181
8182 *'thesaurus'* *'tsr'*
8183'thesaurus' 'tsr' string (default "")
8184 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008185 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008186 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8187 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008188
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008189 This option is not used if 'thesaurusfunc' is set, either for the
8190 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008191
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008192 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008193 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008194 name. See |option-backslash| about using backslashes. The use of
8195 |:set+=| and |:set-=| is preferred when adding or removing directories
8196 from the list. This avoids problems when a future version uses
8197 another default. Backticks cannot be used in this option for security
8198 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008199
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008200 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008201'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008202 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008203 {not available when compiled without the |+eval|
8204 feature}
8205 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008206 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008207 The value can be the name of a function, a |lambda| or a |Funcref|.
8208 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008209
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008210 This option cannot be set from a |modeline| or in the |sandbox|, for
8211 security reasons.
8212
Bram Moolenaar071d4272004-06-13 20:20:40 +00008213 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8214'tildeop' 'top' boolean (default off)
8215 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008216 When on: The tilde command "~" behaves like an operator.
8217 NOTE: This option is reset when 'compatible' is set.
8218
8219 *'timeout'* *'to'* *'notimeout'* *'noto'*
8220'timeout' 'to' boolean (default on)
8221 global
8222 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008223'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008224 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008225 These two options together determine the behavior when part of a
8226 mapped key sequence or keyboard code has been received:
8227
8228 'timeout' 'ttimeout' action ~
8229 off off do not time out
8230 on on or off time out on :mappings and key codes
8231 off on time out on key codes
8232
8233 If both options are off, Vim will wait until either the complete
8234 mapping or key sequence has been received, or it is clear that there
8235 is no mapping or key sequence for the received characters. For
8236 example: if you have mapped "vl" and Vim has received 'v', the next
8237 character is needed to see if the 'v' is followed by an 'l'.
8238 When one of the options is on, Vim will wait for about 1 second for
8239 the next character to arrive. After that the already received
8240 characters are interpreted as single characters. The waiting time can
8241 be changed with the 'timeoutlen' option.
8242 On slow terminals or very busy systems timing out may cause
8243 malfunctioning cursor keys. If both options are off, Vim waits
8244 forever after an entered <Esc> if there are key codes that start
8245 with <Esc>. You will have to type <Esc> twice. If you do not have
8246 problems with key codes, but would like to have :mapped key
8247 sequences not timing out in 1 second, set the 'ttimeout' option and
8248 reset the 'timeout' option.
8249
8250 NOTE: 'ttimeout' is reset when 'compatible' is set.
8251
8252 *'timeoutlen'* *'tm'*
8253'timeoutlen' 'tm' number (default 1000)
8254 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008255
Bram Moolenaar071d4272004-06-13 20:20:40 +00008256 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008257'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008258 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008259 The time in milliseconds that is waited for a key code or mapped key
8260 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8261 when part of a command has been typed.
8262 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8263 different timeout value for key codes is desired set 'ttimeoutlen' to
8264 a non-negative number.
8265
8266 ttimeoutlen mapping delay key code delay ~
8267 < 0 'timeoutlen' 'timeoutlen'
8268 >= 0 'timeoutlen' 'ttimeoutlen'
8269
8270 The timeout only happens when the 'timeout' and 'ttimeout' options
8271 tell so. A useful setting would be >
8272 :set timeout timeoutlen=3000 ttimeoutlen=100
8273< (time out on mapping after three seconds, time out on key codes after
8274 a tenth of a second).
8275
8276 *'title'* *'notitle'*
8277'title' boolean (default off, on when title can be restored)
8278 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008279 When on, the title of the window will be set to the value of
8280 'titlestring' (if it is not empty), or to:
8281 filename [+=-] (path) - VIM
8282 Where:
8283 filename the name of the file being edited
8284 - indicates the file cannot be modified, 'ma' off
8285 + indicates the file was modified
8286 = indicates the file is read-only
8287 =+ indicates the file is read-only and modified
8288 (path) is the path of the file being edited
8289 - VIM the server name |v:servername| or "VIM"
8290 Only works if the terminal supports setting window titles
8291 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008292 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008293 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8294 *X11*
8295 When Vim was compiled with HAVE_X11 defined, the original title will
8296 be restored if possible. The output of ":version" will include "+X11"
8297 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8298 works for the icon name |'icon'|.
8299 But: When Vim was started with the |-X| argument, restoring the title
8300 will not work (except in the GUI).
8301 If the title cannot be restored, it is set to the value of 'titleold'.
8302 You might want to restore the title outside of Vim then.
8303 When using an xterm from a remote machine you can use this command:
8304 rsh machine_name xterm -display $DISPLAY &
8305 then the WINDOWID environment variable should be inherited and the
8306 title of the window should change back to what it should be after
8307 exiting Vim.
8308
8309 *'titlelen'*
8310'titlelen' number (default 85)
8311 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008313 title. When the title is longer, only the end of the path name is
8314 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008315 Using a percentage makes this adapt to the width of the window. But
8316 it won't work perfectly, because the actual number of characters
8317 available also depends on the font used and other things in the title
8318 bar. When 'titlelen' is zero the full path is used. Otherwise,
8319 values from 1 to 30000 percent can be used.
8320 'titlelen' is also used for the 'titlestring' option.
8321
8322 *'titleold'*
8323'titleold' string (default "Thanks for flying Vim")
8324 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008325 This option will be used for the window title when exiting Vim if the
8326 original title cannot be restored. Only happens if 'title' is on or
8327 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008328 This option cannot be set from a |modeline| or in the |sandbox|, for
8329 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008330 *'titlestring'*
8331'titlestring' string (default "")
8332 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008333 When this option is not empty, it will be used for the title of the
8334 window. This happens only when the 'title' option is on.
8335 Only works if the terminal supports setting window titles (currently
8336 Amiga console, Win32 console, all GUI versions and terminals with a
8337 non-empty 't_ts' option).
8338 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008339 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008340
Bram Moolenaar071d4272004-06-13 20:20:40 +00008341 When this option contains printf-style '%' items, they will be
8342 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008343 This option cannot be set in a modeline when 'modelineexpr' is off.
8344
Bram Moolenaar071d4272004-06-13 20:20:40 +00008345 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008346 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8348< The value of 'titlelen' is used to align items in the middle or right
8349 of the available space.
8350 Some people prefer to have the file name first: >
8351 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8352< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008353 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354 separating space only when needed.
8355 NOTE: Use of special characters in 'titlestring' may cause the display
8356 to be garbled (e.g., when it contains a CR or NL character).
8357 {not available when compiled without the |+statusline| feature}
8358
8359 *'toolbar'* *'tb'*
8360'toolbar' 'tb' string (default "icons,tooltips")
8361 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008362 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008363 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008364 possible values are:
8365 icons Toolbar buttons are shown with icons.
8366 text Toolbar buttons shown with text.
8367 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008368 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008369 tooltips Tooltips are active for toolbar buttons.
8370 Tooltips refer to the popup help text which appears after the mouse
8371 cursor is placed over a toolbar button for a brief moment.
8372
8373 If you want the toolbar to be shown with icons as well as text, do the
8374 following: >
8375 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008376< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008377 will show icons if both are requested.
8378
8379 If none of the strings specified in 'toolbar' are valid or if
8380 'toolbar' is empty, this option is ignored. If you want to disable
8381 the toolbar, you need to set the 'guioptions' option. For example: >
8382 :set guioptions-=T
8383< Also see |gui-toolbar|.
8384
8385 *'toolbariconsize'* *'tbis'*
8386'toolbariconsize' 'tbis' string (default "small")
8387 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008388 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008389 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008390 tiny Use tiny icons.
8391 small Use small icons (default).
8392 medium Use medium-sized icons.
8393 large Use large icons.
8394 huge Use even larger icons.
8395 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008397 the current theme. Common dimensions are giant=48x48, huge=32x32,
8398 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008399
8400 If 'toolbariconsize' is empty, the global default size as determined
8401 by user preferences or the current theme is used.
8402
8403 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8404'ttybuiltin' 'tbi' boolean (default on)
8405 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008406 When on, the builtin termcaps are searched before the external ones.
8407 When off the builtin termcaps are searched after the external ones.
8408 When this option is changed, you should set the 'term' option next for
8409 the change to take effect, for example: >
8410 :set notbi term=$TERM
8411< See also |termcap|.
8412 Rationale: The default for this option is "on", because the builtin
8413 termcap entries are generally better (many systems contain faulty
8414 xterm entries...).
8415
8416 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8417'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8418 sun-cmd, screen, rxvt, dtterm or
8419 iris-ansi; also on when running Vim in
8420 a DOS console)
8421 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422 Indicates a fast terminal connection. More characters will be sent to
8423 the screen for redrawing, instead of using insert/delete line
8424 commands. Improves smoothness of redrawing when there are multiple
8425 windows and the terminal does not support a scrolling region.
8426 Also enables the extra writing of characters at the end of each screen
8427 line for lines that wrap. This helps when using copy/paste with the
8428 mouse in an xterm and other terminals.
8429
8430 *'ttymouse'* *'ttym'*
8431'ttymouse' 'ttym' string (default depends on 'term')
8432 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008433 {only in Unix and VMS, doesn't work in the GUI; not
8434 available when compiled without |+mouse|}
8435 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008436 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008437 *xterm-mouse*
8438 xterm xterm-like mouse handling. The mouse generates
8439 "<Esc>[Mscr", where "scr" is three bytes:
8440 "s" = button state
8441 "c" = column plus 33
8442 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008443 This only works up to 223 columns! See "dec",
8444 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008445 xterm2 Works like "xterm", but with the xterm reporting the
8446 mouse position while the mouse is dragged. This works
8447 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008448 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449 work. See below for how Vim detects this
8450 automatically.
8451 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008452 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008453 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008454 for the row and column. No other mouse events are
8455 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008456 *dec-mouse*
8457 dec DEC terminal mouse handling. The mouse generates a
8458 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008459 This is also available for an Xterm, if it was
8460 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008461 *jsbterm-mouse*
8462 jsbterm JSB term mouse handling.
8463 *pterm-mouse*
8464 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008465 *urxvt-mouse*
8466 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008467 The mouse works only if the terminal supports this
8468 encoding style, but it does not have 223 columns limit
8469 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008470 *sgr-mouse*
8471 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008472 mouse reporting. The mouse works even in columns
8473 beyond 223. This option is backward compatible with
8474 "xterm2" because it can also decode "xterm2" style
8475 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008476
8477 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008478 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8479 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008480 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8481 recognized, if enabled at compile time. DEC terminal mouse codes
8482 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008483 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8484 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008485 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008486 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8487 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8488 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008489 Additionally, if vim is compiled with the |+termresponse| feature and
8490 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008491 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008492 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008493 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8494 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8495 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008496 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8497 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008498 :set t_RV=
8499<
8500 *'ttyscroll'* *'tsl'*
8501'ttyscroll' 'tsl' number (default 999)
8502 global
8503 Maximum number of lines to scroll the screen. If there are more lines
8504 to scroll the window is redrawn. For terminals where scrolling is
8505 very slow and redrawing is not slow this can be set to a small number,
8506 e.g., 3, to speed up displaying.
8507
8508 *'ttytype'* *'tty'*
8509'ttytype' 'tty' string (default from $TERM)
8510 global
8511 Alias for 'term', see above.
8512
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008513 *'undodir'* *'udir'*
8514'undodir' 'udir' string (default ".")
8515 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008516 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008517 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008518 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008519 "." means using the directory of the file. The undo file name for
8520 "file.txt" is ".file.txt.un~".
8521 For other directories the file name is the full path of the edited
8522 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008523 When writing: The first directory that exists is used. "." always
8524 works, no directories after "." will be used for writing.
8525 When reading all entries are tried to find an undo file. The first
8526 undo file that exists is used. When it cannot be read an error is
8527 given, no further entry is used.
8528 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008529 This option cannot be set from a |modeline| or in the |sandbox|, for
8530 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008531
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008532 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008533'undofile' 'udf' boolean (default off)
8534 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008535 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008536 When on, Vim automatically saves undo history to an undo file when
8537 writing a buffer to a file, and restores undo history from the same
8538 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008539 The directory where the undo file is stored is specified by 'undodir'.
8540 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008541 The undo file is not read when 'undoreload' causes the buffer from
8542 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008543 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008544 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008545
Bram Moolenaar071d4272004-06-13 20:20:40 +00008546 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008547'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008548 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008549 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008550 is kept in memory, higher numbers will cause more memory to be used.
8551 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008552 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8553 itself: >
8554 set ul=0
8555< But you can also get Vi compatibility by including the 'u' flag in
8556 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008557 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008558 Set to -1 for no undo at all. You might want to do this only for the
8559 current buffer: >
8560 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008561< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008562
8563 The local value is set to -123456 when the global value is to be used.
8564
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008565 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008566
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008567 *'undoreload'* *'ur'*
8568'undoreload' 'ur' number (default 10000)
8569 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008570 Save the whole buffer for undo when reloading it. This applies to the
8571 ":e!" command and reloading for when the buffer changed outside of
8572 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008573 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008574 of lines is smaller than the value of this option.
8575 Set this option to zero to disable undo for a reload.
8576
8577 When saving undo for a reload, any undo file is not read.
8578
8579 Note that this causes the whole buffer to be stored in memory. Set
8580 this option to a lower value if you run out of memory.
8581
Bram Moolenaar071d4272004-06-13 20:20:40 +00008582 *'updatecount'* *'uc'*
8583'updatecount' 'uc' number (default: 200)
8584 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008585 After typing this many characters the swap file will be written to
8586 disk. When zero, no swap file will be created at all (see chapter on
8587 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8588 Vim with the "-n" option, see |startup|. When editing in readonly
8589 mode this option will be initialized to 10000.
8590 The swapfile can be disabled per buffer with |'swapfile'|.
8591 When 'updatecount' is set from zero to non-zero, swap files are
8592 created for all buffers that have 'swapfile' set. When 'updatecount'
8593 is set to zero, existing swap files are not deleted.
8594 Also see |'swapsync'|.
8595 This option has no meaning in buffers where |'buftype'| is "nofile"
8596 or "nowrite".
8597
8598 *'updatetime'* *'ut'*
8599'updatetime' 'ut' number (default 4000)
8600 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 If this many milliseconds nothing is typed the swap file will be
8602 written to disk (see |crash-recovery|). Also used for the
8603 |CursorHold| autocommand event.
8604
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008605 *'varsofttabstop'* *'vsts'*
8606'varsofttabstop' 'vsts' string (default "")
8607 local to buffer
8608 {only available when compiled with the |+vartabs|
8609 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008610 A list of the number of spaces that a <Tab> counts for while editing,
8611 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8612 width <Tab>s are being inserted, while in fact a mixture of spaces
8613 and <Tab>s is used. Tab widths are separated with commas, with the
8614 final value applying to all subsequent tabs.
8615
8616 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008617 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008618 to use the following: >
8619 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008620< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8621 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008622
8623 Note that the value of |'softtabstop'| will be ignored while
8624 'varsofttabstop' is set.
8625
8626 *'vartabstop'* *'vts'*
8627'vartabstop' 'vts' string (default "")
8628 local to buffer
8629 {only available when compiled with the |+vartabs|
8630 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008631 A list of the number of spaces that a <Tab> in the file counts for,
8632 separated by commas. Each value corresponds to one tab, with the
8633 final value applying to all subsequent tabs. For example: >
8634 :set vartabstop=4,20,10,8
8635< This will make the first tab 4 spaces wide, the second 20 spaces,
8636 the third 10 spaces, and all following tabs 8 spaces.
8637
8638 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8639 is set.
8640
Bram Moolenaar071d4272004-06-13 20:20:40 +00008641 *'verbose'* *'vbs'*
8642'verbose' 'vbs' number (default 0)
8643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008644 When bigger than zero, Vim will give messages about what it is doing.
8645 Currently, these messages are given:
8646 >= 1 When the viminfo file is read or written.
8647 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008648 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008649 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008650 >= 8 Files for which a group of autocommands is executed.
8651 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008652 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 >= 12 Every executed function.
8654 >= 13 When an exception is thrown, caught, finished, or discarded.
8655 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008656 >= 15 Every executed Ex command from a script (truncated at 200
8657 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008658 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008659
8660 This option can also be set with the "-V" argument. See |-V|.
8661 This option is also set by the |:verbose| command.
8662
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008663 When the 'verbosefile' option is set then the verbose messages are not
8664 displayed.
8665
8666 *'verbosefile'* *'vfile'*
8667'verbosefile' 'vfile' string (default empty)
8668 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008669 When not empty all messages are written in a file with this name.
8670 When the file exists messages are appended.
8671 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008672 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008673 Setting 'verbosefile' to a new value is like making it empty first.
8674 The difference with |:redir| is that verbose messages are not
8675 displayed when 'verbosefile' is set.
8676
Bram Moolenaar071d4272004-06-13 20:20:40 +00008677 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008678'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008679 "$VIM/vimfiles/view",
8680 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008681 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008682 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008683 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008684 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008685 feature}
8686 Name of the directory where to store files for |:mkview|.
8687 This option cannot be set from a |modeline| or in the |sandbox|, for
8688 security reasons.
8689
8690 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008691'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008692 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008693 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008695 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008696 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697 word save and restore ~
8698 cursor cursor position in file and in window
8699 folds manually created folds, opened/closed folds and local
8700 fold options
8701 options options and mappings local to a window or buffer (not
8702 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008703 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008704 slash backslashes in file names replaced with forward
8705 slashes
8706 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008707 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008708 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008710 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008711 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008712 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713
8714 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008715'viminfo' 'vi' string (Vi default: "", Vim default for
8716 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008717 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8718 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008720 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008721 feature}
8722 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008723 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8724 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008725 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008726 consisting of a single character identifying the particular parameter,
8727 followed by a number or string which specifies the value of that
8728 parameter. If a particular character is left out, then the default
8729 value is used for that parameter. The following is a list of the
8730 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008731 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008732 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733 ! When included, save and restore global variables that start
8734 with an uppercase letter, and don't contain a lowercase
8735 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008736 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008737 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008738 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008739 " Maximum number of lines saved for each register. Old name of
8740 the '<' item, with the disadvantage that you need to put a
8741 backslash before the ", otherwise it will be recognized as the
8742 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008743 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008744 % When included, save and restore the buffer list. If Vim is
8745 started with a file name argument, the buffer list is not
8746 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008747 buffer list is restored from the viminfo file. Quickfix
8748 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8749 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008750 When followed by a number, the number specifies the maximum
8751 number of buffers that are stored. Without a number all
8752 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008753 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 ' Maximum number of previously edited files for which the marks
8755 are remembered. This parameter must always be included when
8756 'viminfo' is non-empty.
8757 Including this item also means that the |jumplist| and the
8758 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008759 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008761 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008762 patterns are also saved. When not included, the value of
8763 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008764 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008765 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008766 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008767 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008768 < Maximum number of lines saved for each register. If zero then
8769 registers are not saved. When not included, all lines are
8770 saved. '"' is the old name for this item.
8771 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008772 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008773 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008774 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008775 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008776 c When included, convert the text in the viminfo file from the
8777 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008778 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008779 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008780 f Whether file marks need to be stored. If zero, file marks ('0
8781 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008782 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008783 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008784 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008785 h Disable the effect of 'hlsearch' when loading the viminfo
8786 file. When not included, it depends on whether ":nohlsearch"
8787 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008788 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008789 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008790 the 'n'. Must be at the end of the option! If the
8791 'viminfofile' option is set, that file name overrides the one
8792 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008793 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008794 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008795 r Removable media. The argument is a string (up to the next
8796 ','). This parameter can be given several times. Each
8797 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008798 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008799 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8800 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8801 ignored. Maximum length of each 'r' argument is 50
8802 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008803 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008804 s Maximum size of an item in Kbyte. If zero then registers are
8805 not saved. Currently only applies to registers. The default
8806 "s10" will exclude registers with more than 10 Kbyte of text.
8807 Also see the '<' item above: line count limit.
8808
8809 Example: >
8810 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8811<
8812 '50 Marks will be remembered for the last 50 files you
8813 edited.
8814 <1000 Contents of registers (up to 1000 lines each) will be
8815 remembered.
8816 s100 Registers with more than 100 Kbyte text are skipped.
8817 :0 Command-line history will not be saved.
8818 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8819 no / Since '/' is not specified, the default will be used,
8820 that is, save all of the search history, and also the
8821 previous search and substitute patterns.
8822 no % The buffer list will not be saved nor read back.
8823 no h 'hlsearch' highlighting will be restored.
8824
8825 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8826 load the contents of the file, this is not done automatically.
8827
8828 This option cannot be set from a |modeline| or in the |sandbox|, for
8829 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008830 NOTE: This option is set to the Vim default value when 'compatible'
8831 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008832
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008833 *'viminfofile'* *'vif'*
8834'viminfofile' 'vif' string (default: "")
8835 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008836 {not available when compiled without the |+viminfo|
8837 feature}
8838 When non-empty, overrides the file name used for viminfo.
8839 When equal to "NONE" no viminfo file will be read or written.
8840 This option can be set with the |-i| command line flag. The |--clean|
8841 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008842 This option cannot be set from a |modeline| or in the |sandbox|, for
8843 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008844
Bram Moolenaar071d4272004-06-13 20:20:40 +00008845 *'virtualedit'* *'ve'*
8846'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008847 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008848 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008849 block Allow virtual editing in Visual block mode.
8850 insert Allow virtual editing in Insert mode.
8851 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008852 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008853 none When used as the local value, do not allow virtual
8854 editing even when the global value is set. When used
8855 as the global value, "none" is the same as "".
8856 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008857
Bram Moolenaar071d4272004-06-13 20:20:40 +00008858 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008859 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008860 of the line. Useful for selecting a rectangle in Visual mode and
8861 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008862 "onemore" is not the same, it will only allow moving the cursor just
8863 after the last character of the line. This makes some commands more
8864 consistent. Previously the cursor was always past the end of the line
8865 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008866 break some plugins or Vim scripts. For example because |l| can move
8867 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008868 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008869 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008870 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008871 It doesn't make sense to combine "all" with "onemore", but you will
8872 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008873 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008874 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008875
8876 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8877'visualbell' 'vb' boolean (default off)
8878 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008879 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008880 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008881 use: >
8882 :set vb t_vb=
8883< If you want a short flash, you can use this on many terminals: >
8884 :set vb t_vb=[?5h$<100>[?5l
8885< Here $<100> specifies the time, you can use a smaller or bigger value
8886 to get a shorter or longer flash.
8887
8888 Note: Vim will limit the bell to once per half a second. This avoids
8889 having to wait for the flashing to finish when there are lots of
8890 bells, e.g. on key repeat. This also happens without 'visualbell'
8891 set.
8892
Bram Moolenaar071d4272004-06-13 20:20:40 +00008893 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8894 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8895 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008896
8897 Note: When the GUI starts, 't_vb' is reset to its default value. You
8898 might want to set it again in your |gvimrc|.
8899
Bram Moolenaar071d4272004-06-13 20:20:40 +00008900 Does not work on the Amiga, you always get a screen flash.
8901 Also see 'errorbells'.
8902
8903 *'warn'* *'nowarn'*
8904'warn' boolean (default on)
8905 global
8906 Give a warning message when a shell command is used while the buffer
8907 has been changed.
8908
8909 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8910'weirdinvert' 'wiv' boolean (default off)
8911 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008912 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008913 It is provided for backwards compatibility with version 4.x.
8914 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8915 vice versa. Has no effect when the GUI is running.
8916
8917 *'whichwrap'* *'ww'*
8918'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8919 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008920 Allow specified keys that move the cursor left/right to move to the
8921 previous/next line when the cursor is on the first/last character in
8922 the line. Concatenate characters to allow this for these keys:
8923 char key mode ~
8924 b <BS> Normal and Visual
8925 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008926 h "h" Normal and Visual (not recommended)
8927 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008928 < <Left> Normal and Visual
8929 > <Right> Normal and Visual
8930 ~ "~" Normal
8931 [ <Left> Insert and Replace
8932 ] <Right> Insert and Replace
8933 For example: >
8934 :set ww=<,>,[,]
8935< allows wrap only when cursor keys are used.
8936 When the movement keys are used in combination with a delete or change
8937 operator, the <EOL> also counts for a character. This makes "3h"
8938 different from "3dh" when the cursor crosses the end of a line. This
8939 is also true for "x" and "X", because they do the same as "dl" and
8940 "dh". If you use this, you may also want to use the mapping
8941 ":map <BS> X" to make backspace delete the character in front of the
8942 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008943 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008944 line (not an empty line) then it will not move to the next line. This
8945 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946 NOTE: This option is set to the Vi default value when 'compatible' is
8947 set and to the Vim default value when 'compatible' is reset.
8948
8949 *'wildchar'* *'wc'*
8950'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8951 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008952 Character you have to type to start wildcard expansion in the
8953 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008954 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008955 The character is not recognized when used inside a macro. See
8956 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008957 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008958 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008959 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008960< NOTE: This option is set to the Vi default value when 'compatible' is
8961 set and to the Vim default value when 'compatible' is reset.
8962
8963 *'wildcharm'* *'wcm'*
8964'wildcharm' 'wcm' number (default: none (0))
8965 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008966 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008967 recognized when used inside a macro. You can find "spare" command-line
8968 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008969 you'll never actually type 'wildcharm', just use it in mappings that
8970 automatically invoke completion mode, e.g.: >
8971 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008972 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008973< Then after typing :ss you can use CTRL-P & CTRL-N.
8974
8975 *'wildignore'* *'wig'*
8976'wildignore' 'wig' string (default "")
8977 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008978 {not available when compiled without the |+wildignore|
8979 feature}
8980 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008981 patterns is ignored when expanding |wildcards|, completing file or
8982 directory names, and influences the result of |expand()|, |glob()| and
8983 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008984 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8985 Also see 'suffixes'.
8986 Example: >
8987 :set wildignore=*.o,*.obj
8988< The use of |:set+=| and |:set-=| is preferred when adding or removing
8989 a pattern from the list. This avoids problems when a future version
8990 uses another default.
8991
Bram Moolenaar94950a92010-12-02 16:01:29 +01008992
Bram Moolenaar81af9252010-12-10 20:35:50 +01008993 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008994'wildignorecase' 'wic' boolean (default off)
8995 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008996 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008997 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008998 Does not apply when the shell is used to expand wildcards, which
8999 happens when there are special characters.
9000
9001
Bram Moolenaar071d4272004-06-13 20:20:40 +00009002 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009003'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005 {not available if compiled without the |+wildmenu|
9006 feature}
9007 When 'wildmenu' is on, command-line completion operates in an enhanced
9008 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
9009 the possible matches are shown just above the command line, with the
9010 first match highlighted (overwriting the status line, if there is
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009011 one). This is the behavior without "pum" in 'wildoptions.
9012 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9014 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9015 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009016 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009017 If there are more matches than can fit in the line, a ">" is shown on
9018 the right and/or a "<" is shown on the left. The status line scrolls
9019 as needed.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009020 When 'wildoptions' contains "pum", then the completion matches are
9021 shown in a popup menu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009022 The "wildmenu" mode is abandoned when a key is hit that is not used
9023 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009024 While the "wildmenu" is active, not using the popup menu, the
9025 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009026
9027 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9028 <Down> - in filename/menu name completion: move into a
9029 subdirectory or submenu.
9030 <CR> - in menu completion, when the cursor is just after a
9031 dot: move into a submenu.
9032 <Up> - in filename/menu name completion: move up into
9033 parent directory or parent menu.
9034
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009035 When using the popup menu for command line completion, the following
9036 keys have special meanings:
9037 <Down> - select next match (like CTRL-N)
9038 <Left> - in filename/menu name completion: move up into
9039 parent directory or parent menu.
9040 <Right> - in filename/menu name completion: move into a
9041 subdirectory or submenu.
9042 <Up> - select previous match (like CTRL-P)
9043 CTRL-E - end completion, go back to what was there before
9044 selecting a match.
9045 CTRL-N - go to the next entry
9046 CTRL-P - go to the previous entry
9047 CTRL-Y - accept the currently selected match and stop
9048 completion.
9049
Bram Moolenaar071d4272004-06-13 20:20:40 +00009050 This makes the menus accessible from the console |console-menus|.
9051
9052 If you prefer the <Left> and <Right> keys to move the cursor instead
9053 of selecting a different match, use this: >
9054 :cnoremap <Left> <Space><BS><Left>
9055 :cnoremap <Right> <Space><BS><Right>
9056<
9057 The "WildMenu" highlighting is used for displaying the current match
9058 |hl-WildMenu|.
9059
9060 *'wildmode'* *'wim'*
9061'wildmode' 'wim' string (Vim default: "full")
9062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009063 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009064 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009065 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009066 first part specifies the behavior for the first use of 'wildchar',
9067 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009068
9069 Each part consists of a colon separated list consisting of the
9070 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009071 "" Complete only the first match.
9072 "full" Complete the next full match. After the last match,
9073 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009074 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009075 "longest" Complete till longest common string. If this doesn't
9076 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009077 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009078 "lastused" When completing buffer names and more than one buffer
9079 matches, sort buffers by time last used (other than
9080 the current buffer).
9081 When there is only a single match, it is fully completed in all cases.
9082
9083 Examples of useful colon-separated values:
9084 "longest:full" Like "longest", but also start 'wildmenu' if it is
9085 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009086 "list:full" When more than one match, list all matches and
9087 complete first match.
9088 "list:longest" When more than one match, list all matches and
9089 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009090 "list:lastused" When more than one buffer matches, list all matches
9091 and sort buffers by time last used (other than the
9092 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009093
9094 Examples: >
9095 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009096< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009097 :set wildmode=longest,full
9098< Complete longest common string, then each full match >
9099 :set wildmode=list:full
9100< List all matches and complete each full match >
9101 :set wildmode=list,full
9102< List all matches without completing, then each full match >
9103 :set wildmode=longest,list
9104< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009105 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009106
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009107 *'wildoptions'* *'wop'*
9108'wildoptions' 'wop' string (default "")
9109 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009110 {not available when compiled without the |+wildignore|
9111 feature}
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009112 A list of words that change how |cmdline-completion| is done.
9113 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009114 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009115 this value is specified, wildcard expansion will not
9116 be used for completion. The matches will be sorted by
9117 the "best match" rather than alphabetically sorted.
9118 This will find more matches than the wildcard
9119 expansion. Currently fuzzy matching based completion
9120 is not supported for file and directory names and
9121 instead wildcard expansion is used.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009122 pum Display the completion matches using the popupmenu
9123 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009124 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009125 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009126 is displayed per line. Often used tag kinds are:
9127 d #define
9128 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009129
Bram Moolenaar071d4272004-06-13 20:20:40 +00009130 *'winaltkeys'* *'wak'*
9131'winaltkeys' 'wak' string (default "menu")
9132 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009133 {only used in Win32, Motif, GTK and Photon GUI}
9134 Some GUI versions allow the access to menu entries by using the ALT
9135 key in combination with a character that appears underlined in the
9136 menu. This conflicts with the use of the ALT key for mappings and
9137 entering special characters. This option tells what to do:
9138 no Don't use ALT keys for menus. ALT key combinations can be
9139 mapped, but there is no automatic handling. This can then be
9140 done with the |:simalt| command.
9141 yes ALT key handling is done by the windowing system. ALT key
9142 combinations cannot be mapped.
9143 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009144 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009145 keys can be mapped.
9146 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9147 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009148 This option is not used for <F10>; on Win32 and with GTK <F10> will
9149 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009150
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009151 *'wincolor'* *'wcr'*
9152'wincolor' 'wcr' string (default empty)
9153 local to window
9154 Highlight group name to use for this window instead of the Normal
9155 color |hl-Normal|.
9156
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009157 *'window'* *'wi'*
9158'window' 'wi' number (default screen height - 1)
9159 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009160 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9161 window and the value is smaller than 'lines' minus one. The screen
9162 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009163 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9164 in a much smarter way, taking care of wrapping lines.
9165 When resizing the Vim window, the value is smaller than 1 or more than
9166 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009167 Note: Do not confuse this with the height of the Vim window, use
9168 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009169
Bram Moolenaar071d4272004-06-13 20:20:40 +00009170 *'winheight'* *'wh'* *E591*
9171'winheight' 'wh' number (default 1)
9172 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009173 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009174 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009175 focus goes to a window that is smaller, its size is increased, at the
9176 cost of the height of other windows.
9177 Set 'winheight' to a small number for normal editing.
9178 Set it to 999 to make the current window fill most of the screen.
9179 Other windows will be only 'winminheight' high. This has the drawback
9180 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9181 to create only two windows, set the option after startup is done,
9182 using the |VimEnter| event: >
9183 au VimEnter * set winheight=999
9184< Minimum value is 1.
9185 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009186 height of the current window.
9187 'winheight' applies to the current window. Use 'winminheight' to set
9188 the minimal height for other windows.
9189
9190 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9191'winfixheight' 'wfh' boolean (default off)
9192 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009193 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009194 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9195 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009196 The height may be changed anyway when running out of room.
9197
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009198 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9199'winfixwidth' 'wfw' boolean (default off)
9200 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009201 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009202 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009203 The width may be changed anyway when running out of room.
9204
Bram Moolenaar071d4272004-06-13 20:20:40 +00009205 *'winminheight'* *'wmh'*
9206'winminheight' 'wmh' number (default 1)
9207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009208 The minimal height of a window, when it's not the current window.
9209 This is a hard minimum, windows will never become smaller.
9210 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9211 status bar) if necessary. They will return to at least one line when
9212 they become active (since the cursor has to have somewhere to go.)
9213 Use 'winheight' to set the minimal height of the current window.
9214 This option is only checked when making a window smaller. Don't use a
9215 large number, it will cause errors when opening more than a few
9216 windows. A value of 0 to 3 is reasonable.
9217
9218 *'winminwidth'* *'wmw'*
9219'winminwidth' 'wmw' number (default 1)
9220 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009221 The minimal width of a window, when it's not the current window.
9222 This is a hard minimum, windows will never become smaller.
9223 When set to zero, windows may be "squashed" to zero columns (i.e. just
9224 a vertical separator) if necessary. They will return to at least one
9225 line when they become active (since the cursor has to have somewhere
9226 to go.)
9227 Use 'winwidth' to set the minimal width of the current window.
9228 This option is only checked when making a window smaller. Don't use a
9229 large number, it will cause errors when opening more than a few
9230 windows. A value of 0 to 12 is reasonable.
9231
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009232 *'winptydll'*
9233'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9234 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009235 {only available when compiled with the |terminal|
9236 feature on MS-Windows}
9237 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009238 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009239 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009240 a fallback.
9241 Environment variables are expanded |:set_env|.
9242 This option cannot be set from a |modeline| or in the |sandbox|, for
9243 security reasons.
9244
Bram Moolenaar071d4272004-06-13 20:20:40 +00009245 *'winwidth'* *'wiw'* *E592*
9246'winwidth' 'wiw' number (default 20)
9247 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009248 Minimal number of columns for the current window. This is not a hard
9249 minimum, Vim will use fewer columns if there is not enough room. If
9250 the current window is smaller, its size is increased, at the cost of
9251 the width of other windows. Set it to 999 to make the current window
9252 always fill the screen. Set it to a small number for normal editing.
9253 The width is not adjusted after one of the commands to change the
9254 width of the current window.
9255 'winwidth' applies to the current window. Use 'winminwidth' to set
9256 the minimal width for other windows.
9257
9258 *'wrap'* *'nowrap'*
9259'wrap' boolean (default on)
9260 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009261 This option changes how text is displayed. It doesn't change the text
9262 in the buffer, see 'textwidth' for that.
9263 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009264 displaying continues on the next line. When off lines will not wrap
9265 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009266 moved to a part that is not shown, the screen will scroll
9267 horizontally.
9268 The line will be broken in the middle of a word if necessary. See
9269 'linebreak' to get the break at a word boundary.
9270 To make scrolling horizontally a bit more useful, try this: >
9271 :set sidescroll=5
9272 :set listchars+=precedes:<,extends:>
9273< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009274 This option can't be set from a |modeline| when the 'diff' option is
9275 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009276
9277 *'wrapmargin'* *'wm'*
9278'wrapmargin' 'wm' number (default 0)
9279 local to buffer
9280 Number of characters from the right window border where wrapping
9281 starts. When typing text beyond this limit, an <EOL> will be inserted
9282 and inserting continues on the next line.
9283 Options that add a margin, such as 'number' and 'foldcolumn', cause
9284 the text width to be further reduced. This is Vi compatible.
9285 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009286 This option is set to 0 when 'paste' is set and restored when 'paste'
9287 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009288 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009289
9290 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9291'wrapscan' 'ws' boolean (default on) *E384* *E385*
9292 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009293 Searches wrap around the end of the file. Also applies to |]s| and
9294 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009295
9296 *'write'* *'nowrite'*
9297'write' boolean (default on)
9298 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009299 Allows writing files. When not set, writing a file is not allowed.
9300 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009301 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009302 argument. Filtering text is still possible, even though this requires
9303 writing a temporary file.
9304
9305 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9306'writeany' 'wa' boolean (default off)
9307 global
9308 Allows writing to any file with no need for "!" override.
9309
9310 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9311'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9312 otherwise)
9313 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009314 Make a backup before overwriting a file. The backup is removed after
9315 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009316 also on.
9317 WARNING: Switching this option off means that when Vim fails to write
9318 your buffer correctly and then, for whatever reason, Vim exits, you
9319 lose both the original file and what you were writing. Only reset
9320 this option if your file system is almost full and it makes the write
9321 fail (and make sure not to exit Vim until the write was successful).
9322 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009323 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009324 Depending on 'backupcopy' the backup is a new file or the original
9325 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009326 NOTE: This option is set to the default value when 'compatible' is
9327 set.
9328
9329 *'writedelay'* *'wd'*
9330'writedelay' 'wd' number (default 0)
9331 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009332 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009333 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009334 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009335
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009336 *'xtermcodes'* *'noxtermcodes'*
9337'xtermcodes' boolean (default on)
9338 global
9339 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009340 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009341 key codes and number of colors from the terminal. This takes care of
9342 various configuration options of the terminal that cannot be obtained
9343 from the termlib/terminfo entry, see |xterm-codes|.
9344 A side effect may be that t_Co changes and Vim will redraw the
9345 display.
9346
9347
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009348 vim:tw=78:ts=8:noet:ft=help:norl: