blob: 9141763649b03c796efa88b6ef383b09f5f70133 [file] [log] [blame]
Bram Moolenaareb490412022-06-28 13:44:46 +01001*options.txt* For Vim version 9.0. Last change: 2022 Jun 27
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
37
Bram Moolenaar47003982021-12-05 21:54:04 +000038:se[t]! termcap Idem, but don't use multiple columns.
39
Bram Moolenaar071d4272004-06-13 20:20:40 +000040 *E518* *E519*
41:se[t] {option}? Show value of {option}.
42
43:se[t] {option} Toggle option: set, switch it on.
44 Number option: show value.
45 String option: show value.
46
47:se[t] no{option} Toggle option: Reset, switch it off.
48
Bram Moolenaar00a927d2010-05-14 23:24:24 +020049 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000050:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020051:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000052
53 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
54:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020055 current value of 'compatible'.
56:se[t] {option}&vi Reset option to its Vi default value.
57:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000058
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010059:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020060 these options are not changed:
61 all terminal options, starting with t_
62 'columns'
63 'cryptmethod'
64 'encoding'
65 'key'
66 'lines'
67 'term'
68 'ttymouse'
69 'ttytype'
70 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000071
72 *:set-args* *E487* *E521*
73:se[t] {option}={value} or
74:se[t] {option}:{value}
75 Set string or number option to {value}.
76 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010077 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000078 The old value can be inserted by typing 'wildchar' (by
79 default this is a <Tab> or CTRL-E if 'compatible' is
80 set). See |cmdline-completion|.
81 White space between {option} and '=' is allowed and
82 will be ignored. White space between '=' and {value}
83 is not allowed.
84 See |option-backslash| for using white space and
85 backslashes in {value}.
86
87:se[t] {option}+={value} *:set+=*
88 Add the {value} to a number option, or append the
89 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010090 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 value was empty.
92 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000093 are removed. When adding a flag that was already
94 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000095 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000096
97:se[t] {option}^={value} *:set^=*
98 Multiply the {value} to a number option, or prepend
99 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100100 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101 value was empty.
102 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103
104:se[t] {option}-={value} *:set-=*
105 Subtract the {value} from a number option, or remove
106 the {value} from a string option, if it is there.
107 If the {value} is not found in a string option, there
108 is no error or warning. When the option is a comma
109 separated list, a comma is deleted, unless the option
110 becomes empty.
111 When the option is a list of flags, {value} must be
112 exactly as they appear in the option. Remove flags
113 one by one to avoid problems.
114 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115
116The {option} arguments to ":set" may be repeated. For example: >
117 :set ai nosi sw=3 ts=3
118If you make an error in one of the arguments, an error message will be given
119and the following arguments will be ignored.
120
121 *:set-verbose*
122When 'verbose' is non-zero, displaying an option value will also tell where it
123was last set. Example: >
124 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200125< shiftwidth=4 ~
126 Last set from modeline line 1 ~
127 cindent ~
128 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000129This is only done when specific option values are requested, not for ":verbose
130set all" or ":verbose set" without an argument.
131When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000132When the option was set while executing a function, user command or
133autocommand, the script in which it was defined is reported.
134Note that an option may also have been set as a side effect of setting
135'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200137 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000138 Option was set in a |modeline|.
139 Last set from --cmd argument ~
140 Option was set with command line argument |--cmd| or +.
141 Last set from -c argument ~
142 Option was set with command line argument |-c|, +, |-S| or
143 |-q|.
144 Last set from environment variable ~
145 Option was set from an environment variable, $VIMINIT,
146 $GVIMINIT or $EXINIT.
147 Last set from error handler ~
148 Option was cleared when evaluating it resulted in an error.
149
Bram Moolenaardb84e452010-08-15 13:50:43 +0200150{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151
152 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000153For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000154override the value from the termcap. You can then use it in a mapping. If
155the "xx" part contains special characters, use the <t_xx> form: >
156 :set <t_#4>=^[Ot
157This can also be used to translate a special code for a normal key. For
158example, if Alt-b produces <Esc>b, use this: >
159 :set <M-b>=^[b
160(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
161The advantage over a mapping is that it works in all situations.
162
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100163You can define any key codes, e.g.: >
164 :set t_xy=^[foo;
165There is no warning for using a name that isn't recognized. You can map these
166codes as you like: >
167 :map <t_xy> something
168< *E846*
169When a key code is not set, it's like it does not exist. Trying to get its
170value will result in an error: >
171 :set t_kb=
172 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000173< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100174
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000175The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
176security reasons.
177
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000179at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180"set all" probably does not fit on the screen, causing Vim to give the
181|more-prompt|.
182
183 *option-backslash*
184To include white space in a string option value it has to be preceded with a
185backslash. To include a backslash you have to use two. Effectively this
186means that the number of backslashes in an option value is halved (rounded
187down).
188A few examples: >
189 :set tags=tags\ /usr/tags results in "tags /usr/tags"
190 :set tags=tags\\,file results in "tags\,file"
191 :set tags=tags\\\ file results in "tags\ file"
192
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000193The "|" character separates a ":set" command from a following command. To
194include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195'titlestring' option to "hi|there": >
196 :set titlestring=hi\|there
197This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
198 :set titlestring=hi|set iconstring=there
199
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200200Similarly, in legacy script the double quote character starts a comment. To
201include the '"' in the option value, use '\"' instead. This example sets the
202'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000203 :set titlestring=hi\ \"there\"
204
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200205In |Vim9| script it's simpler, comments start with a '#' character, and only
206when preceded by white space. A backslash is needed less often: >
207 vim9script
208 set titlestring=hi\ "there"
209 set titlestring=hi#there#
210 set titlestring=hi\ \#there#
211
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100212For Win32 backslashes in file names are mostly not removed. More precise: For
213options that expect a file name (those where environment variables are
214expanded) a backslash before a normal file name character is not removed. But
215a backslash before a special character (space, backslash, comma, etc.) is used
216like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217There is one special situation, when the value starts with "\\": >
218 :set dir=\\machine\path results in "\\machine\path"
219 :set dir=\\\\machine\\path results in "\\machine\path"
220 :set dir=\\path\\file results in "\\path\file" (wrong!)
221For the first one the start is kept, but for the second one the backslashes
222are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000223halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224result which is probably not what you want. Avoid it.
225
226 *add-option-flags* *remove-option-flags*
227 *E539* *E550* *E551* *E552*
228Some options are a list of flags. When you want to add a flag to such an
229option, without changing the existing ones, you can do it like this: >
230 :set guioptions+=a
231Remove a flag from an option like this: >
232 :set guioptions-=a
233This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000234Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
236doesn't appear.
237
238 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000239Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000240environment variable exists the '$' and the following environment variable
241name is replaced with its value. If it does not exist the '$' and the name
242are not modified. Any non-id character (not a letter, digit or '_') may
243follow the environment variable name. That character and what follows is
244appended to the value of the environment variable. Examples: >
245 :set term=$TERM.new
246 :set path=/usr/$INCLUDE,$HOME/include,.
247When adding or removing a string from an option with ":set opt-=val" or ":set
248opt+=val" the expansion is done before the adding or removing.
249
250
251Handling of local options *local-options*
252
253Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100254has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255allows you to set 'list' in one window but not in another. And set
256'shiftwidth' to 3 in one buffer and 4 in another.
257
258The following explains what happens to these local options in specific
259situations. You don't really need to know all of this, since Vim mostly uses
260the option values you would expect. Unfortunately, doing what the user
261expects is a bit complicated...
262
263When splitting a window, the local options are copied to the new window. Thus
264right after the split the contents of the two windows look the same.
265
266When editing a new buffer, its local option values must be initialized. Since
267the local options of the current buffer might be specifically for that buffer,
268these are not used. Instead, for each buffer-local option there also is a
269global value, which is used for new buffers. With ":set" both the local and
270global value is changed. With "setlocal" only the local value is changed,
271thus this value is not used when editing a new buffer.
272
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200273When editing a buffer that has been edited before, the options from the window
274that was last closed are used again. If this buffer has been edited in this
275window, the values from back then are used. Otherwise the values from the
276last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277
278It's possible to set a local window option specifically for a type of buffer.
279When you edit another buffer in the same window, you don't want to keep
280using these local window options. Therefore Vim keeps a global value of the
281local window options, which is used when editing another buffer. Each window
282has its own copy of these values. Thus these are local to the window, but
283global to all buffers in the window. With this you can do: >
284 :e one
285 :set list
286 :e two
287Now the 'list' option will also be set in "two", since with the ":set list"
288command you have also set the global value. >
289 :set nolist
290 :e one
291 :setlocal list
292 :e two
293Now the 'list' option is not set, because ":set nolist" resets the global
294value, ":setlocal list" only changes the local value and ":e two" gets the
295global value. Note that if you do this next: >
296 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200297You will get back the 'list' value as it was the last time you edited "one".
298The options local to a window are remembered for each buffer. This also
299happens when the buffer is not loaded, but they are lost when the buffer is
300wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301
302 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100303:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304 current buffer or window. Not all options have a
305 local value. If the option does not have a local
306 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200307 With the "all" argument: display local values for all
308 local options.
309 Without argument: Display local values for all local
310 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000312 local value. For a global/local boolean option, when
313 the global value is being used, "--" is displayed
314 before the option name.
315 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000318:setl[ocal] {option}< Set the local value of {option} to its global value by
319 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000320
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100321:se[t] {option}< For |global-local| options: Remove the local value of
322 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100325:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 option without changing the local value.
327 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200328 With the "all" argument: display global values for all
329 local options.
330 Without argument: display global values for all local
331 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332
333For buffer-local and window-local options:
334 Command global value local value ~
335 :set option=value set set
336 :setlocal option=value - set
337:setglobal option=value set -
338 :set option? - display
339 :setlocal option? - display
340:setglobal option? display -
341
342
343Global options with a local value *global-local*
344
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000345Options are global when you mostly use one value for all buffers and windows.
346For some global options it's useful to sometimes have a different local value.
347You can set the local value with ":setlocal". That buffer or window will then
348use the local value, while other buffers and windows continue using the global
349value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350
351For example, you have two windows, both on C source code. They use the global
352'makeprg' option. If you do this in one of the two windows: >
353 :set makeprg=gmake
354then the other window will switch to the same value. There is no need to set
355the 'makeprg' option in the other C source window too.
356However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000357another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000358files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359 :setlocal makeprg=perlmake
360You can switch back to using the global value by making the local value empty: >
361 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100362This only works for a string option. For a number or boolean option you need
363to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000364 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100365Note that for non-boolean and non-number options using "<" copies the global
366value to the local value, it doesn't switch back to using the global value
367(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000368 :set path<
369This will make the local value of 'path' empty, so that the global value is
370used. Thus it does the same as: >
371 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000372Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373":setlocal" on a global option might work differently then.
374
375
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000376 *option-value-function*
377Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000378'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000379a function name or a function reference or a lambda function. When using a
380lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000381>
382 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000383 set opfunc=function('MyOpFunc')
384 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000385 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000386
387Set to a script-local function: >
388 set opfunc=s:MyLocalFunc
389 set opfunc=<SID>MyLocalFunc
390In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
391the script: >
392 set opfunc=MyLocalFunc
393
394Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000395 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000396 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000397
398Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000399 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000400
401Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000402 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000403 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000404
405In Vim9 script, in a compiled function, you can use a lambda, but a
406closured does not work, because the function will be called without the
407context of where it was defined.
408
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000409
Bram Moolenaar071d4272004-06-13 20:20:40 +0000410Setting the filetype
411
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200412:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413 Set the 'filetype' option to {filetype}, but only if
414 not done yet in a sequence of (nested) autocommands.
415 This is short for: >
416 :if !did_filetype()
417 : setlocal filetype={filetype}
418 :endif
419< This command is used in a filetype.vim file to avoid
420 setting the 'filetype' option twice, causing different
421 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200422
423 When the optional FALLBACK argument is present, a
424 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100425 'filetype'. This is to be used for filetype
426 detections that are just a guess. |did_filetype()|
427 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200428
Bram Moolenaard58e9292011-02-09 17:07:58 +0100429 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
431:opt[ions] Open a window for viewing and setting all options.
432 Options are grouped by function.
433 Offers short help for each option. Hit <CR> on the
434 short help to open a help window with more help for
435 the option.
436 Modify the value of the option and hit <CR> on the
437 "set" line to set the new value. For window and
438 buffer specific options, the last accessed window is
439 used to set the option value in, unless this is a help
440 window, in which case the window below help window is
441 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100442 {not available when compiled without the |+eval|
443 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000444
445 *$HOME*
446Using "~" is like using "$HOME", but it is only recognized at the start of an
447option and after a space or comma.
448
449On Unix systems "~user" can be used too. It is replaced by the home directory
450of user "user". Example: >
451 :set path=~mool/include,/usr/include,.
452
453On Unix systems the form "${HOME}" can be used too. The name between {} can
454contain non-id characters then. Note that if you want to use this for the
455"gf" command, you need to add the '{' and '}' characters to 'isfname'.
456
457NOTE: expanding environment variables and "~/" is only done with the ":set"
458command, not when assigning a value to an option with ":let".
459
Bram Moolenaarc572da52017-08-27 16:52:01 +0200460 *$HOME-windows*
461On MS-Windows, if $HOME is not defined as an environment variable, then
462at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200463If $HOMEDRIVE is not set then $USERPROFILE is used.
464
465This expanded value is not exported to the environment, this matters when
466running an external command: >
467 :echo system('set | findstr ^HOME=')
468and >
469 :echo luaeval('os.getenv("HOME")')
470should echo nothing (an empty string) despite exists('$HOME') being true.
471When setting $HOME to a non-empty string it will be exported to the
472subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200473
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474
475Note the maximum length of an expanded option is limited. How much depends on
476the system, mostly it is something like 256 or 1024 characters.
477
478 *:fix* *:fixdel*
479:fix[del] Set the value of 't_kD':
480 't_kb' is 't_kD' becomes ~
481 CTRL-? CTRL-H
482 not CTRL-? CTRL-?
483
Bram Moolenaar82be4842021-01-11 19:40:15 +0100484 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000485
486 If your delete key terminal code is wrong, but the
487 code for backspace is alright, you can put this in
488 your .vimrc: >
489 :fixdel
490< This works no matter what the actual code for
491 backspace is.
492
493 If the backspace key terminal code is wrong you can
494 use this: >
495 :if &term == "termname"
496 : set t_kb=^V<BS>
497 : fixdel
498 :endif
499< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000500 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000501 with your terminal name.
502
503 If your <Delete> key sends a strange key sequence (not
504 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
505 :if &term == "termname"
506 : set t_kD=^V<Delete>
507 :endif
508< Where "^V" is CTRL-V and "<Delete>" is the delete key
509 (don't type eight characters!). Replace "termname"
510 with your terminal name.
511
512 *Linux-backspace*
513 Note about Linux: By default the backspace key
514 produces CTRL-?, which is wrong. You can fix it by
515 putting this line in your rc.local: >
516 echo "keycode 14 = BackSpace" | loadkeys
517<
518 *NetBSD-backspace*
519 Note about NetBSD: If your backspace doesn't produce
520 the right code, try this: >
521 xmodmap -e "keycode 22 = BackSpace"
522< If this works, add this in your .Xmodmap file: >
523 keysym 22 = BackSpace
524< You need to restart for this to take effect.
525
526==============================================================================
5272. Automatically setting options *auto-setting*
528
529Besides changing options with the ":set" command, there are three alternatives
530to set options automatically for one or more files:
531
5321. When starting Vim initializations are read from various places. See
533 |initialization|. Most of them are performed for all editing sessions,
534 and some of them depend on the directory where Vim is started.
535 You can create an initialization file with |:mkvimrc|, |:mkview| and
536 |:mksession|.
5372. If you start editing a new file, the automatic commands are executed.
538 This can be used to set options for files matching a particular pattern and
539 many other things. See |autocommand|.
5403. If you start editing a new file, and the 'modeline' option is on, a
541 number of lines at the beginning and end of the file are checked for
542 modelines. This is explained here.
543
544 *modeline* *vim:* *vi:* *ex:* *E520*
545There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100546 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100548[text{white}] empty or any text followed by at least one blank
549 character (<Space> or <Tab>); "ex:" always requires at
550 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200551{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200552[white] optional white space
553{options} a list of option settings, separated with white space
554 or ':', where each part between ':' is the argument
555 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556
Bram Moolenaar14b69452013-06-29 23:05:20 +0200557Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000558 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200559 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560
561The second form (this is compatible with some versions of Vi):
562
Bram Moolenaarade0d392020-01-21 22:33:58 +0100563 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
Bram Moolenaarade0d392020-01-21 22:33:58 +0100565[text{white}] empty or any text followed by at least one blank
566 character (<Space> or <Tab>); "ex:" always requires at
567 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200568{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
569[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200570se[t] the string "set " or "se " (note the space); When
571 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200572{options} a list of options, separated with white space, which
573 is the argument for a ":set" command
574: a colon
575[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576
Bram Moolenaar14b69452013-06-29 23:05:20 +0200577Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000578 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200579 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000580
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200581The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
582chance that a normal word like "lex:" is caught. There is one exception:
583"vi:" and "vim:" can also be at the start of the line (for compatibility with
584version 3.0). Using "ex:" at the start of the line will be ignored (this
585could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586
Hu Jialun9dcd3492021-08-28 20:42:50 +0200587If the modeline is disabled within a modeline, subsequent modelines will be
588ignored. This is to allow turning off modeline on a per-file basis. This is
589useful when a line looks like a modeline but isn't. For example, it would be
590good to start a YAML file containing strings like "vim:" with
591 # vim: nomodeline ~
592so as to avoid modeline misdetection. Following options on the same line
593after modeline deactivation, if any, are still evaluated (but you would
594normally not have any).
595
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596 *modeline-local*
597The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000598buffer and window that contain the file. Although it's possible to set global
599options from a modeline, this is unusual. If you have two windows open and
600the files in it set the same global option to a different value, the result
601depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000602
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000603When editing a file that was already loaded, only the window-local options
604from the modeline are used. Thus if you manually changed a buffer-local
605option after opening the file, it won't be changed if you edit the same buffer
606in another window. But window-local options will be set.
607
Bram Moolenaar071d4272004-06-13 20:20:40 +0000608 *modeline-version*
609If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200610number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 vim{vers}: version {vers} or later
612 vim<{vers}: version before {vers}
613 vim={vers}: version {vers}
614 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100615{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
616For example, to use a modeline only for Vim 7.0:
617 /* vim700: set foldmethod=marker */ ~
618To use a modeline for Vim after version 7.2:
619 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620There can be no blanks between "vim" and the ":".
621
622
623The number of lines that are checked can be set with the 'modelines' option.
624If 'modeline' is off or 'modelines' is 0 no lines are checked.
625
626Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000627like:
628 /* vi:ts=4: */ ~
629will give an error message for the trailing "*/". This line is OK:
630 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631
632If an error is detected the rest of the line is skipped.
633
634If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000635backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100636 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
637This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
638before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200639 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000641might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200642can be set. For some options a flag is set, so that when the value is used
643the |sandbox| is effective. Some options can only be set from the modeline
644when 'modelineexpr' is set (the default is off).
645
646Still, there is always a small risk that a modeline causes trouble. E.g.,
647when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
648So disable modelines before editing untrusted text. The mail ftplugin does
649this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650
651Hint: If you would like to do something else than setting an option, you could
652define an autocommand that checks the file for a specific string. For
653example: >
654 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
655And define a function SetVar() that does something with the line containing
656"VAR".
657
658==============================================================================
6593. Options summary *option-summary*
660
661In the list below all the options are mentioned with their full name and with
662an abbreviation if there is one. Both forms may be used.
663
664In this document when a boolean option is "set" that means that ":set option"
665is entered. When an option is "reset", ":set nooption" is used.
666
667For some options there are two default values: The "Vim default", which is
668used when 'compatible' is not set, and the "Vi default", which is used when
669'compatible' is set.
670
671Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000672are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673different value in each window. For example the 'list' option can be set in
674one window and reset in another for the same text, giving both types of view
675at the same time. There are a few options that are specific to a certain
676file. These can have a different value for each file or buffer. For example
677the 'textwidth' option can be 78 for a normal text file and 0 for a C
678program.
679
680 global one option for all buffers and windows
681 local to window each window has its own copy of this option
682 local to buffer each buffer has its own copy of this option
683
684When creating a new window the option values from the currently active window
685are used as a default value for the window-specific options. For the
686buffer-specific options this depends on the 's' and 'S' flags in the
687'cpoptions' option. If 's' is included (which is the default) the values for
688buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000689first entered. If 'S' is present the options are copied each time the buffer
690is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691present, the options are copied from the currently active buffer when the
692buffer is created.
693
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000694Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000696Not all options are supported in all versions. This depends on the supported
697features and sometimes on the system. A remark about this is in curly braces
698below. When an option is not supported it may still be set without getting an
699error, this is called a hidden option. You can't get the value of a hidden
700option though, it is not stored.
701
702To test if option "foo" can be used with ":set" use something like this: >
703 if exists('&foo')
704This also returns true for a hidden option. To test if option "foo" is really
705supported use something like this: >
706 if exists('+foo')
707<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708 *E355*
709A jump table for the options with a short description can be found at |Q_op|.
710
711 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100712'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714 {only available when compiled with the |+rightleft|
715 feature}
716 The ASCII code for the first letter of the Hebrew alphabet. The
717 routine that maps the keyboard in Hebrew mode, both in Insert mode
718 (when hkmap is set) and on the command-line (when hitting CTRL-_)
719 outputs the Hebrew characters in the range [aleph..aleph+26].
720 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
721 See |rileft.txt|.
722
723 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
724'allowrevins' 'ari' boolean (default off)
725 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726 {only available when compiled with the |+rightleft|
727 feature}
728 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
729 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
730 into reverse Insert mode, and don't know how to get out. See
731 'revins'.
732 NOTE: This option is reset when 'compatible' is set.
733
734 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
735'altkeymap' 'akm' boolean (default off)
736 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737 {only available when compiled with the |+farsi|
738 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100739 This option was for using Farsi, which has been removed. See
740 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741
742 *'ambiwidth'* *'ambw'*
743'ambiwidth' 'ambw' string (default: "single")
744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000745 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
746 Tells Vim what to do with characters with East Asian Width Class
747 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
748 letters, Cyrillic letters).
749
750 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000751 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 expected by most users.
753 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200754 *E834* *E835*
755 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100756 contains a character that would be double width. These errors may
757 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200758
759 The values are overruled for characters specified with
760 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761
762 There are a number of CJK fonts for which the width of glyphs for
763 those characters are solely based on how many octets they take in
764 legacy/traditional CJK encodings. In those encodings, Euro,
765 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000766 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000768 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 Vim is running inside a terminal (emulators) that uses a CJK font
770 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
771 this option should be set to "double" to match the width perceived
772 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100773 to be set to "double" under CJK MS-Windows when the system locale is
774 set to one of CJK locales. See Unicode Standard Annex #11
775 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100777 Vim may set this option automatically at startup time when Vim is
778 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200779 escape sequence to request cursor position report. The response can
780 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100781
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
783'antialias' 'anti' boolean (default: off)
784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200786 on macOS}
787 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
789 which can be easier to read at certain sizes on certain displays.
790 Setting this option can sometimes cause problems if 'guifont' is set
791 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100792 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793
794 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
795'autochdir' 'acd' boolean (default off)
796 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200797 {only available when compiled with it, use
798 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000799 When on, Vim will change the current working directory whenever you
800 open a file, switch buffers, delete a buffer or open/close a window.
801 It will change to the directory containing the file which was opened
Bram Moolenaare8008642022-08-19 17:15:35 +0100802 or selected. When a buffer has no name it also has no directory, thus
803 the current directory won't change when navigating to it.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000804 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200806 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
807'autoshelldir' 'asd' boolean (default off)
808 global
809 When on, Vim will change the current working directory whenever you
810 change the directory of the shell running in a terminal window. You
811 need proper setting-up, so whenever the shell's pwd changes an OSC 7
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100812 escape sequence will be emitted. For example, on Linux, you can
813 source /etc/profile.d/vte.sh in your shell profile if you use bash or
814 zsh. For bash this should work (put it in a bash init file): >
815 if [[ -n "$VIM_TERMINAL" ]]; then
816 PROMPT_COMMAND='_vim_sync_PWD'
817 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100818 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100819 }
820 fi
821<
822 Or, in a zsh init file: >
823 if [[ -n "$VIM_TERMINAL" ]]; then
824 autoload -Uz add-zsh-hook
825 add-zsh-hook -Uz chpwd _vim_sync_PWD
826 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100827 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100828 }
829 fi
830<
831 In a fish init file: >
832 if test -n "$VIM_TERMINAL"
833 function _vim_sync_PWD --on-variable=PWD
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100834 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100835 end
836 end
837<
838 You can find an alternative method at |terminal-autoshelldir|.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000839 When the parsing of the OSC sequence fails you get *E1179* .
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200840
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
842'arabic' 'arab' boolean (default off)
843 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844 {only available when compiled with the |+arabic|
845 feature}
846 This option can be set to start editing Arabic text.
847 Setting this option will:
848 - Set the 'rightleft' option, unless 'termbidi' is set.
849 - Set the 'arabicshape' option, unless 'termbidi' is set.
850 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
851 between typing English and Arabic key mapping.
852 - Set the 'delcombine' option
853 Note that 'encoding' must be "utf-8" for working with Arabic text.
854
855 Resetting this option will:
856 - Reset the 'rightleft' option.
857 - Disable the use of 'keymap' (without changing its value).
858 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200859 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100860 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861 Also see |arabic.txt|.
862
863 *'arabicshape'* *'arshape'*
864 *'noarabicshape'* *'noarshape'*
865'arabicshape' 'arshape' boolean (default on)
866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 {only available when compiled with the |+arabic|
868 feature}
869 When on and 'termbidi' is off, the required visual character
870 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200871 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872 one which encompasses:
873 a) the changing/morphing of characters based on their location
874 within a word (initial, medial, final and stand-alone).
875 b) the enabling of the ability to compose characters
876 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100877 When disabled the display shows each character's true stand-alone
878 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879 Arabic is a complex language which requires other settings, for
880 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100881 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882
883 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
884'autoindent' 'ai' boolean (default off)
885 local to buffer
886 Copy indent from current line when starting a new line (typing <CR>
887 in Insert mode or when using the "o" or "O" command). If you do not
888 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000889 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
890 to another line has the same effect, unless the 'I' flag is included
891 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000892 When autoindent is on, formatting (with the "gq" command or when you
893 reach 'textwidth' in Insert mode) uses the indentation of the first
894 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 When 'smartindent' or 'cindent' is on the indent is changed in
896 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200897 The 'autoindent' option is reset when the 'paste' option is set and
898 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899
900 *'autoread'* *'ar'* *'noautoread'* *'noar'*
901'autoread' 'ar' boolean (default off)
902 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903 When a file has been detected to have been changed outside of Vim and
904 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200905 When the file has been deleted this is not done, so you have the text
906 from before it was deleted. When it appears again then it is read.
907 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908 If this option has a local value, use this command to switch back to
909 using the global value: >
910 :set autoread<
911<
912 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
913'autowrite' 'aw' boolean (default off)
914 global
915 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000916 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000917 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
918 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000919 to another file.
920 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000921 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 Note that for some commands the 'autowrite' option is not used, see
923 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200924 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200925 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926
927 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
928'autowriteall' 'awa' boolean (default off)
929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
931 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
932 Setting this option also implies that Vim behaves like 'autowrite' has
933 been set.
934
935 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200936'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 When set to "dark", Vim will try to use colors that look good on a
939 dark background. When set to "light", Vim will try to use colors that
940 look good on a light background. Any other value is illegal.
941 Vim tries to set the default value according to the terminal used.
942 This will not always be correct.
943 Setting this option does not change the background color, it tells Vim
944 what the background color looks like. For changing the background
945 color, see |:hi-normal|.
946
947 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000948 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000949 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100950 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951 setting 'background' will cause the color scheme to be reloaded. If
952 the color scheme adjusts to the value of 'background' this will work.
953 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100954 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955
956 When setting 'background' to the default value with: >
957 :set background&
958< Vim will guess the value. In the GUI this should work correctly,
959 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200960 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200961 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200963 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200964 color from the terminal. If the returned RGB value is dark/light and
965 'background' is not dark/light, 'background' will be set and the
966 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200967 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100968 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200969
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 When starting the GUI, the default value for 'background' will be
971 "light". When the value is not set in the .gvimrc, and Vim detects
972 that the background is actually quite dark, 'background' is set to
973 "dark". But this happens only AFTER the .gvimrc file has been read
974 (because the window needs to be opened to find the actual background
975 color). To get around this, force the GUI window to be opened by
976 putting a ":gui" command in the .gvimrc file, before where the value
977 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200978
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100979 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200980 For other systems "dark" is used when 'term' is "linux",
981 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
982 background. Otherwise the default is "light".
983
Bram Moolenaarc572da52017-08-27 16:52:01 +0200984 The |:terminal| command and the |term_start()| function use the
985 'background' value to decide whether the terminal window will start
986 with a white or black background.
987
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988 Normally this option would be set in the .vimrc file. Possibly
989 depending on the terminal name. Example: >
990 :if &term == "pcterm"
991 : set background=dark
992 :endif
993< When this option is set, the default settings for the highlight groups
994 will change. To use other settings, place ":highlight" commands AFTER
995 the setting of the 'background' option.
996 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
997 to select the colors for syntax highlighting. After changing this
998 option, you must load syntax.vim again to see the result. This can be
999 done with ":syntax on".
1000
1001 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001002'backspace' 'bs' string (default "", set to "indent,eol,start"
1003 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1006 mode. This is a list of items, separated by commas. Each item allows
1007 a way to backspace over something:
1008 value effect ~
1009 indent allow backspacing over autoindent
1010 eol allow backspacing over line breaks (join lines)
1011 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1012 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001013 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1014 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015
Bram Moolenaar46eea442022-03-30 10:51:39 +01001016 When the value is empty, Vi compatible backspacing is used, none of
1017 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018
1019 For backwards compatibility with version 5.4 and earlier:
1020 value effect ~
1021 0 same as ":set backspace=" (Vi compatible)
1022 1 same as ":set backspace=indent,eol"
1023 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001024 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025
1026 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1027 NOTE: This option is set to "" when 'compatible' is set.
1028
1029 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1030'backup' 'bk' boolean (default off)
1031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032 Make a backup before overwriting a file. Leave it around after the
1033 file has been successfully written. If you do not want to keep the
1034 backup file, but you do want a backup while the file is being
1035 written, reset this option and set the 'writebackup' option (this is
1036 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001037 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038 |backup-table| for more explanations.
1039 When the 'backupskip' pattern matches, a backup is not made anyway.
1040 When 'patchmode' is set, the backup may be renamed to become the
1041 oldest version of a file.
1042 NOTE: This option is reset when 'compatible' is set.
1043
1044 *'backupcopy'* *'bkc'*
1045'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001046 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001048 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049
1050 The main values are:
1051 "yes" make a copy of the file and overwrite the original one
1052 "no" rename the file and write a new one
1053 "auto" one of the previous, what works best
1054
1055 Extra values that can be combined with the ones above are:
1056 "breaksymlink" always break symlinks when writing
1057 "breakhardlink" always break hardlinks when writing
1058
1059 Making a copy and overwriting the original file:
1060 - Takes extra time to copy the file.
1061 + When the file has special attributes, is a (hard/symbolic) link or
1062 has a resource fork, all this is preserved.
1063 - When the file is a link the backup will have the name of the link,
1064 not of the real file.
1065
1066 Renaming the file and writing a new one:
1067 + It's fast.
1068 - Sometimes not all attributes of the file can be copied to the new
1069 file.
1070 - When the file is a link the new file will not be a link.
1071
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001072 The "auto" value is the middle way: When Vim sees that renaming the
1073 file is possible without side effects (the attributes can be passed on
1074 and the file is not a link) that is used. When problems are expected,
1075 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001076
1077 The "breaksymlink" and "breakhardlink" values can be used in
1078 combination with any of "yes", "no" and "auto". When included, they
1079 force Vim to always break either symbolic or hard links by doing
1080 exactly what the "no" option does, renaming the original file to
1081 become the backup and writing a new file in its place. This can be
1082 useful for example in source trees where all the files are symbolic or
1083 hard links and any changes should stay in the local source tree, not
1084 be propagated back to the original source.
1085 *crontab*
1086 One situation where "no" and "auto" will cause problems: A program
1087 that opens a file, invokes Vim to edit that file, and then tests if
1088 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001089 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090 example.
1091
1092 When a copy is made, the original file is truncated and then filled
1093 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001094 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001095 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 group of the backup is set to the group of the original file. If this
1097 fails, the protection bits for the group are made the same as for
1098 others.
1099
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001100 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 the same attributes of the original file, and the newly written file
1102 is owned by the current user. When the file was a (hard/symbolic)
1103 link, the new file will not! That's why the "auto" value doesn't
1104 rename when the file is a link. The owner and group of the newly
1105 written file will be set to the same ones as the original file, but
1106 the system may refuse to do this. In that case the "auto" value will
1107 again not rename the file.
1108
Bram Moolenaar036986f2017-03-16 17:41:02 +01001109 NOTE: This option is set to the Vi default value when 'compatible' is
1110 set and to the Vim default value when 'compatible' is reset.
1111
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112 *'backupdir'* *'bdir'*
1113'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001114 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115 for Unix: ".,~/tmp,~/")
1116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 List of directories for the backup file, separated with commas.
1118 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001119 where this is possible. The directory must exist, Vim will not
1120 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001121 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122 impossible!). Writing may fail because of this.
1123 - A directory "." means to put the backup file in the same directory
1124 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001125 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1126 the backup file relative to where the edited file is. The leading
1127 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128 ("." inside a directory name has no special meaning).
1129 - Spaces after the comma are ignored, other spaces are considered part
1130 of the directory name. To have a space at the start of a directory
1131 name, precede it with a backslash.
1132 - To include a comma in a directory name precede it with a backslash.
1133 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001134 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001135 the backup file name will be built from the complete path to the
1136 file with all path separators changed to percent '%' signs. This
1137 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001138 On Win32, it is also possible to end with "\\". However, When a
1139 separating comma is following, you must use "//", since "\\" will
1140 include the comma in the file name. Therefore it is recommended to
1141 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142 - Environment variables are expanded |:set_env|.
1143 - Careful with '\' characters, type one before a space, type two to
1144 get one in the option (see |option-backslash|), for example: >
1145 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1146< - For backwards compatibility with Vim version 3.0 a '>' at the start
1147 of the option is removed.
1148 See also 'backup' and 'writebackup' options.
1149 If you want to hide your backup files on Unix, consider this value: >
1150 :set backupdir=./.backup,~/.backup,.,/tmp
1151< You must create a ".backup" directory in each directory and in your
1152 home directory for this to work properly.
1153 The use of |:set+=| and |:set-=| is preferred when adding or removing
1154 directories from the list. This avoids problems when a future version
1155 uses another default.
1156 This option cannot be set from a |modeline| or in the |sandbox|, for
1157 security reasons.
1158
1159 *'backupext'* *'bex'* *E589*
1160'backupext' 'bex' string (default "~", for VMS: "_")
1161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162 String which is appended to a file name to make the name of the
1163 backup file. The default is quite unusual, because this avoids
1164 accidentally overwriting existing files with a backup file. You might
1165 prefer using ".bak", but make sure that you don't have files with
1166 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001167 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001169 If you like to keep a lot of backups, you could use a BufWritePre
1170 autocommand to change 'backupext' just before writing the file to
1171 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001172 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001173< Use 'backupdir' to put the backup in a different directory.
1174
Bram Moolenaar071d4272004-06-13 20:20:40 +00001175 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001176'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1177 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1178 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 {not available when compiled without the |+wildignore|
1181 feature}
1182 A list of file patterns. When one of the patterns matches with the
1183 name of the file which is written, no backup file is created. Both
1184 the specified file name and the full path name of the file are used.
1185 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1186 Watch out for special characters, see |option-backslash|.
1187 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001188 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001189
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001190 WARNING: Not having a backup file means that when Vim fails to write
1191 your buffer correctly and then, for whatever reason, Vim exits, you
1192 lose both the original file and what you were writing. Only disable
1193 backups if you don't care about losing the file.
1194
Bram Moolenaar02467872007-05-06 13:22:01 +00001195 Note that environment variables are not expanded. If you want to use
1196 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001197 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001198
1199< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001200 backup would be made by renaming the original file crontab won't see
1201 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001202
1203 *'balloondelay'* *'bdlay'*
1204'balloondelay' 'bdlay' number (default: 600)
1205 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206 {only available when compiled with the |+balloon_eval|
1207 feature}
1208 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1209
1210 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1211'ballooneval' 'beval' boolean (default off)
1212 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001214 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001215 Switch on the |balloon-eval| functionality for the GUI.
1216
1217 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1218 *'nobevalterm'*
1219'balloonevalterm' 'bevalterm' boolean (default off)
1220 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001221 {only available when compiled with the
1222 |+balloon_eval_term| feature}
1223 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001225 *'balloonexpr'* *'bexpr'*
1226'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001227 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001228 {only available when compiled with the |+balloon_eval|
1229 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001230 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001231 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1232 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001233
1234 v:beval_bufnr number of the buffer in which balloon is going to show
1235 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001236 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001237 v:beval_lnum line number
1238 v:beval_col column number (byte index)
1239 v:beval_text word under or after the mouse pointer
1240
Bram Moolenaar54775062019-07-31 21:07:14 +02001241 Instead of showing a balloon, which is limited to plain text, consider
1242 using a popup window, see |popup_beval_example|. A popup window can
1243 use highlighting and show a border.
1244
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001245 The evaluation of the expression must not have side effects!
1246 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001247 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001248 return 'Cursor is at line ' .. v:beval_lnum ..
1249 \ ', column ' .. v:beval_col ..
1250 \ ' of file ' .. bufname(v:beval_bufnr) ..
1251 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001252 endfunction
1253 set bexpr=MyBalloonExpr()
1254 set ballooneval
1255<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001256 Also see |balloon_show()|, it can be used if the content of the balloon
1257 is to be fetched asynchronously. In that case evaluating
1258 'balloonexpr' should result in an empty string. If you get a balloon
1259 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001260
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001261 NOTE: The balloon is displayed only if the cursor is on a text
1262 character. If the result of evaluating 'balloonexpr' is not empty,
1263 Vim does not try to send a message to an external debugger (Netbeans
1264 or Sun Workshop).
1265
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001266 If the expression starts with s: or |<SID>|, then it is replaced with
1267 the script ID (|local-function|). Example: >
1268 set bexpr=s:MyBalloonExpr()
1269 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001270< Otherwise, the expression is evaluated in the context of the script
1271 where the option was set, thus script-local items are available.
1272
Bram Moolenaar30b65812012-07-12 22:01:11 +02001273 The expression will be evaluated in the |sandbox| when set from a
1274 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001275 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001276
1277 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001278 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001279
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001280 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001281 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001282< When they are supported "\n" characters will start a new line. If the
1283 expression evaluates to a |List| this is equal to using each List item
1284 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001285 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001286
Bram Moolenaar165bc692015-07-21 17:53:25 +02001287 *'belloff'* *'bo'*
1288'belloff' 'bo' string (default "")
1289 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001290 Specifies for which events the bell will not be rung. It is a comma
1291 separated list of items. For each item that is present, the bell
1292 will be silenced. This is most useful to specify specific events in
1293 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001294 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001295
1296 item meaning when present ~
1297 all All events.
1298 backspace When hitting <BS> or <Del> and deleting results in an
1299 error.
1300 cursor Fail to move around using the cursor keys or
1301 <PageUp>/<PageDown> in |Insert-mode|.
1302 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1303 |i_CTRL-X_CTRL-T|.
1304 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1305 |i_CTRL-E|.
1306 ctrlg Unknown Char after <C-G> in Insert mode.
1307 error Other Error occurred (e.g. try to join last line)
1308 (mostly used in |Normal-mode| or |Cmdline-mode|).
1309 esc hitting <Esc> in |Normal-mode|.
1310 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001311 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001312 insertmode Pressing <Esc> in 'insertmode'.
1313 lang Calling the beep module for Lua/Mzscheme/TCL.
1314 mess No output available for |g<|.
1315 showmatch Error occurred for 'showmatch' function.
1316 operator Empty region error |cpo-E|.
1317 register Unknown register after <C-R> in |Insert-mode|.
1318 shell Bell from shell output |:!|.
1319 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001320 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001321 wildmode More matches in |cmdline-completion| available
1322 (depends on the 'wildmode' setting).
1323
Bram Moolenaar036986f2017-03-16 17:41:02 +01001324 This is most useful to fine tune when in Insert mode the bell should
1325 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001326 indicate that an error occurred. It can be silenced by adding the
1327 "error" keyword.
1328
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1330'binary' 'bin' boolean (default off)
1331 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001332 This option should be set before editing a binary file. You can also
1333 use the |-b| Vim argument. When this option is switched on a few
1334 options will be changed (also when it already was on):
1335 'textwidth' will be set to 0
1336 'wrapmargin' will be set to 0
1337 'modeline' will be off
1338 'expandtab' will be off
1339 Also, 'fileformat' and 'fileformats' options will not be used, the
1340 file is read and written like 'fileformat' was "unix" (a single <NL>
1341 separates lines).
1342 The 'fileencoding' and 'fileencodings' options will not be used, the
1343 file is read without conversion.
1344 NOTE: When you start editing a(nother) file while the 'bin' option is
1345 on, settings from autocommands may change the settings again (e.g.,
1346 'textwidth'), causing trouble when editing. You might want to set
1347 'bin' again when the file has been loaded.
1348 The previous values of these options are remembered and restored when
1349 'bin' is switched from on to off. Each buffer has its own set of
1350 saved option values.
1351 To edit a file with 'binary' set you can use the |++bin| argument.
1352 This avoids you have to do ":set bin", which would have effect for all
1353 files you edit.
1354 When writing a file the <EOL> for the last line is only written if
1355 there was one in the original file (normally Vim appends an <EOL> to
1356 the last line if there is none; this would make the file longer). See
1357 the 'endofline' option.
1358
1359 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1360'bioskey' 'biosk' boolean (default on)
1361 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001362 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001363 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001364
1365 *'bomb'* *'nobomb'*
1366'bomb' boolean (default off)
1367 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001368 When writing a file and the following conditions are met, a BOM (Byte
1369 Order Mark) is prepended to the file:
1370 - this option is on
1371 - the 'binary' option is off
1372 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1373 endian variants.
1374 Some applications use the BOM to recognize the encoding of the file.
1375 Often used for UCS-2 files on MS-Windows. For other applications it
1376 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001377 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001378 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1379 check for the presence of the BOM is done and 'bomb' set accordingly.
1380 Unless 'binary' is set, it is removed from the first line, so that you
1381 don't see it when editing. When you don't change the options, the BOM
1382 will be restored when writing the file.
1383
1384 *'breakat'* *'brk'*
1385'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1386 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001387 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001388 feature}
1389 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001390 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1391 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001393 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001394'breakindent' 'bri' boolean (default off)
1395 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001396 {not available when compiled without the |+linebreak|
1397 feature}
1398 Every wrapped line will continue visually indented (same amount of
1399 space as the beginning of that line), thus preserving horizontal blocks
1400 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001401 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001402
1403 *'breakindentopt'* *'briopt'*
1404'breakindentopt' 'briopt' string (default empty)
1405 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001406 {not available when compiled without the |+linebreak|
1407 feature}
1408 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001409 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001410 min:{n} Minimum text width that will be kept after
1411 applying 'breakindent', even if the resulting
1412 text should normally be narrower. This prevents
1413 text indented almost to the right window border
1414 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001415 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001416 shift:{n} After applying 'breakindent', the wrapped line's
1417 beginning will be shifted by the given number of
1418 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001419 indentation (negative) or emphasizing the line
1420 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001421 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001422 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001423 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001424 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001425 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001426 numbered or bulleted list (using the
1427 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001428 list:-1 Uses the length of a match with 'formatlistpat'
1429 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001430 (default: 0)
1431 column:{n} Indent at column {n}. Will overrule the other
1432 sub-options. Note: an additional indent may be
1433 added for the 'showbreak' setting.
1434 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001435
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001437'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001439 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001441 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001442 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443 buffer Use the directory of the related buffer.
1444 current Use the current directory.
1445 {path} Use the specified directory
1446
1447 *'bufhidden'* *'bh'*
1448'bufhidden' 'bh' string (default: "")
1449 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450 This option specifies what happens when a buffer is no longer
1451 displayed in a window:
1452 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001453 hide hide the buffer (don't unload it), even if 'hidden' is
1454 not set
1455 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001456 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001457 delete delete the buffer from the buffer list, even if
1458 'hidden' is set; the |:hide| command will also delete
1459 the buffer, making it behave like |:bdelete|
1460 wipe wipe the buffer from the buffer list, even if
1461 'hidden' is set; the |:hide| command will also wipe
1462 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001464 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001465 are lost without a warning. Also, these values may break autocommands
1466 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467 This option is used together with 'buftype' and 'swapfile' to specify
1468 special kinds of buffers. See |special-buffers|.
1469
1470 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1471'buflisted' 'bl' boolean (default: on)
1472 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001473 When this option is set, the buffer shows up in the buffer list. If
1474 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1475 This option is reset by Vim for buffers that are only used to remember
1476 a file name or marks. Vim sets it when starting to edit a buffer.
1477 But not when moving to a buffer with ":buffer".
1478
1479 *'buftype'* *'bt'* *E382*
1480'buftype' 'bt' string (default: "")
1481 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001482 The value of this option specifies the type of a buffer:
1483 <empty> normal buffer
1484 nofile buffer which is not related to a file and will not be
1485 written
1486 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001487 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001488 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001490 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001491 help help buffer (you are not supposed to set this
1492 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001493 terminal buffer for a |terminal| (you are not supposed to set
1494 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001495 prompt buffer where only the last line can be edited, meant
1496 to be used by a plugin, see |prompt-buffer|
1497 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001498 popup buffer used in a popup window, see |popup|.
1499 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500
1501 This option is used together with 'bufhidden' and 'swapfile' to
1502 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001503 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504
1505 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001506 One such effect is that Vim will not check the timestamp of the file,
1507 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508
Bram Moolenaar280f1262006-01-30 00:14:18 +00001509 A "quickfix" buffer is only used for the error list and the location
1510 list. This value is set by the |:cwindow| and |:lwindow| commands and
1511 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512
1513 "nofile" and "nowrite" buffers are similar:
1514 both: The buffer is not to be written to disk, ":w" doesn't
1515 work (":w filename" does work though).
1516 both: The buffer is never considered to be |'modified'|.
1517 There is no warning when the changes will be lost, for
1518 example when you quit Vim.
1519 both: A swap file is only created when using too much memory
1520 (when 'swapfile' has been reset there is never a swap
1521 file).
1522 nofile only: The buffer name is fixed, it is not handled like a
1523 file name. It is not modified in response to a |:cd|
1524 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001525 both: When using ":e bufname" and already editing "bufname"
1526 the buffer is made empty and autocommands are
1527 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001528 *E676*
1529 "acwrite" implies that the buffer name is not related to a file, like
1530 "nofile", but it will be written. Thus, in contrast to "nofile" and
1531 "nowrite", ":w" does work and a modified buffer can't be abandoned
1532 without saving. For writing there must be matching |BufWriteCmd|,
1533 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001534
1535 *'casemap'* *'cmp'*
1536'casemap' 'cmp' string (default: "internal,keepascii")
1537 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 Specifies details about changing the case of letters. It may contain
1539 these words, separated by a comma:
1540 internal Use internal case mapping functions, the current
1541 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001542 matters when 'encoding' is a Unicode encoding,
1543 "latin1" or "iso-8859-15". When "internal" is
1544 omitted, the towupper() and towlower() system library
1545 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1547 case mapping, the current locale is not effective.
1548 This probably only matters for Turkish.
1549
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001550 *'cdhome'* *'cdh'*
1551'cdhome' 'cdh' boolean (default: off)
1552 global
1553 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1554 current working directory to the |$HOME| directory like in Unix.
1555 When off, those commands just print the current directory name.
1556 On Unix this option has no effect.
1557 NOTE: This option is reset when 'compatible' is set.
1558
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559 *'cdpath'* *'cd'* *E344* *E346*
1560'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001562 {not available when compiled without the
1563 |+file_in_path| feature}
1564 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001565 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1566 searched for has a relative path, not an absolute part starting with
1567 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 The 'cdpath' option's value has the same form and semantics as
1569 |'path'|. Also see |file-searching|.
1570 The default value is taken from $CDPATH, with a "," prepended to look
1571 in the current directory first.
1572 If the default value taken from $CDPATH is not what you want, include
1573 a modified version of the following command in your vimrc file to
1574 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001575 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001576< This option cannot be set from a |modeline| or in the |sandbox|, for
1577 security reasons.
1578 (parts of 'cdpath' can be passed to the shell to expand file names).
1579
1580 *'cedit'*
1581'cedit' string (Vi default: "", Vim default: CTRL-F)
1582 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583 The key used in Command-line Mode to open the command-line window.
1584 The default is CTRL-F when 'compatible' is off.
1585 Only non-printable keys are allowed.
1586 The key can be specified as a single character, but it is difficult to
1587 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001588 :exe "set cedit=\<C-Y>"
1589 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590< |Nvi| also has this option, but it only uses the first character.
1591 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001592 NOTE: This option is set to the Vim default value when 'compatible'
1593 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594
1595 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1596'charconvert' 'ccv' string (default "")
1597 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001598 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 An expression that is used for character encoding conversion. It is
1600 evaluated when a file that is to be read or has been written has a
1601 different encoding from what is desired.
1602 'charconvert' is not used when the internal iconv() function is
1603 supported and is able to do the conversion. Using iconv() is
1604 preferred, because it is much faster.
1605 'charconvert' is not used when reading stdin |--|, because there is no
1606 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001607 The expression must return zero, false or an empty string for success,
1608 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609 The possible encoding names encountered are in 'encoding'.
1610 Additionally, names given in 'fileencodings' and 'fileencoding' are
1611 used.
1612 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1613 is done internally by Vim, 'charconvert' is not used for this.
1614 'charconvert' is also used to convert the viminfo file, if the 'c'
1615 flag is present in 'viminfo'. Also used for Unicode conversion.
1616 Example: >
1617 set charconvert=CharConvert()
1618 fun CharConvert()
1619 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001620 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1621 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001622 return v:shell_error
1623 endfun
1624< The related Vim variables are:
1625 v:charconvert_from name of the current encoding
1626 v:charconvert_to name of the desired encoding
1627 v:fname_in name of the input file
1628 v:fname_out name of the output file
1629 Note that v:fname_in and v:fname_out will never be the same.
1630 Note that v:charconvert_from and v:charconvert_to may be different
1631 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001632
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 Encryption is not done by Vim when using 'charconvert'. If you want
1634 to encrypt the file after conversion, 'charconvert' should take care
1635 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001636
1637 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1638 replaced with the script ID (|local-function|). Example: >
1639 set charconvert=s:MyConvert()
1640 set charconvert=<SID>SomeConvert()
1641< Otherwise the expression is evaluated in the context of the script
1642 where the option was set, thus script-local items are available.
1643
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644 This option cannot be set from a |modeline| or in the |sandbox|, for
1645 security reasons.
1646
1647 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1648'cindent' 'cin' boolean (default off)
1649 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001650 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001651 that trigger reindenting in insert mode and 'cinoptions' to set your
1652 preferred indent style.
1653 If 'indentexpr' is not empty, it overrules 'cindent'.
1654 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1655 the "=" operator indents using this algorithm rather than calling an
1656 external program.
1657 See |C-indenting|.
1658 When you don't like the way 'cindent' works, try the 'smartindent'
1659 option or 'indentexpr'.
1660 This option is not used when 'paste' is set.
1661 NOTE: This option is reset when 'compatible' is set.
1662
1663 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001664'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001666 A list of keys that, when typed in Insert mode, cause reindenting of
1667 the current line. Only used if 'cindent' is on and 'indentexpr' is
1668 empty.
1669 For the format of this option see |cinkeys-format|.
1670 See |C-indenting|.
1671
1672 *'cinoptions'* *'cino'*
1673'cinoptions' 'cino' string (default "")
1674 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1676 program. See |cinoptions-values| for the values of this option, and
1677 |C-indenting| for info on C indenting in general.
1678
1679
1680 *'cinwords'* *'cinw'*
1681'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1682 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001683 These keywords start an extra indent in the next line when
1684 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1685 an appropriate place (inside {}).
1686 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1687 matter, include the keyword both the uppercase and lowercase:
1688 "if,If,IF".
1689
Tom Praschan3506cf32022-04-07 12:39:08 +01001690 *'cinscopedecls'* *'cinsd'*
1691'cinscopedecls' 'cinsd' string (default "public,protected,private")
1692 local to buffer
Tom Praschan3506cf32022-04-07 12:39:08 +01001693 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1694 Useful e.g. for working with the Qt framework that defines additional
1695 scope declarations "signals", "public slots" and "private slots": >
1696 set cinscopedecls+=signals,public\ slots,private\ slots
1697
1698< *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1700 for X-windows, "" otherwise)
1701 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702 {only in GUI versions or when the |+xterm_clipboard|
1703 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001704 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001705 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001706 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001707 prepend, e.g.: >
1708 set clipboard^=unnamed
1709< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001711 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712 unnamed When included, Vim will use the clipboard register '*'
1713 for all yank, delete, change and put operations which
1714 would normally go to the unnamed register. When a
1715 register is explicitly specified, it will always be
1716 used regardless of whether "unnamed" is in 'clipboard'
1717 or not. The clipboard register can always be
1718 explicitly accessed using the "* notation. Also see
1719 |gui-clipboard|.
1720
Bram Moolenaar30b65812012-07-12 22:01:11 +02001721 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001722 unnamedplus A variant of the "unnamed" flag which uses the
1723 clipboard register '+' (|quoteplus|) instead of
1724 register '*' for all yank, delete, change and put
1725 operations which would normally go to the unnamed
1726 register. When "unnamed" is also included to the
1727 option, yank operations (but not delete, change or
1728 put) will additionally copy the text into register
1729 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001730 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001731 Availability can be checked with: >
1732 if has('unnamedplus')
1733<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001734 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735 autoselect Works like the 'a' flag in 'guioptions': If present,
1736 then whenever Visual mode is started, or the Visual
1737 area extended, Vim tries to become the owner of the
1738 windowing system's global selection or put the
1739 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001740 register "*. See |'go-a'| and |quotestar| for details.
1741 When the GUI is active, the 'a' flag in 'guioptions'
1742 is used, when the GUI is not active, this "autoselect"
1743 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 Also applies to the modeless selection.
1745
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001746 *clipboard-autoselectplus*
1747 autoselectplus Like "autoselect" but using the + register instead of
1748 the * register. Compare to the 'P' flag in
1749 'guioptions'.
1750
1751 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752 autoselectml Like "autoselect", but for the modeless selection
1753 only. Compare to the 'A' flag in 'guioptions'.
1754
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001755 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001756 html When the clipboard contains HTML, use this when
1757 pasting. When putting text on the clipboard, mark it
1758 as HTML. This works to copy rendered HTML from
1759 Firefox, paste it as raw HTML in Vim, select the HTML
1760 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001761 You probably want to add this only temporarily,
1762 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001763 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001764
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001765 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 exclude:{pattern}
1767 Defines a pattern that is matched against the name of
1768 the terminal 'term'. If there is a match, no
1769 connection will be made to the X server. This is
1770 useful in this situation:
1771 - Running Vim in a console.
1772 - $DISPLAY is set to start applications on another
1773 display.
1774 - You do not want to connect to the X server in the
1775 console, but do want this in a terminal emulator.
1776 To never connect to the X server use: >
1777 exclude:.*
1778< This has the same effect as using the |-X| argument.
1779 Note that when there is no connection to the X server
1780 the window title won't be restored and the clipboard
1781 cannot be accessed.
1782 The value of 'magic' is ignored, {pattern} is
1783 interpreted as if 'magic' was on.
1784 The rest of the option value will be used for
1785 {pattern}, this must be the last entry.
1786
1787 *'cmdheight'* *'ch'*
1788'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001789 global or local to tab page
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 Number of screen lines to use for the command-line. Helps avoiding
1791 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001792 The value of this option is stored with the tab page, so that each tab
1793 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001795 When 'cmdheight' is zero, there is no command-line unless it is being
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01001796 used. Some informative messages will not be displayed, any other
Bram Moolenaare1f3fd12022-08-15 18:51:32 +01001797 messages will cause the |hit-enter| prompt. Expect some other
1798 unexpected behavior too.
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001799
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800 *'cmdwinheight'* *'cwh'*
1801'cmdwinheight' 'cwh' number (default 7)
1802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803 Number of screen lines to use for the command-line window. |cmdwin|
1804
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001805 *'colorcolumn'* *'cc'*
1806'colorcolumn' 'cc' string (default "")
1807 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001808 {not available when compiled without the |+syntax|
1809 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001810 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001811 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1812 text. Will make screen redrawing slower.
1813 The screen column can be an absolute number, or a number preceded with
1814 '+' or '-', which is added to or subtracted from 'textwidth'. >
1815
1816 :set cc=+1 " highlight column after 'textwidth'
1817 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1818 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1819<
1820 When 'textwidth' is zero then the items with '-' and '+' are not used.
1821 A maximum of 256 columns are highlighted.
1822
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 *'columns'* *'co'* *E594*
1824'columns' 'co' number (default 80 or terminal width)
1825 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001827 initialization and does not have to be set by hand. Also see
1828 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 When Vim is running in the GUI or in a resizable window, setting this
1830 option will cause the window size to be changed. When you only want
1831 to use the size for the GUI, put the command in your |gvimrc| file.
1832 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001833 number of columns of the display, the display may be messed up. For
1834 the GUI it is always possible and Vim limits the number of columns to
1835 what fits on the screen. You can use this command to get the widest
1836 window possible: >
1837 :set columns=9999
1838< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839
1840 *'comments'* *'com'* *E524* *E525*
1841'comments' 'com' string (default
1842 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1843 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001844 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001845 |format-comments|. See |option-backslash| about using backslashes to
1846 insert a space.
1847
1848 *'commentstring'* *'cms'* *E537*
1849'commentstring' 'cms' string (default "/*%s*/")
1850 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001851 {not available when compiled without the |+folding|
1852 feature}
1853 A template for a comment. The "%s" in the value is replaced with the
1854 comment text. Currently only used to add markers for folding, see
1855 |fold-marker|.
1856
1857 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001858'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001859 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861 This option has the effect of making Vim either more Vi-compatible, or
1862 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001863
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001865 other options are also changed as a side effect.
1866 NOTE: Setting or resetting this option can have a lot of unexpected
1867 effects: Mappings are interpreted in another way, undo behaves
1868 differently, etc. If you set this option in your vimrc file, you
1869 should probably put it at the very start.
1870
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871 By default this option is on and the Vi defaults are used for the
1872 options. This default was chosen for those people who want to use Vim
1873 just like Vi, and don't even (want to) know about the 'compatible'
1874 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001875 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001876 this option is switched off, and all options that have not been
1877 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001878 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001879 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001880 happen for the system-wide vimrc or gvimrc file, nor for a file given
1881 with the |-u| argument). Also see |compatible-default| and
1882 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883 You can also set this option with the "-C" argument, and reset it with
1884 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001885 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886
Bram Moolenaar214641f2017-03-05 17:04:09 +01001887 When this option is set, numerous other options are set to make Vim as
1888 Vi-compatible as possible. When this option is unset, various options
1889 are set to make Vim more useful. The table below lists all the
1890 options affected.
1891 The {?} column indicates when the options are affected:
1892 + Means that the option is set to the value given in {set value} when
1893 'compatible' is set.
1894 & Means that the option is set to the value given in {set value} when
1895 'compatible' is set AND is set to its Vim default value when
1896 'compatible' is unset.
1897 - Means the option is NOT changed when setting 'compatible' but IS
1898 set to its Vim default when 'compatible' is unset.
1899 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001900
Bram Moolenaar036986f2017-03-16 17:41:02 +01001901 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001902
1903 'allowrevins' + off no CTRL-_ command
1904 'antialias' + off don't use antialiased fonts
1905 'arabic' + off reset arabic-related options
1906 'arabicshape' + on correct character shapes
1907 'backspace' + "" normal backspace
1908 'backup' + off no backup file
1909 'backupcopy' & Unix: "yes" backup file is a copy
1910 else: "auto" copy or rename backup file
1911 'balloonexpr' + "" text to show in evaluation balloon
1912 'breakindent' + off don't indent when wrapping lines
1913 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001914 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001915 'cindent' + off no C code indentation
1916 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1917 'copyindent' + off don't copy indent structure
1918 'cpoptions' & (all flags) Vi-compatible flags
1919 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001920 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001921 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001922 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001923 'cscopeverbose' + off see |cscopeverbose|
1924 'delcombine' + off unicode: delete whole char combination
1925 'digraph' + off no digraphs
1926 'esckeys' & off no <Esc>-keys in Insert mode
1927 'expandtab' + off tabs not expanded to spaces
1928 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001929 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001930 'formatexpr' + "" use 'formatprg' for auto-formatting
1931 'formatoptions' & "vt" Vi compatible formatting
1932 'gdefault' + off no default 'g' flag for ":s"
1933 'history' & 0 no commandline history
1934 'hkmap' + off no Hebrew keyboard mapping
1935 'hkmapp' + off no phonetic Hebrew keyboard mapping
1936 'hlsearch' + off no highlighting of search matches
1937 'incsearch' + off no incremental searching
1938 'indentexpr' + "" no indenting by expression
1939 'insertmode' + off do not start in Insert mode
1940 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001941 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001942 'joinspaces' + on insert 2 spaces after period
1943 'modeline' & off no modelines
1944 'more' & off no pauses in listings
1945 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1946 'numberwidth' & 8 min number of columns for line number
1947 'preserveindent'+ off don't preserve current indent structure
1948 when changing it
1949 'revins' + off no reverse insert
1950 'ruler' + off no ruler
1951 'scrolljump' + 1 no jump scroll
1952 'scrolloff' + 0 no scroll offset
1953 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1954 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001955 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001956 'showcmd' & off command characters not shown
1957 'showmode' & off current mode not shown
1958 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1959 'smartcase' + off no automatic ignore case switch
1960 'smartindent' + off no smart indentation
1961 'smarttab' + off no smart tab size
1962 'softtabstop' + 0 tabs are always 'tabstop' positions
1963 'startofline' + on goto startofline with some commands
1964 'tagcase' & "followic" 'ignorecase' when searching tags file
1965 'tagrelative' & off tag file names are not relative
1966 'termguicolors' + off don't use highlight-(guifg|guibg)
1967 'textauto' & off no automatic textmode detection
1968 'textwidth' + 0 no automatic line wrap
1969 'tildeop' + off tilde is not an operator
1970 'ttimeout' + off no terminal timeout
1971 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001972 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001973 'virtualedit' + "" cursor can only be placed on characters
1974 'whichwrap' & "" left-right movements don't wrap
1975 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001977 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001978
1979 *'complete'* *'cpt'* *E535*
1980'complete' 'cpt' string (default: ".,w,b,u,t,i")
1981 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982 This option specifies how keyword completion |ins-completion| works
1983 when CTRL-P or CTRL-N are used. It is also used for whole-line
1984 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001985 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001986 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001987 w scan buffers from other windows
1988 b scan other loaded buffers that are in the buffer list
1989 u scan the unloaded buffers that are in the buffer list
1990 U scan the buffers that are not in the buffer list
1991 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001992 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993 k{dict} scan the file {dict}. Several "k" flags can be given,
1994 patterns are valid too. For example: >
1995 :set cpt=k/usr/dict/*,k~/spanish
1996< s scan the files given with the 'thesaurus' option
1997 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1998 are valid too.
1999 i scan current and included files
2000 d scan current and included files for defined name or macro
2001 |i_CTRL-X_CTRL-D|
2002 ] tag completion
2003 t same as "]"
2004
2005 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2006 not executed, this may lead to unexpected completions from some files
2007 (gzipped files for example). Unloaded buffers are not scanned for
2008 whole-line completion.
2009
2010 The default is ".,w,b,u,t,i", which means to scan:
2011 1. the current buffer
2012 2. buffers in other windows
2013 3. other loaded buffers
2014 4. unloaded buffers
2015 5. tags
2016 6. included files
2017
2018 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002019 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2020 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002022 *'completefunc'* *'cfu'*
2023'completefunc' 'cfu' string (default: empty)
2024 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002025 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002026 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002027 This option specifies a function to be used for Insert mode completion
2028 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002029 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002030 invoked and what it should return. The value can be the name of a
2031 function, a |lambda| or a |Funcref|. See |option-value-function| for
2032 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002033 This option cannot be set from a |modeline| or in the |sandbox|, for
2034 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002035
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002036 *'completeslash'* *'csl'*
2037'completeslash' 'csl' string (default: "")
2038 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002039 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002040 When this option is set it overrules 'shellslash' for completion:
2041 - When this option is set to "slash", a forward slash is used for path
2042 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002043 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002044 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002045 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002046 - When this option is empty, same character is used as for
2047 'shellslash'.
2048 For Insert mode completion the buffer-local value is used. For
2049 command line completion the global value is used.
2050
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002051 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002052'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002053 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002054 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002055 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002056
2057 menu Use a popup menu to show the possible completions. The
2058 menu is only shown when there is more than one match and
2059 sufficient colors are available. |ins-completion-menu|
2060
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002061 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002062 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002063 match, e.g., what file it comes from.
2064
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002065 longest Only insert the longest common text of the matches. If
2066 the menu is displayed you can use CTRL-L to add more
2067 characters. Whether case is ignored depends on the kind
2068 of completion. For buffer text the 'ignorecase' option is
2069 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002070
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002071 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002072 completion in the preview window. Only works in
2073 combination with "menu" or "menuone".
2074
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002075 popup Show extra information about the currently selected
2076 completion in a popup window. Only works in combination
2077 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002078 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002079 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002080
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002081 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002082 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002083 |CompleteChanged| autocommand to fetch the info and call
2084 |popup_show()| once the popup has been filled.
2085 See the example at |complete-popuphidden|.
2086 {only works when compiled with the |+textprop| feature}
2087
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002088 noinsert Do not insert any text for a match until the user selects
2089 a match from the menu. Only works in combination with
2090 "menu" or "menuone". No effect if "longest" is present.
2091
2092 noselect Do not select a match in the menu, force the user to
2093 select one from the menu. Only works in combination with
2094 "menu" or "menuone".
2095
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002096
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002097 *'completepopup'* *'cpp'*
2098'completepopup' 'cpp' string (default empty)
2099 global
2100 {not available when compiled without the |+textprop|
2101 or |+quickfix| feature}
2102 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002103 properties of the info popup when it is created. If an info popup
2104 window already exists it is closed, so that the option value is
2105 applied when it is created again.
2106 You can also use |popup_findinfo()| and then set properties for an
2107 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002108
2109
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002110 *'concealcursor'* *'cocu'*
2111'concealcursor' 'cocu' string (default: "")
2112 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002113 {not available when compiled without the |+conceal|
2114 feature}
2115 Sets the modes in which text in the cursor line can also be concealed.
2116 When the current mode is listed then concealing happens just like in
2117 other lines.
2118 n Normal mode
2119 v Visual mode
2120 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002121 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002122
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002123 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002124 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002125 are moving around text is concealed, but when starting to insert text
2126 or selecting a Visual area the concealed text is displayed, so that
2127 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002128 Keep in mind that the cursor position is not always where it's
2129 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002130
2131
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002132 *'conceallevel'* *'cole'*
2133'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002134 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002135 {not available when compiled without the |+conceal|
2136 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002137 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2138 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002139
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002140 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002141 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002142 1 Each block of concealed text is replaced with one
2143 character. If the syntax item does not have a custom
2144 replacement character defined (see |:syn-cchar|) the
2145 character defined in 'listchars' is used (default is a
2146 space).
2147 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002148 2 Concealed text is completely hidden unless it has a
2149 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002150 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002151 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002152
Bram Moolenaara7781e02010-07-19 20:13:22 +02002153 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002154 edit and copy the text. This can be changed with the 'concealcursor'
2155 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002156
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2158'confirm' 'cf' boolean (default off)
2159 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160 When 'confirm' is on, certain operations that would normally
2161 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2162 instead raise a |dialog| asking if you wish to save the current
2163 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2164 If 'confirm' is off you can still activate confirmation for one
2165 command only (this is most useful in mappings) with the |:confirm|
2166 command.
2167 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2168
2169 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2170'conskey' 'consk' boolean (default off)
2171 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002172 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002173
2174 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2175'copyindent' 'ci' boolean (default off)
2176 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 Copy the structure of the existing lines indent when autoindenting a
2178 new line. Normally the new indent is reconstructed by a series of
2179 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2180 in which case only spaces are used). Enabling this option makes the
2181 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002182 existing line. 'expandtab' has no effect on these characters, a Tab
2183 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002185 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186 Also see 'preserveindent'.
2187
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002188 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189'cpoptions' 'cpo' string (Vim default: "aABceFs",
2190 Vi default: all flags)
2191 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002193 this indicates Vi-compatible behavior. This is used for things where
2194 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002195 'cpoptions' stands for "compatible-options".
2196 Commas can be added for readability.
2197 To avoid problems with flags that are added in the future, use the
2198 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002199
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200 NOTE: This option is set to the Vi default value when 'compatible' is
2201 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002202
2203 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2204 is saved, 'cpoptions' is set to the Vim default, and the saved value
2205 is restored at the end of the script. Changes to the value of
2206 'cpoptions' will be applied to the saved value, but keep in mind that
2207 removing a flag that is not present when 'cpoptions' is changed has no
2208 effect. In the |.vimrc| file the value is not restored, thus using
2209 `vim9script` in the |.vimrc| file results in using the Vim default.
2210
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002211 NOTE: This option is set to the POSIX default value at startup when
2212 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002213 variable exists |posix|. This means Vim tries to behave like the
2214 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215
2216 contains behavior ~
2217 *cpo-a*
2218 a When included, a ":read" command with a file name
2219 argument will set the alternate file name for the
2220 current window.
2221 *cpo-A*
2222 A When included, a ":write" command with a file name
2223 argument will set the alternate file name for the
2224 current window.
2225 *cpo-b*
2226 b "\|" in a ":map" command is recognized as the end of
2227 the map command. The '\' is included in the mapping,
2228 the text after the '|' is interpreted as the next
2229 command. Use a CTRL-V instead of a backslash to
2230 include the '|' in the mapping. Applies to all
2231 mapping, abbreviation, menu and autocmd commands.
2232 See also |map_bar|.
2233 *cpo-B*
2234 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002235 abbreviations, user commands and the "to" part of the
2236 menu commands. Remove this flag to be able to use a
2237 backslash like a CTRL-V. For example, the command
2238 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 'B' included: "\^[" (^[ is a real <Esc>)
2240 'B' excluded: "<Esc>" (5 characters)
2241 ('<' excluded in both cases)
2242 *cpo-c*
2243 c Searching continues at the end of any match at the
2244 cursor position, but not further than the start of the
2245 next line. When not present searching continues
2246 one character from the cursor position. With 'c'
2247 "abababababab" only gets three matches when repeating
2248 "/abab", without 'c' there are five matches.
2249 *cpo-C*
2250 C Do not concatenate sourced lines that start with a
2251 backslash. See |line-continuation|.
2252 *cpo-d*
2253 d Using "./" in the 'tags' option doesn't mean to use
2254 the tags file relative to the current file, but the
2255 tags file in the current directory.
2256 *cpo-D*
2257 D Can't use CTRL-K to enter a digraph after Normal mode
2258 commands with a character argument, like |r|, |f| and
2259 |t|.
2260 *cpo-e*
2261 e When executing a register with ":@r", always add a
2262 <CR> to the last line, also when the register is not
2263 linewise. If this flag is not present, the register
2264 is not linewise and the last line does not end in a
2265 <CR>, then the last line is put on the command-line
2266 and can be edited before hitting <CR>.
2267 *cpo-E*
2268 E It is an error when using "y", "d", "c", "g~", "gu" or
2269 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002270 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002271 This makes "y0" fail in the first column.
2272 *cpo-f*
2273 f When included, a ":read" command with a file name
2274 argument will set the file name for the current buffer,
2275 if the current buffer doesn't have a file name yet.
2276 *cpo-F*
2277 F When included, a ":write" command with a file name
2278 argument will set the file name for the current
2279 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002280 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002281 *cpo-g*
2282 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002283 *cpo-H*
2284 H When using "I" on a line with only blanks, insert
2285 before the last blank. Without this flag insert after
2286 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287 *cpo-i*
2288 i When included, interrupting the reading of a file will
2289 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002290 *cpo-I*
2291 I When moving the cursor up or down just after inserting
2292 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293 *cpo-j*
2294 j When joining lines, only add two spaces after a '.',
2295 not after '!' or '?'. Also see 'joinspaces'.
2296 *cpo-J*
2297 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002298 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002299 white space.
2300 *cpo-k*
2301 k Disable the recognition of raw key codes in
2302 mappings, abbreviations, and the "to" part of menu
2303 commands. For example, if <Key> sends ^[OA (where ^[
2304 is <Esc>), the command ":map X ^[OA" results in X
2305 being mapped to:
2306 'k' included: "^[OA" (3 characters)
2307 'k' excluded: "<Key>" (one key code)
2308 Also see the '<' flag below.
2309 *cpo-K*
2310 K Don't wait for a key code to complete when it is
2311 halfway a mapping. This breaks mapping <F1><F1> when
2312 only part of the second <F1> has been read. It
2313 enables cancelling the mapping by typing <F1><Esc>.
2314 *cpo-l*
2315 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002316 literally, only "\]", "\^", "\-" and "\\" are special.
2317 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2319 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002320 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002321 *cpo-L*
2322 L When the 'list' option is set, 'wrapmargin',
2323 'textwidth', 'softtabstop' and Virtual Replace mode
2324 (see |gR|) count a <Tab> as two characters, instead of
2325 the normal behavior of a <Tab>.
2326 *cpo-m*
2327 m When included, a showmatch will always wait half a
2328 second. When not included, a showmatch will wait half
2329 a second or until a character is typed. |'showmatch'|
2330 *cpo-M*
2331 M When excluded, "%" matching will take backslashes into
2332 account. Thus in "( \( )" and "\( ( \)" the outer
2333 parenthesis match. When included "%" ignores
2334 backslashes, which is Vi compatible.
2335 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002336 n When included, the column used for 'number' and
2337 'relativenumber' will also be used for text of wrapped
2338 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339 *cpo-o*
2340 o Line offset to search command is not remembered for
2341 next search.
2342 *cpo-O*
2343 O Don't complain if a file is being overwritten, even
2344 when it didn't exist when editing it. This is a
2345 protection against a file unexpectedly created by
2346 someone else. Vi didn't complain about this.
2347 *cpo-p*
2348 p Vi compatible Lisp indenting. When not present, a
2349 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002350 *cpo-P*
2351 P When included, a ":write" command that appends to a
2352 file will set the file name for the current buffer, if
2353 the current buffer doesn't have a file name yet and
2354 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002355 *cpo-q*
2356 q When joining multiple lines leave the cursor at the
2357 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358 *cpo-r*
2359 r Redo ("." command) uses "/" to repeat a search
2360 command, instead of the actually used search string.
2361 *cpo-R*
2362 R Remove marks from filtered lines. Without this flag
2363 marks are kept like |:keepmarks| was used.
2364 *cpo-s*
2365 s Set buffer options when entering the buffer for the
2366 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002367 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368 set when the buffer is created.
2369 *cpo-S*
2370 S Set buffer options always when entering a buffer
2371 (except 'readonly', 'fileformat', 'filetype' and
2372 'syntax'). This is the (most) Vi compatible setting.
2373 The options are set to the values in the current
2374 buffer. When you change an option and go to another
2375 buffer, the value is copied. Effectively makes the
2376 buffer options global to all buffers.
2377
2378 's' 'S' copy buffer options
2379 no no when buffer created
2380 yes no when buffer first entered (default)
2381 X yes each time when buffer entered (vi comp.)
2382 *cpo-t*
2383 t Search pattern for the tag command is remembered for
2384 "n" command. Otherwise Vim only puts the pattern in
2385 the history for search pattern, but doesn't change the
2386 last used search pattern.
2387 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002388 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389 *cpo-v*
2390 v Backspaced characters remain visible on the screen in
2391 Insert mode. Without this flag the characters are
2392 erased from the screen right away. With this flag the
2393 screen newly typed text overwrites backspaced
2394 characters.
2395 *cpo-w*
2396 w When using "cw" on a blank character, only change one
2397 character and not all blanks until the start of the
2398 next word.
2399 *cpo-W*
2400 W Don't overwrite a readonly file. When omitted, ":w!"
2401 overwrites a readonly file, if possible.
2402 *cpo-x*
2403 x <Esc> on the command-line executes the command-line.
2404 The default in Vim is to abandon the command-line,
2405 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002406 *cpo-X*
2407 X When using a count with "R" the replaced text is
2408 deleted only once. Also when repeating "R" with "."
2409 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002411 y A yank command can be redone with ".". Think twice if
2412 you really want to use this, it may break some
2413 plugins, since most people expect "." to only repeat a
2414 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002415 *cpo-Z*
2416 Z When using "w!" while the 'readonly' option is set,
2417 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002418 *cpo-!*
2419 ! When redoing a filter command, use the last used
2420 external command, whatever it was. Otherwise the last
2421 used -filter- command is used.
2422 *cpo-$*
2423 $ When making a change to one line, don't redisplay the
2424 line, but put a '$' at the end of the changed text.
2425 The changed text will be overwritten when you type the
2426 new text. The line is redisplayed if you type any
2427 command that moves the cursor from the insertion
2428 point.
2429 *cpo-%*
2430 % Vi-compatible matching is done for the "%" command.
2431 Does not recognize "#if", "#endif", etc.
2432 Does not recognize "/*" and "*/".
2433 Parens inside single and double quotes are also
2434 counted, causing a string that contains a paren to
2435 disturb the matching. For example, in a line like
2436 "if (strcmp("foo(", s))" the first paren does not
2437 match the last one. When this flag is not included,
2438 parens inside single and double quotes are treated
2439 specially. When matching a paren outside of quotes,
2440 everything inside quotes is ignored. When matching a
2441 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002442 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002443 This flag is also used for other features, such as
2444 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002445 *cpo--*
2446 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002447 it would go above the first line or below the last
2448 line. Without it the cursor moves to the first or
2449 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002450 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002451 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002452 *cpo-+*
2453 + When included, a ":write file" command will reset the
2454 'modified' flag of the buffer, even though the buffer
2455 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002456 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002457 * Use ":*" in the same way as ":@". When not included,
2458 ":*" is an alias for ":'<,'>", select the Visual area.
2459 *cpo-<*
2460 < Disable the recognition of special key codes in |<>|
2461 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002462 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002463 ":map X <Tab>" results in X being mapped to:
2464 '<' included: "<Tab>" (5 characters)
2465 '<' excluded: "^I" (^I is a real <Tab>)
2466 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002467 *cpo->*
2468 > When appending to a register, put a line break before
2469 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002470 *cpo-;*
2471 ; When using |,| or |;| to repeat the last |t| search
2472 and the cursor is right in front of the searched
2473 character, the cursor won't move. When not included,
2474 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002475 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002476
2477 POSIX flags. These are not included in the Vi default value, except
2478 when $VIM_POSIX was set on startup. |posix|
2479
2480 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002481 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002482 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002483 *cpo-&*
2484 & When ":preserve" was used keep the swap file when
2485 exiting normally while this buffer is still loaded.
2486 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002487 *cpo-\*
2488 \ Backslash in a [] range in a search pattern is taken
2489 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002490 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2491 '\' excluded: "/[ \-]" finds <Space> and '-'
2492 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002493 *cpo-/*
2494 / When "%" is used as the replacement string in a |:s|
2495 command, use the previous replacement string. |:s%|
2496 *cpo-{*
2497 { The |{| and |}| commands also stop at a "{" character
2498 at the start of a line.
2499 *cpo-.*
2500 . The ":chdir" and ":cd" commands fail if the current
2501 buffer is modified, unless ! is used. Vim doesn't
2502 need this, since it remembers the full path of an
2503 opened file.
2504 *cpo-bar*
2505 | The value of the $LINES and $COLUMNS environment
2506 variables overrule the terminal size values obtained
2507 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002508
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002510 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002511'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002512 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002513 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002514 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002515 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002516 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002517 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002518 blowfish Blowfish method. Medium strong encryption but it has
2519 an implementation flaw. Requires Vim 7.3 or later,
2520 files can NOT be read by Vim 7.2 and older. This adds
2521 a "seed" to the file, every time you write the file
2522 the encrypted bytes will be different.
2523 *blowfish2*
2524 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002525 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002526 and older. This adds a "seed" to the file, every time
2527 you write the file the encrypted bytes will be
2528 different. The whole undo file is encrypted, not just
2529 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002530 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002531 *E1197* *E1198* *E1199* *E1200* *E1201*
2532 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2533 Code. Medium strong till strong encryption.
2534 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002535 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002536 It adds a seed and a message authentication code (MAC)
2537 to the file. This needs at least a Vim 8.2.3022 to
2538 read the encrypted file.
2539 Encryption of swap files is not supported, therefore
2540 no swap file will be used when xchacha20 encryption is
2541 enabled.
2542 Encryption of undo files is not yet supported,
2543 therefore no undo file will currently be written.
2544 CURRENTLY EXPERIMENTAL: Files written with this method
2545 might have to be read back with the same version of
2546 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002547
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002548 You should use "blowfish2", also to re-encrypt older files.
2549
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002550 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002551 to the detected method of the file being read. Thus if you write it
2552 without changing 'cryptmethod' the same method will be used.
2553 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002554 explicitly write it, you don't get a warning unless there are other
2555 modifications. Also see |:X|.
2556
2557 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002558 the value "blowfish2". When setting the local value to an empty
2559 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002560
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002561 When a new encryption method is added in a later version of Vim, and
2562 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002563 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002564
2565
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566 *'cscopepathcomp'* *'cspc'*
2567'cscopepathcomp' 'cspc' number (default 0)
2568 global
2569 {not available when compiled without the |+cscope|
2570 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 Determines how many components of the path to show in a list of tags.
2572 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002573 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574
2575 *'cscopeprg'* *'csprg'*
2576'cscopeprg' 'csprg' string (default "cscope")
2577 global
2578 {not available when compiled without the |+cscope|
2579 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580 Specifies the command to execute cscope. See |cscopeprg|.
2581 This option cannot be set from a |modeline| or in the |sandbox|, for
2582 security reasons.
2583
2584 *'cscopequickfix'* *'csqf'*
2585'cscopequickfix' 'csqf' string (default "")
2586 global
2587 {not available when compiled without the |+cscope|
2588 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589 Specifies whether to use quickfix window to show cscope results.
2590 See |cscopequickfix|.
2591
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002592 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002593'cscoperelative' 'csre' boolean (default off)
2594 global
2595 {not available when compiled without the |+cscope|
2596 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002597 In the absence of a prefix (-P) for cscope. setting this option enables
2598 to use the basename of cscope.out path as the prefix.
2599 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002600 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002601
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2603'cscopetag' 'cst' boolean (default off)
2604 global
2605 {not available when compiled without the |+cscope|
2606 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002607 Use cscope for tag commands. See |cscope-options|.
2608 NOTE: This option is reset when 'compatible' is set.
2609
2610 *'cscopetagorder'* *'csto'*
2611'cscopetagorder' 'csto' number (default 0)
2612 global
2613 {not available when compiled without the |+cscope|
2614 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615 Determines the order in which ":cstag" performs a search. See
2616 |cscopetagorder|.
2617 NOTE: This option is set to 0 when 'compatible' is set.
2618
2619 *'cscopeverbose'* *'csverb'*
2620 *'nocscopeverbose'* *'nocsverb'*
2621'cscopeverbose' 'csverb' boolean (default off)
2622 global
2623 {not available when compiled without the |+cscope|
2624 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 Give messages when adding a cscope database. See |cscopeverbose|.
2626 NOTE: This option is reset when 'compatible' is set.
2627
Bram Moolenaar860cae12010-06-05 23:22:07 +02002628 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2629'cursorbind' 'crb' boolean (default off)
2630 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002631 When this option is set, as the cursor in the current
2632 window moves other cursorbound windows (windows that also have
2633 this option set) move their cursors to the corresponding line and
2634 column. This option is useful for viewing the
2635 differences between two versions of a file (see 'diff'); in diff mode,
2636 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002637 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002638
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002639
2640 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2641'cursorcolumn' 'cuc' boolean (default off)
2642 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002643 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002644 feature}
2645 Highlight the screen column of the cursor with CursorColumn
2646 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2647 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002648 If you only want the highlighting in the current window you can use
2649 these autocommands: >
2650 au WinLeave * set nocursorline nocursorcolumn
2651 au WinEnter * set cursorline cursorcolumn
2652<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002653
2654 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2655'cursorline' 'cul' boolean (default off)
2656 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002657 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002658 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002659 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2660 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002661 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002662 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002663
2664
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002665 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002666'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002667 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002668 {not available when compiled without the |+syntax|
2669 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002670 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002671 Valid values:
2672 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002673 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002674 "screenline" Highlight only the screen line of the cursor with
2675 CursorLine |hl-CursorLine|.
2676 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002677 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002678
2679 Special value:
2680 "both" Alias for the values "line,number".
2681
2682 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002683
2684
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 *'debug'*
2686'debug' string (default "")
2687 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002688 These values can be used:
2689 msg Error messages that would otherwise be omitted will be given
2690 anyway.
2691 throw Error messages that would otherwise be omitted will be given
2692 anyway and also throw an exception and set |v:errmsg|.
2693 beep A message will be given when otherwise only a beep would be
2694 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002695 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002696 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2697 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698
2699 *'define'* *'def'*
2700'define' 'def' string (default "^\s*#\s*define")
2701 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002702 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703 pattern, just like for the "/" command. This option is used for the
2704 commands like "[i" and "[d" |include-search|. The 'isident' option is
2705 used to recognize the defined name after the match:
2706 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2707 See |option-backslash| about inserting backslashes to include a space
2708 or backslash.
2709 The default value is for C programs. For C++ this value would be
2710 useful, to include const type declarations: >
2711 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002712< You can also use "\ze" just before the name and continue the pattern
2713 to check what is following. E.g. for Javascript, if a function is
2714 defined with "func_name = function(args)": >
2715 ^\s*\ze\i\+\s*=\s*function(
2716< If the function is defined with "func_name : function() {...": >
2717 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002719 To avoid that use `:let` with a single quote string: >
2720 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002721<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722
2723 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2724'delcombine' 'deco' boolean (default off)
2725 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002726 If editing Unicode and this option is set, backspace and Normal mode
2727 "x" delete each combining character on its own. When it is off (the
2728 default) the character along with its combining characters are
2729 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002730 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731
2732 This is useful for Arabic, Hebrew and many other languages where one
2733 may have combining characters overtop of base characters, and want
2734 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002735 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736
2737 *'dictionary'* *'dict'*
2738'dictionary' 'dict' string (default "")
2739 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740 List of file names, separated by commas, that are used to lookup words
2741 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2742 contain a list of words. This can be one word per line, or several
2743 words per line, separated by non-keyword characters (white space is
2744 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002745
2746 When this option is empty or an entry "spell" is present, and spell
2747 checking is enabled, words in the word lists for the currently active
2748 'spelllang' are used. See |spell|.
2749
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002750 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 after a comma are ignored, otherwise spaces are included in the file
2752 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002753 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 Where to find a list of words?
2755 - On FreeBSD, there is the file "/usr/share/dict/words".
2756 - In the Simtel archive, look in the "msdos/linguist" directory.
2757 - In "miscfiles" of the GNU collection.
2758 The use of |:set+=| and |:set-=| is preferred when adding or removing
2759 directories from the list. This avoids problems when a future version
2760 uses another default.
2761 Backticks cannot be used in this option for security reasons.
2762
2763 *'diff'* *'nodiff'*
2764'diff' boolean (default off)
2765 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 {not available when compiled without the |+diff|
2767 feature}
2768 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002769 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770
2771 *'dex'* *'diffexpr'*
2772'diffexpr' 'dex' string (default "")
2773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 {not available when compiled without the |+diff|
2775 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002776 Expression which is evaluated to obtain a diff file (either ed-style
2777 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 This option cannot be set from a |modeline| or in the |sandbox|, for
2779 security reasons.
2780
2781 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002782'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 {not available when compiled without the |+diff|
2785 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002786 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787 All are optional. Items must be separated by a comma.
2788
2789 filler Show filler lines, to keep the text
2790 synchronized with a window that has inserted
2791 lines at the same position. Mostly useful
2792 when windows are side-by-side and 'scrollbind'
2793 is set.
2794
2795 context:{n} Use a context of {n} lines between a change
2796 and a fold that contains unchanged lines.
2797 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002798 When using zero the context is actually one,
2799 since folds require a line in between, also
2800 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002801 See |fold-diff|.
2802
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002803 iblank Ignore changes where lines are all blank. Adds
2804 the "-B" flag to the "diff" command if
2805 'diffexpr' is empty. Check the documentation
2806 of the "diff" command for what this does
2807 exactly.
2808 NOTE: the diff windows will get out of sync,
2809 because no differences between blank lines are
2810 taken into account.
2811
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 icase Ignore changes in case of text. "a" and "A"
2813 are considered the same. Adds the "-i" flag
2814 to the "diff" command if 'diffexpr' is empty.
2815
2816 iwhite Ignore changes in amount of white space. Adds
2817 the "-b" flag to the "diff" command if
2818 'diffexpr' is empty. Check the documentation
2819 of the "diff" command for what this does
2820 exactly. It should ignore adding trailing
2821 white space, but not leading white space.
2822
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002823 iwhiteall Ignore all white space changes. Adds
2824 the "-w" flag to the "diff" command if
2825 'diffexpr' is empty. Check the documentation
2826 of the "diff" command for what this does
2827 exactly.
2828
2829 iwhiteeol Ignore white space changes at end of line.
2830 Adds the "-Z" flag to the "diff" command if
2831 'diffexpr' is empty. Check the documentation
2832 of the "diff" command for what this does
2833 exactly.
2834
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002835 horizontal Start diff mode with horizontal splits (unless
2836 explicitly specified otherwise).
2837
2838 vertical Start diff mode with vertical splits (unless
2839 explicitly specified otherwise).
2840
Bram Moolenaarc8234772019-11-10 21:00:27 +01002841 closeoff When a window is closed where 'diff' is set
2842 and there is only one window remaining in the
2843 same tab page with 'diff' set, execute
2844 `:diffoff` in that window. This undoes a
2845 `:diffsplit` command.
2846
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002847 hiddenoff Do not use diff mode for a buffer when it
2848 becomes hidden.
2849
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002850 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2851 starting diff mode. Without this 2 is used.
2852
Bram Moolenaar4223d432021-02-10 13:18:17 +01002853 followwrap Follow the 'wrap' option and leave as it is.
2854
Bram Moolenaare828b762018-09-10 17:51:58 +02002855 internal Use the internal diff library. This is
2856 ignored when 'diffexpr' is set. *E960*
2857 When running out of memory when writing a
2858 buffer this item will be ignored for diffs
2859 involving that buffer. Set the 'verbose'
2860 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002861
Bram Moolenaare828b762018-09-10 17:51:58 +02002862 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002863 Use the indent heuristic for the internal
2864 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002865
2866 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002867 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002868 algorithms are:
2869 myers the default algorithm
2870 minimal spend extra time to generate the
2871 smallest possible diff
2872 patience patience diff algorithm
2873 histogram histogram diff algorithm
2874
2875 Examples: >
2876 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002878 :set diffopt=internal,filler,foldcolumn:3
2879 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880<
2881 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2882'digraph' 'dg' boolean (default off)
2883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002884 {not available when compiled without the |+digraphs|
2885 feature}
2886 Enable the entering of digraphs in Insert mode with {char1} <BS>
2887 {char2}. See |digraphs|.
2888 NOTE: This option is reset when 'compatible' is set.
2889
2890 *'directory'* *'dir'*
2891'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002892 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 for Unix: ".,~/tmp,/var/tmp,/tmp")
2894 global
2895 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002896 Recommended value: ".,~/vimswap//" - this will put the swap file next
2897 to the edited file if possible, and in your personal swap directory
2898 otherwise. Make sure "~/vimswap//" is only readable for you.
2899
2900 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 - The swap file will be created in the first directory where this is
2902 possible.
2903 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002904 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 - A directory "." means to put the swap file in the same directory as
2906 the edited file. On Unix, a dot is prepended to the file name, so
2907 it doesn't show in a directory listing. On MS-Windows the "hidden"
2908 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002909 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2910 the swap file relative to where the edited file is. The leading "."
2911 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002912 - For Unix and Win32, if a directory ends in two path separators "//",
2913 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002914 with all path separators replaced by percent '%' signs (including
2915 the colon following the drive letter on Win32). This will ensure
2916 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002917 On Win32, it is also possible to end with "\\". However, When a
2918 separating comma is following, you must use "//", since "\\" will
2919 include the comma in the file name. Therefore it is recommended to
2920 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 - Spaces after the comma are ignored, other spaces are considered part
2922 of the directory name. To have a space at the start of a directory
2923 name, precede it with a backslash.
2924 - To include a comma in a directory name precede it with a backslash.
2925 - A directory name may end in an ':' or '/'.
2926 - Environment variables are expanded |:set_env|.
2927 - Careful with '\' characters, type one before a space, type two to
2928 get one in the option (see |option-backslash|), for example: >
2929 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2930< - For backwards compatibility with Vim version 3.0 a '>' at the start
2931 of the option is removed.
2932 Using "." first in the list is recommended. This means that editing
2933 the same file twice will result in a warning. Using "/tmp" on Unix is
2934 discouraged: When the system crashes you lose the swap file.
2935 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002936 choice than "/tmp". But others on the computer may be able to see the
2937 files, and it can contain a lot of files, your swap files get lost in
2938 the crowd. That is why a "tmp" directory in your home directory is
2939 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 The use of |:set+=| and |:set-=| is preferred when adding or removing
2941 directories from the list. This avoids problems when a future version
2942 uses another default.
2943 This option cannot be set from a |modeline| or in the |sandbox|, for
2944 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945
2946 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002947'display' 'dy' string (default "", set to "truncate" in
2948 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002950 Change the way text is displayed. This is comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 flags:
2952 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002953 in a window will be displayed. "@@@" is put in the
2954 last columns of the last screen line to indicate the
2955 rest of the line is not displayed.
2956 truncate Like "lastline", but "@@@" is displayed in the first
2957 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 uhex Show unprintable characters hexadecimal as <xx>
2959 instead of using ^C and ~C.
2960
Bram Moolenaard0796902016-09-16 20:02:31 +02002961 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002962 doesn't fit is replaced with "@" lines.
2963
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 *'eadirection'* *'ead'*
2965'eadirection' 'ead' string (default "both")
2966 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 Tells when the 'equalalways' option applies:
2968 ver vertically, width of windows is not affected
2969 hor horizontally, height of windows is not affected
2970 both width and height of windows is affected
2971
2972 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2973'edcompatible' 'ed' boolean (default off)
2974 global
2975 Makes the 'g' and 'c' flags of the ":substitute" command to be
2976 toggled each time the flag is given. See |complex-change|. See
2977 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002978 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002979 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980
Bram Moolenaar03413f42016-04-12 21:07:15 +02002981 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002982'emoji' 'emo' boolean (default: on)
2983 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002984 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002985 This excludes "text emoji" characters, which are normally displayed as
2986 single width. Unfortunately there is no good specification for this
2987 and it has been determined on trial-and-error basis. Use the
2988 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002989
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002991'encoding' 'enc' string (default for MS-Windows: "utf-8",
2992 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 Sets the character encoding used inside Vim. It applies to text in
2995 the buffers, registers, Strings in expressions, text stored in the
2996 viminfo file, etc. It sets the kind of characters which Vim can work
2997 with. See |encoding-names| for the possible values.
2998
2999 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003000 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003002 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003
Bram Moolenaar865242e2010-07-14 21:12:05 +02003004 This option cannot be set from a |modeline|. It would most likely
3005 corrupt the text.
3006
Bram Moolenaar3df01732017-02-17 22:47:16 +01003007 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3008 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 'encoding', "utf-8" is the natural choice for the environment and
3010 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003011 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 versions, and to avoid changing the encoding of newly created files
3013 without your knowledge (in case 'fileencodings' is empty).
3014
3015 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003016 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 iconv() or as specified with 'charconvert'.
3018
Bram Moolenaar207f0092020-08-30 17:20:20 +02003019 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003020 can use: >
3021 if has("multi_byte_encoding")
3022<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 Normally 'encoding' will be equal to your current locale. This will
3024 be the default if Vim recognizes your environment settings. If
3025 'encoding' is not set to the current locale, 'termencoding' must be
3026 set to convert typed and displayed text. See |encoding-table|.
3027
3028 When you set this option, it fires the |EncodingChanged| autocommand
3029 event so that you can set up fonts if necessary.
3030
3031 When the option is set, the value is converted to lowercase. Thus
3032 you can set it with uppercase values too. Underscores are translated
3033 to '-' signs.
3034 When the encoding is recognized, it is changed to the standard name.
3035 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3036 "iso-8859-2" and "utf8" becomes "utf-8".
3037
3038 Note: "latin1" is also used when the encoding could not be detected.
3039 This only works when editing files in the same encoding! When the
3040 actual character set is not latin1, make sure 'fileencoding' and
3041 'fileencodings' are empty. When conversion is needed, switch to using
3042 utf-8.
3043
3044 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3045 You don't notice this while editing, but it does matter for the
3046 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3047 setting 'encoding' to one of these values instead of utf-8 only has
3048 effect for encoding used for files when 'fileencoding' is empty.
3049
Bram Moolenaar661b1822005-07-28 22:36:45 +00003050 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3051 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052
3053 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3054'endofline' 'eol' boolean (default on)
3055 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003057 is on, or 'fixeol' option is off, no <EOL> will be written for the
3058 last line in the file. This option is automatically set or reset when
3059 starting to edit a new file, depending on whether file has an <EOL>
3060 for the last line in the file. Normally you don't have to set or
3061 reset this option.
3062 When 'binary' is off and 'fixeol' is on the value is not used when
3063 writing the file. When 'binary' is on or 'fixeol' is off it is used
3064 to remember the presence of a <EOL> for the last line in the file, so
3065 that when you write the file the situation from the original file can
3066 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067
3068 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3069'equalalways' 'ea' boolean (default on)
3070 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003072 splitting or closing a window. This also happens the moment the
3073 option is switched on. When off, splitting a window will reduce the
3074 size of the current window and leave the other windows the same. When
3075 closing a window the extra lines are given to the window next to it
3076 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077 When mixing vertically and horizontally split windows, a minimal size
3078 is computed and some windows may be larger if there is room. The
3079 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003080 Changing the height and width of a window can be avoided by setting
3081 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003082 If a window size is specified when creating a new window sizes are
3083 currently not equalized (it's complicated, but may be implemented in
3084 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085
3086 *'equalprg'* *'ep'*
3087'equalprg' 'ep' string (default "")
3088 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003090 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003091 or 'indentexpr'. When Vim was compiled without internal formatting,
3092 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003093 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 about including spaces and backslashes.
3095 This option cannot be set from a |modeline| or in the |sandbox|, for
3096 security reasons.
3097
3098 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3099'errorbells' 'eb' boolean (default off)
3100 global
3101 Ring the bell (beep or screen flash) for error messages. This only
3102 makes a difference for error messages, the bell will be used always
3103 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003104 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003105 screen flash or do nothing. See 'belloff' to finetune when to ring the
3106 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107
3108 *'errorfile'* *'ef'*
3109'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3110 others: "errors.err")
3111 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 {not available when compiled without the |+quickfix|
3113 feature}
3114 Name of the errorfile for the QuickFix mode (see |:cf|).
3115 When the "-q" command-line argument is used, 'errorfile' is set to the
3116 following argument. See |-q|.
3117 NOT used for the ":make" command. See 'makeef' for that.
3118 Environment variables are expanded |:set_env|.
3119 See |option-backslash| about including spaces and backslashes.
3120 This option cannot be set from a |modeline| or in the |sandbox|, for
3121 security reasons.
3122
3123 *'errorformat'* *'efm'*
3124'errorformat' 'efm' string (default is very long)
3125 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126 {not available when compiled without the |+quickfix|
3127 feature}
3128 Scanf-like description of the format for the lines in the error file
3129 (see |errorformat|).
3130
3131 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3132'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3133 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 Function keys that start with an <Esc> are recognized in Insert
3135 mode. When this option is off, the cursor and function keys cannot be
3136 used in Insert mode if they start with an <Esc>. The advantage of
3137 this is that the single <Esc> is recognized immediately, instead of
3138 after one second. Instead of resetting this option, you might want to
3139 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3140 when 'esckeys' is off, you can still map anything, but the cursor keys
3141 won't work by default.
3142 NOTE: This option is set to the Vi default value when 'compatible' is
3143 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003144 NOTE: when this option is off then the |modifyOtherKeys| functionality
3145 is disabled while in Insert mode to avoid ending Insert mode with any
3146 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147
3148 *'eventignore'* *'ei'*
3149'eventignore' 'ei' string (default "")
3150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003152 When set to "all" or when "all" is one of the items, all autocommand
3153 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003154 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155 :set ei=WinEnter,WinLeave
3156<
3157 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3158'expandtab' 'et' boolean (default off)
3159 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003161 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3163 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003164 This option is reset when the 'paste' option is set and restored when
3165 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166 NOTE: This option is reset when 'compatible' is set.
3167
3168 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3169'exrc' 'ex' boolean (default off)
3170 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003172 directory.
3173
3174 Setting this option is a potential security leak. E.g., consider
3175 unpacking a package or fetching files from github, a .vimrc in there
3176 might be a trojan horse. BETTER NOT SET THIS OPTION!
3177 Instead, define an autocommand in your .vimrc to set options for a
3178 matching directory.
3179
3180 If you do switch this option on you should also consider setting the
3181 'secure' option (see |initialization|).
3182 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 This option cannot be set from a |modeline| or in the |sandbox|, for
3184 security reasons.
3185
3186 *'fileencoding'* *'fenc'* *E213*
3187'fileencoding' 'fenc' string (default: "")
3188 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003190
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003192 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 When 'fileencoding' is empty, the same value as 'encoding' will be
3194 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003195 No error will be given when the value is set, only when it is used,
3196 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003197 Conversion will also be done when 'encoding' and 'fileencoding' are
3198 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3199 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003201 'encoding' is "utf-8" or another Unicode encoding, conversion
3202 is most likely done in a way that the reverse conversion
3203 results in the same text. When 'encoding' is not "utf-8" some
3204 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003205
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 See 'encoding' for the possible values. Additionally, values may be
3207 specified that can be handled by the converter, see
3208 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003209
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 When reading a file 'fileencoding' will be set from 'fileencodings'.
3211 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003212 'fileencoding', use the |++enc| argument. One exception: when
3213 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003214 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003215
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3217 When the option is set, the value is converted to lowercase. Thus
3218 you can set it with uppercase values too. '_' characters are
3219 replaced with '-'. If a name is recognized from the list for
3220 'encoding', it is replaced by the standard name. For example
3221 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003222
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 When this option is set, after starting to edit a file, the 'modified'
3224 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003225
3226 Keep in mind that changing 'fenc' from a modeline happens
3227 AFTER the text has been read, thus it applies to when the file will be
3228 written. If you do set 'fenc' in a modeline, you might want to set
3229 'nomodified' to avoid not being able to ":q".
3230
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231 This option can not be changed when 'modifiable' is off.
3232
3233 *'fe'*
3234 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003235 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 old short name was 'fe', which is no longer used.
3237
3238 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003239'fileencodings' 'fencs' string (default: "ucs-bom",
3240 "ucs-bom,utf-8,default,latin1" when
3241 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 This is a list of character encodings considered when starting to edit
3244 an existing file. When a file is read, Vim tries to use the first
3245 mentioned character encoding. If an error is detected, the next one
3246 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003247 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 an empty string, which means the value of 'encoding' is used.
3249 WARNING: Conversion can cause loss of information! When
3250 'encoding' is "utf-8" (or one of the other Unicode variants)
3251 conversion is most likely done in a way that the reverse
3252 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003253 "utf-8" some non-ASCII characters may be lost! You can use
3254 the |++bad| argument to specify what is done with characters
3255 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256 For an empty file or a file with only ASCII characters most encodings
3257 will work and the first entry of 'fileencodings' will be used (except
3258 "ucs-bom", which requires the BOM to be present). If you prefer
3259 another encoding use an BufReadPost autocommand event to test if your
3260 preferred encoding is to be used. Example: >
3261 au BufReadPost * if search('\S', 'w') == 0 |
3262 \ set fenc=iso-2022-jp | endif
3263< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3264 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003265 When the |++enc| argument is used then the value of 'fileencodings' is
3266 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003267 Note that 'fileencodings' is not used for a new file, the global value
3268 of 'fileencoding' is used instead. You can set it with: >
3269 :setglobal fenc=iso-8859-2
3270< This means that a non-existing file may get a different encoding than
3271 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 The special value "ucs-bom" can be used to check for a Unicode BOM
3273 (Byte Order Mark) at the start of the file. It must not be preceded
3274 by "utf-8" or another Unicode encoding for this to work properly.
3275 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3276 because Vim cannot detect an error, thus the encoding is always
3277 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003278 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003279 environment. On MS-Windows this is the system encoding. Otherwise
3280 this is the default value for 'encoding'. It is useful when
3281 'encoding' is set to "utf-8" and your environment uses a non-latin1
3282 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003283 When 'encoding' is "utf-8" and a file contains an illegal byte
3284 sequence it won't be recognized as UTF-8. You can use the |8g8|
3285 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 WRONG VALUES: WHAT'S WRONG:
3287 latin1,utf-8 "latin1" will always be used
3288 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3289 file
3290 cp1250,latin1 "cp1250" will always be used
3291 If 'fileencodings' is empty, 'fileencoding' is not modified.
3292 See 'fileencoding' for the possible values.
3293 Setting this option does not have an effect until the next time a file
3294 is read.
3295
3296 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003297'fileformat' 'ff' string (MS-Windows default: "dos",
3298 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 This gives the <EOL> of the current buffer, which is used for
3301 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003302 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 unix <NL>
3304 mac <CR>
3305 When "dos" is used, CTRL-Z at the end of a file is ignored.
3306 See |file-formats| and |file-read|.
3307 For the character encoding of the file see 'fileencoding'.
3308 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003309 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 This option is set automatically when starting to edit a file and
3311 'fileformats' is not empty and 'binary' is off.
3312 When this option is set, after starting to edit a file, the 'modified'
3313 option is set, because the file would be different when written.
3314 This option can not be changed when 'modifiable' is off.
3315 For backwards compatibility: When this option is set to "dos",
3316 'textmode' is set, otherwise 'textmode' is reset.
3317
3318 *'fileformats'* *'ffs'*
3319'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003320 Vim+Vi MS-Windows: "dos,unix",
3321 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 Vi Cygwin: "unix,dos",
3323 Vi others: "")
3324 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 This gives the end-of-line (<EOL>) formats that will be tried when
3326 starting to edit a new buffer and when reading a file into an existing
3327 buffer:
3328 - When empty, the format defined with 'fileformat' will be used
3329 always. It is not set automatically.
3330 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003331 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 'fileformats' name will be used when a file is read into an existing
3333 buffer, no matter what 'fileformat' for that buffer is set to.
3334 - When more than one name is present, separated by commas, automatic
3335 <EOL> detection will be done when reading a file. When starting to
3336 edit a file, a check is done for the <EOL>:
3337 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3338 'fileformat' is set to "dos".
3339 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003340 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003342 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3343 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003344 This means that "mac" is only chosen when:
3345 "unix" is not present or no <NL> is found in the file, and
3346 "dos" is not present or no <CR><NL> is found in the file.
3347 Except: if "unix" was chosen, but there is a <CR> before
3348 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003349 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 4. If 'fileformat' is still not set, the first name from
3351 'fileformats' is used.
3352 When reading a file into an existing buffer, the same is done, but
3353 this happens like 'fileformat' has been set appropriately for that
3354 file only, the option is not changed.
3355 When 'binary' is set, the value of 'fileformats' is not used.
3356
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003357 When Vim starts up with an empty buffer the first item is used. You
3358 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003359
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3361 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3362 done:
3363 - When 'fileformats' is empty, there is no automatic detection. Dos
3364 format will be used.
3365 - When 'fileformats' is set to one or more names, automatic detection
3366 is done. This is based on the first <NL> in the file: If there is a
3367 <CR> in front of it, Dos format is used, otherwise Unix format is
3368 used.
3369 Also see |file-formats|.
3370 For backwards compatibility: When this option is set to an empty
3371 string or one format (no comma is included), 'textauto' is reset,
3372 otherwise 'textauto' is set.
3373 NOTE: This option is set to the Vi default value when 'compatible' is
3374 set and to the Vim default value when 'compatible' is reset.
3375
Bram Moolenaarbf884932013-04-05 22:26:15 +02003376 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3377'fileignorecase' 'fic' boolean (default on for systems where case in file
3378 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003379 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003380 When set case is ignored when using file names and directories.
3381 See 'wildignorecase' for only ignoring case when doing completion.
3382
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 *'filetype'* *'ft'*
3384'filetype' 'ft' string (default: "")
3385 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 When this option is set, the FileType autocommand event is triggered.
3387 All autocommands that match with the value of this option will be
3388 executed. Thus the value of 'filetype' is used in place of the file
3389 name.
3390 Otherwise this option does not always reflect the current file type.
3391 This option is normally set when the file type is detected. To enable
3392 this use the ":filetype on" command. |:filetype|
3393 Setting this option to a different value is most useful in a modeline,
3394 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003395 Example, for in an IDL file:
3396 /* vim: set filetype=idl : */ ~
3397 |FileType| |filetypes|
3398 When a dot appears in the value then this separates two filetype
3399 names. Example:
3400 /* vim: set filetype=c.doxygen : */ ~
3401 This will use the "c" filetype first, then the "doxygen" filetype.
3402 This works both for filetype plugins and for syntax files. More than
3403 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404 This option is not copied to another buffer, independent of the 's' or
3405 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003406 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407
3408 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003409'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003410 global or local to window |global-local|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003411 {not available when compiled without the |+folding|
3412 feature}
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003413 Characters to fill the statuslines, vertical separators and special
3414 lines in the window.
3415 It is a comma-separated list of items. Each item has a name, a colon
3416 and the value of that item:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003418 item name default Used for ~
3419 stl ' ' or '^' statusline of the current window
3420 stlnc ' ' or '=' statusline of the non-current windows
3421 vert '|' vertical separators |:vsplit|
3422 fold '-' filling 'foldtext'
3423 foldopen '-' mark the beginning of a fold
3424 foldclose '+' show a closed fold
3425 foldsep '|' open fold middle character
3426 diff '-' deleted lines of the 'diff' option
3427 eob '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003428
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003429 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003430 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 otherwise.
3432
3433 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003434 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435< This is similar to the default, except that these characters will also
3436 be used when there is highlighting.
3437
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003438 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3439 single-byte and multibyte characters are supported. But double-width
3440 characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003441
Bram Moolenaar071d4272004-06-13 20:20:40 +00003442 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003443 item name highlight group ~
3444 stl StatusLine |hl-StatusLine|
3445 stlnc StatusLineNC |hl-StatusLineNC|
3446 vert VertSplit |hl-VertSplit|
3447 fold Folded |hl-Folded|
3448 diff DiffDelete |hl-DiffDelete|
3449 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003450
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003451 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3452'fixendofline' 'fixeol' boolean (default on)
3453 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003454 When writing a file and this option is on, <EOL> at the end of file
3455 will be restored if missing. Turn this option off if you want to
3456 preserve the situation from the original file.
3457 When the 'binary' option is set the value of this option doesn't
3458 matter.
3459 See the 'endofline' option.
3460
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003462'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 {only available when compiled with the |+rightleft|
3465 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003466 This option was for using Farsi, which has been removed. See
3467 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468
3469 *'foldclose'* *'fcl'*
3470'foldclose' 'fcl' string (default "")
3471 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 {not available when compiled without the |+folding|
3473 feature}
3474 When set to "all", a fold is closed when the cursor isn't in it and
3475 its level is higher than 'foldlevel'. Useful if you want folds to
3476 automatically close when moving out of them.
3477
3478 *'foldcolumn'* *'fdc'*
3479'foldcolumn' 'fdc' number (default 0)
3480 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481 {not available when compiled without the |+folding|
3482 feature}
3483 When non-zero, a column with the specified width is shown at the side
3484 of the window which indicates open and closed folds. The maximum
3485 value is 12.
3486 See |folding|.
3487
3488 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3489'foldenable' 'fen' boolean (default on)
3490 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 {not available when compiled without the |+folding|
3492 feature}
3493 When off, all folds are open. This option can be used to quickly
3494 switch between showing all text unfolded and viewing the text with
3495 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003496 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 'foldenable' is off.
3498 This option is set by commands that create a new fold or close a fold.
3499 See |folding|.
3500
3501 *'foldexpr'* *'fde'*
3502'foldexpr' 'fde' string (default: "0")
3503 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003505 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003507 for each line to obtain its fold level. The context is set to the
3508 script where 'foldexpr' was set, script-local items can be accessed.
3509 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003510
Bram Moolenaar30b65812012-07-12 22:01:11 +02003511 The expression will be evaluated in the |sandbox| if set from a
3512 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003513 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003514 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003515
3516 It is not allowed to change text or jump to another window while
3517 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518
3519 *'foldignore'* *'fdi'*
3520'foldignore' 'fdi' string (default: "#")
3521 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522 {not available when compiled without the |+folding|
3523 feature}
3524 Used only when 'foldmethod' is "indent". Lines starting with
3525 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003526 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 The default "#" works well for C programs. See |fold-indent|.
3528
3529 *'foldlevel'* *'fdl'*
3530'foldlevel' 'fdl' number (default: 0)
3531 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 {not available when compiled without the |+folding|
3533 feature}
3534 Sets the fold level: Folds with a higher level will be closed.
3535 Setting this option to zero will close all folds. Higher numbers will
3536 close fewer folds.
3537 This option is set by commands like |zm|, |zM| and |zR|.
3538 See |fold-foldlevel|.
3539
3540 *'foldlevelstart'* *'fdls'*
3541'foldlevelstart' 'fdls' number (default: -1)
3542 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 {not available when compiled without the |+folding|
3544 feature}
3545 Sets 'foldlevel' when starting to edit another buffer in a window.
3546 Useful to always start editing with all folds closed (value zero),
3547 some folds closed (one) or no folds closed (99).
3548 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003549 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 ignores this option and closes all folds.
3551 It is also done before BufReadPre autocommands, to allow an autocmd to
3552 overrule the 'foldlevel' value for specific files.
3553 When the value is negative, it is not used.
3554
3555 *'foldmarker'* *'fmr'* *E536*
3556'foldmarker' 'fmr' string (default: "{{{,}}}")
3557 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 {not available when compiled without the |+folding|
3559 feature}
3560 The start and end marker used when 'foldmethod' is "marker". There
3561 must be one comma, which separates the start and end marker. The
3562 marker is a literal string (a regular expression would be too slow).
3563 See |fold-marker|.
3564
3565 *'foldmethod'* *'fdm'*
3566'foldmethod' 'fdm' string (default: "manual")
3567 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 {not available when compiled without the |+folding|
3569 feature}
3570 The kind of folding used for the current window. Possible values:
3571 |fold-manual| manual Folds are created manually.
3572 |fold-indent| indent Lines with equal indent form a fold.
3573 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3574 |fold-marker| marker Markers are used to specify folds.
3575 |fold-syntax| syntax Syntax highlighting items specify folds.
3576 |fold-diff| diff Fold text that is not changed.
3577
3578 *'foldminlines'* *'fml'*
3579'foldminlines' 'fml' number (default: 1)
3580 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 {not available when compiled without the |+folding|
3582 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003583 Sets the number of screen lines above which a fold can be displayed
3584 closed. Also for manually closed folds. With the default value of
3585 one a fold can only be closed if it takes up two or more screen lines.
3586 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003587 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003588 "zc" to close a fold, which is displayed open because it's smaller
3589 than 'foldminlines', a following "zc" may close a containing fold.
3590
3591 *'foldnestmax'* *'fdn'*
3592'foldnestmax' 'fdn' number (default: 20)
3593 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 {not available when compiled without the |+folding|
3595 feature}
3596 Sets the maximum nesting of folds for the "indent" and "syntax"
3597 methods. This avoids that too many folds will be created. Using more
3598 than 20 doesn't work, because the internal limit is 20.
3599
3600 *'foldopen'* *'fdo'*
3601'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3602 search,tag,undo")
3603 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 {not available when compiled without the |+folding|
3605 feature}
3606 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003607 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003609 NOTE: When the command is part of a mapping this option is not used.
3610 Add the |zv| command to the mapping to get the same effect.
3611 (rationale: the mapping may want to control opening folds itself)
3612
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 item commands ~
3614 all any
3615 block "(", "{", "[[", "[{", etc.
3616 hor horizontal movements: "l", "w", "fx", etc.
3617 insert any command in Insert mode
3618 jump far jumps: "G", "gg", etc.
3619 mark jumping to a mark: "'m", CTRL-O, etc.
3620 percent "%"
3621 quickfix ":cn", ":crew", ":make", etc.
3622 search search for a pattern: "/", "n", "*", "gd", etc.
3623 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003624 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 tag jumping to a tag: ":ta", CTRL-T, etc.
3626 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 When a movement command is used for an operator (e.g., "dl" or "y%")
3628 this option is not used. This means the operator will include the
3629 whole closed fold.
3630 Note that vertical movements are not here, because it would make it
3631 very difficult to move onto a closed fold.
3632 In insert mode the folds containing the cursor will always be open
3633 when text is inserted.
3634 To close folds you can re-apply 'foldlevel' with the |zx| command or
3635 set the 'foldclose' option to "all".
3636
3637 *'foldtext'* *'fdt'*
3638'foldtext' 'fdt' string (default: "foldtext()")
3639 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640 {not available when compiled without the |+folding|
3641 feature}
3642 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003643 fold. The context is set to the script where 'foldexpr' was set,
3644 script-local items can be accessed. See |fold-foldtext| for the
3645 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646
Bram Moolenaar30b65812012-07-12 22:01:11 +02003647 The expression will be evaluated in the |sandbox| if set from a
3648 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003649 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003650
3651 It is not allowed to change text or jump to another window while
3652 evaluating 'foldtext' |textlock|.
3653
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003654 *'formatexpr'* *'fex'*
3655'formatexpr' 'fex' string (default "")
3656 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003657 {not available when compiled without the |+eval|
3658 feature}
3659 Expression which is evaluated to format a range of lines for the |gq|
3660 operator or automatic formatting (see 'formatoptions'). When this
3661 option is empty 'formatprg' is used.
3662
3663 The |v:lnum| variable holds the first line to be formatted.
3664 The |v:count| variable holds the number of lines to be formatted.
3665 The |v:char| variable holds the character that is going to be
3666 inserted if the expression is being evaluated due to
3667 automatic formatting. This can be empty. Don't insert
3668 it yet!
3669
3670 Example: >
3671 :set formatexpr=mylang#Format()
3672< This will invoke the mylang#Format() function in the
3673 autoload/mylang.vim file in 'runtimepath'. |autoload|
3674
3675 The expression is also evaluated when 'textwidth' is set and adding
3676 text beyond that limit. This happens under the same conditions as
3677 when internal formatting is used. Make sure the cursor is kept in the
3678 same spot relative to the text then! The |mode()| function will
3679 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003680
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003681 When the expression evaluates to non-zero Vim will fall back to using
3682 the internal format mechanism.
3683
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003684 If the expression starts with s: or |<SID>|, then it is replaced with
3685 the script ID (|local-function|). Example: >
3686 set formatexpr=s:MyFormatExpr()
3687 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003688< Otherwise, the expression is evaluated in the context of the script
3689 where the option was set, thus script-local items are available.
3690
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003691 The expression will be evaluated in the |sandbox| when set from a
3692 modeline, see |sandbox-option|. That stops the option from working,
3693 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003694 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003695 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003696
Bram Moolenaar86b68352004-12-27 21:59:20 +00003697 *'formatlistpat'* *'flp'*
3698'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3699 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003700 A pattern that is used to recognize a list header. This is used for
3701 the "n" flag in 'formatoptions'.
3702 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003703 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003704 while still checking more characters. There must be a character
3705 following the pattern, when it matches the whole line it is handled
3706 like there is no match.
3707 The default recognizes a number, followed by an optional punctuation
3708 character and white space.
3709
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003710 *'formatoptions'* *'fo'*
3711'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3712 local to buffer
3713 This is a sequence of letters which describes how automatic
3714 formatting is to be done. See |fo-table|. When the 'paste' option is
3715 on, no formatting is done (like 'formatoptions' is empty). Commas can
3716 be inserted for readability.
3717 To avoid problems with flags that are added in the future, use the
3718 "+=" and "-=" feature of ":set" |add-option-flags|.
3719 NOTE: This option is set to the Vi default value when 'compatible' is
3720 set and to the Vim default value when 'compatible' is reset.
3721
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 *'formatprg'* *'fp'*
3723'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003724 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003726 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003728 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003729 If the 'formatexpr' option is not empty it will be used instead.
3730 Otherwise, if 'formatprg' option is an empty string, the internal
3731 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003732 Environment variables are expanded |:set_env|. See |option-backslash|
3733 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003734 This option cannot be set from a |modeline| or in the |sandbox|, for
3735 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736
Bram Moolenaard94464e2015-11-02 15:28:18 +01003737 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003738'fsync' 'fs' boolean (default on)
3739 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003740 When on, the library function fsync() will be called after writing a
3741 file. This will flush a file to disk, ensuring that it is safely
3742 written even on filesystems which do metadata-only journaling. This
3743 will force the harddrive to spin up on Linux systems running in laptop
3744 mode, so it may be undesirable in some situations. Be warned that
3745 turning this off increases the chances of data loss after a crash. On
3746 systems without an fsync() implementation, this variable is always
3747 off.
3748 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003749 'fsync' also applies to |writefile()| (unless a flag is used to
3750 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003751 This option cannot be set from a |modeline| or in the |sandbox|, for
3752 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003753
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3755'gdefault' 'gd' boolean (default off)
3756 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 When on, the ":substitute" flag 'g' is default on. This means that
3758 all matches in a line are substituted instead of one. When a 'g' flag
3759 is given to a ":substitute" command, this will toggle the substitution
3760 of all or one match. See |complex-change|.
3761
3762 command 'gdefault' on 'gdefault' off ~
3763 :s/// subst. all subst. one
3764 :s///g subst. one subst. all
3765 :s///gg subst. all subst. one
3766
3767 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003768 DEPRECATED: Setting this option may break plugins that are not aware
3769 of this option. Also, many users get confused that adding the /g flag
3770 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003771 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772
3773 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003774'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 Format to recognize for the ":grep" command output.
3777 This is a scanf-like string that uses the same format as the
3778 'errorformat' option: see |errorformat|.
3779
3780 *'grepprg'* *'gp'*
3781'grepprg' 'gp' string (default "grep -n ",
3782 Unix: "grep -n $* /dev/null",
3783 Win32: "findstr /n" or "grep -n",
3784 VMS: "SEARCH/NUMBERS ")
3785 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003786 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 and '#' characters, which are expanded like when used in a command-
3788 line. The placeholder "$*" is allowed to specify where the arguments
3789 will be included. Environment variables are expanded |:set_env|. See
3790 |option-backslash| about including spaces and backslashes.
3791 When your "grep" accepts the "-H" argument, use this to make ":grep"
3792 also work well with a single file: >
3793 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003794< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003795 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3796 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003797 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 apply equally to 'grepprg'.
3799 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3800 otherwise it's "grep -n".
3801 This option cannot be set from a |modeline| or in the |sandbox|, for
3802 security reasons.
3803
3804 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3805'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3806 ve:ver35-Cursor,
3807 o:hor50-Cursor,
3808 i-ci:ver25-Cursor/lCursor,
3809 r-cr:hor20-Cursor/lCursor,
3810 sm:block-Cursor
3811 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003812 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 "n-v-c:block,o:hor50,i-ci:hor15,
3814 r-cr:hor30,sm:block")
3815 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003817 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003819 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003820 height of the cursor can be changed. This can be done by specifying a
3821 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003822 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3823 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003825 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 mode-list and an argument-list:
3827 mode-list:argument-list,mode-list:argument-list,..
3828 The mode-list is a dash separated list of these modes:
3829 n Normal mode
3830 v Visual mode
3831 ve Visual mode with 'selection' "exclusive" (same as 'v',
3832 if not specified)
3833 o Operator-pending mode
3834 i Insert mode
3835 r Replace mode
3836 c Command-line Normal (append) mode
3837 ci Command-line Insert mode
3838 cr Command-line Replace mode
3839 sm showmatch in Insert mode
3840 a all modes
3841 The argument-list is a dash separated list of these arguments:
3842 hor{N} horizontal bar, {N} percent of the character height
3843 ver{N} vertical bar, {N} percent of the character width
3844 block block cursor, fills the whole character
3845 [only one of the above three should be present]
3846 blinkwait{N} *cursor-blinking*
3847 blinkon{N}
3848 blinkoff{N}
3849 blink times for cursor: blinkwait is the delay before
3850 the cursor starts blinking, blinkon is the time that
3851 the cursor is shown and blinkoff is the time that the
3852 cursor is not shown. The times are in msec. When one
3853 of the numbers is zero, there is no blinking. The
3854 default is: "blinkwait700-blinkon400-blinkoff250".
3855 These numbers are used for a missing entry. This
3856 means that blinking is enabled by default. To switch
3857 blinking off you can use "blinkon0". The cursor only
3858 blinks when Vim is waiting for input, not while
3859 executing a command.
3860 To make the cursor blink in an xterm, see
3861 |xterm-blink|.
3862 {group-name}
3863 a highlight group name, that sets the color and font
3864 for the cursor
3865 {group-name}/{group-name}
3866 Two highlight group names, the first is used when
3867 no language mappings are used, the other when they
3868 are. |language-mapping|
3869
3870 Examples of parts:
3871 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3872 block cursor with colors from the "nCursor"
3873 highlight group
3874 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3875 In Insert and Command-line Insert mode, use a
3876 30% vertical bar cursor with colors from the
3877 "iCursor" highlight group. Blink a bit
3878 faster.
3879
3880 The 'a' mode is different. It will set the given argument-list for
3881 all modes. It does not reset anything to defaults. This can be used
3882 to do a common setting for all modes. For example, to switch off
3883 blinking: "a:blinkon0"
3884
3885 Examples of cursor highlighting: >
3886 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3887 :highlight Cursor gui=NONE guifg=bg guibg=fg
3888<
3889 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003890 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891'guifont' 'gfn' string (default "")
3892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 {only available when compiled with GUI enabled}
3894 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003895 In its simplest form the value is just one font name.
3896 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897
3898 *'guifontset'* *'gfs'*
3899 *E250* *E252* *E234* *E597* *E598*
3900'guifontset' 'gfs' string (default "")
3901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 {only available when compiled with GUI enabled and
3903 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003904 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 When not empty, specifies two (or more) fonts to be used. The first
3906 one for normal English, the second one for your special language. See
3907 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003908
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3910'guifontwide' 'gfw' string (default "")
3911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 {only available when compiled with GUI enabled}
3913 When not empty, specifies a comma-separated list of fonts to be used
3914 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003915 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003916
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 *'guiheadroom'* *'ghr'*
3918'guiheadroom' 'ghr' number (default 50)
3919 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003920 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 The number of pixels subtracted from the screen height when fitting
3922 the GUI window on the screen. Set this before the GUI is started,
3923 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003924 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 lines will be left for window decorations and other items on the
3926 screen. Set it to a negative value to allow windows taller than the
3927 screen.
3928
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003929 *'guiligatures'* *'gli'* *E1243*
3930'guiligatures' 'gli' string (default "")
3931 global
3932 {only for GTK GUI}
3933 List of ASCII characters that, when combined together, can create more
3934 complex shapes. Each character must be a printable ASCII character
3935 with a value in the 32-127 range.
3936 Example: >
3937 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3938< Changing this option updates screen output immediately. Set it to an
3939 empty string to disable ligatures.
3940
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003942'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3943 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003944 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003945 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003948 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 sequence of letters which describes what components and options of the
3950 GUI should be used.
3951 To avoid problems with flags that are added in the future, use the
3952 "+=" and "-=" feature of ":set" |add-option-flags|.
3953
Bram Moolenaar13568252018-03-16 20:46:58 +01003954 Valid characters are as follows:
3955 *'go-!'*
3956 '!' External commands are executed in a terminal window. Without
3957 this flag the MS-Windows GUI will open a console window to
3958 execute the command. The Unix GUI will simulate a dumb
3959 terminal to list the command output.
3960 The terminal window will be positioned at the bottom, and grow
3961 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003962 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003963 'a' Autoselect: If present, then whenever VISUAL mode is started,
3964 or the Visual area extended, Vim tries to become the owner of
3965 the windowing system's global selection. This means that the
3966 Visually highlighted text is available for pasting into other
3967 applications as well as into Vim itself. When the Visual mode
3968 ends, possibly due to an operation on the text, or when an
3969 application wants to paste the selection, the highlighted text
3970 is automatically yanked into the "* selection register.
3971 Thus the selection is still available for pasting into other
3972 applications after the VISUAL mode has ended.
3973 If not present, then Vim won't become the owner of the
3974 windowing system's global selection unless explicitly told to
3975 by a yank or delete operation for the "* register.
3976 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003977 *'go-P'*
3978 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003979 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003980 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003981 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 applies to the modeless selection.
3983
3984 'guioptions' autoselect Visual autoselect modeless ~
3985 "" - -
3986 "a" yes yes
3987 "A" - yes
3988 "aA" yes yes
3989
Bram Moolenaar02467872007-05-06 13:22:01 +00003990 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 'c' Use console dialogs instead of popup dialogs for simple
3992 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003993 *'go-d'*
3994 'd' Use dark theme variant if available. Currently only works for
3995 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003996 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003997 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003998 'guitablabel' can be used to change the text in the labels.
3999 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004000 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004001 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004002 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003 'f' Foreground: Don't use fork() to detach the GUI from the shell
4004 where it was started. Use this for programs that wait for the
4005 editor to finish (e.g., an e-mail program). Alternatively you
4006 can use "gvim -f" or ":gui -f" to start the GUI in the
4007 foreground. |gui-fork|
4008 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004009 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004010 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4012 corner of the window. It's black&white on non-GTK, because of
4013 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004014 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004016 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004017 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004019 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004021 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004022 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023 'g' Grey menu items: Make menu items that are not active grey. If
4024 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004025 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 't' Include tearoff menu items. Currently only works for Win32,
4027 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004028 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004029 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4030 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004031 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004033 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 'R' Right-hand scrollbar is present when there is a vertically
4035 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004036 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004038 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 'L' Left-hand scrollbar is present when there is a vertically
4040 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004041 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4043 the longest visible line, or on the cursor line if the 'h'
4044 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004045 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 'h' Limit horizontal scrollbar size to the length of the cursor
4047 line. Reduces computations. |gui-horiz-scroll|
4048
4049 And yes, you may even have scrollbars on the left AND the right if
4050 you really want to :-). See |gui-scrollbars| for more information.
4051
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004052 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 'v' Use a vertical button layout for dialogs. When not included,
4054 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004055 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004056 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 'p' Use Pointer callbacks for X11 GUI. This is required for some
4058 window managers. If the cursor is not blinking or hollow at
4059 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004060 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004062 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004063 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004064 *'go-k'*
4065 'k' Keep the GUI window size when adding/removing a scrollbar, or
4066 toolbar, tabline, etc. Instead, the behavior is similar to
4067 when the window is maximized and will adjust 'lines' and
4068 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004069 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004070 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004071
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072 *'guipty'* *'noguipty'*
4073'guipty' boolean (default on)
4074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 {only available when compiled with GUI enabled}
4076 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4077 I/O to/from shell commands. See |gui-pty|.
4078
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004079 *'guitablabel'* *'gtl'*
4080'guitablabel' 'gtl' string (default empty)
4081 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004082 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004083 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004084 pages line. When empty and when the result is empty Vim will use a
4085 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004086
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004087 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004088 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004089 The expression will be evaluated in the |sandbox| when set from a
4090 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004091 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004092
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004093 Only used when the GUI tab pages line is displayed. 'e' must be
4094 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4095 used.
4096
Bram Moolenaar57657d82006-04-21 22:12:41 +00004097 *'guitabtooltip'* *'gtt'*
4098'guitabtooltip' 'gtt' string (default empty)
4099 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004100 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004101 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004102 pages line. When empty Vim will use a default tooltip.
4103 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004104 You can include a line break. Simplest method is to use |:let|: >
4105 :let &guitabtooltip = "line one\nline two"
4106<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004107
Bram Moolenaar071d4272004-06-13 20:20:40 +00004108 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004109'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004110 (others) "$VIMRUNTIME/doc/help.txt")
4111 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 Name of the main help file. All distributed help files should be
4113 placed together in one directory. Additionally, all "doc" directories
4114 in 'runtimepath' will be used.
4115 Environment variables are expanded |:set_env|. For example:
4116 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004117 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 spaces and backslashes.
4119 This option cannot be set from a |modeline| or in the |sandbox|, for
4120 security reasons.
4121
4122 *'helpheight'* *'hh'*
4123'helpheight' 'hh' number (default 20)
4124 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125 Minimal initial height of the help window when it is opened with the
4126 ":help" command. The initial height of the help window is half of the
4127 current window, or (when the 'ea' option is on) the same as other
4128 windows. When the height is less than 'helpheight', the height is
4129 set to 'helpheight'. Set to zero to disable.
4130
4131 *'helplang'* *'hlg'*
4132'helplang' 'hlg' string (default: messages language or empty)
4133 global
4134 {only available when compiled with the |+multi_lang|
4135 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004136 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137 for which the desired help can be found. The English help will always
4138 be used as a last resort. You can add "en" to prefer English over
4139 another language, but that will only find tags that exist in that
4140 language and not in the English help.
4141 Example: >
4142 :set helplang=de,it
4143< This will first search German, then Italian and finally English help
4144 files.
4145 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4146 try to find the tag in the current language before using this option.
4147 See |help-translated|.
4148
4149 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4150'hidden' 'hid' boolean (default off)
4151 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 When off a buffer is unloaded when it is |abandon|ed. When on a
4153 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4154 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004155
Bram Moolenaar071d4272004-06-13 20:20:40 +00004156 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004157 hidden even if the 'hidden' option is off when these three are true:
4158 - the buffer is modified
4159 - 'autowrite' is off or writing is not possible
4160 - the '!' flag was used
4161 Also see |windows.txt|.
4162
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004163 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 This option is set for one command with ":hide {command}" |:hide|.
4165 WARNING: It's easy to forget that you have changes in hidden buffers.
4166 Think twice when using ":q!" or ":qa!".
4167
4168 *'highlight'* *'hl'*
4169'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004170 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4171 d:Directory,e:ErrorMsg,i:IncSearch,
4172 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004173 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004174 N:CursorLineNr,r:Question,s:StatusLine,
4175 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004176 v:Visual,V:VisualNOS,w:WarningMsg,
4177 W:WildMenu,f:Folded,F:FoldColumn,
4178 A:DiffAdd,C:DiffChange,D:DiffDelete,
4179 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004180 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004181 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004182 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4183 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004184 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004185 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004188 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004190 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004192 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4193 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 characters from 'showbreak'
4195 |hl-Directory| d directories in CTRL-D listing and other special
4196 things in listings
4197 |hl-ErrorMsg| e error messages
4198 h (obsolete, ignored)
4199 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004200 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4202 |hl-MoreMsg| m |more-prompt|
4203 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004204 |hl-LineNr| n line number for ":number" and ":#" commands, and
4205 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004206 |hl-LineNrAbove| a line number above the cursor for when the
4207 'relativenumber' option is set.
4208 |hl-LineNrBelow| b line number below the cursor for when the
4209 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004210 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4211 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 |hl-Question| r |hit-enter| prompt and yes/no questions
4213 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004214 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4216 |hl-VertSplit| c column used to separate vertically split windows
4217 |hl-Visual| v Visual mode
4218 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4219 Selection" Only X11 Gui's |gui-x11| and
4220 |xterm-clipboard|.
4221 |hl-WarningMsg| w warning messages
4222 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4223 |hl-Folded| f line used for closed folds
4224 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004225 |hl-DiffAdd| A added line in diff mode
4226 |hl-DiffChange| C changed line in diff mode
4227 |hl-DiffDelete| D deleted line in diff mode
4228 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004230 |hl-Conceal| - the placeholders used for concealed characters
4231 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004232 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004233 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004234 |hl-SpellRare| R rare word |spell|
4235 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004236 |hl-Pmenu| + popup menu normal line
4237 |hl-PmenuSel| = popup menu selected line
4238 |hl-PmenuSbar| x popup menu scrollbar
4239 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240
4241 The display modes are:
4242 r reverse (termcap entry "mr" and "me")
4243 i italic (termcap entry "ZH" and "ZR")
4244 b bold (termcap entry "md" and "me")
4245 s standout (termcap entry "so" and "se")
4246 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004247 c undercurl (termcap entry "Us" and "Ce")
4248 2 double underline (termcap entry "Ds" and "Ce")
4249 d dotted underline (termcap entry "ds" and "Ce")
4250 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004251 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004252 n no highlighting
4253 - no highlighting
4254 : use a highlight group
4255 The default is used for occasions that are not included.
4256 If you want to change what the display modes do, see |dos-colors|
4257 for an example.
4258 When using the ':' display mode, this must be followed by the name of
4259 a highlight group. A highlight group can be used to define any type
4260 of highlighting, including using color. See |:highlight| on how to
4261 define one. The default uses a different group for each occasion.
4262 See |highlight-default| for the default highlight groups.
4263
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004265'history' 'hi' number (Vim default: 50, Vi default: 0,
4266 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004269 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004271 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004272 NOTE: This option is set to the Vi default value when 'compatible' is
4273 set and to the Vim default value when 'compatible' is reset.
4274
4275 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4276'hkmap' 'hk' boolean (default off)
4277 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 {only available when compiled with the |+rightleft|
4279 feature}
4280 When on, the keyboard is mapped for the Hebrew character set.
4281 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4282 toggle this option. See |rileft.txt|.
4283 NOTE: This option is reset when 'compatible' is set.
4284
4285 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4286'hkmapp' 'hkp' boolean (default off)
4287 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288 {only available when compiled with the |+rightleft|
4289 feature}
4290 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4291 This is useful if you have a non-Hebrew keyboard.
4292 See |rileft.txt|.
4293 NOTE: This option is reset when 'compatible' is set.
4294
Bram Moolenaar036986f2017-03-16 17:41:02 +01004295 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4296'hlsearch' 'hls' boolean (default off)
4297 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004298 {not available when compiled without the
4299 |+extra_search| feature}
4300 When there is a previous search pattern, highlight all its matches.
4301 The type of highlighting used can be set with the 'l' occasion in the
4302 'highlight' option. This uses the "Search" highlight group by
4303 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004304 are not applied. If the "CurSearch" highlight group is set then the
4305 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004306 See also: 'incsearch' and |:match|.
4307 When you get bored looking at the highlighted matches, you can turn it
4308 off with |:nohlsearch|. This does not change the option value, as
4309 soon as you use a search command, the highlighting comes back.
4310 'redrawtime' specifies the maximum time spent on finding matches.
4311 When the search pattern can match an end-of-line, Vim will try to
4312 highlight all of the matched text. However, this depends on where the
4313 search starts. This will be the first line in the window or the first
4314 line below a closed fold. A match in a previous line which is not
4315 drawn may not continue in a newly drawn line.
4316 You can specify whether the highlight status is restored on startup
4317 with the 'h' flag in 'viminfo' |viminfo-h|.
4318 NOTE: This option is reset when 'compatible' is set.
4319
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 *'icon'* *'noicon'*
4321'icon' boolean (default off, on when title can be restored)
4322 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004323 When on, the icon text of the window will be set to the value of
4324 'iconstring' (if it is not empty), or to the name of the file
4325 currently being edited. Only the last part of the name is used.
4326 Overridden by the 'iconstring' option.
4327 Only works if the terminal supports setting window icons (currently
4328 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4329 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4330 builtin termcap).
4331 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004332 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004334 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335
4336 *'iconstring'*
4337'iconstring' string (default "")
4338 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004339 When this option is not empty, it will be used for the icon text of
4340 the window. This happens only when the 'icon' option is on.
4341 Only works if the terminal supports setting window icon text
4342 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004343 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 When Vim was compiled with HAVE_X11 defined, the original icon will be
4345 restored if possible |X11|.
4346 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004347 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004348 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004349 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 {not available when compiled without the |+statusline| feature}
4351
4352 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4353'ignorecase' 'ic' boolean (default off)
4354 global
4355 Ignore case in search patterns. Also used when searching in the tags
4356 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004357 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 Can be overruled by using "\c" or "\C" in the pattern, see
4359 |/ignorecase|.
4360
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004361 *'imactivatefunc'* *'imaf'*
4362'imactivatefunc' 'imaf' string (default "")
4363 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004364 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004365 activate or deactivate the Input Method. The value can be the name of
4366 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4367 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004368 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004369 The expression will be evaluated in the |sandbox| when set from a
4370 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004371
4372 Example: >
4373 function ImActivateFunc(active)
4374 if a:active
4375 ... do something
4376 else
4377 ... do something
4378 endif
4379 " return value is not used
4380 endfunction
4381 set imactivatefunc=ImActivateFunc
4382<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383 *'imactivatekey'* *'imak'*
4384'imactivatekey' 'imak' string (default "")
4385 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004387 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 Specifies the key that your Input Method in X-Windows uses for
4389 activation. When this is specified correctly, vim can fully control
4390 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4391 You can't use this option to change the activation key, the option
4392 tells Vim what the key is.
4393 Format:
4394 [MODIFIER_FLAG-]KEY_STRING
4395
4396 These characters can be used for MODIFIER_FLAG (case is ignored):
4397 S Shift key
4398 L Lock key
4399 C Control key
4400 1 Mod1 key
4401 2 Mod2 key
4402 3 Mod3 key
4403 4 Mod4 key
4404 5 Mod5 key
4405 Combinations are allowed, for example "S-C-space" or "SC-space" are
4406 both shift+ctrl+space.
4407 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4408
4409 Example: >
4410 :set imactivatekey=S-space
4411< "S-space" means shift+space. This is the activation key for kinput2 +
4412 canna (Japanese), and ami (Korean).
4413
4414 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4415'imcmdline' 'imc' boolean (default off)
4416 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 When set the Input Method is always on when starting to edit a command
4418 line, unless entering a search pattern (see 'imsearch' for that).
4419 Setting this option is useful when your input method allows entering
4420 English characters directly, e.g., when it's used to type accented
4421 characters with dead keys.
4422
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004423 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4425 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426 When set the Input Method is never used. This is useful to disable
4427 the IM when it doesn't work properly.
4428 Currently this option is on by default for SGI/IRIX machines. This
4429 may change in later releases.
4430
4431 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004432'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 Specifies whether :lmap or an Input Method (IM) is to be used in
4435 Insert mode. Valid values:
4436 0 :lmap is off and IM is off
4437 1 :lmap is ON and IM is off
4438 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 To always reset the option to zero when leaving Insert mode with <Esc>
4440 this can be used: >
4441 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4442< This makes :lmap and IM turn off automatically when leaving Insert
4443 mode.
4444 Note that this option changes when using CTRL-^ in Insert mode
4445 |i_CTRL-^|.
4446 The value is set to 1 when setting 'keymap' to a valid keymap name.
4447 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004448 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004449 methods. Use 'imdisable' to disable XIM then.
4450
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004451 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004452 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004453 |+multi_byte_ime| or |global-ime|.
4454
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004456'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458 Specifies whether :lmap or an Input Method (IM) is to be used when
4459 entering a search pattern. Valid values:
4460 -1 the value of 'iminsert' is used, makes it look like
4461 'iminsert' is also used when typing a search pattern
4462 0 :lmap is off and IM is off
4463 1 :lmap is ON and IM is off
4464 2 :lmap is off and IM is ON
4465 Note that this option changes when using CTRL-^ in Command-line mode
4466 |c_CTRL-^|.
4467 The value is set to 1 when it is not -1 and setting the 'keymap'
4468 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004469 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470 methods. Use 'imdisable' to disable XIM then.
4471
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004472 *'imstatusfunc'* *'imsf'*
4473'imstatusfunc' 'imsf' string (default "")
4474 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004475 This option specifies a function that is called to obtain the status
4476 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004477 The value can be the name of a function, a |lambda| or a |Funcref|.
4478 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004479 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004480
4481 Example: >
4482 function ImStatusFunc()
4483 let is_active = ...do something
4484 return is_active ? 1 : 0
4485 endfunction
4486 set imstatusfunc=ImStatusFunc
4487<
4488 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004489 The expression will be evaluated in the |sandbox| when set from a
4490 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004491
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004492 *'imstyle'* *'imst'*
4493'imstyle' 'imst' number (default 1)
4494 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004495 {only available when compiled with |+xim| and
4496 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004497 This option specifies the input style of Input Method:
4498 0 use on-the-spot style
4499 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004500 See: |xim-input-style|
4501
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004502 For a long time on-the-spot style had been used in the GTK version of
4503 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004504 |single-repeat|, etc. Therefore over-the-spot style becomes the
4505 default now. This should work fine for most people, however if you
4506 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004507 The expression will be evaluated in the |sandbox| when set from a
4508 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004509
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 *'include'* *'inc'*
4511'include' 'inc' string (default "^\s*#\s*include")
4512 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 {not available when compiled without the
4514 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004515 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 pattern, just like for the "/" command (See |pattern|). The default
4517 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004518 "]I", "[d", etc.
4519 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004520 comes after the matched pattern. But if "\zs" appears in the pattern
4521 then the text matched from "\zs" to the end, or until "\ze" if it
4522 appears, is used as the file name. Use this to include characters
4523 that are not in 'isfname', such as a space. You can then use
4524 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004525 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526
4527 *'includeexpr'* *'inex'*
4528'includeexpr' 'inex' string (default "")
4529 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004531 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004533 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004534 :set includeexpr=substitute(v:fname,'\\.','/','g')
4535< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004536
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004538 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 Also used for |<cfile>|.
4540
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004541 If the expression starts with s: or |<SID>|, then it is replaced with
4542 the script ID (|local-function|). Example: >
4543 set includeexpr=s:MyIncludeExpr(v:fname)
4544 set includeexpr=<SID>SomeIncludeExpr(v:fname)
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004545< Otherwise, the expression is evaluated in the context of the script
4546 where the option was set, thus script-local items are available.
4547
Bram Moolenaar30b65812012-07-12 22:01:11 +02004548 The expression will be evaluated in the |sandbox| when set from a
4549 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004550 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004551
4552 It is not allowed to change text or jump to another window while
4553 evaluating 'includeexpr' |textlock|.
4554
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004556'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004557 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004560 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004561 While typing a search command, show where the pattern, as it was typed
4562 so far, matches. The matched string is highlighted. If the pattern
4563 is invalid or not found, nothing is shown. The screen will be updated
4564 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004565 Also applies to the pattern in commands: >
4566 :global
4567 :lvimgrep
4568 :lvimgrepadd
4569 :smagic
4570 :snomagic
4571 :sort
4572 :substitute
4573 :vglobal
4574 :vimgrep
4575 :vimgrepadd
4576< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004577 original position when no match is found and when pressing <Esc>. You
4578 still need to finish the search command with <Enter> to move the
4579 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004580 You can use the CTRL-G and CTRL-T keys to move to the next and
4581 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004582 When compiled with the |+reltime| feature Vim only searches for about
4583 half a second. With a complicated pattern and/or a lot of text the
4584 match may not be found. This is to avoid that Vim hangs while you
4585 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004586 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004587 When 'hlsearch' is on, all matched strings are highlighted too while
4588 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004589 If you don't want to turn 'hlsearch' on, but want to highlight all
4590 matches while searching, you can turn on and off 'hlsearch' with
4591 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004592 augroup vimrc-incsearch-highlight
4593 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004594 autocmd CmdlineEnter /,\? :set hlsearch
4595 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004596 augroup END
4597<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004598 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004599 to the command line. If 'ignorecase' and 'smartcase' are set and the
4600 command line has no uppercase characters, the added character is
4601 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004602 CTRL-R CTRL-W can be used to add the word at the end of the current
4603 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604 NOTE: This option is reset when 'compatible' is set.
4605
4606 *'indentexpr'* *'inde'*
4607'indentexpr' 'inde' string (default "")
4608 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004609 {not available when compiled without the |+eval|
4610 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 Expression which is evaluated to obtain the proper indent for a line.
4612 It is used when a new line is created, for the |=| operator and
4613 in Insert mode as specified with the 'indentkeys' option.
4614 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004615 'smartindent' indenting. When 'lisp' is set, this option is
4616 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 When 'paste' is set this option is not used for indenting.
4618 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004619 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004621
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004622 If the expression starts with s: or |<SID>|, then it is replaced with
4623 the script ID (|local-function|). Example: >
4624 set indentexpr=s:MyIndentExpr()
4625 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004626< Otherwise, the expression is evaluated in the context of the script
4627 where the option was set, thus script-local items are available.
4628
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629 The expression must return the number of spaces worth of indent. It
4630 can return "-1" to keep the current indent (this means 'autoindent' is
4631 used for the indent).
4632 Functions useful for computing the indent are |indent()|, |cindent()|
4633 and |lispindent()|.
4634 The evaluation of the expression must not have side effects! It must
4635 not change the text, jump to another window, etc. Afterwards the
4636 cursor position is always restored, thus the cursor may be moved.
4637 Normally this option would be set to call a function: >
4638 :set indentexpr=GetMyIndent()
4639< Error messages will be suppressed, unless the 'debug' option contains
4640 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004641 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004642 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643
Bram Moolenaar30b65812012-07-12 22:01:11 +02004644 The expression will be evaluated in the |sandbox| when set from a
4645 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004646 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004647
4648 It is not allowed to change text or jump to another window while
4649 evaluating 'indentexpr' |textlock|.
4650
4651
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004653'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 A list of keys that, when typed in Insert mode, cause reindenting of
4656 the current line. Only happens if 'indentexpr' isn't empty.
4657 The format is identical to 'cinkeys', see |indentkeys-format|.
4658 See |C-indenting| and |indent-expression|.
4659
4660 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4661'infercase' 'inf' boolean (default off)
4662 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004664 'ignorecase' is also on, the case of the match is adjusted depending
4665 on the typed text. If the typed text contains a lowercase letter
4666 where the match has an upper case letter, the completed part is made
4667 lowercase. If the typed text has no lowercase letters and the match
4668 has a lowercase letter where the typed text has an uppercase letter,
4669 and there is a letter before it, the completed part is made uppercase.
4670 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671
4672 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4673'insertmode' 'im' boolean (default off)
4674 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675 Makes Vim work in a way that Insert mode is the default mode. Useful
4676 if you want to use Vim as a modeless editor. Used for |evim|.
4677 These Insert mode commands will be useful:
4678 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004679 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 this is a mapping, it is executed as if 'insertmode' was off.
4681 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004683 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4684 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685
4686 These items change when 'insertmode' is set:
4687 - when starting to edit of a file, Vim goes to Insert mode.
4688 - <Esc> in Insert mode is a no-op and beeps.
4689 - <Esc> in Normal mode makes Vim go to Insert mode.
4690 - CTRL-L in Insert mode is a command, it is not inserted.
4691 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4692 However, when <Esc> is used inside a mapping, it behaves like
4693 'insertmode' was not set. This was done to be able to use the same
4694 mappings with 'insertmode' set or not set.
4695 When executing commands with |:normal| 'insertmode' is not used.
4696
4697 NOTE: This option is reset when 'compatible' is set.
4698
4699 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004700'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4702 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4703 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4704 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4705 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4706 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 The characters specified by this option are included in file names and
4708 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004709 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710 Multi-byte characters 256 and above are always included, only the
4711 characters up to 255 are specified with this option.
4712 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004713 Think twice before adding white space to this option. Although a
4714 space may appear inside a file name, the effect will be that Vim
4715 doesn't know where a file name starts or ends when doing completion.
4716 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004717
4718 Note that on systems using a backslash as path separator, Vim tries to
4719 do its best to make it work as you would expect. That is a bit
4720 tricky, since Vi originally used the backslash to escape special
4721 characters. Vim will not remove a backslash in front of a normal file
4722 name character on these systems, but it will on Unix and alikes. The
4723 '&' and '^' are not included by default, because these are special for
4724 cmd.exe.
4725
4726 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004727 Each part can be a single character number or a range. A range is two
4728 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 decimal number between 0 and 255 or the ASCII character itself (does
4730 not work for digits). Example:
4731 "_,-,128-140,#-43" (include '_' and '-' and the range
4732 128 to 140 and '#' to 43)
4733 If a part starts with '^', the following character number or range
4734 will be excluded from the option. The option is interpreted from left
4735 to right. Put the excluded character after the range where it is
4736 included. To include '^' itself use it as the last character of the
4737 option or the end of a range. Example:
4738 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4739 If the character is '@', all characters where isalpha() returns TRUE
4740 are included. Normally these are the characters a to z and A to Z,
4741 plus accented characters. To include '@' itself use "@-@". Examples:
4742 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004743 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 "a-z,A-Z,@-@" All letters plus the '@' character.
4745 A comma can be included by using it where a character number is
4746 expected. Example:
4747 "48-57,,,_" Digits, comma and underscore.
4748 A comma can be excluded by prepending a '^'. Example:
4749 " -~,^,,9" All characters from space to '~', excluding
4750 comma, plus <Tab>.
4751 See |option-backslash| about including spaces and backslashes.
4752
4753 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004754'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755 "@,48-57,_,128-167,224-235"
4756 otherwise: "@,48-57,_,192-255")
4757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758 The characters given by this option are included in identifiers.
4759 Identifiers are used in recognizing environment variables and after a
4760 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004761 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004762 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004764 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4766
4767 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004768'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769 "@,48-57,_,128-167,224-235"
4770 otherwise: "@,48-57,_,192-255"
4771 Vi default: "@,48-57,_")
4772 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004774 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004775 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004776 characters above 255 check the "word" character class (any character
4777 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004778 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004779 For a help file it is set to all non-blank printable characters except
4780 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4781 command).
4782 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004783 This option also influences syntax highlighting, unless the syntax
4784 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004785 NOTE: This option is set to the Vi default value when 'compatible' is
4786 set and to the Vim default value when 'compatible' is reset.
4787
4788 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004789'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790 "@,~-255"; otherwise: "@,161-255")
4791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792 The characters given by this option are displayed directly on the
4793 screen. It is also used for "\p" in a |pattern|. The characters from
4794 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4795 even when they are not included in 'isprint' or excluded. See
4796 'isfname' for a description of the format of this option.
4797
4798 Non-printable characters are displayed with two characters:
4799 0 - 31 "^@" - "^_"
4800 32 - 126 always single characters
4801 127 "^?"
4802 128 - 159 "~@" - "~_"
4803 160 - 254 "| " - "|~"
4804 255 "~?"
4805 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4806 displayed as <xx>, with the hexadecimal value of the byte.
4807 When 'display' contains "uhex" all unprintable characters are
4808 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004809 The SpecialKey highlighting will be used for unprintable characters.
4810 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811
4812 Multi-byte characters 256 and above are always included, only the
4813 characters up to 255 are specified with this option. When a character
4814 is printable but it is not available in the current font, a
4815 replacement character will be shown.
4816 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4817 There is no option to specify these characters.
4818
4819 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4820'joinspaces' 'js' boolean (default on)
4821 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 Insert two spaces after a '.', '?' and '!' with a join command.
4823 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4824 Otherwise only one space is inserted.
4825 NOTE: This option is set when 'compatible' is set.
4826
4827 *'key'*
4828'key' string (default "")
4829 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004830 {only available when compiled with the |+cryptv|
4831 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004833 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834 Careful: Do not set the key value by hand, someone might see the typed
4835 key. Use the |:X| command. But you can make 'key' empty: >
4836 :set key=
4837< It is not possible to get the value of this option with ":set key" or
4838 "echo &key". This is to avoid showing it to someone who shouldn't
4839 know. It also means you cannot see it yourself once you have set it,
4840 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004841 You can use "&key" in an expression to detect whether encryption is
4842 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843
4844 *'keymap'* *'kmp'* *E544*
4845'keymap' 'kmp' string (default "")
4846 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847 {only available when compiled with the |+keymap|
4848 feature}
4849 Name of a keyboard mapping. See |mbyte-keymap|.
4850 Setting this option to a valid keymap name has the side effect of
4851 setting 'iminsert' to one, so that the keymap becomes effective.
4852 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004853 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004854
4855 *'keymodel'* *'km'*
4856'keymodel' 'km' string (default "")
4857 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004858 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 can do. These values can be used:
4860 startsel Using a shifted special key starts selection (either
4861 Select mode or Visual mode, depending on "key" being
4862 present in 'selectmode').
4863 stopsel Using a not-shifted special key stops selection.
4864 Special keys in this context are the cursor keys, <End>, <Home>,
4865 <PageUp> and <PageDown>.
4866 The 'keymodel' option is set by the |:behave| command.
4867
4868 *'keywordprg'* *'kp'*
4869'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004870 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 Program to use for the |K| command. Environment variables are
4873 expanded |:set_env|. ":help" may be used to access the Vim internal
4874 help. (Note that previously setting the global option to the empty
4875 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004876 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01004877 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004878 When "man", "man -s" or an Ex command is used, Vim will automatically
4879 translate a count for the "K" command and pass it as the first
4880 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 See |option-backslash| about including spaces and backslashes.
4882 Example: >
4883 :set keywordprg=man\ -s
4884< This option cannot be set from a |modeline| or in the |sandbox|, for
4885 security reasons.
4886
4887 *'langmap'* *'lmap'* *E357* *E358*
4888'langmap' 'lmap' string (default "")
4889 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890 {only available when compiled with the |+langmap|
4891 feature}
4892 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004893 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004894 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895 care of translating these special characters to the original meaning
4896 of the key. This means you don't have to change the keyboard mode to
4897 be able to execute Normal mode commands.
4898 This is the opposite of the 'keymap' option, where characters are
4899 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004900 Also consider setting 'langremap' to off, to prevent 'langmap' from
4901 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004902 This option cannot be set from a |modeline| or in the |sandbox|, for
4903 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004905 Example (for Greek, in UTF-8): *greek* >
4906 :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 +00004907< Example (exchanges meaning of z and y for commands): >
4908 :set langmap=zy,yz,ZY,YZ
4909<
4910 The 'langmap' option is a list of parts, separated with commas. Each
4911 part can be in one of two forms:
4912 1. A list of pairs. Each pair is a "from" character immediately
4913 followed by the "to" character. Examples: "aA", "aAbBcC".
4914 2. A list of "from" characters, a semi-colon and a list of "to"
4915 characters. Example: "abc;ABC"
4916 Example: "aA,fgh;FGH,cCdDeE"
4917 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004918 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919
4920 This will allow you to activate vim actions without having to switch
4921 back and forth between the languages. Your language characters will
4922 be understood as normal vim English characters (according to the
4923 langmap mappings) in the following cases:
4924 o Normal/Visual mode (commands, buffer/register names, user mappings)
4925 o Insert/Replace Mode: Register names after CTRL-R
4926 o Insert/Replace Mode: Mappings
4927 Characters entered in Command-line mode will NOT be affected by
4928 this option. Note that this option can be changed at any time
4929 allowing to switch between mappings for different languages/encodings.
4930 Use a mapping to avoid having to type it each time!
4931
4932 *'langmenu'* *'lm'*
4933'langmenu' 'lm' string (default "")
4934 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004935 {only available when compiled with the |+menu| and
4936 |+multi_lang| features}
4937 Language to use for menu translation. Tells which file is loaded
4938 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004939 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940< (without the spaces). For example, to always use the Dutch menus, no
4941 matter what $LANG is set to: >
4942 :set langmenu=nl_NL.ISO_8859-1
4943< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004944 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 If your $LANG is set to a non-English language but you do want to use
4946 the English menus: >
4947 :set langmenu=none
4948< This option must be set before loading menus, switching on filetype
4949 detection or syntax highlighting. Once the menus are defined setting
4950 this option has no effect. But you could do this: >
4951 :source $VIMRUNTIME/delmenu.vim
4952 :set langmenu=de_DE.ISO_8859-1
4953 :source $VIMRUNTIME/menu.vim
4954< Warning: This deletes all menus that you defined yourself!
4955
Bram Moolenaard94464e2015-11-02 15:28:18 +01004956 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004957'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004958 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004959 {only available when compiled with the |+langmap|
4960 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004961 This is just like 'langremap' but with the value inverted. It only
4962 exists for backwards compatibility. When setting 'langremap' then
4963 'langnoremap' is set to the inverted value, and the other way around.
4964
4965 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004966'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004967 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004968 {only available when compiled with the |+langmap|
4969 feature}
4970 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004971 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004972 'langmap' disables some of your mappings, try resetting this option.
4973 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004974 that works for you to avoid mappings to break.
4975
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 *'laststatus'* *'ls'*
4977'laststatus' 'ls' number (default 1)
4978 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979 The value of this option influences when the last window will have a
4980 status line:
4981 0: never
4982 1: only if there are at least two windows
4983 2: always
4984 The screen looks nicer with a status line if you have several
4985 windows, but it takes another screen line. |status-line|
4986
4987 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4988'lazyredraw' 'lz' boolean (default off)
4989 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 When this option is set, the screen will not be redrawn while
4991 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004992 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01004994 This may occasionally cause display errors. It is only meant to be set
4995 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01004996 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004997
4998 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4999'linebreak' 'lbr' boolean (default off)
5000 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005001 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005002 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005003 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 than at the last character that fits on the screen. Unlike
5005 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005006 it only affects the way the file is displayed, not its contents.
5007 If 'breakindent' is set, line is visually indented. Then, the value
5008 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005009 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005010 Note that <Tab> characters after an <EOL> are mostly not displayed
5011 with the right amount of white space.
5012
5013 *'lines'* *E593*
5014'lines' number (default 24 or terminal height)
5015 global
5016 Number of lines of the Vim window.
5017 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005018 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 When Vim is running in the GUI or in a resizable window, setting this
5020 option will cause the window size to be changed. When you only want
5021 to use the size for the GUI, put the command in your |gvimrc| file.
5022 Vim limits the number of lines to what fits on the screen. You can
5023 use this command to get the tallest window possible: >
5024 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005025< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005026 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027 When you set this option and Vim is unable to change the physical
5028 number of lines of the display, the display may be messed up.
5029
5030 *'linespace'* *'lsp'*
5031'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5032 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 {only in the GUI}
5034 Number of pixel lines inserted between characters. Useful if the font
5035 uses the full character cell height, making lines touch each other.
5036 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005037 With some fonts there can be too much room between lines (to have
5038 space for ascents and descents). Then it makes sense to set
5039 'linespace' to a negative value. This may cause display problems
5040 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005041
5042 *'lisp'* *'nolisp'*
5043'lisp' boolean (default off)
5044 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045 Lisp mode: When <Enter> is typed in insert mode set the indent for
5046 the next line to Lisp standards (well, sort of). Also happens with
5047 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5048 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5049 better. Also see 'lispwords'.
5050 The '-' character is included in keyword characters. Redefines the
5051 "=" operator to use this same indentation algorithm rather than
5052 calling an external program if 'equalprg' is empty.
5053 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054
5055 *'lispwords'* *'lw'*
5056'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005057 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005058 Comma-separated list of words that influence the Lisp indenting when
5059 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060
5061 *'list'* *'nolist'*
5062'list' boolean (default off)
5063 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005064 List mode: By default show tabs as CTRL-I is displayed, display $
5065 after end of line. Useful to see the difference between tabs and
5066 spaces and for trailing blanks. Further changed by the 'listchars'
5067 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005068
5069 The cursor is displayed at the start of the space a Tab character
5070 occupies, not at the end as usual in Normal mode. To get this cursor
5071 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005072 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005073<
5074 Note that list mode will also affect formatting (set with 'textwidth'
5075 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076 changing the way tabs are displayed.
5077
5078 *'listchars'* *'lcs'*
5079'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005080 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005081 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005082 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005083 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 eol:c Character to show at the end of each line. When
5085 omitted, there is no extra character at the end of the
5086 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005087 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005088 tab:xy[z] Two or three characters to be used to show a tab.
5089 The third character is optional.
5090
5091 tab:xy The 'x' is always used, then 'y' as many times as will
5092 fit. Thus "tab:>-" displays:
5093 >
5094 >-
5095 >--
5096 etc.
5097
5098 tab:xyz The 'z' is always used, then 'x' is prepended, and
5099 then 'y' is used as many times as will fit. Thus
5100 "tab:<->" displays:
5101 >
5102 <>
5103 <->
5104 <-->
5105 etc.
5106
5107 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005108 *lcs-space*
5109 space:c Character to show for a space. When omitted, spaces
5110 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005111 *lcs-multispace*
5112 multispace:c...
5113 One or more characters to use cyclically to show for
5114 multiple consecutive spaces. Overrides the "space"
5115 setting, except for single spaces. When omitted, the
5116 "space" setting is used. For example,
5117 `:set listchars=multispace:---+` shows ten consecutive
5118 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005119 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005120 *lcs-lead*
5121 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005122 leading spaces are blank. Overrides the "space" and
5123 "multispace" settings for leading spaces. You can
5124 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005125 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005126< *lcs-leadmultispace*
5127 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005128 Like the |lcs-multispace| value, but for leading
5129 spaces only. Also overrides |lcs-lead| for leading
5130 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005131 `:set listchars=leadmultispace:---+` shows ten
5132 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005133 ---+---+--XXX ~
5134 Where "XXX" denotes the first non-blank characters in
5135 the line.
5136 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005137 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005138 trailing spaces are blank. Overrides the "space" and
5139 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005140 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141 extends:c Character to show in the last column, when 'wrap' is
5142 off and the line continues beyond the right of the
5143 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005144 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005145 precedes:c Character to show in the first visible column of the
5146 physical line, when there is text preceding the
5147 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005148 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005149 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005150 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005151 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005152 nbsp:c Character to show for a non-breakable space character
5153 (0xA0 (160 decimal) and U+202F). Left blank when
5154 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005156 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005158 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005160 Each character can be specified as hex: >
5161 set listchars=eol:\\x24
5162 set listchars=eol:\\u21b5
5163 set listchars=eol:\\U000021b5
5164< Note that a double backslash is used. The number of hex characters
5165 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5166
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 Examples: >
5168 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005169 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 :set lcs=extends:>,precedes:<
5171< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005172 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5173 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005174 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175
5176 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5177'loadplugins' 'lpl' boolean (default on)
5178 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 When on the plugin scripts are loaded when starting up |load-plugins|.
5180 This option can be reset in your |vimrc| file to disable the loading
5181 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005182 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5183 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184
Bram Moolenaard94464e2015-11-02 15:28:18 +01005185 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005186'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005187 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005188 {only available when compiled with the |+lua/dyn|
5189 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005190 Specifies the name of the Lua shared library. The default is
5191 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005192 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005193 This option cannot be set from a |modeline| or in the |sandbox|, for
5194 security reasons.
5195
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005196 *'macatsui'* *'nomacatsui'*
5197'macatsui' boolean (default on)
5198 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005199 {not supported}
5200 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005201
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 *'magic'* *'nomagic'*
5203'magic' boolean (default on)
5204 global
5205 Changes the special characters that can be used in search patterns.
5206 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005207 WARNING: Switching this option off most likely breaks plugins! That
5208 is because many patterns assume it's on and will fail when it's off.
5209 Only switch it off when working with old Vi scripts. In any other
5210 situation write patterns that work when 'magic' is on. Include "\M"
5211 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005212 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5213 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214
5215 *'makeef'* *'mef'*
5216'makeef' 'mef' string (default: "")
5217 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 {not available when compiled without the |+quickfix|
5219 feature}
5220 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5221 and the |:grep| command.
5222 When it is empty, an internally generated temp file will be used.
5223 When "##" is included, it is replaced by a number to make the name
5224 unique. This makes sure that the ":make" command doesn't overwrite an
5225 existing file.
5226 NOT used for the ":cf" command. See 'errorfile' for that.
5227 Environment variables are expanded |:set_env|.
5228 See |option-backslash| about including spaces and backslashes.
5229 This option cannot be set from a |modeline| or in the |sandbox|, for
5230 security reasons.
5231
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005232 *'makeencoding'* *'menc'*
5233'makeencoding' 'menc' string (default "")
5234 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005235 Encoding used for reading the output of external commands. When empty,
5236 encoding is not converted.
5237 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5238 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5239 and `:laddfile`.
5240
5241 This would be mostly useful when you use MS-Windows and set 'encoding'
5242 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5243 'makeencoding' to "char" has the same effect as setting to the system
5244 locale encoding. Example: >
5245 :set encoding=utf-8
5246 :set makeencoding=char " system locale is used
5247<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248 *'makeprg'* *'mp'*
5249'makeprg' 'mp' string (default "make", VMS: "MMS")
5250 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005251 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005252 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5253 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005254 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005255 Environment variables are expanded |:set_env|. See |option-backslash|
5256 about including spaces and backslashes.
5257 Note that a '|' must be escaped twice: once for ":set" and once for
5258 the interpretation of a command. When you use a filter called
5259 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 :set makeprg=gmake\ \\\|\ myfilter
5261< The placeholder "$*" can be given (even multiple times) to specify
5262 where the arguments will be included, for example: >
5263 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5264< This option cannot be set from a |modeline| or in the |sandbox|, for
5265 security reasons.
5266
5267 *'matchpairs'* *'mps'*
5268'matchpairs' 'mps' string (default "(:),{:},[:]")
5269 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005271 other.
5272 Only character pairs are allowed that are different, thus you cannot
5273 jump between two double quotes.
5274 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005275 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005276 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 :set mps+=<:>
5278
5279< A more exotic example, to jump between the '=' and ';' in an
5280 assignment, useful for languages like C and Java: >
5281 :au FileType c,cpp,java set mps+==:;
5282
5283< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005284 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285
5286 *'matchtime'* *'mat'*
5287'matchtime' 'mat' number (default 5)
5288 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289 Tenths of a second to show the matching paren, when 'showmatch' is
5290 set. Note that this is not in milliseconds, like other options that
5291 set a time. This is to be compatible with Nvi.
5292
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005293 *'maxcombine'* *'mco'*
5294'maxcombine' 'mco' number (default 2)
5295 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005296 The maximum number of combining characters supported for displaying.
5297 Only used when 'encoding' is "utf-8".
5298 The default is OK for most languages. Hebrew may require 4.
5299 Maximum value is 6.
5300 Even when this option is set to 2 you can still edit text with more
5301 combining characters, you just can't see them. Use |g8| or |ga|.
5302 See |mbyte-combining|.
5303
Bram Moolenaar071d4272004-06-13 20:20:40 +00005304 *'maxfuncdepth'* *'mfd'*
5305'maxfuncdepth' 'mfd' number (default 100)
5306 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005307 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005308 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309 Maximum depth of function calls for user functions. This normally
5310 catches endless recursion. When using a recursive function with
5311 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5312 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005313 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005314 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315 See also |:function|.
5316
5317 *'maxmapdepth'* *'mmd'* *E223*
5318'maxmapdepth' 'mmd' number (default 1000)
5319 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320 Maximum number of times a mapping is done without resulting in a
5321 character to be used. This normally catches endless mappings, like
5322 ":map x y" with ":map y x". It still does not catch ":map g wg",
5323 because the 'w' is used before the next mapping is done. See also
5324 |key-mapping|.
5325
5326 *'maxmem'* *'mm'*
5327'maxmem' 'mm' number (default between 256 to 5120 (system
5328 dependent) or half the amount of memory
5329 available)
5330 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5332 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005333 other memory to be freed.
5334 The maximum usable value is about 2000000. Use this to work without a
5335 limit.
5336 The value is ignored when 'swapfile' is off.
5337 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005339 *'maxmempattern'* *'mmp'*
5340'maxmempattern' 'mmp' number (default 1000)
5341 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005342 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005343 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005344 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005345 When Vim runs into the limit it gives an error message and mostly
5346 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005347 Running into the limit often means that the pattern is very
5348 inefficient or too complex. This may already happen with the pattern
5349 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005350 Might also happen on redraw, when syntax rules try to match a complex
5351 text structure.
5352 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5353 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005354
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 *'maxmemtot'* *'mmt'*
5356'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5357 dependent) or half the amount of memory
5358 available)
5359 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005360 Maximum amount of memory in Kbyte to use for all buffers together.
5361 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005362 without a limit.
5363 On 64 bit machines higher values might work. But hey, do you really
5364 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005365 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005366 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005367 Buffers with 'swapfile' off still count to the total amount of memory
5368 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005369 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370
5371 *'menuitems'* *'mis'*
5372'menuitems' 'mis' number (default 25)
5373 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374 {not available when compiled without the |+menu|
5375 feature}
5376 Maximum number of items to use in a menu. Used for menus that are
5377 generated from a list of items, e.g., the Buffers menu. Changing this
5378 option has no direct effect, the menu must be refreshed first.
5379
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005380 *'mkspellmem'* *'msm'*
5381'mkspellmem' 'msm' string (default "460000,2000,500")
5382 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005383 {not available when compiled without the |+syntax|
5384 feature}
5385 Parameters for |:mkspell|. This tunes when to start compressing the
5386 word tree. Compression can be slow when there are many words, but
5387 it's needed to avoid running out of memory. The amount of memory used
5388 per word depends very much on how similar the words are, that's why
5389 this tuning is complicated.
5390
5391 There are three numbers, separated by commas:
5392 {start},{inc},{added}
5393
5394 For most languages the uncompressed word tree fits in memory. {start}
5395 gives the amount of memory in Kbyte that can be used before any
5396 compression is done. It should be a bit smaller than the amount of
5397 memory that is available to Vim.
5398
5399 When going over the {start} limit the {inc} number specifies the
5400 amount of memory in Kbyte that can be allocated before another
5401 compression is done. A low number means compression is done after
5402 less words are added, which is slow. A high number means more memory
5403 will be allocated.
5404
5405 After doing compression, {added} times 1024 words can be added before
5406 the {inc} limit is ignored and compression is done when any extra
5407 amount of memory is needed. A low number means there is a smaller
5408 chance of hitting the {inc} limit, less memory is used but it's
5409 slower.
5410
5411 The languages for which these numbers are important are Italian and
5412 Hungarian. The default works for when you have about 512 Mbyte. If
5413 you have 1 Gbyte you could use: >
5414 :set mkspellmem=900000,3000,800
5415< If you have less than 512 Mbyte |:mkspell| may fail for some
5416 languages, no matter what you set 'mkspellmem' to.
5417
Bram Moolenaar07607392019-05-26 19:20:43 +02005418 This option cannot be set from a |modeline| or in the |sandbox|.
5419
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005421'modeline' 'ml' boolean (Vim default: on (off for root),
5422 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005424 If 'modeline' is on 'modelines' gives the number of lines that is
5425 checked for set commands. If 'modeline' is off or 'modelines' is zero
5426 no lines are checked. See |modeline|.
5427
5428 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5429'modelineexpr' 'mle' boolean (default: off)
5430 global
5431 When on allow some options that are an expression to be set in the
5432 modeline. Check the option for whether it is affected by
5433 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005434 This option cannot be set from a |modeline| or in the |sandbox|, for
5435 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005436
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437 *'modelines'* *'mls'*
5438'modelines' 'mls' number (default 5)
5439 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 If 'modeline' is on 'modelines' gives the number of lines that is
5441 checked for set commands. If 'modeline' is off or 'modelines' is zero
5442 no lines are checked. See |modeline|.
5443 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5444 set and to the Vim default value when 'compatible' is reset.
5445
5446 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005447 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448'modifiable' 'ma' boolean (default on)
5449 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005450 When off the buffer contents cannot be changed. The 'fileformat' and
5451 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005452 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453
5454 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5455'modified' 'mod' boolean (default off)
5456 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457 When on, the buffer is considered to be modified. This option is set
5458 when:
5459 1. A change was made to the text since it was last written. Using the
5460 |undo| command to go back to the original text will reset the
5461 option. But undoing changes that were made before writing the
5462 buffer will set the option again, since the text is different from
5463 when it was written.
5464 2. 'fileformat' or 'fileencoding' is different from its original
5465 value. The original value is set when the buffer is read or
5466 written. A ":set nomodified" command also resets the original
5467 values to the current values and the 'modified' option will be
5468 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005469 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005470 This option is not set when a change is made to the buffer as the
5471 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5472 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5473 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005474 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5475 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005476 Note that the text may actually be the same, e.g. 'modified' is set
5477 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005478
5479 *'more'* *'nomore'*
5480'more' boolean (Vim default: on, Vi default: off)
5481 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482 When on, listings pause when the whole screen is filled. You will get
5483 the |more-prompt|. When this option is off there are no pauses, the
5484 listing continues until finished.
5485 NOTE: This option is set to the Vi default value when 'compatible' is
5486 set and to the Vim default value when 'compatible' is reset.
5487
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005488 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005489'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005490 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005492 Enable the use of the mouse. Works for most terminals (xterm, Win32
5493 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5494 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5495 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005496 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005497 v Visual mode
5498 i Insert mode
5499 c Command-line mode
5500 h all previous modes when editing a help file
5501 a all previous modes
5502 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005503 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005505< If your terminal can't overrule the mouse events going to the
5506 application, use: >
5507 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005508< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005509 back to Vim using the mouse events.
5510 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5511 "xterm".
5512
5513 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514 modeless selection. This doesn't move the text cursor.
5515
5516 See |mouse-using|. Also see |'clipboard'|.
5517
5518 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005519 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005520 the mouse buttons can still be used by keeping the shift key pressed.
5521 Also see the 'clipboard' option.
5522
5523 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5524'mousefocus' 'mousef' boolean (default off)
5525 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526 {only works in the GUI}
5527 The window that the mouse pointer is on is automatically activated.
5528 When changing the window layout or window focus in another way, the
5529 mouse pointer is moved to the window with keyboard focus. Off is the
5530 default because it makes using the pull down menus a little goofy, as
5531 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005532 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005533 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534
5535 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5536'mousehide' 'mh' boolean (default on)
5537 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005538 {only works in the GUI}
5539 When on, the mouse pointer is hidden when characters are typed.
5540 The mouse pointer is restored when the mouse is moved.
5541
5542 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005543'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005545 Sets the model to use for the mouse. The name mostly specifies what
5546 the right mouse button is used for:
5547 extend Right mouse button extends a selection. This works
5548 like in an xterm.
5549 popup Right mouse button pops up a menu. The shifted left
5550 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005551 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005552 popup_setpos Like "popup", but the cursor will be moved to the
5553 position where the mouse was clicked, and thus the
5554 selected operation will act upon the clicked object.
5555 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005556 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005557 course, that right clicking outside a selection will
5558 end Visual mode.
5559 Overview of what button does what for each model:
5560 mouse extend popup(_setpos) ~
5561 left click place cursor place cursor
5562 left drag start selection start selection
5563 shift-left search word extend selection
5564 right click extend selection popup menu (place cursor)
5565 right drag extend selection -
5566 middle click paste paste
5567
5568 In the "popup" model the right mouse button produces a pop-up menu.
5569 You need to define this first, see |popup-menu|.
5570
5571 Note that you can further refine the meaning of buttons with mappings.
5572 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5573 selection (because that's handled in the GUI code directly).
5574
5575 The 'mousemodel' option is set by the |:behave| command.
5576
Ernie Raelc4cb5442022-04-03 15:47:28 +01005577 *'mousemoveevent'* *'mousemev'*
5578'mousemoveevent' 'mousemev' boolean (default off)
5579 global
5580 {only works in the GUI}
5581 When on, mouse move events are delivered to the input queue and are
5582 available for mapping. The default, off, avoids the mouse movement
5583 overhead except when needed. See |gui-mouse-mapping|.
5584 Warning: Setting this option can make pending mappings to be aborted
5585 when the mouse is moved.
5586 Currently only works in the GUI, may be made to work in a terminal
5587 later.
5588
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005590'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5591 vs:leftright,vd:lrsizing,m:no,
5592 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 {only available when compiled with the |+mouseshape|
5595 feature}
5596 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005597 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005598 like used for 'guicursor'. Each part consist of a mode/location-list
5599 and an argument-list:
5600 mode-list:shape,mode-list:shape,..
5601 The mode-list is a dash separated list of these modes/locations:
5602 In a normal window: ~
5603 n Normal mode
5604 v Visual mode
5605 ve Visual mode with 'selection' "exclusive" (same as 'v',
5606 if not specified)
5607 o Operator-pending mode
5608 i Insert mode
5609 r Replace mode
5610
5611 Others: ~
5612 c appending to the command-line
5613 ci inserting in the command-line
5614 cr replacing in the command-line
5615 m at the 'Hit ENTER' or 'More' prompts
5616 ml idem, but cursor in the last line
5617 e any mode, pointer below last window
5618 s any mode, pointer on a status line
5619 sd any mode, while dragging a status line
5620 vs any mode, pointer on a vertical separator line
5621 vd any mode, while dragging a vertical separator line
5622 a everywhere
5623
5624 The shape is one of the following:
5625 avail name looks like ~
5626 w x arrow Normal mouse pointer
5627 w x blank no pointer at all (use with care!)
5628 w x beam I-beam
5629 w x updown up-down sizing arrows
5630 w x leftright left-right sizing arrows
5631 w x busy The system's usual busy pointer
5632 w x no The system's usual 'no input' pointer
5633 x udsizing indicates up-down resizing
5634 x lrsizing indicates left-right resizing
5635 x crosshair like a big thin +
5636 x hand1 black hand
5637 x hand2 white hand
5638 x pencil what you write with
5639 x question big ?
5640 x rightup-arrow arrow pointing right-up
5641 w x up-arrow arrow pointing up
5642 x <number> any X11 pointer number (see X11/cursorfont.h)
5643
5644 The "avail" column contains a 'w' if the shape is available for Win32,
5645 x for X11.
5646 Any modes not specified or shapes not available use the normal mouse
5647 pointer.
5648
5649 Example: >
5650 :set mouseshape=s:udsizing,m:no
5651< will make the mouse turn to a sizing arrow over the status lines and
5652 indicate no input when the hit-enter prompt is displayed (since
5653 clicking the mouse has no effect in this state.)
5654
5655 *'mousetime'* *'mouset'*
5656'mousetime' 'mouset' number (default 500)
5657 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005658 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659 time in msec between two mouse clicks for the second click to be
5660 recognized as a multi click.
5661
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005662 *'mzschemedll'*
5663'mzschemedll' string (default depends on the build)
5664 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005665 {only available when compiled with the |+mzscheme/dyn|
5666 feature}
5667 Specifies the name of the MzScheme shared library. The default is
5668 DYNAMIC_MZSCH_DLL which was specified at compile time.
5669 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005670 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005671 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005672 This option cannot be set from a |modeline| or in the |sandbox|, for
5673 security reasons.
5674
5675 *'mzschemegcdll'*
5676'mzschemegcdll' string (default depends on the build)
5677 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005678 {only available when compiled with the |+mzscheme/dyn|
5679 feature}
5680 Specifies the name of the MzScheme GC shared library. The default is
5681 DYNAMIC_MZGC_DLL which was specified at compile time.
5682 The value can be equal to 'mzschemedll' if it includes the GC code.
5683 Environment variables are expanded |:set_env|.
5684 This option cannot be set from a |modeline| or in the |sandbox|, for
5685 security reasons.
5686
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005687 *'mzquantum'* *'mzq'*
5688'mzquantum' 'mzq' number (default 100)
5689 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005690 {not available when compiled without the |+mzscheme|
5691 feature}
5692 The number of milliseconds between polls for MzScheme threads.
5693 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005694 NOTE: This option is set to the Vim default value when 'compatible'
5695 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005696
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005698'nrformats' 'nf' string (default "bin,octal,hex",
5699 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 This defines what bases Vim will consider for numbers when using the
5702 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5703 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005704 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005706 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005707 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005709 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 considered to be hexadecimal. Example: Using CTRL-X on
5711 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005712 bin If included, numbers starting with "0b" or "0B" will be
5713 considered to be binary. Example: Using CTRL-X on
5714 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005715 unsigned If included, numbers are recognized as unsigned. Thus a
5716 leading dash or negative sign won't be considered as part of
5717 the number. Examples:
5718 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5719 (without "unsigned" it would become "9-2021").
5720 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5721 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005722 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5723 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005724 Numbers which simply begin with a digit in the range 1-9 are always
5725 considered decimal. This also happens for numbers that are not
5726 recognized as octal or hex.
5727
5728 *'number'* *'nu'* *'nonumber'* *'nonu'*
5729'number' 'nu' boolean (default off)
5730 local to window
5731 Print the line number in front of each line. When the 'n' option is
5732 excluded from 'cpoptions' a wrapped line will not use the column of
5733 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005734 The 'numberwidth' option can be used to set the room used for the line
5735 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005736 When a long, wrapped line doesn't start with the first character, '-'
5737 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005738 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5739 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005740 *number_relativenumber*
5741 The 'relativenumber' option changes the displayed number to be
5742 relative to the cursor. Together with 'number' there are these
5743 four combinations (cursor in line 3):
5744
Bram Moolenaar3848e002016-03-19 18:42:29 +01005745 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005746 'nornu' 'nornu' 'rnu' 'rnu'
5747
5748 |apple | 1 apple | 2 apple | 2 apple
5749 |pear | 2 pear | 1 pear | 1 pear
5750 |nobody | 3 nobody | 0 nobody |3 nobody
5751 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005753 *'numberwidth'* *'nuw'*
5754'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5755 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005756 {only available when compiled with the |+linebreak|
5757 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005758 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005759 when the 'number' or 'relativenumber' option is set or printing lines
5760 with a line number. Since one space is always between the number and
5761 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005762 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005763 fit the highest line number in the buffer respectively the number of
5764 rows in the window, depending on whether 'number' or 'relativenumber'
5765 is set. Thus with the Vim default of 4 there is room for a line number
5766 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005767 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005768 NOTE: This option is set to the Vi default value when 'compatible' is
5769 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005770
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005771 *'omnifunc'* *'ofu'*
5772'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005773 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005774 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005775 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005776 This option specifies a function to be used for Insert mode omni
5777 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005778 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005779 invoked and what it should return. The value can be the name of a
5780 function, a |lambda| or a |Funcref|. See |option-value-function| for
5781 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005782 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005783 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005784 This option cannot be set from a |modeline| or in the |sandbox|, for
5785 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005786
5787
Bram Moolenaar02467872007-05-06 13:22:01 +00005788 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005789'opendevice' 'odev' boolean (default off)
5790 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005791 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005792 Enable reading and writing from devices. This may get Vim stuck on a
5793 device that can be opened but doesn't actually do the I/O. Therefore
5794 it is off by default.
5795 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5796 result in editing a device.
5797
5798
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005799 *'operatorfunc'* *'opfunc'*
5800'operatorfunc' 'opfunc' string (default: empty)
5801 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005802 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005803 See |:map-operator| for more info and an example. The value can be
5804 the name of a function, a |lambda| or a |Funcref|. See
5805 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005806
5807 This option cannot be set from a |modeline| or in the |sandbox|, for
5808 security reasons.
5809
5810
Bram Moolenaar251e1912011-06-19 05:09:16 +02005811 *'osfiletype'* *'oft'*
5812'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005814 This option was supported on RISC OS, which has been removed.
5815
Bram Moolenaar071d4272004-06-13 20:20:40 +00005816
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005817 *'packpath'* *'pp'*
5818'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005819 Directories used to find packages. See |packages|.
5820
5821
Bram Moolenaar071d4272004-06-13 20:20:40 +00005822 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005823'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824 global
5825 Specifies the nroff macros that separate paragraphs. These are pairs
5826 of two letters (see |object-motions|).
5827
5828 *'paste'* *'nopaste'*
5829'paste' boolean (default off)
5830 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005831 Put Vim in Paste mode. This is useful if you want to cut or copy
5832 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833 unexpected effects.
5834 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005835 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836 knows about pasting and will mostly do the right thing without 'paste'
5837 being set. The same is true for a terminal where Vim handles the
5838 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005839 This option is reset when starting the GUI. Thus if you set it in
5840 your .vimrc it will work in a terminal, but not in the GUI. Setting
5841 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5842 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843 When the 'paste' option is switched on (also when it was already on):
5844 - mapping in Insert mode and Command-line mode is disabled
5845 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005847 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005848 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849 - 'revins' is reset
5850 - 'ruler' is reset
5851 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005852 - 'smarttab' is reset
5853 - 'softtabstop' is set to 0
5854 - 'textwidth' is set to 0
5855 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005856 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005857 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005858 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005859 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005860 - 'indentexpr'
5861 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005862 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 NOTE: When you start editing another file while the 'paste' option is
5864 on, settings from the modelines or autocommands may change the
5865 settings again, causing trouble when pasting text. You might want to
5866 set the 'paste' option again.
5867 When the 'paste' option is reset the mentioned options are restored to
5868 the value before the moment 'paste' was switched from off to on.
5869 Resetting 'paste' before ever setting it does not have any effect.
5870 Since mapping doesn't work while 'paste' is active, you need to use
5871 the 'pastetoggle' option to toggle the 'paste' option with some key.
5872
5873 *'pastetoggle'* *'pt'*
5874'pastetoggle' 'pt' string (default "")
5875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005876 When non-empty, specifies the key sequence that toggles the 'paste'
5877 option. This is like specifying a mapping: >
5878 :map {keys} :set invpaste<CR>
5879< Where {keys} is the value of 'pastetoggle'.
5880 The difference is that it will work even when 'paste' is set.
5881 'pastetoggle' works in Insert mode and Normal mode, but not in
5882 Command-line mode.
5883 Mappings are checked first, thus overrule 'pastetoggle'. However,
5884 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5885 this: >
5886 :map <F10> :set paste<CR>
5887 :map <F11> :set nopaste<CR>
5888 :imap <F10> <C-O>:set paste<CR>
5889 :imap <F11> <nop>
5890 :set pastetoggle=<F11>
5891< This will make <F10> start paste mode and <F11> stop paste mode.
5892 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5893 mode everything is inserted literally, except the 'pastetoggle' key
5894 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005895 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896
5897 *'pex'* *'patchexpr'*
5898'patchexpr' 'pex' string (default "")
5899 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900 {not available when compiled without the |+diff|
5901 feature}
5902 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005903 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904
Bram Moolenaardbc28022014-07-26 13:40:44 +02005905 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005906'patchmode' 'pm' string (default "")
5907 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908 When non-empty the oldest version of a file is kept. This can be used
5909 to keep the original version of a file if you are changing files in a
5910 source distribution. Only the first time that a file is written a
5911 copy of the original file will be kept. The name of the copy is the
5912 name of the original file with the string in the 'patchmode' option
5913 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005914 ".orig" or ".org". 'backupdir' must not be empty for this to work
5915 (Detail: The backup file is renamed to the patchmode file after the
5916 new file has been successfully written, that's why it must be possible
5917 to write a backup file). If there was no file to be backed up, an
5918 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005919 When the 'backupskip' pattern matches, a patchmode file is not made.
5920 Using 'patchmode' for compressed files appends the extension at the
5921 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5922 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005923 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005924
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005925 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005926'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 other systems: ".,,")
5928 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005929 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005930 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5931 provided that the file being searched for has a relative path (not
5932 starting with "/", "./" or "../"). The directories in the 'path'
5933 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 - Use commas to separate directory names: >
5935 :set path=.,/usr/local/include,/usr/include
5936< - Spaces can also be used to separate directory names (for backwards
5937 compatibility with version 3.0). To have a space in a directory
5938 name, precede it with an extra backslash, and escape the space: >
5939 :set path=.,/dir/with\\\ space
5940< - To include a comma in a directory name precede it with an extra
5941 backslash: >
5942 :set path=.,/dir/with\\,comma
5943< - To search relative to the directory of the current file, use: >
5944 :set path=.
5945< - To search in the current directory use an empty string between two
5946 commas: >
5947 :set path=,,
5948< - A directory name may end in a ':' or '/'.
5949 - Environment variables are expanded |:set_env|.
5950 - When using |netrw.vim| URLs can be used. For example, adding
5951 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005952 - Search upwards and downwards in a directory tree using "*", "**" and
5953 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005954 {not available when compiled without the |+path_extra| feature}
5955 - Careful with '\' characters, type two to get one in the option: >
5956 :set path=.,c:\\include
5957< Or just use '/' instead: >
5958 :set path=.,c:/include
5959< Don't forget "." or files won't even be found in the same directory as
5960 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005961 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005962 it is something like 256 or 1024 characters.
5963 You can check if all the include files are found, using the value of
5964 'path', see |:checkpath|.
5965 The use of |:set+=| and |:set-=| is preferred when adding or removing
5966 directories from the list. This avoids problems when a future version
5967 uses another default. To remove the current directory use: >
5968 :set path-=
5969< To add the current directory use: >
5970 :set path+=
5971< To use an environment variable, you probably need to replace the
5972 separator. Here is an example to append $INCL, in which directory
5973 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005974 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005975< Replace the ';' with a ':' or whatever separator is used. Note that
5976 this doesn't work when $INCL contains a comma or white space.
5977
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005978 *'perldll'*
5979'perldll' string (default depends on the build)
5980 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005981 {only available when compiled with the |+perl/dyn|
5982 feature}
5983 Specifies the name of the Perl shared library. The default is
5984 DYNAMIC_PERL_DLL, which was specified at compile time.
5985 Environment variables are expanded |:set_env|.
5986 This option cannot be set from a |modeline| or in the |sandbox|, for
5987 security reasons.
5988
Bram Moolenaar071d4272004-06-13 20:20:40 +00005989 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5990'preserveindent' 'pi' boolean (default off)
5991 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005992 When changing the indent of the current line, preserve as much of the
5993 indent structure as possible. Normally the indent is replaced by a
5994 series of tabs followed by spaces as required (unless |'expandtab'| is
5995 enabled, in which case only spaces are used). Enabling this option
5996 means the indent will preserve as many existing characters as possible
5997 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005998 'expandtab' does not apply to the preserved white space, a Tab remains
5999 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006000 NOTE: When using ">>" multiple times the resulting indent is a mix of
6001 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006002 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006003 Also see 'copyindent'.
6004 Use |:retab| to clean up white space.
6005
6006 *'previewheight'* *'pvh'*
6007'previewheight' 'pvh' number (default 12)
6008 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006009 {not available when compiled without the |+quickfix|
6010 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006011 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006012 commands. Used for |CTRL-W_}| when no count is given. Not used when
6013 'previewpopup' is set.
6014
6015 *'previewpopup'* *'pvp'*
6016'previewpopup' 'pvp' string (default empty)
6017 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006018 {not available when compiled without the |+textprop|
6019 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006020 When not empty a popup window is used for commands that would open a
6021 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006022 Not used for the insert completion info, add "popup" to
6023 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006024
6025 *'previewwindow'* *'nopreviewwindow'*
6026 *'pvw'* *'nopvw'* *E590*
6027'previewwindow' 'pvw' boolean (default off)
6028 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006029 {not available when compiled without the |+quickfix|
6030 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006031 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006032 set. It's normally not set directly, but by using one of the commands
6033 |:ptag|, |:pedit|, etc.
6034
6035 *'printdevice'* *'pdev'*
6036'printdevice' 'pdev' string (default empty)
6037 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 {only available when compiled with the |+printer|
6039 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006040 The name of the printer to be used for |:hardcopy|.
6041 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006042 This option cannot be set from a |modeline| or in the |sandbox|, for
6043 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044
Bram Moolenaar8299df92004-07-10 09:47:34 +00006045 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006046'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006047 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006048 {only available when compiled with the |+printer|
6049 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006050 Sets the character encoding used when printing.
6051 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006052
6053 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006054'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006056 {only available when compiled with the |+printer|
6057 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006058 Expression used to print the PostScript produced with |:hardcopy|.
6059 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006060 This option cannot be set from a |modeline| or in the |sandbox|, for
6061 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006062
Bram Moolenaar8299df92004-07-10 09:47:34 +00006063 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006064'printfont' 'pfn' string (default "courier")
6065 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 {only available when compiled with the |+printer|
6067 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006068 The name of the font that will be used for |:hardcopy|.
6069 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070
6071 *'printheader'* *'pheader'*
6072'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074 {only available when compiled with the |+printer|
6075 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006076 The format of the header produced in |:hardcopy| output.
6077 See |pheader-option|.
6078
6079 *'printmbcharset'* *'pmbcs'*
6080'printmbcharset' 'pmbcs' string (default "")
6081 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006082 {only available when compiled with the |+printer|
6083 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006084 The CJK character set to be used for CJK output from |:hardcopy|.
6085 See |pmbcs-option|.
6086
6087 *'printmbfont'* *'pmbfn'*
6088'printmbfont' 'pmbfn' string (default "")
6089 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006090 {only available when compiled with the |+printer|
6091 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006092 List of font names to be used for CJK output from |:hardcopy|.
6093 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094
6095 *'printoptions'* *'popt'*
6096'printoptions' 'popt' string (default "")
6097 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006099 List of items that control the format of the output of |:hardcopy|.
6100 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006102 *'prompt'* *'noprompt'*
6103'prompt' boolean (default on)
6104 global
6105 When on a ":" prompt is used in Ex mode.
6106
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006107 *'pumheight'* *'ph'*
6108'pumheight' 'ph' number (default 0)
6109 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006110 Determines the maximum number of items to show in the popup menu for
6111 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006112 |ins-completion-menu|.
6113
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006114 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006115'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006116 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006117 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006118 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006119
Bram Moolenaard94464e2015-11-02 15:28:18 +01006120 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006121'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006122 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006123 {only available when compiled with the |+python/dyn|
6124 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006125 Specifies the name of the Python 2.x shared library. The default is
6126 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006127 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006128 This option cannot be set from a |modeline| or in the |sandbox|, for
6129 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006130
Bram Moolenaar94073162018-01-31 21:49:05 +01006131 *'pythonhome'*
6132'pythonhome' string (default "")
6133 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006134 {only available when compiled with the |+python/dyn|
6135 feature}
6136 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6137 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6138 which was specified at compile time, will be used for the Python 2.x
6139 home directory.
6140 Environment variables are expanded |:set_env|.
6141 This option cannot be set from a |modeline| or in the |sandbox|, for
6142 security reasons.
6143
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006144 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006145'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006146 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006147 {only available when compiled with the |+python3/dyn|
6148 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006149 Specifies the name of the Python 3 shared library. The default is
6150 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006151 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006152 This option cannot be set from a |modeline| or in the |sandbox|, for
6153 security reasons.
6154
Bram Moolenaar94073162018-01-31 21:49:05 +01006155 *'pythonthreehome'*
6156'pythonthreehome' string (default "")
6157 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006158 {only available when compiled with the |+python3/dyn|
6159 feature}
6160 Specifies the name of the Python 3 home directory. When
6161 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6162 PYTHON3_HOME, which was specified at compile time, will be used for
6163 the Python 3 home directory.
6164 Environment variables are expanded |:set_env|.
6165 This option cannot be set from a |modeline| or in the |sandbox|, for
6166 security reasons.
6167
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006168 *'pyxversion'* *'pyx'*
6169'pyxversion' 'pyx' number (default depends on the build)
6170 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006171 {only available when compiled with the |+python| or
6172 the |+python3| feature}
6173 Specifies the python version used for pyx* functions and commands
6174 |python_x|. The default value is as follows:
6175
6176 Compiled with Default ~
6177 |+python| and |+python3| 0
6178 only |+python| 2
6179 only |+python3| 3
6180
6181 Available values are 0, 2 and 3.
6182 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6183 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6184 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6185 to 2 if Python 2 is available.
6186 See also: |has-pythonx|
6187
6188 If Vim is compiled with only |+python| or |+python3| setting
6189 'pyxversion' has no effect. The pyx* functions and commands are
6190 always the same as the compiled version.
6191
6192 This option cannot be set from a |modeline| or in the |sandbox|, for
6193 security reasons.
6194
Bram Moolenaar858ba062020-05-31 23:11:59 +02006195 *'quickfixtextfunc'* *'qftf'*
6196'quickfixtextfunc' 'qftf' string (default "")
6197 global
6198 {only available when compiled with the |+quickfix|
6199 feature}
6200 This option specifies a function to be used to get the text to display
6201 in the quickfix and location list windows. This can be used to
6202 customize the information displayed in the quickfix or location window
6203 for each entry in the corresponding quickfix or location list. See
6204 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006205 function and an example. The value can be the name of a function, a
6206 |lambda| or a |Funcref|. See |option-value-function| for more
6207 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006208
6209 This option cannot be set from a |modeline| or in the |sandbox|, for
6210 security reasons.
6211
Bram Moolenaar677ee682005-01-27 14:41:15 +00006212 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006213'quoteescape' 'qe' string (default "\")
6214 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006215 The characters that are used to escape quotes in a string. Used for
6216 objects like a', a" and a` |a'|.
6217 When one of the characters in this option is found inside a string,
6218 the following character will be skipped. The default value makes the
6219 text "foo\"bar\\" considered to be one string.
6220
Bram Moolenaar071d4272004-06-13 20:20:40 +00006221 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6222'readonly' 'ro' boolean (default off)
6223 local to buffer
6224 If on, writes fail unless you use a '!'. Protects you from
6225 accidentally overwriting a file. Default on when Vim is started
6226 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006227 When using ":w!" the 'readonly' option is reset for the current
6228 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006229 When using the ":view" command the 'readonly' option is set for the
6230 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006231 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006233 *'redrawtime'* *'rdt'*
6234'redrawtime' 'rdt' number (default 2000)
6235 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006236 {only available when compiled with the |+reltime|
6237 feature}
6238 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006239 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006240 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006241 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006242 matches will be highlighted.
6243 For syntax highlighting the time applies per window. When over the
6244 limit syntax highlighting is disabled until |CTRL-L| is used.
6245 This is used to avoid that Vim hangs when using a very complicated
6246 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006247
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006248 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006249'regexpengine' 're' number (default 0)
6250 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006251 This selects the default regexp engine. |two-engines|
6252 The possible values are:
6253 0 automatic selection
6254 1 old engine
6255 2 NFA engine
6256 Note that when using the NFA engine and the pattern contains something
6257 that is not supported the pattern will not match. This is only useful
6258 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006259 Using automatic selection enables Vim to switch the engine, if the
6260 default engine becomes too costly. E.g., when the NFA engine uses too
6261 many states. This should prevent Vim from hanging on a combination of
6262 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006263
Bram Moolenaar64486672010-05-16 15:46:46 +02006264 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6265'relativenumber' 'rnu' boolean (default off)
6266 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006267 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006268 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006269 precede some vertical motion commands (e.g. j k + -) with, without
6270 having to calculate it yourself. Especially useful in combination with
6271 other commands (e.g. y d c < > gq gw =).
6272 When the 'n' option is excluded from 'cpoptions' a wrapped
6273 line will not use the column of line numbers (this is the default when
6274 'compatible' isn't set).
6275 The 'numberwidth' option can be used to set the room used for the line
6276 number.
6277 When a long, wrapped line doesn't start with the first character, '-'
6278 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006279 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6280 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006281
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006282 The number in front of the cursor line also depends on the value of
6283 'number', see |number_relativenumber| for all combinations of the two
6284 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006285
Bram Moolenaar071d4272004-06-13 20:20:40 +00006286 *'remap'* *'noremap'*
6287'remap' boolean (default on)
6288 global
6289 Allows for mappings to work recursively. If you do not want this for
6290 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006291 NOTE: To avoid portability problems with Vim scripts, always keep
6292 this option at the default "on". Only switch it off when working with
6293 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006295 *'renderoptions'* *'rop'*
6296'renderoptions' 'rop' string (default: empty)
6297 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006298 {only available when compiled with GUI and DIRECTX on
6299 MS-Windows}
6300 Select a text renderer and set its options. The options depend on the
6301 renderer.
6302
6303 Syntax: >
6304 set rop=type:{renderer}(,{name}:{value})*
6305<
6306 Currently, only one optional renderer is available.
6307
6308 render behavior ~
6309 directx Vim will draw text using DirectX (DirectWrite). It makes
6310 drawn glyphs more beautiful than default GDI.
6311 It requires 'encoding' is "utf-8", and only works on
6312 MS-Windows Vista or newer version.
6313
6314 Options:
6315 name meaning type value ~
6316 gamma gamma float 1.0 - 2.2 (maybe)
6317 contrast enhancedContrast float (unknown)
6318 level clearTypeLevel float (unknown)
6319 geom pixelGeometry int 0 - 2 (see below)
6320 renmode renderingMode int 0 - 6 (see below)
6321 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006322 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006323
Bram Moolenaar92467d32017-12-05 13:22:16 +01006324 See this URL for detail (except for scrlines):
6325 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006326
6327 For geom: structure of a device pixel.
6328 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6329 1 - DWRITE_PIXEL_GEOMETRY_RGB
6330 2 - DWRITE_PIXEL_GEOMETRY_BGR
6331
6332 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006333 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006334
6335 For renmode: method of rendering glyphs.
6336 0 - DWRITE_RENDERING_MODE_DEFAULT
6337 1 - DWRITE_RENDERING_MODE_ALIASED
6338 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6339 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6340 4 - DWRITE_RENDERING_MODE_NATURAL
6341 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6342 6 - DWRITE_RENDERING_MODE_OUTLINE
6343
6344 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006345 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006346
6347 For taamode: antialiasing mode used for drawing text.
6348 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6349 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6350 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6351 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6352
6353 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006354 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6355
Bram Moolenaara338adc2018-01-31 20:51:47 +01006356 For scrlines:
6357 This was used for optimizing scrolling behavior, however this
6358 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006359
6360 Example: >
6361 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006362 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006363 set rop=type:directx
6364<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006365 If select a raster font (Courier, Terminal or FixedSys which
6366 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006367 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006368
6369 NOTE: It is known that some fonts and options combination
6370 causes trouble on drawing glyphs.
6371
Bram Moolenaar92467d32017-12-05 13:22:16 +01006372 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006373 special made fonts (True-Type fonts which includes only
6374 bitmap glyphs).
6375 - 'taamode:3' will not work with some vector fonts.
6376
6377 NOTE: With this option, you can display colored emoji
6378 (emoticon) in Windows 8.1 or later. To display colored emoji,
6379 there are some conditions which you should notice.
6380
6381 - If your font includes non-colored emoji already, it will
6382 be used.
6383 - If your font doesn't have emoji, the system chooses an
6384 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6385 will be used.
6386 - When this alternative font didn't have fixed width glyph,
6387 emoji might be rendered beyond the bounding box of drawing
6388 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006389
6390 Other render types are currently not supported.
6391
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 *'report'*
6393'report' number (default 2)
6394 global
6395 Threshold for reporting number of lines changed. When the number of
6396 changed lines is more than 'report' a message will be given for most
6397 ":" commands. If you want it always, set 'report' to 0.
6398 For the ":substitute" command the number of substitutions is used
6399 instead of the number of lines.
6400
6401 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6402'restorescreen' 'rs' boolean (default on)
6403 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006404 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405 When set, the screen contents is restored when exiting Vim. This also
6406 happens when executing external commands.
6407
6408 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6409 options in your .vimrc. To disable restoring:
6410 set t_ti= t_te=
6411 To enable restoring (for an xterm):
6412 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6413 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6414
6415 *'revins'* *'ri'* *'norevins'* *'nori'*
6416'revins' 'ri' boolean (default off)
6417 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 {only available when compiled with the |+rightleft|
6419 feature}
6420 Inserting characters in Insert mode will work backwards. See "typing
6421 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6422 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006423 NOTE: This option is reset when 'compatible' is set.
6424 This option is reset when 'paste' is set and restored when 'paste' is
6425 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426
6427 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6428'rightleft' 'rl' boolean (default off)
6429 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 {only available when compiled with the |+rightleft|
6431 feature}
6432 When on, display orientation becomes right-to-left, i.e., characters
6433 that are stored in the file appear from the right to the left.
6434 Using this option, it is possible to edit files for languages that
6435 are written from the right to the left such as Hebrew and Arabic.
6436 This option is per window, so it is possible to edit mixed files
6437 simultaneously, or to view the same file in both ways (this is
6438 useful whenever you have a mixed text file with both right-to-left
6439 and left-to-right strings so that both sets are displayed properly
6440 in different windows). Also see |rileft.txt|.
6441
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006442 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443'rightleftcmd' 'rlc' string (default "search")
6444 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445 {only available when compiled with the |+rightleft|
6446 feature}
6447 Each word in this option enables the command line editing to work in
6448 right-to-left mode for a group of commands:
6449
6450 search "/" and "?" commands
6451
6452 This is useful for languages such as Hebrew, Arabic and Farsi.
6453 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6454
Bram Moolenaard94464e2015-11-02 15:28:18 +01006455 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006456'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006457 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006458 {only available when compiled with the |+ruby/dyn|
6459 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006460 Specifies the name of the Ruby shared library. The default is
6461 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006462 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006463 This option cannot be set from a |modeline| or in the |sandbox|, for
6464 security reasons.
6465
Bram Moolenaar071d4272004-06-13 20:20:40 +00006466 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006467'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469 {not available when compiled without the
6470 |+cmdline_info| feature}
6471 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006472 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 text in the file is shown on the far right:
6474 Top first line is visible
6475 Bot last line is visible
6476 All first and last line are visible
6477 45% relative position in the file
6478 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006479 Each window has its own ruler. If a window has a status line, the
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01006480 ruler is shown there. If a window doesn't have a status line and
6481 'cmdheight' is zero, the ruler is not shown. Otherwise it is shown in
6482 the last line of the screen. If the statusline is given by
6483 'statusline' (i.e. not empty), this option takes precedence over
zeertzjq75020942022-07-31 11:37:20 +01006484 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006485 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006486 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 the text column (byte number) and the screen column are shown,
6488 separated with a dash.
6489 For an empty line "0-1" is shown.
6490 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006491 This option is reset when 'paste' is set and restored when 'paste' is
6492 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006493 If you don't want to see the ruler all the time but want to know where
6494 you are, use "g CTRL-G" |g_CTRL-G|.
6495 NOTE: This option is reset when 'compatible' is set.
6496
6497 *'rulerformat'* *'ruf'*
6498'rulerformat' 'ruf' string (default empty)
6499 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 {not available when compiled without the |+statusline|
6501 feature}
6502 When this option is not empty, it determines the content of the ruler
6503 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006504 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006505 This option cannot be set in a modeline when 'modelineexpr' is off.
6506
Bram Moolenaar071d4272004-06-13 20:20:40 +00006507 The default ruler width is 17 characters. To make the ruler 15
6508 characters wide, put "%15(" at the start and "%)" at the end.
6509 Example: >
6510 :set rulerformat=%15(%c%V\ %p%%%)
6511<
6512 *'runtimepath'* *'rtp'* *vimfiles*
6513'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006514 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515 $VIM/vimfiles,
6516 $VIMRUNTIME,
6517 $VIM/vimfiles/after,
6518 $HOME/.vim/after"
6519 Amiga: "home:vimfiles,
6520 $VIM/vimfiles,
6521 $VIMRUNTIME,
6522 $VIM/vimfiles/after,
6523 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006524 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 $VIM/vimfiles,
6526 $VIMRUNTIME,
6527 $VIM/vimfiles/after,
6528 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006529 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 $VIMRUNTIME,
6531 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006532 Haiku: "$BE_USER_SETTINGS/vim,
6533 $VIM/vimfiles,
6534 $VIMRUNTIME,
6535 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006536 $BE_USER_SETTINGS/vim/after"
6537 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 $VIM/vimfiles,
6539 $VIMRUNTIME,
6540 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006541 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006542 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543 This is a list of directories which will be searched for runtime
6544 files:
6545 filetype.vim filetypes by file name |new-filetype|
6546 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006547 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 colors/ color scheme files |:colorscheme|
6549 compiler/ compiler files |:compiler|
6550 doc/ documentation |write-local-help|
6551 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006552 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 indent/ indent scripts |indent-expression|
6554 keymap/ key mapping files |mbyte-keymap|
6555 lang/ menu translations |:menutrans|
6556 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006557 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006558 plugin/ plugin scripts |write-plugin|
6559 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006560 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561 syntax/ syntax files |mysyntaxfile|
6562 tutor/ files for vimtutor |tutor|
6563
6564 And any other file searched for with the |:runtime| command.
6565
6566 The defaults for most systems are setup to search five locations:
6567 1. In your home directory, for your personal preferences.
6568 2. In a system-wide Vim directory, for preferences from the system
6569 administrator.
6570 3. In $VIMRUNTIME, for files distributed with Vim.
6571 *after-directory*
6572 4. In the "after" directory in the system-wide Vim directory. This is
6573 for the system administrator to overrule or add to the distributed
6574 defaults (rarely needed)
6575 5. In the "after" directory in your home directory. This is for
6576 personal preferences to overrule or add to the distributed defaults
6577 or system-wide settings (rarely needed).
6578
Bram Moolenaard0796902016-09-16 20:02:31 +02006579 More entries are added when using |packages|. If it gets very long
6580 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6581 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006582
Bram Moolenaar071d4272004-06-13 20:20:40 +00006583 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6584 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006585 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 wildcards.
6587 See |:runtime|.
6588 Example: >
6589 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6590< This will use the directory "~/vimruntime" first (containing your
6591 personal Vim runtime files), then "/mygroup/vim" (shared between a
6592 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6593 files).
6594 You probably should always include $VIMRUNTIME somewhere, to use the
6595 distributed runtime files. You can put a directory before $VIMRUNTIME
6596 to find files which replace a distributed runtime files. You can put
6597 a directory after $VIMRUNTIME to find files which add to distributed
6598 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006599 When Vim is started with |--clean| the home directory entries are not
6600 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 This option cannot be set from a |modeline| or in the |sandbox|, for
6602 security reasons.
6603
6604 *'scroll'* *'scr'*
6605'scroll' 'scr' number (default: half the window height)
6606 local to window
6607 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6608 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006609 changes. This may happen when enabling the |status-line| or
6610 'tabline' option after setting the 'scroll' option.
6611 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006612 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006613 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614
6615 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6616'scrollbind' 'scb' boolean (default off)
6617 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006618 See also |scroll-binding|. When this option is set, the current
6619 window scrolls as other scrollbind windows (windows that also have
6620 this option set) scroll. This option is useful for viewing the
6621 differences between two versions of a file, see 'diff'.
6622 See |'scrollopt'| for options that determine how this option should be
6623 interpreted.
6624 This option is mostly reset when splitting a window to edit another
6625 file. This means that ":split | edit file" results in two windows
6626 with scroll-binding, but ":split file" does not.
6627
Bram Moolenaarae20f342019-11-05 21:09:23 +01006628 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6629'scrollfocus' 'scf' boolean (default off)
6630 global
6631 {only for MS-Windows GUI}
6632 When using the scroll wheel and this option is set, the window under
6633 the mouse pointer is scrolled. With this option off the current
6634 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006635 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006636
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 *'scrolljump'* *'sj'*
6638'scrolljump' 'sj' number (default 1)
6639 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006640 Minimal number of lines to scroll when the cursor gets off the
6641 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6642 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006643 When set to a negative number from -1 to -100 this is used as the
6644 percentage of the window height. Thus -50 scrolls half the window
6645 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006646 NOTE: This option is set to 1 when 'compatible' is set.
6647
6648 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006649'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006650 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651 Minimal number of screen lines to keep above and below the cursor.
6652 This will make some context visible around where you are working. If
6653 you set it to a very large value (999) the cursor line will always be
6654 in the middle of the window (except at the start or end of the file or
6655 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006656 After using the local value, go back the global value with one of
6657 these two: >
6658 setlocal scrolloff<
6659 setlocal scrolloff=-1
6660< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661 NOTE: This option is set to 0 when 'compatible' is set.
6662
6663 *'scrollopt'* *'sbo'*
6664'scrollopt' 'sbo' string (default "ver,jump")
6665 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006666 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006667 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6668 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 The following words are available:
6670 ver Bind vertical scrolling for 'scrollbind' windows
6671 hor Bind horizontal scrolling for 'scrollbind' windows
6672 jump Applies to the offset between two windows for vertical
6673 scrolling. This offset is the difference in the first
6674 displayed line of the bound windows. When moving
6675 around in a window, another 'scrollbind' window may
6676 reach a position before the start or after the end of
6677 the buffer. The offset is not changed though, when
6678 moving back the 'scrollbind' window will try to scroll
6679 to the desired position when possible.
6680 When now making that window the current one, two
6681 things can be done with the relative offset:
6682 1. When "jump" is not included, the relative offset is
6683 adjusted for the scroll position in the new current
6684 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006685 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686 2. When "jump" is included, the other windows are
6687 scrolled to keep the same relative offset. When
6688 going back to the other window, it still uses the
6689 same relative offset.
6690 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006691 When 'diff' mode is active there always is vertical scroll binding,
6692 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693
6694 *'sections'* *'sect'*
6695'sections' 'sect' string (default "SHNHH HUnhsh")
6696 global
6697 Specifies the nroff macros that separate sections. These are pairs of
6698 two letters (See |object-motions|). The default makes a section start
6699 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6700
6701 *'secure'* *'nosecure'* *E523*
6702'secure' boolean (default off)
6703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006704 When on, ":autocmd", shell and write commands are not allowed in
6705 ".vimrc" and ".exrc" in the current directory and map commands are
6706 displayed. Switch it off only if you know that you will not run into
6707 problems, or when the 'exrc' option is off. On Unix this option is
6708 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006709 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006710 'secure' at the end of your ~/.vimrc then.
6711 This option cannot be set from a |modeline| or in the |sandbox|, for
6712 security reasons.
6713
6714 *'selection'* *'sel'*
6715'selection' 'sel' string (default "inclusive")
6716 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 This option defines the behavior of the selection. It is only used
6718 in Visual and Select mode.
6719 Possible values:
6720 value past line inclusive ~
6721 old no yes
6722 inclusive yes yes
6723 exclusive yes no
6724 "past line" means that the cursor is allowed to be positioned one
6725 character past the line.
6726 "inclusive" means that the last character of the selection is included
6727 in an operation. For example, when "x" is used to delete the
6728 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006729 When "old" is used and 'virtualedit' allows the cursor to move past
6730 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006731 Note that when "exclusive" is used and selecting from the end
6732 backwards, you cannot include the last character of a line, when
6733 starting in Normal mode and 'virtualedit' empty.
6734
6735 The 'selection' option is set by the |:behave| command.
6736
6737 *'selectmode'* *'slm'*
6738'selectmode' 'slm' string (default "")
6739 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006740 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741 Select mode instead of Visual mode, when a selection is started.
6742 Possible values:
6743 mouse when using the mouse
6744 key when using shifted special keys
6745 cmd when using "v", "V" or CTRL-V
6746 See |Select-mode|.
6747 The 'selectmode' option is set by the |:behave| command.
6748
6749 *'sessionoptions'* *'ssop'*
6750'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006751 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006753 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 feature}
6755 Changes the effect of the |:mksession| command. It is a comma
6756 separated list of words. Each word enables saving and restoring
6757 something:
6758 word save and restore ~
6759 blank empty windows
6760 buffers hidden and unloaded buffers, not just those in windows
6761 curdir the current directory
6762 folds manually created folds, opened/closed folds and local
6763 fold options
6764 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006765 and contain at least one lowercase letter. Only
6766 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006767 help the help window
6768 localoptions options and mappings local to a window or buffer (not
6769 global values for local options)
6770 options all options and mappings (also global values for local
6771 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006772 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 resize size of the Vim window: 'lines' and 'columns'
6774 sesdir the directory in which the session file is located
6775 will become the current directory (useful with
6776 projects accessed over a network from different
6777 systems)
6778 slash backslashes in file names replaced with forward
6779 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006780 tabpages all tab pages; without this only the current tab page
6781 is restored, so that you can make a session for each
6782 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006783 terminal include terminal windows where the command can be
6784 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 unix with Unix end-of-line format (single <NL>), even when
6786 on Windows or DOS
6787 winpos position of the whole Vim window
6788 winsize window sizes
6789
6790 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006791 When neither "curdir" nor "sesdir" is included, file names are stored
6792 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006793 If you leave out "options" many things won't work well after restoring
6794 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795 "slash" and "unix" are useful on Windows when sharing session files
6796 with Unix. The Unix version of Vim cannot source dos format scripts,
6797 but the Windows version of Vim can source unix format scripts.
6798
6799 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006800'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 global
6802 Name of the shell to use for ! and :! commands. When changing the
6803 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6804 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006805 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 See |option-backslash| about including spaces and backslashes.
6807 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006808
Bram Moolenaara2baa732022-02-04 16:09:54 +00006809 In |restricted-mode| shell commands will not be possible. This mode
6810 is used if the value of $SHELL ends in "false" or "nologin".
6811
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006812 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006813 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6815< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006816 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006818 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006820 Example with escaped space (Vim will do this when initializing the
6821 option from $SHELL): >
6822 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006823< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006824 backslashes are consumed by `:set`.
6825
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826 Under MS-Windows, when the executable ends in ".com" it must be
6827 included. Thus setting the shell to "command.com" or "4dos.com"
6828 works, but "command" and "4dos" do not work for all commands (e.g.,
6829 filtering).
6830 For unknown reasons, when using "4dos.com" the current directory is
6831 changed to "C:\". To avoid this set 'shell' like this: >
6832 :set shell=command.com\ /c\ 4dos
6833< This option cannot be set from a |modeline| or in the |sandbox|, for
6834 security reasons.
6835
6836 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006837'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006838 Win32, when 'shell' contains "powershell":
6839 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006840 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006843 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6844 For MS-Windows, the default is set according to the value of 'shell',
6845 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006846 On Unix it can have more than one flag. Each white space separated
6847 part is passed as an argument to the shell command.
6848 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006849 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006850 This option cannot be set from a |modeline| or in the |sandbox|, for
6851 security reasons.
6852
6853 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006854'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6855 "2>&1| tee", 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 {not available when compiled without the |+quickfix|
6859 feature}
6860 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006861 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006862 including spaces and backslashes.
6863 The name of the temporary file can be represented by "%s" if necessary
6864 (the file name is appended automatically if no %s appears in the value
6865 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006866 For the Amiga the default is ">". For MS-Windows using powershell the
6867 default is "2>&1 | Out-File -Encoding default", otherwise the default
6868 is ">%s 2>&1". The output is directly saved in a file and not echoed
6869 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006870 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 in a file and echoed to the screen. If the 'shell' option is "csh" or
6872 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006873 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006874 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6875 means that stderr is also included. Before using the 'shell' option a
6876 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006877 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6878 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 The initialization of this option is done after reading the ".vimrc"
6880 and the other initializations, so that when the 'shell' option is set
6881 there, the 'shellpipe' option changes automatically, unless it was
6882 explicitly set before.
6883 When 'shellpipe' is set to an empty string, no redirection of the
6884 ":make" output will be done. This is useful if you use a 'makeprg'
6885 that writes to 'makeef' by itself. If you want no piping, but do
6886 want to include the 'makeef', set 'shellpipe' to a single space.
6887 Don't forget to precede the space with a backslash: ":set sp=\ ".
6888 In the future pipes may be used for filtering and this option will
6889 become obsolete (at least for Unix).
6890 This option cannot be set from a |modeline| or in the |sandbox|, for
6891 security reasons.
6892
6893 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006894'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896 Quoting character(s), put around the command passed to the shell, for
6897 the "!" and ":!" commands. The redirection is kept outside of the
6898 quoting. See 'shellxquote' to include the redirection. It's
6899 probably not useful to set both options.
6900 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006901 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006902 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 This option cannot be set from a |modeline| or in the |sandbox|, for
6904 security reasons.
6905
6906 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006907'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6908 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910 String to be used to put the output of a filter command in a temporary
6911 file. See also |:!|. See |option-backslash| about including spaces
6912 and backslashes.
6913 The name of the temporary file can be represented by "%s" if necessary
6914 (the file name is appended automatically if no %s appears in the value
6915 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006916 The default is ">". For Unix, if the 'shell' option is "csh" or
6917 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006918 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006919 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6920 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006921 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6922 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006923 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6924 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 The initialization of this option is done after reading the ".vimrc"
6926 and the other initializations, so that when the 'shell' option is set
6927 there, the 'shellredir' option changes automatically unless it was
6928 explicitly set before.
6929 In the future pipes may be used for filtering and this option will
6930 become obsolete (at least for Unix).
6931 This option cannot be set from a |modeline| or in the |sandbox|, for
6932 security reasons.
6933
6934 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6935'shellslash' 'ssl' boolean (default off)
6936 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006937 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006939 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006940 powershell.exe. Backward slashes can still be typed, but they are
6941 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006942 Note that setting or resetting this option has no effect for some
6943 existing file names, thus this option needs to be set before opening
6944 any file for best results. This might change in the future.
6945 'shellslash' only works when a backslash can be used as a path
6946 separator. To test if this is so use: >
6947 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006948< Also see 'completeslash'.
6949
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006950 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6951'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6952 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006953 When on, use temp files for shell commands. When off use a pipe.
6954 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006955 Currently a pipe is only supported on Unix and MS-Windows 2K and
6956 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006957 :if has("filterpipe")
6958< The advantage of using a pipe is that nobody can read the temp file
6959 and the 'shell' command does not need to support redirection.
6960 The advantage of using a temp file is that the file type and encoding
6961 can be detected.
6962 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6963 |FilterWritePost| autocommands event are not triggered when
6964 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006965 The `system()` function does not respect this option and always uses
6966 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006967 NOTE: This option is set to the Vim default value when 'compatible'
6968 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006969
Bram Moolenaar071d4272004-06-13 20:20:40 +00006970 *'shelltype'* *'st'*
6971'shelltype' 'st' number (default 0)
6972 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006973 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974 On the Amiga this option influences the way how the commands work
6975 which use a shell.
6976 0 and 1: always use the shell
6977 2 and 3: use the shell only to filter lines
6978 4 and 5: use shell only for ':sh' command
6979 When not using the shell, the command is executed directly.
6980
6981 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6982 1 and 3: use "shell cmd" to start external commands
6983
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006984 *'shellxescape'* *'sxe'*
6985'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006986 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006987 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006988 When 'shellxquote' is set to "(" then the characters listed in this
6989 option will be escaped with a '^' character. This makes it possible
6990 to execute most external commands with cmd.exe.
6991
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 *'shellxquote'* *'sxq'*
6993'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006994 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006995 for Win32, when 'shell' is
6996 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006997 for Win32, when 'shell' contains "sh"
6998 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999 for Unix, when using system(): "\"")
7000 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001 Quoting character(s), put around the command passed to the shell, for
7002 the "!" and ":!" commands. Includes the redirection. See
7003 'shellquote' to exclude the redirection. It's probably not useful
7004 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007005 When the value is '(' then ')' is appended. When the value is '"('
7006 then ')"' is appended.
7007 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007008 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007009 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7010 pwsh.exe which automatically strips off the first and last quote on a
7011 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7012 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007013 'shell', to reduce the need to set this option by the user. See
7014 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015 This option cannot be set from a |modeline| or in the |sandbox|, for
7016 security reasons.
7017
7018 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7019'shiftround' 'sr' boolean (default off)
7020 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 Round indent to multiple of 'shiftwidth'. Applies to > and <
7022 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7023 a multiple of 'shiftwidth' (this is Vi compatible).
7024 NOTE: This option is reset when 'compatible' is set.
7025
7026 *'shiftwidth'* *'sw'*
7027'shiftwidth' 'sw' number (default 8)
7028 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007029 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007031 When zero the 'ts' value will be used. Use the |shiftwidth()|
7032 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007033
7034 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007035'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7036 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007037 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007038 This option helps to avoid all the |hit-enter| prompts caused by file
7039 messages, for example with CTRL-G, and to avoid some other messages.
7040 It is a list of flags:
7041 flag meaning when present ~
7042 f use "(3 of 5)" instead of "(file 3 of 5)"
7043 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02007044 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045 m use "[+]" instead of "[Modified]"
7046 n use "[New]" instead of "[New File]"
7047 r use "[RO]" instead of "[readonly]"
7048 w use "[w]" instead of "written" for file write message
7049 and "[a]" instead of "appended" for ':w >> file' command
7050 x use "[dos]" instead of "[dos format]", "[unix]" instead of
7051 "[unix format]" and "[mac]" instead of "[mac format]".
7052 a all of the above abbreviations
7053
7054 o overwrite message for writing a file with subsequent message
7055 for reading a file (useful for ":wn" or when 'autowrite' on)
7056 O message for reading a file overwrites any previous message.
7057 Also for quickfix message (e.g., ":cn").
7058 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02007059 hit TOP, continuing at BOTTOM" messages; when using the search
7060 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061 t truncate file message at the start if it is too long to fit
7062 on the command-line, "<" will appear in the left most column.
7063 Ignored in Ex mode.
7064 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00007065 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066 Ignored in Ex mode.
7067 W don't give "written" or "[w]" when writing a file
7068 A don't give the "ATTENTION" message when an existing swap file
7069 is found.
7070 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02007071 c don't give |ins-completion-menu| messages. For example,
7072 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
7073 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01007074 q use "recording" instead of "recording @a"
7075 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02007076 was used for the command; note that this also affects messages
7077 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007078 S do not show search count message when searching, e.g.
7079 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080
7081 This gives you the opportunity to avoid that a change between buffers
7082 requires you to hit <Enter>, but still gives as useful a message as
7083 possible for the space available. To get the whole message that you
7084 would have got with 'shm' empty, use ":file!"
7085 Useful values:
7086 shm= No abbreviation of message.
7087 shm=a Abbreviation, but no loss of information.
7088 shm=at Abbreviation, and truncate message when necessary.
7089
7090 NOTE: This option is set to the Vi default value when 'compatible' is
7091 set and to the Vim default value when 'compatible' is reset.
7092
7093 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7094'shortname' 'sn' boolean (default off)
7095 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096 Filenames are assumed to be 8 characters plus one extension of 3
7097 characters. Multiple dots in file names are not allowed. When this
7098 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007099 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007101 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102
7103 *'showbreak'* *'sbr'* *E595*
7104'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007105 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007106 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 feature}
7108 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007109 values are "> " or "+++ ": >
7110 :set showbreak=>\
7111< Note the backslash to escape the trailing space. It's easier like
7112 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007113 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007114< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 comma (in a future version the comma might be used to separate the
7116 part that is shown at the end and at the start of a line).
7117 The characters are highlighted according to the '@' flag in
7118 'highlight'.
7119 Note that tabs after the showbreak will be displayed differently.
7120 If you want the 'showbreak' to appear in between line numbers, add the
7121 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007122 A window-local value overrules a global value. If the global value is
7123 set and you want no value in the current window use NONE: >
7124 :setlocal showbreak=NONE
7125<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007127'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7128 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 {not available when compiled without the
7131 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007132 Show (partial) command in the last line of the screen. Set this
7133 option off if your terminal is slow.
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01007134 The option has no effect when 'cmdheight' is zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007135 In Visual mode the size of the selected area is shown:
7136 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007137 If the number of bytes is different it is also displayed: "2-6"
7138 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007140 - When selecting a block, the size in screen characters:
7141 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142 NOTE: This option is set to the Vi default value when 'compatible' is
7143 set and to the Vim default value when 'compatible' is reset.
7144
7145 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7146'showfulltag' 'sft' boolean (default off)
7147 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 When completing a word in insert mode (see |ins-completion|) from the
7149 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007150 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007151 matched a C function, you can see a template for what arguments are
7152 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007153 Note that this doesn't work well together with having "longest" in
7154 'completeopt', because the completion from the search pattern may not
7155 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156
7157 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7158'showmatch' 'sm' boolean (default off)
7159 global
7160 When a bracket is inserted, briefly jump to the matching one. The
7161 jump is only done if the match can be seen on the screen. The time to
7162 show the match can be set with 'matchtime'.
7163 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007164 seen or not).
7165 This option is reset when 'paste' is set and restored when 'paste' is
7166 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007167 When the 'm' flag is not included in 'cpoptions', typing a character
7168 will immediately move the cursor back to where it belongs.
7169 See the "sm" field in 'guicursor' for setting the cursor shape and
7170 blinking when showing the match.
7171 The 'matchpairs' option can be used to specify the characters to show
7172 matches for. 'rightleft' and 'revins' are used to look for opposite
7173 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007174 Also see the matchparen plugin for highlighting the match when moving
7175 around |pi_paren.txt|.
7176 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177
7178 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7179'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7180 global
7181 If in Insert, Replace or Visual mode put a message on the last line.
7182 Use the 'M' flag in 'highlight' to set the type of highlighting for
7183 this message.
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01007184 The option has no effect when 'cmdheight' is zero.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007185 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007186 doesn't mean XIM is really active, especially when 'imactivatekey' is
7187 not set.
7188 NOTE: This option is set to the Vi default value when 'compatible' is
7189 set and to the Vim default value when 'compatible' is reset.
7190
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007191 *'showtabline'* *'stal'*
7192'showtabline' 'stal' number (default 1)
7193 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007194 The value of this option specifies when the line with tab page labels
7195 will be displayed:
7196 0: never
7197 1: only if there are at least two tab pages
7198 2: always
7199 This is both for the GUI and non-GUI implementation of the tab pages
7200 line.
7201 See |tab-page| for more information about tab pages.
7202
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 *'sidescroll'* *'ss'*
7204'sidescroll' 'ss' number (default 0)
7205 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 The minimal number of columns to scroll horizontally. Used only when
7207 the 'wrap' option is off and the cursor is moved off of the screen.
7208 When it is zero the cursor will be put in the middle of the screen.
7209 When using a slow terminal set it to a large number or 0. When using
7210 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7211 commands.
7212
7213 *'sidescrolloff'* *'siso'*
7214'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007215 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007217 right of the cursor if 'nowrap' is set. Setting this option to a
7218 value greater than 0 while having |'sidescroll'| also at a non-zero
7219 value makes some context visible in the line you are scrolling in
7220 horizontally (except at beginning of the line). Setting this option
7221 to a large value (like 999) has the effect of keeping the cursor
7222 horizontally centered in the window, as long as one does not come too
7223 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007224 After using the local value, go back the global value with one of
7225 these two: >
7226 setlocal sidescrolloff<
7227 setlocal sidescrolloff=-1
7228< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007229
7230 Example: Try this together with 'sidescroll' and 'listchars' as
7231 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007232 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233
7234 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7235 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007236<
7237 *'signcolumn'* *'scl'*
7238'signcolumn' 'scl' string (default "auto")
7239 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007240 {not available when compiled without the |+signs|
7241 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007242 Whether or not to draw the signcolumn. Valid values are:
7243 "auto" only when there is a sign to display
7244 "no" never
7245 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007246 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007247 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248
7249
7250 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7251'smartcase' 'scs' boolean (default off)
7252 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 Override the 'ignorecase' option if the search pattern contains upper
7254 case characters. Only used when the search pattern is typed and
7255 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007256 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007257 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7258 recalling the search pattern from history and hitting <Enter>.
7259 NOTE: This option is reset when 'compatible' is set.
7260
7261 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7262'smartindent' 'si' boolean (default off)
7263 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007264 Do smart autoindenting when starting a new line. Works for C-like
7265 programs, but can also be used for other languages. 'cindent' does
7266 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007267 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007268 setting 'si' has no effect. 'indentexpr' is a more advanced
7269 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007270 Normally 'autoindent' should also be on when using 'smartindent'.
7271 An indent is automatically inserted:
7272 - After a line ending in '{'.
7273 - After a line starting with a keyword from 'cinwords'.
7274 - Before a line starting with '}' (only with the "O" command).
7275 When typing '}' as the first character in a new line, that line is
7276 given the same indent as the matching '{'.
7277 When typing '#' as the first character in a new line, the indent for
7278 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007279 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007280 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7281 When using the ">>" command, lines starting with '#' are not shifted
7282 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007283 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007284 This option is reset when 'paste' is set and restored when 'paste' is
7285 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286
7287 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7288'smarttab' 'sta' boolean (default off)
7289 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007291 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7292 <BS> will delete a 'shiftwidth' worth of space at the start of the
7293 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007294 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007295 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7296 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007297 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007298 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007299 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007300 This option is reset when 'paste' is set and restored when 'paste' is
7301 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007302 NOTE: This option is reset when 'compatible' is set.
7303
7304 *'softtabstop'* *'sts'*
7305'softtabstop' 'sts' number (default 0)
7306 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307 Number of spaces that a <Tab> counts for while performing editing
7308 operations, like inserting a <Tab> or using <BS>. It "feels" like
7309 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7310 used. This is useful to keep the 'ts' setting at its standard value
7311 of 8, while being able to edit like it is set to 'sts'. However,
7312 commands like "x" still work on the actual characters.
7313 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007314 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007315 'softtabstop' is set to 0 when the 'paste' option is set and restored
7316 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7318 spaces is minimized by using <Tab>s.
7319 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7320 set.
7321 NOTE: This option is set to 0 when 'compatible' is set.
7322
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007323 If Vim is compiled with the |+vartabs| feature then the value of
7324 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7325 anything other than an empty string.
7326
Bram Moolenaar217ad922005-03-20 22:37:15 +00007327 *'spell'* *'nospell'*
7328'spell' boolean (default off)
7329 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007330 {not available when compiled without the |+syntax|
7331 feature}
7332 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007333 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007334
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007335 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007336'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007337 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007338 {not available when compiled without the |+syntax|
7339 feature}
7340 Pattern to locate the end of a sentence. The following word will be
7341 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007342 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007343 When this check is not wanted make this option empty.
7344 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007345 Be careful with special characters, see |option-backslash| about
7346 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007347 To set this option automatically depending on the language, see
7348 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007349
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007350 *'spellfile'* *'spf'*
7351'spellfile' 'spf' string (default empty)
7352 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007353 {not available when compiled without the |+syntax|
7354 feature}
7355 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007356 commands. It must end in ".{encoding}.add". You need to include the
7357 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007358 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007359 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007360 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007361 |zg| and |zw| commands can be used to access each. This allows using
7362 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007363 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007364 you: Using the first directory in 'runtimepath' that is writable. If
7365 there is no "spell" directory yet it will be created. For the file
7366 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007367 ignoring the region.
7368 The resulting ".spl" file will be used for spell checking, it does not
7369 have to appear in 'spelllang'.
7370 Normally one file is used for all regions, but you can add the region
7371 name if you want to. However, it will then only be used when
7372 'spellfile' is set to it, for entries in 'spelllang' only files
7373 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007374 This option cannot be set from a |modeline| or in the |sandbox|, for
7375 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007376
Bram Moolenaar217ad922005-03-20 22:37:15 +00007377 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007378'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007379 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007380 {not available when compiled without the |+syntax|
7381 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007382 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007383 on spellchecking will be done for these languages. Example: >
7384 set spelllang=en_us,nl,medical
7385< This means US English, Dutch and medical words are recognized. Words
7386 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007387 The word list name must consist of alphanumeric characters, a dash or
7388 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007389 recommended to separate the two letter language name from a
7390 specification. Thus "en-rare" is used for rare English words.
7391 A region name must come last and have the form "_xx", where "xx" is
7392 the two-letter, lower case region name. You can use more than one
7393 region by listing them: "en_us,en_ca" supports both US and Canadian
7394 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007395 Britain. (Note: currently en_au and en_nz dictionaries are older than
7396 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007397 If the name "cjk" is included East Asian characters are excluded from
7398 spell checking. This is useful when editing text that also has Asian
7399 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007400 Note that the "medical" dictionary does not exist, it is just an
7401 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007402 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007403 As a special case the name of a .spl file can be given as-is. The
7404 first "_xx" in the name is removed and used as the region name
7405 (_xx is an underscore, two letters and followed by a non-letter).
7406 This is mainly for testing purposes. You must make sure the correct
7407 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007408 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007409 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7410 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007411 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007412
Bram Moolenaar98692072006-02-04 00:57:42 +00007413 If the |spellfile.vim| plugin is active and you use a language name
7414 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7415 will ask you if you want to download the file.
7416
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007417 After this option has been set successfully, Vim will source the files
7418 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007419 up to the first character that is not an ASCII letter or number and
7420 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007421
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007422 *'spelloptions'* *'spo'*
7423'spelloptions' 'spo' string (default "")
7424 local to buffer
7425 {not available when compiled without the |+syntax|
7426 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007427 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007428 camel When a word is CamelCased, assume "Cased" is a
7429 separate word: every upper-case character in a word
7430 that comes after a lower case character indicates the
7431 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007432
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007433 *'spellsuggest'* *'sps'*
7434'spellsuggest' 'sps' string (default "best")
7435 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007436 {not available when compiled without the |+syntax|
7437 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007438 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007439 the |spellsuggest()| function. This is a comma-separated list of
7440 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007441
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007442 best Internal method that works best for English. Finds
7443 changes like "fast" and uses a bit of sound-a-like
7444 scoring to improve the ordering.
7445
7446 double Internal method that uses two methods and mixes the
7447 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007448 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007449 word. That only works when the language specifies
7450 sound folding. Can be slow and doesn't always give
7451 better results.
7452
7453 fast Internal method that only checks for simple changes:
7454 character inserts/deletes/swaps. Works well for
7455 simple typing mistakes.
7456
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007457 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007458 Not used for |spellsuggest()|. The number of
7459 suggestions is never more than the value of 'lines'
7460 minus two.
7461
Bram Moolenaar585ee072022-01-29 11:22:17 +00007462 timeout:{millisec} Limit the time searching for suggestions to
7463 {millisec} milli seconds. Applies to the following
7464 methods. When omitted the limit is 5000. When
7465 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007466 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007467
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007468 file:{filename} Read file {filename}, which must have two columns,
7469 separated by a slash. The first column contains the
7470 bad word, the second column the suggested good word.
7471 Example:
7472 theribal/terrible ~
7473 Use this for common mistakes that do not appear at the
7474 top of the suggestion list with the internal methods.
7475 Lines without a slash are ignored, use this for
7476 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007477 The word in the second column must be correct,
7478 otherwise it will not be used. Add the word to an
7479 ".add" file if it is currently flagged as a spelling
7480 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007481 The file is used for all languages.
7482
7483 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7484 trouble with spaces. |v:val| holds the badly spelled
7485 word. The expression must evaluate to a List of
7486 Lists, each with a suggestion and a score.
7487 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007488 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007489 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007490 internal methods use. A lower score is better.
7491 This may invoke |spellsuggest()| if you temporarily
7492 set 'spellsuggest' to exclude the "expr:" part.
7493 Errors are silently ignored, unless you set the
7494 'verbose' option to a non-zero value.
7495
7496 Only one of "best", "double" or "fast" may be used. The others may
7497 appear several times in any order. Example: >
7498 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7499<
7500 This option cannot be set from a |modeline| or in the |sandbox|, for
7501 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007502
7503
Bram Moolenaar071d4272004-06-13 20:20:40 +00007504 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7505'splitbelow' 'sb' boolean (default off)
7506 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 When on, splitting a window will put the new window below the current
7508 one. |:split|
7509
7510 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7511'splitright' 'spr' boolean (default off)
7512 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513 When on, splitting a window will put the new window right of the
7514 current one. |:vsplit|
7515
7516 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7517'startofline' 'sol' boolean (default on)
7518 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007520 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007521 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007522 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523 with a linewise operator, with "%" with a count and to buffer changing
7524 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7525 only has a line number, e.g., ":25" or ":+".
7526 In case of buffer changing commands the cursor is placed at the column
7527 where it was the last time the buffer was edited.
7528 NOTE: This option is set when 'compatible' is set.
7529
Bram Moolenaar00654022011-02-25 14:42:19 +01007530 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007532 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007533 {not available when compiled without the |+statusline|
7534 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007535 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536 Also see |status-line|.
7537
7538 The option consists of printf style '%' items interspersed with
7539 normal text. Each status line item is of the form:
7540 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007541 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007542 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007543
Bram Moolenaar238a5642006-02-21 22:12:05 +00007544 When the option starts with "%!" then it is used as an expression,
7545 evaluated and the result is used as the option value. Example: >
7546 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007547< The *g:statusline_winid* variable will be set to the |window-ID| of the
7548 window that the status line belongs to.
7549 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007550 Note that the "%!" expression is evaluated in the context of the
7551 current window and buffer, while %{} items are evaluated in the
7552 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007553
7554 When there is error while evaluating the option then it will be made
7555 empty to avoid further errors. Otherwise screen updating would loop.
7556
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557 Note that the only effect of 'ruler' when this option is set (and
7558 'laststatus' is 2) is controlling the output of |CTRL-G|.
7559
7560 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007561 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007563 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564 minwid Minimum width of the item, padding as set by '-' & '0'.
7565 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007566 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567 on the left for text items. Numeric items will be
7568 shifted down to maxwid-2 digits followed by '>'number
7569 where number is the amount of missing digits, much like
7570 an exponential notation.
7571 item A one letter code as described below.
7572
7573 Following is a description of the possible statusline items. The
7574 second character in "item" is the type:
7575 N for number
7576 S for string
7577 F for flags as described below
7578 - not applicable
7579
7580 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007581 f S Path to the file in the buffer, as typed or relative to current
7582 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007583 F S Full path to the file in the buffer.
7584 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007585 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007587 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007589 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007590 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007591 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007593 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007594 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007595 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007596 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7597 being used: "<keymap>"
7598 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007599 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 B N As above, in hexadecimal.
7601 o N Byte number in file of byte under cursor, first byte is 1.
7602 Mnemonic: Offset from start of file (with one added)
7603 {not available when compiled without |+byte_offset| feature}
7604 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007605 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007606 l N Line number.
7607 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007608 c N Column number (byte index).
7609 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007610 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007611 p N Percentage through file in lines as in |CTRL-G|.
7612 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007613 percentage described for 'ruler'. Always 3 in length, unless
7614 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007615 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007617 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007618 Note that there is no '%' before the closing '}'. The
7619 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007620 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007621 {% - This is almost same as { except the result of the expression is
7622 re-evaluated as a statusline format string. Thus if the
7623 return value of expr contains % items they will get expanded.
7624 The expression can contain the } character, the end of
7625 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007626 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007627 func! Stl_filename() abort
7628 return "%t"
7629 endfunc
7630< `stl=%{Stl_filename()}` results in `"%t"`
7631 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007632 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 ( - Start of item group. Can be used for setting the width and
7634 alignment of a section. Must be followed by %) somewhere.
7635 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007636 T N For 'tabline': start of tab page N label. Use %T after the last
7637 label. This information is used for mouse clicks.
7638 X N For 'tabline': start of close tab N label. Use %X after the
7639 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7640 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007641 < - Where to truncate line if too long. Default is at the start.
7642 No width fields allowed.
7643 = - Separation point between left and right aligned items.
7644 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007645 # - Set highlight group. The name must follow and then a # again.
7646 Thus use %#HLname# for highlight group HLname. The same
7647 highlighting is used, also for the statusline of non-current
7648 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007650 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007651 The difference between User{N} and StatusLine will be applied
7652 to StatusLineNC for the statusline of non-current windows.
7653 The number N must be between 1 and 9. See |hl-User1..9|
7654
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007655 When displaying a flag, Vim removes the leading comma, if any, when
7656 that flag comes right after plaintext. This will make a nice display
7657 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007658
Bram Moolenaar582fd852005-03-28 20:58:01 +00007659 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007660 not set) and a minwid is not set for the group, the whole group will
7661 become empty. This will make a group like the following disappear
7662 completely from the statusline when none of the flags are set. >
7663 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007664< Beware that an expression is evaluated each and every time the status
7665 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007666 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007667 While evaluating %{} the current buffer and current window will be set
7668 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007669 currently being drawn. The expression will evaluate in this context.
7670 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7671 real current buffer and "g:actual_curwin" to the |window-ID| of the
7672 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007673
Bram Moolenaar30b65812012-07-12 22:01:11 +02007674 The 'statusline' option will be evaluated in the |sandbox| if set from
7675 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007676 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007677
7678 It is not allowed to change text or jump to another window while
7679 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007680
7681 If the statusline is not updated when you want it (e.g., after setting
7682 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007683 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007685 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007686 Otherwise the result is taken as flag text and applied to the rules
7687 described above.
7688
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007689 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007691 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007692
7693 Examples:
7694 Emulate standard status line with 'ruler' set >
7695 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7696< Similar, but add ASCII value of char under the cursor (like "ga") >
7697 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7698< Display byte count and byte value, modified flag in red. >
7699 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7700 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7701< Display a ,GZ flag if a compressed file is loaded >
7702 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7703< In the |:autocmd|'s: >
7704 :let b:gzflag = 1
7705< And: >
7706 :unlet b:gzflag
7707< And define this function: >
7708 :function VarExists(var, val)
7709 : if exists(a:var) | return a:val | else | return '' | endif
7710 :endfunction
7711<
7712 *'suffixes'* *'su'*
7713'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715 Files with these suffixes get a lower priority when multiple files
7716 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007717 suffixes. Spaces after the comma are ignored. A dot is also seen as
7718 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719 separator, precede it with a backslash (see |option-backslash| about
7720 including spaces and backslashes).
7721 See 'wildignore' for completely ignoring files.
7722 The use of |:set+=| and |:set-=| is preferred when adding or removing
7723 suffixes from the list. This avoids problems when a future version
7724 uses another default.
7725
7726 *'suffixesadd'* *'sua'*
7727'suffixesadd' 'sua' string (default "")
7728 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 {not available when compiled without the
7730 |+file_in_path| feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007731 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007732 file for the "gf", "[I", etc. commands. Example: >
7733 :set suffixesadd=.java
7734<
7735 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7736'swapfile' 'swf' boolean (default on)
7737 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007738 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007739 swapfile is not wanted for a specific buffer. For example, with
7740 confidential information that even root must not be able to access.
7741 Careful: All text will be in memory:
7742 - Don't use this for big files.
7743 - Recovery will be impossible!
7744 A swapfile will only be present when |'updatecount'| is non-zero and
7745 'swapfile' is set.
7746 When 'swapfile' is reset, the swap file for the current buffer is
7747 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7748 non-zero, a swap file is immediately created.
7749 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007750 If you want to open a new buffer without creating a swap file for it,
7751 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007752 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753
7754 This option is used together with 'bufhidden' and 'buftype' to
7755 specify special kinds of buffers. See |special-buffers|.
7756
7757 *'swapsync'* *'sws'*
7758'swapsync' 'sws' string (default "fsync")
7759 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007761 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007762 When this option is empty parts of the swap file may be in memory and
7763 not written to disk. When the system crashes you may lose more work.
7764 On Unix the system does a sync now and then without Vim asking for it,
7765 so the disadvantage of setting this option off is small. On some
7766 systems the swap file will not be written at all. For a unix system
7767 setting it to "sync" will use the sync() call instead of the default
7768 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007769 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007770
7771 *'switchbuf'* *'swb'*
7772'switchbuf' 'swb' string (default "")
7773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007774 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007775 Mostly for |quickfix| commands some values are also used for other
7776 commands, as mentioned below.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007777 Possible values (comma-separated list):
Bram Moolenaar071d4272004-06-13 20:20:40 +00007778 useopen If included, jump to the first open window that
7779 contains the specified buffer (if there is one).
7780 Otherwise: Do not examine other windows.
7781 This setting is checked with |quickfix| commands, when
7782 jumping to errors (":cc", ":cn", "cp", etc.). It is
7783 also used in all buffer related split commands, for
7784 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007785 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007786 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007788 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007789 Otherwise: do not split, use current window (when used
7790 in the quickfix window: the previously used window or
7791 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007792 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007793 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007794 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007795 uselast If included, jump to the previously used window when
7796 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007798 *'synmaxcol'* *'smc'*
7799'synmaxcol' 'smc' number (default 3000)
7800 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007801 {not available when compiled without the |+syntax|
7802 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007803 Maximum column in which to search for syntax items. In long lines the
7804 text after this column is not highlighted and following lines may not
7805 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007806 This helps to avoid very slow redrawing for an XML file that is one
7807 long line.
7808 Set to zero to remove the limit.
7809
Bram Moolenaar071d4272004-06-13 20:20:40 +00007810 *'syntax'* *'syn'*
7811'syntax' 'syn' string (default empty)
7812 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007813 {not available when compiled without the |+syntax|
7814 feature}
7815 When this option is set, the syntax with this name is loaded, unless
7816 syntax highlighting has been switched off with ":syntax off".
7817 Otherwise this option does not always reflect the current syntax (the
7818 b:current_syntax variable does).
7819 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007820 not automatically recognized. Example, in an IDL file:
7821 /* vim: set syntax=idl : */ ~
7822 When a dot appears in the value then this separates two filetype
7823 names. Example:
7824 /* vim: set syntax=c.doxygen : */ ~
7825 This will use the "c" syntax first, then the "doxygen" syntax.
7826 Note that the second one must be prepared to be loaded as an addition,
7827 otherwise it will be skipped. More than one dot may appear.
7828 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 :set syntax=OFF
7830< To switch syntax highlighting on according to the current value of the
7831 'filetype' option: >
7832 :set syntax=ON
7833< What actually happens when setting the 'syntax' option is that the
7834 Syntax autocommand event is triggered with the value as argument.
7835 This option is not copied to another buffer, independent of the 's' or
7836 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007837 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007838
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007839 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007840'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007841 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00007842 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007843 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007844 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007845
7846 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007847 option and only when there is no GUI tab line. When 'e' is in
7848 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007849 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007850
7851 The value is evaluated like with 'statusline'. You can use
7852 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007853 the text to be displayed. Use "%1T" for the first label, "%2T" for
7854 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007855
Bram Moolenaare12bab32019-01-08 22:02:56 +01007856 When changing something that is used in 'tabline' that does not
7857 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007858 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007859
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007860 Keep in mind that only one of the tab pages is the current one, others
7861 are invisible and you can't jump to their windows.
7862
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007863
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007864 *'tabpagemax'* *'tpm'*
7865'tabpagemax' 'tpm' number (default 10)
7866 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007867 Maximum number of tab pages to be opened by the |-p| command line
7868 argument or the ":tab all" command. |tabpage|
7869
7870
7871 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872'tabstop' 'ts' number (default 8)
7873 local to buffer
7874 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007875 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876
7877 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007878 appear wrong in many places, e.g., when printing it.
7879 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007880
7881 There are four main ways to use tabs in Vim:
7882 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7883 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007884 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007885 behave like a tab appears every 4 (or 3) characters.
7886 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7887 'expandtab'. This way you will always insert spaces. The
7888 formatting will never be messed up when 'tabstop' is changed.
7889 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007890 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007891 works when using Vim to edit the file.
7892 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7893 'noexpandtab'. This should then work (for initial indents only)
7894 for any tabstop setting that people use. It might be nice to have
7895 tabs after the first non-blank inserted as spaces if you do this
7896 though. Otherwise aligned comments will be wrong when 'tabstop' is
7897 changed.
7898
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007899 If Vim is compiled with the |+vartabs| feature then the value of
7900 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7901 than an empty string.
7902
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7904'tagbsearch' 'tbs' boolean (default on)
7905 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007906 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007907 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007908 searching makes searching for a tag a LOT faster, but a linear search
7909 will find more tags if the tags file wasn't properly sorted.
7910 Vim normally assumes that your tags files are sorted, or indicate that
7911 they are not sorted. Only when this is not the case does the
7912 'tagbsearch' option need to be switched off.
7913
7914 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007915 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007916 certain files, or retry all files with a linear search. When
7917 'tagbsearch' is off, only a linear search is done.
7918
7919 Linear searching is done anyway, for one file, when Vim finds a line
7920 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007921 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922< [The whitespace before and after the '0' must be a single <Tab>]
7923
7924 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007925 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007926 instead of a normal tag name, a retry is done with a linear search.
7927 Tags in unsorted tags files, and matches with different case will only
7928 be found in the retry.
7929
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007930 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007931 linear search can be avoided when case is ignored. Use a value of '2'
7932 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7933 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00007934 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
7935 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
7936 used for this as well. Note that case must be folded to uppercase for
7937 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007938
7939 By default, tag searches are case-sensitive. Case is ignored when
7940 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7941 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007942 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7943 'tagcase' is "smart", and the pattern contains only lowercase
7944 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945
7946 When 'tagbsearch' is off, tags searching is slower when a full match
7947 exists, but faster when no full match exists. Tags in unsorted tags
7948 files may only be found with 'tagbsearch' off.
7949 When the tags file is not sorted, or sorted in a wrong way (not on
7950 ASCII byte value), 'tagbsearch' should be off, or the line given above
7951 must be included in the tags file.
7952 This option doesn't affect commands that find all matching tags (e.g.,
7953 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007955 *'tagcase'* *'tc'*
7956'tagcase' 'tc' string (default "followic")
7957 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007958 This option specifies how case is handled when searching the tags
7959 file:
7960 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007961 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007962 ignore Ignore case
7963 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007964 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007965 NOTE: This option is set to the Vi default value when 'compatible' is
7966 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007967
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007968 *'tagfunc'* *'tfu'*
7969'tagfunc' 'tfu' string (default: empty)
7970 local to buffer
7971 {not available when compiled without the |+eval|
7972 feature}
7973 This option specifies a function to be used to perform tag searches.
7974 The function gets the tag pattern and should return a List of matching
7975 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007976 function and an example. The value can be the name of a function, a
7977 |lambda| or a |Funcref|. See |option-value-function| for more
7978 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007979
Bram Moolenaar071d4272004-06-13 20:20:40 +00007980 *'taglength'* *'tl'*
7981'taglength' 'tl' number (default 0)
7982 global
7983 If non-zero, tags are significant up to this number of characters.
7984
7985 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7986'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7987 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007988 If on and using a tags file in another directory, file names in that
7989 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990 NOTE: This option is set to the Vi default value when 'compatible' is
7991 set and to the Vim default value when 'compatible' is reset.
7992
7993 *'tags'* *'tag'* *E433*
7994'tags' 'tag' string (default "./tags,tags", when compiled with
7995 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7996 global or local to buffer |global-local|
7997 Filenames for the tag command, separated by spaces or commas. To
7998 include a space or comma in a file name, precede it with a backslash
7999 (see |option-backslash| about including spaces and backslashes).
8000 When a file name starts with "./", the '.' is replaced with the path
8001 of the current file. But only when the 'd' flag is not included in
8002 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8003 |tags-option|.
8004 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008005 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8006 find all files named "tags" below "/lib". The filename itself cannot
8007 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
8008 files called "tags?". {not available when compiled without the
8009 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008010 The |tagfiles()| function can be used to get a list of the file names
8011 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008012 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8013 files are also supported. They are automatically recognized. The
8014 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8015 differences are ignored (MS-Windows). |emacs-tags|
8016 The use of |:set+=| and |:set-=| is preferred when adding or removing
8017 file names from the list. This avoids problems when a future version
8018 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008019
8020 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8021'tagstack' 'tgst' boolean (default on)
8022 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008023 When on, the |tagstack| is used normally. When off, a ":tag" or
8024 ":tselect" command with an argument will not push the tag onto the
8025 tagstack. A following ":tag" without an argument, a ":pop" command or
8026 any other command that uses the tagstack will use the unmodified
8027 tagstack, but does change the pointer to the active entry.
8028 Resetting this option is useful when using a ":tag" command in a
8029 mapping which should not change the tagstack.
8030
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008031 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008032'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008033 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008034 {only available when compiled with the |+tcl/dyn|
8035 feature}
8036 Specifies the name of the Tcl shared library. The default is
8037 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008038 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008039 This option cannot be set from a |modeline| or in the |sandbox|, for
8040 security reasons.
8041
Bram Moolenaar071d4272004-06-13 20:20:40 +00008042 *'term'* *E529* *E530* *E531*
8043'term' string (default is $TERM, if that fails:
8044 in the GUI: "builtin_gui"
8045 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008046 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 on Unix: "ansi"
8049 on VMS: "ansi"
8050 on Win 32: "win32")
8051 global
8052 Name of the terminal. Used for choosing the terminal control
8053 characters. Environment variables are expanded |:set_env|.
8054 For example: >
8055 :set term=$TERM
8056< See |termcap|.
8057
8058 *'termbidi'* *'tbidi'*
8059 *'notermbidi'* *'notbidi'*
8060'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 {only available when compiled with the |+arabic|
8063 feature}
8064 The terminal is in charge of Bi-directionality of text (as specified
8065 by Unicode). The terminal is also expected to do the required shaping
8066 that some languages (such as Arabic) require.
8067 Setting this option implies that 'rightleft' will not be set when
8068 'arabic' is set and the value of 'arabicshape' will be ignored.
8069 Note that setting 'termbidi' has the immediate effect that
8070 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8071 This option is reset when the GUI is started.
8072 For further details see |arabic.txt|.
8073
8074 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008075'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008076 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008077 Encoding used for the terminal. This specifies what character
8078 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008079 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008080 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008081 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008082 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008083 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8084 Any attempts to set a different value will be rejected, and an error
8085 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008086 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008087 because the Win32 system always passes Unicode characters.
8088 When empty, the same encoding is used as for the 'encoding' option.
8089 This is the normal value.
8090 Not all combinations for 'termencoding' and 'encoding' are valid. See
8091 |encoding-table|.
8092 The value for this option must be supported by internal conversions or
8093 iconv(). When this is not possible no conversion will be done and you
8094 will probably experience problems with non-ASCII characters.
8095 Example: You are working with the locale set to euc-jp (Japanese) and
8096 want to edit a UTF-8 file: >
8097 :let &termencoding = &encoding
8098 :set encoding=utf-8
8099< You need to do this when your system has no locale support for UTF-8.
8100
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008101 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008102'termguicolors' 'tgc' boolean (default off)
8103 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008104 {not available when compiled without the
8105 |+termguicolors| feature}
8106 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008107 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008108
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008109 Requires a ISO-8613-3 compatible terminal. If setting this option
8110 does not work (produces a colorless UI) reading |xterm-true-color|
8111 might help.
8112
8113 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8114 is required. Use this check to find out: >
8115 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008116< This requires Vim to be built with the |+vtp| feature.
8117
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008118 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008119
8120 When using Vim with Windows Terminal, the background of Windows
8121 Terminal is normally filled with the Vim background color. Setting
8122 'termguicolors' and the guibg of the Normal highlight group to NONE
8123 will make the background transparent: >
8124 :hi Normal guibg=NONE
8125<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008126 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008127
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008128 *'termwinkey'* *'twk'*
8129'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008130 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008131 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008132 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008133 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008134 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008135< The string must be one key stroke but can be multiple bytes.
8136 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008137 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008138 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008139
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008140 *'termwinscroll'* *'twsl'*
8141'termwinscroll' 'twsl' number (default 10000)
8142 local to buffer
8143 {not available when compiled without the
8144 |+terminal| feature}
8145 Number of scrollback lines to keep. When going over this limit the
8146 first 10% of the scrollback lines are deleted. This is just to reduce
8147 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008148 Also used as a limit for text sent to the terminal in one write,
8149 multiplied by the number of columns times 3 (average number of bytes
8150 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008151
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008152 *'termwinsize'* *'tws'*
8153'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008154 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008155 Size used when opening the |terminal| window. Format:
8156 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008157 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008158 - When set with a "x" (e.g., "24x80") the terminal size is not
8159 adjusted to the window size. If the window is smaller only the
8160 top-left part is displayed.
8161 - When set with a "*" (e.g., "10*50") the terminal size follows the
8162 window size, but will not be smaller than the specified rows and/or
8163 columns.
8164 - When rows is zero then use the height of the window.
8165 - When columns is zero then use the width of the window.
8166 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008167 - Can be overruled in the |term_start()| options with "term_rows" and
8168 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008169
8170 Examples:
8171 "30x0" uses 30 rows and the current window width.
8172 "20*0" uses at least 20 rows and the current window width.
8173 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008174 Note that the command running in the terminal window may still change
8175 the size of the terminal. In that case the Vim window will be
8176 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008177
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008178 *'termwintype'* *'twt'*
8179'termwintype' 'twt' string (default "")
8180 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008181 {only available when compiled with the |terminal|
8182 feature on MS-Windows}
8183 Specify the virtual console (pty) used when opening the terminal
8184 window.
8185
8186 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008187 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008188 "winpty" use winpty, fail if not supported
8189 "conpty" use |ConPTY|, fail if not supported
8190
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008191 |ConPTY| support depends on the platform. Windows 10 October 2018
8192 Update is the first version that supports ConPTY, however it is still
8193 considered unstable. ConPTY might become stable in the next release
8194 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008195 supported then you cannot open a terminal window.
8196
Bram Moolenaar071d4272004-06-13 20:20:40 +00008197 *'terse'* *'noterse'*
8198'terse' boolean (default off)
8199 global
8200 When set: Add 's' flag to 'shortmess' option (this makes the message
8201 for a search that hits the start or end of the file not being
8202 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8203 shortens a lot of messages}
8204
8205 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8206'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008208 This option is obsolete. Use 'fileformats'.
8209 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8210 set to the default value for the current system. When 'textauto' is
8211 reset, 'fileformats' is made empty.
8212 NOTE: This option is set to the Vi default value when 'compatible' is
8213 set and to the Vim default value when 'compatible' is reset.
8214
8215 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008216'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 others: default off)
8218 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008219 This option is obsolete. Use 'fileformat'.
8220 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8221 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8222 "unix".
8223
8224 *'textwidth'* *'tw'*
8225'textwidth' 'tw' number (default 0)
8226 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227 Maximum width of text that is being inserted. A longer line will be
8228 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008229 this.
8230 'textwidth' is set to 0 when the 'paste' option is set and restored
8231 when 'paste' is reset.
8232 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008233 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008234 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008235 NOTE: This option is set to 0 when 'compatible' is set.
8236
8237 *'thesaurus'* *'tsr'*
8238'thesaurus' 'tsr' string (default "")
8239 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008240 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008241 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8242 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008243
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008244 This option is not used if 'thesaurusfunc' is set, either for the
8245 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008246
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008247 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008248 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008249 name. See |option-backslash| about using backslashes. The use of
8250 |:set+=| and |:set-=| is preferred when adding or removing directories
8251 from the list. This avoids problems when a future version uses
8252 another default. Backticks cannot be used in this option for security
8253 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008254
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008255 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008256'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008257 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008258 {not available when compiled without the |+eval|
8259 feature}
8260 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008261 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008262 The value can be the name of a function, a |lambda| or a |Funcref|.
8263 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008264
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008265 This option cannot be set from a |modeline| or in the |sandbox|, for
8266 security reasons.
8267
Bram Moolenaar071d4272004-06-13 20:20:40 +00008268 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8269'tildeop' 'top' boolean (default off)
8270 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008271 When on: The tilde command "~" behaves like an operator.
8272 NOTE: This option is reset when 'compatible' is set.
8273
8274 *'timeout'* *'to'* *'notimeout'* *'noto'*
8275'timeout' 'to' boolean (default on)
8276 global
8277 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008278'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008279 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008280 These two options together determine the behavior when part of a
8281 mapped key sequence or keyboard code has been received:
8282
8283 'timeout' 'ttimeout' action ~
8284 off off do not time out
8285 on on or off time out on :mappings and key codes
8286 off on time out on key codes
8287
8288 If both options are off, Vim will wait until either the complete
8289 mapping or key sequence has been received, or it is clear that there
8290 is no mapping or key sequence for the received characters. For
8291 example: if you have mapped "vl" and Vim has received 'v', the next
8292 character is needed to see if the 'v' is followed by an 'l'.
8293 When one of the options is on, Vim will wait for about 1 second for
8294 the next character to arrive. After that the already received
8295 characters are interpreted as single characters. The waiting time can
8296 be changed with the 'timeoutlen' option.
8297 On slow terminals or very busy systems timing out may cause
8298 malfunctioning cursor keys. If both options are off, Vim waits
8299 forever after an entered <Esc> if there are key codes that start
8300 with <Esc>. You will have to type <Esc> twice. If you do not have
8301 problems with key codes, but would like to have :mapped key
8302 sequences not timing out in 1 second, set the 'ttimeout' option and
8303 reset the 'timeout' option.
8304
8305 NOTE: 'ttimeout' is reset when 'compatible' is set.
8306
8307 *'timeoutlen'* *'tm'*
8308'timeoutlen' 'tm' number (default 1000)
8309 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008310
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008312'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008313 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008314 The time in milliseconds that is waited for a key code or mapped key
8315 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8316 when part of a command has been typed.
8317 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8318 different timeout value for key codes is desired set 'ttimeoutlen' to
8319 a non-negative number.
8320
8321 ttimeoutlen mapping delay key code delay ~
8322 < 0 'timeoutlen' 'timeoutlen'
8323 >= 0 'timeoutlen' 'ttimeoutlen'
8324
8325 The timeout only happens when the 'timeout' and 'ttimeout' options
8326 tell so. A useful setting would be >
8327 :set timeout timeoutlen=3000 ttimeoutlen=100
8328< (time out on mapping after three seconds, time out on key codes after
8329 a tenth of a second).
8330
8331 *'title'* *'notitle'*
8332'title' boolean (default off, on when title can be restored)
8333 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008334 When on, the title of the window will be set to the value of
8335 'titlestring' (if it is not empty), or to:
8336 filename [+=-] (path) - VIM
8337 Where:
8338 filename the name of the file being edited
8339 - indicates the file cannot be modified, 'ma' off
8340 + indicates the file was modified
8341 = indicates the file is read-only
8342 =+ indicates the file is read-only and modified
8343 (path) is the path of the file being edited
8344 - VIM the server name |v:servername| or "VIM"
8345 Only works if the terminal supports setting window titles
8346 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008347 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008348 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8349 *X11*
8350 When Vim was compiled with HAVE_X11 defined, the original title will
8351 be restored if possible. The output of ":version" will include "+X11"
8352 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8353 works for the icon name |'icon'|.
8354 But: When Vim was started with the |-X| argument, restoring the title
8355 will not work (except in the GUI).
8356 If the title cannot be restored, it is set to the value of 'titleold'.
8357 You might want to restore the title outside of Vim then.
8358 When using an xterm from a remote machine you can use this command:
8359 rsh machine_name xterm -display $DISPLAY &
8360 then the WINDOWID environment variable should be inherited and the
8361 title of the window should change back to what it should be after
8362 exiting Vim.
8363
8364 *'titlelen'*
8365'titlelen' number (default 85)
8366 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008367 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008368 title. When the title is longer, only the end of the path name is
8369 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008370 Using a percentage makes this adapt to the width of the window. But
8371 it won't work perfectly, because the actual number of characters
8372 available also depends on the font used and other things in the title
8373 bar. When 'titlelen' is zero the full path is used. Otherwise,
8374 values from 1 to 30000 percent can be used.
8375 'titlelen' is also used for the 'titlestring' option.
8376
8377 *'titleold'*
8378'titleold' string (default "Thanks for flying Vim")
8379 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008380 This option will be used for the window title when exiting Vim if the
8381 original title cannot be restored. Only happens if 'title' is on or
8382 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008383 This option cannot be set from a |modeline| or in the |sandbox|, for
8384 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008385 *'titlestring'*
8386'titlestring' string (default "")
8387 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388 When this option is not empty, it will be used for the title of the
8389 window. This happens only when the 'title' option is on.
8390 Only works if the terminal supports setting window titles (currently
8391 Amiga console, Win32 console, all GUI versions and terminals with a
8392 non-empty 't_ts' option).
8393 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008394 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008395
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396 When this option contains printf-style '%' items, they will be
8397 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008398 This option cannot be set in a modeline when 'modelineexpr' is off.
8399
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008401 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008402 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8403< The value of 'titlelen' is used to align items in the middle or right
8404 of the available space.
8405 Some people prefer to have the file name first: >
8406 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8407< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008408 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008409 separating space only when needed.
8410 NOTE: Use of special characters in 'titlestring' may cause the display
8411 to be garbled (e.g., when it contains a CR or NL character).
8412 {not available when compiled without the |+statusline| feature}
8413
8414 *'toolbar'* *'tb'*
8415'toolbar' 'tb' string (default "icons,tooltips")
8416 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008417 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008418 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008419 possible values are:
8420 icons Toolbar buttons are shown with icons.
8421 text Toolbar buttons shown with text.
8422 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008423 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008424 tooltips Tooltips are active for toolbar buttons.
8425 Tooltips refer to the popup help text which appears after the mouse
8426 cursor is placed over a toolbar button for a brief moment.
8427
8428 If you want the toolbar to be shown with icons as well as text, do the
8429 following: >
8430 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008431< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008432 will show icons if both are requested.
8433
8434 If none of the strings specified in 'toolbar' are valid or if
8435 'toolbar' is empty, this option is ignored. If you want to disable
8436 the toolbar, you need to set the 'guioptions' option. For example: >
8437 :set guioptions-=T
8438< Also see |gui-toolbar|.
8439
8440 *'toolbariconsize'* *'tbis'*
8441'toolbariconsize' 'tbis' string (default "small")
8442 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008443 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008444 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008445 tiny Use tiny icons.
8446 small Use small icons (default).
8447 medium Use medium-sized icons.
8448 large Use large icons.
8449 huge Use even larger icons.
8450 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008451 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008452 the current theme. Common dimensions are giant=48x48, huge=32x32,
8453 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008454
8455 If 'toolbariconsize' is empty, the global default size as determined
8456 by user preferences or the current theme is used.
8457
8458 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8459'ttybuiltin' 'tbi' boolean (default on)
8460 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008461 When on, the builtin termcaps are searched before the external ones.
8462 When off the builtin termcaps are searched after the external ones.
8463 When this option is changed, you should set the 'term' option next for
8464 the change to take effect, for example: >
8465 :set notbi term=$TERM
8466< See also |termcap|.
8467 Rationale: The default for this option is "on", because the builtin
8468 termcap entries are generally better (many systems contain faulty
8469 xterm entries...).
8470
8471 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8472'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8473 sun-cmd, screen, rxvt, dtterm or
8474 iris-ansi; also on when running Vim in
8475 a DOS console)
8476 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008477 Indicates a fast terminal connection. More characters will be sent to
8478 the screen for redrawing, instead of using insert/delete line
8479 commands. Improves smoothness of redrawing when there are multiple
8480 windows and the terminal does not support a scrolling region.
8481 Also enables the extra writing of characters at the end of each screen
8482 line for lines that wrap. This helps when using copy/paste with the
8483 mouse in an xterm and other terminals.
8484
8485 *'ttymouse'* *'ttym'*
8486'ttymouse' 'ttym' string (default depends on 'term')
8487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008488 {only in Unix and VMS, doesn't work in the GUI; not
8489 available when compiled without |+mouse|}
8490 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008491 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008492 *xterm-mouse*
8493 xterm xterm-like mouse handling. The mouse generates
8494 "<Esc>[Mscr", where "scr" is three bytes:
8495 "s" = button state
8496 "c" = column plus 33
8497 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008498 This only works up to 223 columns! See "dec",
8499 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008500 xterm2 Works like "xterm", but with the xterm reporting the
8501 mouse position while the mouse is dragged. This works
8502 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008503 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008504 work. See below for how Vim detects this
8505 automatically.
8506 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008507 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008508 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008509 for the row and column. No other mouse events are
8510 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008511 *dec-mouse*
8512 dec DEC terminal mouse handling. The mouse generates a
8513 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008514 This is also available for an Xterm, if it was
8515 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008516 *jsbterm-mouse*
8517 jsbterm JSB term mouse handling.
8518 *pterm-mouse*
8519 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008520 *urxvt-mouse*
8521 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008522 The mouse works only if the terminal supports this
8523 encoding style, but it does not have 223 columns limit
8524 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008525 *sgr-mouse*
8526 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008527 mouse reporting. The mouse works even in columns
8528 beyond 223. This option is backward compatible with
8529 "xterm2" because it can also decode "xterm2" style
8530 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008531
8532 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008533 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8534 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008535 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8536 recognized, if enabled at compile time. DEC terminal mouse codes
8537 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008538 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8539 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008540 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008541 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8542 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8543 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008544 Additionally, if vim is compiled with the |+termresponse| feature and
8545 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008546 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008547 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008548 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8549 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8550 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008551 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8552 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008553 :set t_RV=
8554<
8555 *'ttyscroll'* *'tsl'*
8556'ttyscroll' 'tsl' number (default 999)
8557 global
8558 Maximum number of lines to scroll the screen. If there are more lines
8559 to scroll the window is redrawn. For terminals where scrolling is
8560 very slow and redrawing is not slow this can be set to a small number,
8561 e.g., 3, to speed up displaying.
8562
8563 *'ttytype'* *'tty'*
8564'ttytype' 'tty' string (default from $TERM)
8565 global
8566 Alias for 'term', see above.
8567
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008568 *'undodir'* *'udir'*
8569'undodir' 'udir' string (default ".")
8570 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008571 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008572 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008573 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008574 "." means using the directory of the file. The undo file name for
8575 "file.txt" is ".file.txt.un~".
8576 For other directories the file name is the full path of the edited
8577 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008578 When writing: The first directory that exists is used. "." always
8579 works, no directories after "." will be used for writing.
8580 When reading all entries are tried to find an undo file. The first
8581 undo file that exists is used. When it cannot be read an error is
8582 given, no further entry is used.
8583 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008584 This option cannot be set from a |modeline| or in the |sandbox|, for
8585 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008586
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008587 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008588'undofile' 'udf' boolean (default off)
8589 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008590 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008591 When on, Vim automatically saves undo history to an undo file when
8592 writing a buffer to a file, and restores undo history from the same
8593 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008594 The directory where the undo file is stored is specified by 'undodir'.
8595 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008596 The undo file is not read when 'undoreload' causes the buffer from
8597 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008598 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008599 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008600
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008602'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008603 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008605 is kept in memory, higher numbers will cause more memory to be used.
8606 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008607 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8608 itself: >
8609 set ul=0
8610< But you can also get Vi compatibility by including the 'u' flag in
8611 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008612 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008613 Set to -1 for no undo at all. You might want to do this only for the
8614 current buffer: >
8615 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008616< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008617
8618 The local value is set to -123456 when the global value is to be used.
8619
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008620 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008621
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008622 *'undoreload'* *'ur'*
8623'undoreload' 'ur' number (default 10000)
8624 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008625 Save the whole buffer for undo when reloading it. This applies to the
8626 ":e!" command and reloading for when the buffer changed outside of
8627 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008628 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008629 of lines is smaller than the value of this option.
8630 Set this option to zero to disable undo for a reload.
8631
8632 When saving undo for a reload, any undo file is not read.
8633
8634 Note that this causes the whole buffer to be stored in memory. Set
8635 this option to a lower value if you run out of memory.
8636
Bram Moolenaar071d4272004-06-13 20:20:40 +00008637 *'updatecount'* *'uc'*
8638'updatecount' 'uc' number (default: 200)
8639 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008640 After typing this many characters the swap file will be written to
8641 disk. When zero, no swap file will be created at all (see chapter on
8642 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8643 Vim with the "-n" option, see |startup|. When editing in readonly
8644 mode this option will be initialized to 10000.
8645 The swapfile can be disabled per buffer with |'swapfile'|.
8646 When 'updatecount' is set from zero to non-zero, swap files are
8647 created for all buffers that have 'swapfile' set. When 'updatecount'
8648 is set to zero, existing swap files are not deleted.
8649 Also see |'swapsync'|.
8650 This option has no meaning in buffers where |'buftype'| is "nofile"
8651 or "nowrite".
8652
8653 *'updatetime'* *'ut'*
8654'updatetime' 'ut' number (default 4000)
8655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 If this many milliseconds nothing is typed the swap file will be
8657 written to disk (see |crash-recovery|). Also used for the
8658 |CursorHold| autocommand event.
8659
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008660 *'varsofttabstop'* *'vsts'*
8661'varsofttabstop' 'vsts' string (default "")
8662 local to buffer
8663 {only available when compiled with the |+vartabs|
8664 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008665 A list of the number of spaces that a <Tab> counts for while editing,
8666 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8667 width <Tab>s are being inserted, while in fact a mixture of spaces
8668 and <Tab>s is used. Tab widths are separated with commas, with the
8669 final value applying to all subsequent tabs.
8670
8671 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008672 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008673 to use the following: >
8674 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008675< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8676 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008677
8678 Note that the value of |'softtabstop'| will be ignored while
8679 'varsofttabstop' is set.
8680
8681 *'vartabstop'* *'vts'*
8682'vartabstop' 'vts' string (default "")
8683 local to buffer
8684 {only available when compiled with the |+vartabs|
8685 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008686 A list of the number of spaces that a <Tab> in the file counts for,
8687 separated by commas. Each value corresponds to one tab, with the
8688 final value applying to all subsequent tabs. For example: >
8689 :set vartabstop=4,20,10,8
8690< This will make the first tab 4 spaces wide, the second 20 spaces,
8691 the third 10 spaces, and all following tabs 8 spaces.
8692
8693 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8694 is set.
8695
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 *'verbose'* *'vbs'*
8697'verbose' 'vbs' number (default 0)
8698 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699 When bigger than zero, Vim will give messages about what it is doing.
8700 Currently, these messages are given:
8701 >= 1 When the viminfo file is read or written.
8702 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008703 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008704 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705 >= 8 Files for which a group of autocommands is executed.
8706 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008707 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008708 >= 12 Every executed function.
8709 >= 13 When an exception is thrown, caught, finished, or discarded.
8710 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008711 >= 15 Every executed Ex command from a script (truncated at 200
8712 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008713 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008714
8715 This option can also be set with the "-V" argument. See |-V|.
8716 This option is also set by the |:verbose| command.
8717
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008718 When the 'verbosefile' option is set then the verbose messages are not
8719 displayed.
8720
8721 *'verbosefile'* *'vfile'*
8722'verbosefile' 'vfile' string (default empty)
8723 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008724 When not empty all messages are written in a file with this name.
8725 When the file exists messages are appended.
8726 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008727 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008728 Setting 'verbosefile' to a new value is like making it empty first.
8729 The difference with |:redir| is that verbose messages are not
8730 displayed when 'verbosefile' is set.
8731
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008733'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008734 "$VIM/vimfiles/view",
8735 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008736 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008737 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008739 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008740 feature}
8741 Name of the directory where to store files for |:mkview|.
8742 This option cannot be set from a |modeline| or in the |sandbox|, for
8743 security reasons.
8744
8745 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008746'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008747 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008748 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008749 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008750 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008751 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008752 word save and restore ~
8753 cursor cursor position in file and in window
8754 folds manually created folds, opened/closed folds and local
8755 fold options
8756 options options and mappings local to a window or buffer (not
8757 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008758 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008759 slash backslashes in file names replaced with forward
8760 slashes
8761 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008762 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008763 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008765 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008766 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008767 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008768
8769 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008770'viminfo' 'vi' string (Vi default: "", Vim default for
8771 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008772 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8773 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008775 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008776 feature}
8777 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008778 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8779 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008780 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008781 consisting of a single character identifying the particular parameter,
8782 followed by a number or string which specifies the value of that
8783 parameter. If a particular character is left out, then the default
8784 value is used for that parameter. The following is a list of the
8785 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008786 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008787 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008788 ! When included, save and restore global variables that start
8789 with an uppercase letter, and don't contain a lowercase
8790 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008791 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008792 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008793 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008794 " Maximum number of lines saved for each register. Old name of
8795 the '<' item, with the disadvantage that you need to put a
8796 backslash before the ", otherwise it will be recognized as the
8797 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008798 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008799 % When included, save and restore the buffer list. If Vim is
8800 started with a file name argument, the buffer list is not
8801 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008802 buffer list is restored from the viminfo file. Quickfix
8803 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8804 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008805 When followed by a number, the number specifies the maximum
8806 number of buffers that are stored. Without a number all
8807 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008808 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008809 ' Maximum number of previously edited files for which the marks
8810 are remembered. This parameter must always be included when
8811 'viminfo' is non-empty.
8812 Including this item also means that the |jumplist| and the
8813 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008814 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008815 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008816 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008817 patterns are also saved. When not included, the value of
8818 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008819 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008820 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008821 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008822 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008823 < Maximum number of lines saved for each register. If zero then
8824 registers are not saved. When not included, all lines are
8825 saved. '"' is the old name for this item.
8826 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008827 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008828 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008829 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008830 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008831 c When included, convert the text in the viminfo file from the
8832 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008833 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008834 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008835 f Whether file marks need to be stored. If zero, file marks ('0
8836 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008837 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008839 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008840 h Disable the effect of 'hlsearch' when loading the viminfo
8841 file. When not included, it depends on whether ":nohlsearch"
8842 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008843 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008844 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008845 the 'n'. Must be at the end of the option! If the
8846 'viminfofile' option is set, that file name overrides the one
8847 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008848 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008849 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008850 r Removable media. The argument is a string (up to the next
8851 ','). This parameter can be given several times. Each
8852 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008853 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8855 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8856 ignored. Maximum length of each 'r' argument is 50
8857 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008858 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008859 s Maximum size of an item in Kbyte. If zero then registers are
8860 not saved. Currently only applies to registers. The default
8861 "s10" will exclude registers with more than 10 Kbyte of text.
8862 Also see the '<' item above: line count limit.
8863
8864 Example: >
8865 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8866<
8867 '50 Marks will be remembered for the last 50 files you
8868 edited.
8869 <1000 Contents of registers (up to 1000 lines each) will be
8870 remembered.
8871 s100 Registers with more than 100 Kbyte text are skipped.
8872 :0 Command-line history will not be saved.
8873 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8874 no / Since '/' is not specified, the default will be used,
8875 that is, save all of the search history, and also the
8876 previous search and substitute patterns.
8877 no % The buffer list will not be saved nor read back.
8878 no h 'hlsearch' highlighting will be restored.
8879
8880 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8881 load the contents of the file, this is not done automatically.
8882
8883 This option cannot be set from a |modeline| or in the |sandbox|, for
8884 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008885 NOTE: This option is set to the Vim default value when 'compatible'
8886 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008887
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008888 *'viminfofile'* *'vif'*
8889'viminfofile' 'vif' string (default: "")
8890 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008891 {not available when compiled without the |+viminfo|
8892 feature}
8893 When non-empty, overrides the file name used for viminfo.
8894 When equal to "NONE" no viminfo file will be read or written.
8895 This option can be set with the |-i| command line flag. The |--clean|
8896 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008897 This option cannot be set from a |modeline| or in the |sandbox|, for
8898 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008899
Bram Moolenaar071d4272004-06-13 20:20:40 +00008900 *'virtualedit'* *'ve'*
8901'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008902 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008903 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008904 block Allow virtual editing in Visual block mode.
8905 insert Allow virtual editing in Insert mode.
8906 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008907 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008908 none When used as the local value, do not allow virtual
8909 editing even when the global value is set. When used
8910 as the global value, "none" is the same as "".
8911 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008912
Bram Moolenaar071d4272004-06-13 20:20:40 +00008913 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008914 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008915 of the line. Useful for selecting a rectangle in Visual mode and
8916 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008917 "onemore" is not the same, it will only allow moving the cursor just
8918 after the last character of the line. This makes some commands more
8919 consistent. Previously the cursor was always past the end of the line
8920 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008921 break some plugins or Vim scripts. For example because |l| can move
8922 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008923 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008924 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008925 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008926 It doesn't make sense to combine "all" with "onemore", but you will
8927 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008928 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008929 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008930
8931 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8932'visualbell' 'vb' boolean (default off)
8933 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008934 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008935 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008936 use: >
8937 :set vb t_vb=
8938< If you want a short flash, you can use this on many terminals: >
8939 :set vb t_vb=[?5h$<100>[?5l
8940< Here $<100> specifies the time, you can use a smaller or bigger value
8941 to get a shorter or longer flash.
8942
8943 Note: Vim will limit the bell to once per half a second. This avoids
8944 having to wait for the flashing to finish when there are lots of
8945 bells, e.g. on key repeat. This also happens without 'visualbell'
8946 set.
8947
Bram Moolenaar071d4272004-06-13 20:20:40 +00008948 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8949 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8950 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008951
8952 Note: When the GUI starts, 't_vb' is reset to its default value. You
8953 might want to set it again in your |gvimrc|.
8954
Bram Moolenaar071d4272004-06-13 20:20:40 +00008955 Does not work on the Amiga, you always get a screen flash.
8956 Also see 'errorbells'.
8957
8958 *'warn'* *'nowarn'*
8959'warn' boolean (default on)
8960 global
8961 Give a warning message when a shell command is used while the buffer
8962 has been changed.
8963
8964 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8965'weirdinvert' 'wiv' boolean (default off)
8966 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008967 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008968 It is provided for backwards compatibility with version 4.x.
8969 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8970 vice versa. Has no effect when the GUI is running.
8971
8972 *'whichwrap'* *'ww'*
8973'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8974 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008975 Allow specified keys that move the cursor left/right to move to the
8976 previous/next line when the cursor is on the first/last character in
8977 the line. Concatenate characters to allow this for these keys:
8978 char key mode ~
8979 b <BS> Normal and Visual
8980 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008981 h "h" Normal and Visual (not recommended)
8982 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008983 < <Left> Normal and Visual
8984 > <Right> Normal and Visual
8985 ~ "~" Normal
8986 [ <Left> Insert and Replace
8987 ] <Right> Insert and Replace
8988 For example: >
8989 :set ww=<,>,[,]
8990< allows wrap only when cursor keys are used.
8991 When the movement keys are used in combination with a delete or change
8992 operator, the <EOL> also counts for a character. This makes "3h"
8993 different from "3dh" when the cursor crosses the end of a line. This
8994 is also true for "x" and "X", because they do the same as "dl" and
8995 "dh". If you use this, you may also want to use the mapping
8996 ":map <BS> X" to make backspace delete the character in front of the
8997 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008998 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008999 line (not an empty line) then it will not move to the next line. This
9000 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001 NOTE: This option is set to the Vi default value when 'compatible' is
9002 set and to the Vim default value when 'compatible' is reset.
9003
9004 *'wildchar'* *'wc'*
9005'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9006 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009007 Character you have to type to start wildcard expansion in the
9008 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009009 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009010 The character is not recognized when used inside a macro. See
9011 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009012 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009014 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009015< NOTE: This option is set to the Vi default value when 'compatible' is
9016 set and to the Vim default value when 'compatible' is reset.
9017
9018 *'wildcharm'* *'wcm'*
9019'wildcharm' 'wcm' number (default: none (0))
9020 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009021 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009022 recognized when used inside a macro. You can find "spare" command-line
9023 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009024 you'll never actually type 'wildcharm', just use it in mappings that
9025 automatically invoke completion mode, e.g.: >
9026 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009027 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009028< Then after typing :ss you can use CTRL-P & CTRL-N.
9029
9030 *'wildignore'* *'wig'*
9031'wildignore' 'wig' string (default "")
9032 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009033 {not available when compiled without the |+wildignore|
9034 feature}
9035 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009036 patterns is ignored when expanding |wildcards|, completing file or
9037 directory names, and influences the result of |expand()|, |glob()| and
9038 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009039 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9040 Also see 'suffixes'.
9041 Example: >
9042 :set wildignore=*.o,*.obj
9043< The use of |:set+=| and |:set-=| is preferred when adding or removing
9044 a pattern from the list. This avoids problems when a future version
9045 uses another default.
9046
Bram Moolenaar94950a92010-12-02 16:01:29 +01009047
Bram Moolenaar81af9252010-12-10 20:35:50 +01009048 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009049'wildignorecase' 'wic' boolean (default off)
9050 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009051 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009052 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009053 Does not apply when the shell is used to expand wildcards, which
9054 happens when there are special characters.
9055
9056
Bram Moolenaar071d4272004-06-13 20:20:40 +00009057 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009058'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009059 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009060 {not available if compiled without the |+wildmenu|
9061 feature}
9062 When 'wildmenu' is on, command-line completion operates in an enhanced
9063 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
9064 the possible matches are shown just above the command line, with the
9065 first match highlighted (overwriting the status line, if there is
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009066 one). This is the behavior without "pum" in 'wildoptions'.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009067 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009068 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9069 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9070 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009071 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009072 If there are more matches than can fit in the line, a ">" is shown on
9073 the right and/or a "<" is shown on the left. The status line scrolls
9074 as needed.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009075 When 'wildoptions' contains "pum", then the completion matches are
9076 shown in a popup menu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009077 The "wildmenu" mode is abandoned when a key is hit that is not used
9078 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009079 While the "wildmenu" is active, not using the popup menu, the
9080 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009081
9082 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9083 <Down> - in filename/menu name completion: move into a
9084 subdirectory or submenu.
9085 <CR> - in menu completion, when the cursor is just after a
9086 dot: move into a submenu.
9087 <Up> - in filename/menu name completion: move up into
9088 parent directory or parent menu.
9089
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009090 When using the popup menu for command line completion, the following
9091 keys have special meanings:
9092 <Down> - select next match (like CTRL-N)
9093 <Left> - in filename/menu name completion: move up into
9094 parent directory or parent menu.
9095 <Right> - in filename/menu name completion: move into a
9096 subdirectory or submenu.
9097 <Up> - select previous match (like CTRL-P)
9098 CTRL-E - end completion, go back to what was there before
9099 selecting a match.
9100 CTRL-N - go to the next entry
9101 CTRL-P - go to the previous entry
9102 CTRL-Y - accept the currently selected match and stop
9103 completion.
9104
Bram Moolenaar071d4272004-06-13 20:20:40 +00009105 This makes the menus accessible from the console |console-menus|.
9106
9107 If you prefer the <Left> and <Right> keys to move the cursor instead
9108 of selecting a different match, use this: >
9109 :cnoremap <Left> <Space><BS><Left>
9110 :cnoremap <Right> <Space><BS><Right>
9111<
9112 The "WildMenu" highlighting is used for displaying the current match
9113 |hl-WildMenu|.
9114
9115 *'wildmode'* *'wim'*
9116'wildmode' 'wim' string (Vim default: "full")
9117 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009118 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009119 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009120 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009121 first part specifies the behavior for the first use of 'wildchar',
9122 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009123
9124 Each part consists of a colon separated list consisting of the
9125 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009126 "" Complete only the first match.
9127 "full" Complete the next full match. After the last match,
9128 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009129 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009130 "longest" Complete till longest common string. If this doesn't
9131 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009132 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009133 "lastused" When completing buffer names and more than one buffer
9134 matches, sort buffers by time last used (other than
9135 the current buffer).
9136 When there is only a single match, it is fully completed in all cases.
9137
9138 Examples of useful colon-separated values:
9139 "longest:full" Like "longest", but also start 'wildmenu' if it is
9140 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009141 "list:full" When more than one match, list all matches and
9142 complete first match.
9143 "list:longest" When more than one match, list all matches and
9144 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009145 "list:lastused" When more than one buffer matches, list all matches
9146 and sort buffers by time last used (other than the
9147 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009148
9149 Examples: >
9150 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009151< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009152 :set wildmode=longest,full
9153< Complete longest common string, then each full match >
9154 :set wildmode=list:full
9155< List all matches and complete each full match >
9156 :set wildmode=list,full
9157< List all matches without completing, then each full match >
9158 :set wildmode=longest,list
9159< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009160 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009161
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009162 *'wildoptions'* *'wop'*
9163'wildoptions' 'wop' string (default "")
9164 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009165 {not available when compiled without the |+wildignore|
9166 feature}
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009167 A list of words that change how |cmdline-completion| is done.
9168 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009169 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009170 this value is specified, wildcard expansion will not
9171 be used for completion. The matches will be sorted by
9172 the "best match" rather than alphabetically sorted.
9173 This will find more matches than the wildcard
9174 expansion. Currently fuzzy matching based completion
9175 is not supported for file and directory names and
9176 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009177 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009178 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009179 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009180 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009181 is displayed per line. Often used tag kinds are:
9182 d #define
9183 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009184
Bram Moolenaar071d4272004-06-13 20:20:40 +00009185 *'winaltkeys'* *'wak'*
9186'winaltkeys' 'wak' string (default "menu")
9187 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009188 {only used in Win32, Motif, GTK and Photon GUI}
9189 Some GUI versions allow the access to menu entries by using the ALT
9190 key in combination with a character that appears underlined in the
9191 menu. This conflicts with the use of the ALT key for mappings and
9192 entering special characters. This option tells what to do:
9193 no Don't use ALT keys for menus. ALT key combinations can be
9194 mapped, but there is no automatic handling. This can then be
9195 done with the |:simalt| command.
9196 yes ALT key handling is done by the windowing system. ALT key
9197 combinations cannot be mapped.
9198 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009199 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009200 keys can be mapped.
9201 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9202 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009203 This option is not used for <F10>; on Win32 and with GTK <F10> will
9204 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009205
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009206 *'wincolor'* *'wcr'*
9207'wincolor' 'wcr' string (default empty)
9208 local to window
9209 Highlight group name to use for this window instead of the Normal
9210 color |hl-Normal|.
9211
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009212 *'window'* *'wi'*
9213'window' 'wi' number (default screen height - 1)
9214 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009215 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9216 window and the value is smaller than 'lines' minus one. The screen
9217 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009218 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9219 in a much smarter way, taking care of wrapping lines.
9220 When resizing the Vim window, the value is smaller than 1 or more than
9221 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009222 Note: Do not confuse this with the height of the Vim window, use
9223 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009224
Bram Moolenaar071d4272004-06-13 20:20:40 +00009225 *'winheight'* *'wh'* *E591*
9226'winheight' 'wh' number (default 1)
9227 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009228 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009229 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009230 focus goes to a window that is smaller, its size is increased, at the
9231 cost of the height of other windows.
9232 Set 'winheight' to a small number for normal editing.
9233 Set it to 999 to make the current window fill most of the screen.
9234 Other windows will be only 'winminheight' high. This has the drawback
9235 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9236 to create only two windows, set the option after startup is done,
9237 using the |VimEnter| event: >
9238 au VimEnter * set winheight=999
9239< Minimum value is 1.
9240 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009241 height of the current window.
9242 'winheight' applies to the current window. Use 'winminheight' to set
9243 the minimal height for other windows.
9244
9245 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9246'winfixheight' 'wfh' boolean (default off)
9247 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009248 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009249 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9250 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009251 The height may be changed anyway when running out of room.
9252
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009253 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9254'winfixwidth' 'wfw' boolean (default off)
9255 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009256 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009257 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009258 The width may be changed anyway when running out of room.
9259
Bram Moolenaar071d4272004-06-13 20:20:40 +00009260 *'winminheight'* *'wmh'*
9261'winminheight' 'wmh' number (default 1)
9262 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009263 The minimal height of a window, when it's not the current window.
9264 This is a hard minimum, windows will never become smaller.
9265 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9266 status bar) if necessary. They will return to at least one line when
9267 they become active (since the cursor has to have somewhere to go.)
9268 Use 'winheight' to set the minimal height of the current window.
9269 This option is only checked when making a window smaller. Don't use a
9270 large number, it will cause errors when opening more than a few
9271 windows. A value of 0 to 3 is reasonable.
9272
9273 *'winminwidth'* *'wmw'*
9274'winminwidth' 'wmw' number (default 1)
9275 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009276 The minimal width of a window, when it's not the current window.
9277 This is a hard minimum, windows will never become smaller.
9278 When set to zero, windows may be "squashed" to zero columns (i.e. just
9279 a vertical separator) if necessary. They will return to at least one
9280 line when they become active (since the cursor has to have somewhere
9281 to go.)
9282 Use 'winwidth' to set the minimal width of the current window.
9283 This option is only checked when making a window smaller. Don't use a
9284 large number, it will cause errors when opening more than a few
9285 windows. A value of 0 to 12 is reasonable.
9286
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009287 *'winptydll'*
9288'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9289 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009290 {only available when compiled with the |terminal|
9291 feature on MS-Windows}
9292 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009293 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009294 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009295 a fallback.
9296 Environment variables are expanded |:set_env|.
9297 This option cannot be set from a |modeline| or in the |sandbox|, for
9298 security reasons.
9299
Bram Moolenaar071d4272004-06-13 20:20:40 +00009300 *'winwidth'* *'wiw'* *E592*
9301'winwidth' 'wiw' number (default 20)
9302 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009303 Minimal number of columns for the current window. This is not a hard
9304 minimum, Vim will use fewer columns if there is not enough room. If
9305 the current window is smaller, its size is increased, at the cost of
9306 the width of other windows. Set it to 999 to make the current window
9307 always fill the screen. Set it to a small number for normal editing.
9308 The width is not adjusted after one of the commands to change the
9309 width of the current window.
9310 'winwidth' applies to the current window. Use 'winminwidth' to set
9311 the minimal width for other windows.
9312
9313 *'wrap'* *'nowrap'*
9314'wrap' boolean (default on)
9315 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009316 This option changes how text is displayed. It doesn't change the text
9317 in the buffer, see 'textwidth' for that.
9318 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009319 displaying continues on the next line. When off lines will not wrap
9320 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009321 moved to a part that is not shown, the screen will scroll
9322 horizontally.
9323 The line will be broken in the middle of a word if necessary. See
9324 'linebreak' to get the break at a word boundary.
9325 To make scrolling horizontally a bit more useful, try this: >
9326 :set sidescroll=5
9327 :set listchars+=precedes:<,extends:>
9328< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009329 This option can't be set from a |modeline| when the 'diff' option is
9330 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009331
9332 *'wrapmargin'* *'wm'*
9333'wrapmargin' 'wm' number (default 0)
9334 local to buffer
9335 Number of characters from the right window border where wrapping
9336 starts. When typing text beyond this limit, an <EOL> will be inserted
9337 and inserting continues on the next line.
9338 Options that add a margin, such as 'number' and 'foldcolumn', cause
9339 the text width to be further reduced. This is Vi compatible.
9340 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009341 This option is set to 0 when 'paste' is set and restored when 'paste'
9342 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009343 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009344
9345 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9346'wrapscan' 'ws' boolean (default on) *E384* *E385*
9347 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009348 Searches wrap around the end of the file. Also applies to |]s| and
9349 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009350
9351 *'write'* *'nowrite'*
9352'write' boolean (default on)
9353 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009354 Allows writing files. When not set, writing a file is not allowed.
9355 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009356 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009357 argument. Filtering text is still possible, even though this requires
9358 writing a temporary file.
9359
9360 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9361'writeany' 'wa' boolean (default off)
9362 global
9363 Allows writing to any file with no need for "!" override.
9364
9365 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9366'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9367 otherwise)
9368 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009369 Make a backup before overwriting a file. The backup is removed after
9370 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009371 also on.
9372 WARNING: Switching this option off means that when Vim fails to write
9373 your buffer correctly and then, for whatever reason, Vim exits, you
9374 lose both the original file and what you were writing. Only reset
9375 this option if your file system is almost full and it makes the write
9376 fail (and make sure not to exit Vim until the write was successful).
9377 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009378 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009379 Depending on 'backupcopy' the backup is a new file or the original
9380 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009381 NOTE: This option is set to the default value when 'compatible' is
9382 set.
9383
9384 *'writedelay'* *'wd'*
9385'writedelay' 'wd' number (default 0)
9386 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009387 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009388 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009389 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009390
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009391 *'xtermcodes'* *'noxtermcodes'*
9392'xtermcodes' boolean (default on)
9393 global
9394 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009395 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009396 key codes and number of colors from the terminal. This takes care of
9397 various configuration options of the terminal that cannot be obtained
9398 from the termlib/terminfo entry, see |xterm-codes|.
9399 A side effect may be that t_Co changes and Vim will redraw the
9400 display.
9401
9402
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009403 vim:tw=78:ts=8:noet:ft=help:norl: