blob: ee17e64454c19e42d49c1657b00f546a6dfa3d50 [file] [log] [blame]
Bram Moolenaareb490412022-06-28 13:44:46 +01001*options.txt* For Vim version 9.0. Last change: 2022 Jun 27
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
37
Bram Moolenaar47003982021-12-05 21:54:04 +000038:se[t]! termcap Idem, but don't use multiple columns.
39
Bram Moolenaar071d4272004-06-13 20:20:40 +000040 *E518* *E519*
41:se[t] {option}? Show value of {option}.
42
43:se[t] {option} Toggle option: set, switch it on.
44 Number option: show value.
45 String option: show value.
46
47:se[t] no{option} Toggle option: Reset, switch it off.
48
Bram Moolenaar00a927d2010-05-14 23:24:24 +020049 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000050:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020051:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000052
53 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
54:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020055 current value of 'compatible'.
56:se[t] {option}&vi Reset option to its Vi default value.
57:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000058
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010059:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020060 these options are not changed:
61 all terminal options, starting with t_
62 'columns'
63 'cryptmethod'
64 'encoding'
65 'key'
66 'lines'
67 'term'
68 'ttymouse'
69 'ttytype'
70 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000071
72 *:set-args* *E487* *E521*
73:se[t] {option}={value} or
74:se[t] {option}:{value}
75 Set string or number option to {value}.
76 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010077 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000078 The old value can be inserted by typing 'wildchar' (by
79 default this is a <Tab> or CTRL-E if 'compatible' is
80 set). See |cmdline-completion|.
81 White space between {option} and '=' is allowed and
82 will be ignored. White space between '=' and {value}
83 is not allowed.
84 See |option-backslash| for using white space and
85 backslashes in {value}.
86
87:se[t] {option}+={value} *:set+=*
88 Add the {value} to a number option, or append the
89 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010090 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 value was empty.
92 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000093 are removed. When adding a flag that was already
94 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000095 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000096
97:se[t] {option}^={value} *:set^=*
98 Multiply the {value} to a number option, or prepend
99 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100100 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101 value was empty.
102 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103
104:se[t] {option}-={value} *:set-=*
105 Subtract the {value} from a number option, or remove
106 the {value} from a string option, if it is there.
107 If the {value} is not found in a string option, there
108 is no error or warning. When the option is a comma
109 separated list, a comma is deleted, unless the option
110 becomes empty.
111 When the option is a list of flags, {value} must be
112 exactly as they appear in the option. Remove flags
113 one by one to avoid problems.
114 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115
116The {option} arguments to ":set" may be repeated. For example: >
117 :set ai nosi sw=3 ts=3
118If you make an error in one of the arguments, an error message will be given
119and the following arguments will be ignored.
120
121 *:set-verbose*
122When 'verbose' is non-zero, displaying an option value will also tell where it
123was last set. Example: >
124 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200125< shiftwidth=4 ~
126 Last set from modeline line 1 ~
127 cindent ~
128 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000129This is only done when specific option values are requested, not for ":verbose
130set all" or ":verbose set" without an argument.
131When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000132When the option was set while executing a function, user command or
133autocommand, the script in which it was defined is reported.
134Note that an option may also have been set as a side effect of setting
135'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200137 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000138 Option was set in a |modeline|.
139 Last set from --cmd argument ~
140 Option was set with command line argument |--cmd| or +.
141 Last set from -c argument ~
142 Option was set with command line argument |-c|, +, |-S| or
143 |-q|.
144 Last set from environment variable ~
145 Option was set from an environment variable, $VIMINIT,
146 $GVIMINIT or $EXINIT.
147 Last set from error handler ~
148 Option was cleared when evaluating it resulted in an error.
149
Bram Moolenaardb84e452010-08-15 13:50:43 +0200150{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151
152 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000153For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000154override the value from the termcap. You can then use it in a mapping. If
155the "xx" part contains special characters, use the <t_xx> form: >
156 :set <t_#4>=^[Ot
157This can also be used to translate a special code for a normal key. For
158example, if Alt-b produces <Esc>b, use this: >
159 :set <M-b>=^[b
160(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
161The advantage over a mapping is that it works in all situations.
162
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100163You can define any key codes, e.g.: >
164 :set t_xy=^[foo;
165There is no warning for using a name that isn't recognized. You can map these
166codes as you like: >
167 :map <t_xy> something
168< *E846*
169When a key code is not set, it's like it does not exist. Trying to get its
170value will result in an error: >
171 :set t_kb=
172 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000173< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100174
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000175The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
176security reasons.
177
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000179at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180"set all" probably does not fit on the screen, causing Vim to give the
181|more-prompt|.
182
183 *option-backslash*
184To include white space in a string option value it has to be preceded with a
185backslash. To include a backslash you have to use two. Effectively this
186means that the number of backslashes in an option value is halved (rounded
187down).
188A few examples: >
189 :set tags=tags\ /usr/tags results in "tags /usr/tags"
190 :set tags=tags\\,file results in "tags\,file"
191 :set tags=tags\\\ file results in "tags\ file"
192
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000193The "|" character separates a ":set" command from a following command. To
194include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195'titlestring' option to "hi|there": >
196 :set titlestring=hi\|there
197This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
198 :set titlestring=hi|set iconstring=there
199
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200200Similarly, in legacy script the double quote character starts a comment. To
201include the '"' in the option value, use '\"' instead. This example sets the
202'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000203 :set titlestring=hi\ \"there\"
204
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200205In |Vim9| script it's simpler, comments start with a '#' character, and only
206when preceded by white space. A backslash is needed less often: >
207 vim9script
208 set titlestring=hi\ "there"
209 set titlestring=hi#there#
210 set titlestring=hi\ \#there#
211
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100212For Win32 backslashes in file names are mostly not removed. More precise: For
213options that expect a file name (those where environment variables are
214expanded) a backslash before a normal file name character is not removed. But
215a backslash before a special character (space, backslash, comma, etc.) is used
216like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217There is one special situation, when the value starts with "\\": >
218 :set dir=\\machine\path results in "\\machine\path"
219 :set dir=\\\\machine\\path results in "\\machine\path"
220 :set dir=\\path\\file results in "\\path\file" (wrong!)
221For the first one the start is kept, but for the second one the backslashes
222are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000223halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224result which is probably not what you want. Avoid it.
225
226 *add-option-flags* *remove-option-flags*
227 *E539* *E550* *E551* *E552*
228Some options are a list of flags. When you want to add a flag to such an
229option, without changing the existing ones, you can do it like this: >
230 :set guioptions+=a
231Remove a flag from an option like this: >
232 :set guioptions-=a
233This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000234Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
236doesn't appear.
237
238 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000239Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000240environment variable exists the '$' and the following environment variable
241name is replaced with its value. If it does not exist the '$' and the name
242are not modified. Any non-id character (not a letter, digit or '_') may
243follow the environment variable name. That character and what follows is
244appended to the value of the environment variable. Examples: >
245 :set term=$TERM.new
246 :set path=/usr/$INCLUDE,$HOME/include,.
247When adding or removing a string from an option with ":set opt-=val" or ":set
248opt+=val" the expansion is done before the adding or removing.
249
250
251Handling of local options *local-options*
252
253Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100254has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255allows you to set 'list' in one window but not in another. And set
256'shiftwidth' to 3 in one buffer and 4 in another.
257
258The following explains what happens to these local options in specific
259situations. You don't really need to know all of this, since Vim mostly uses
260the option values you would expect. Unfortunately, doing what the user
261expects is a bit complicated...
262
263When splitting a window, the local options are copied to the new window. Thus
264right after the split the contents of the two windows look the same.
265
266When editing a new buffer, its local option values must be initialized. Since
267the local options of the current buffer might be specifically for that buffer,
268these are not used. Instead, for each buffer-local option there also is a
269global value, which is used for new buffers. With ":set" both the local and
270global value is changed. With "setlocal" only the local value is changed,
271thus this value is not used when editing a new buffer.
272
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200273When editing a buffer that has been edited before, the options from the window
274that was last closed are used again. If this buffer has been edited in this
275window, the values from back then are used. Otherwise the values from the
276last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277
278It's possible to set a local window option specifically for a type of buffer.
279When you edit another buffer in the same window, you don't want to keep
280using these local window options. Therefore Vim keeps a global value of the
281local window options, which is used when editing another buffer. Each window
282has its own copy of these values. Thus these are local to the window, but
283global to all buffers in the window. With this you can do: >
284 :e one
285 :set list
286 :e two
287Now the 'list' option will also be set in "two", since with the ":set list"
288command you have also set the global value. >
289 :set nolist
290 :e one
291 :setlocal list
292 :e two
293Now the 'list' option is not set, because ":set nolist" resets the global
294value, ":setlocal list" only changes the local value and ":e two" gets the
295global value. Note that if you do this next: >
296 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200297You will get back the 'list' value as it was the last time you edited "one".
298The options local to a window are remembered for each buffer. This also
299happens when the buffer is not loaded, but they are lost when the buffer is
300wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301
302 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100303:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304 current buffer or window. Not all options have a
305 local value. If the option does not have a local
306 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200307 With the "all" argument: display local values for all
308 local options.
309 Without argument: Display local values for all local
310 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000312 local value. For a global/local boolean option, when
313 the global value is being used, "--" is displayed
314 before the option name.
315 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000318:setl[ocal] {option}< Set the local value of {option} to its global value by
319 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000320
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100321:se[t] {option}< For |global-local| options: Remove the local value of
322 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100325:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 option without changing the local value.
327 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200328 With the "all" argument: display global values for all
329 local options.
330 Without argument: display global values for all local
331 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332
333For buffer-local and window-local options:
334 Command global value local value ~
335 :set option=value set set
336 :setlocal option=value - set
337:setglobal option=value set -
338 :set option? - display
339 :setlocal option? - display
340:setglobal option? display -
341
342
343Global options with a local value *global-local*
344
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000345Options are global when you mostly use one value for all buffers and windows.
346For some global options it's useful to sometimes have a different local value.
347You can set the local value with ":setlocal". That buffer or window will then
348use the local value, while other buffers and windows continue using the global
349value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350
351For example, you have two windows, both on C source code. They use the global
352'makeprg' option. If you do this in one of the two windows: >
353 :set makeprg=gmake
354then the other window will switch to the same value. There is no need to set
355the 'makeprg' option in the other C source window too.
356However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000357another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000358files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359 :setlocal makeprg=perlmake
360You can switch back to using the global value by making the local value empty: >
361 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100362This only works for a string option. For a number or boolean option you need
363to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000364 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100365Note that for non-boolean and non-number options using "<" copies the global
366value to the local value, it doesn't switch back to using the global value
367(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000368 :set path<
369This will make the local value of 'path' empty, so that the global value is
370used. Thus it does the same as: >
371 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000372Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373":setlocal" on a global option might work differently then.
374
375
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000376 *option-value-function*
377Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000378'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000379a function name or a function reference or a lambda function. When using a
380lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000381>
382 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000383 set opfunc=function('MyOpFunc')
384 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000385 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000386
387Set to a script-local function: >
388 set opfunc=s:MyLocalFunc
389 set opfunc=<SID>MyLocalFunc
390In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
391the script: >
392 set opfunc=MyLocalFunc
393
394Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000395 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000396 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000397
398Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000399 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000400
401Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000402 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000403 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000404
405In Vim9 script, in a compiled function, you can use a lambda, but a
406closured does not work, because the function will be called without the
407context of where it was defined.
408
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000409
Bram Moolenaar071d4272004-06-13 20:20:40 +0000410Setting the filetype
411
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200412:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413 Set the 'filetype' option to {filetype}, but only if
414 not done yet in a sequence of (nested) autocommands.
415 This is short for: >
416 :if !did_filetype()
417 : setlocal filetype={filetype}
418 :endif
419< This command is used in a filetype.vim file to avoid
420 setting the 'filetype' option twice, causing different
421 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200422
423 When the optional FALLBACK argument is present, a
424 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100425 'filetype'. This is to be used for filetype
426 detections that are just a guess. |did_filetype()|
427 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200428
Bram Moolenaard58e9292011-02-09 17:07:58 +0100429 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
431:opt[ions] Open a window for viewing and setting all options.
432 Options are grouped by function.
433 Offers short help for each option. Hit <CR> on the
434 short help to open a help window with more help for
435 the option.
436 Modify the value of the option and hit <CR> on the
437 "set" line to set the new value. For window and
438 buffer specific options, the last accessed window is
439 used to set the option value in, unless this is a help
440 window, in which case the window below help window is
441 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100442 {not available when compiled without the |+eval|
443 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000444
445 *$HOME*
446Using "~" is like using "$HOME", but it is only recognized at the start of an
447option and after a space or comma.
448
449On Unix systems "~user" can be used too. It is replaced by the home directory
450of user "user". Example: >
451 :set path=~mool/include,/usr/include,.
452
453On Unix systems the form "${HOME}" can be used too. The name between {} can
454contain non-id characters then. Note that if you want to use this for the
455"gf" command, you need to add the '{' and '}' characters to 'isfname'.
456
457NOTE: expanding environment variables and "~/" is only done with the ":set"
458command, not when assigning a value to an option with ":let".
459
Bram Moolenaarc572da52017-08-27 16:52:01 +0200460 *$HOME-windows*
461On MS-Windows, if $HOME is not defined as an environment variable, then
462at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200463If $HOMEDRIVE is not set then $USERPROFILE is used.
464
465This expanded value is not exported to the environment, this matters when
466running an external command: >
467 :echo system('set | findstr ^HOME=')
468and >
469 :echo luaeval('os.getenv("HOME")')
470should echo nothing (an empty string) despite exists('$HOME') being true.
471When setting $HOME to a non-empty string it will be exported to the
472subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200473
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474
475Note the maximum length of an expanded option is limited. How much depends on
476the system, mostly it is something like 256 or 1024 characters.
477
478 *:fix* *:fixdel*
479:fix[del] Set the value of 't_kD':
480 't_kb' is 't_kD' becomes ~
481 CTRL-? CTRL-H
482 not CTRL-? CTRL-?
483
Bram Moolenaar82be4842021-01-11 19:40:15 +0100484 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000485
486 If your delete key terminal code is wrong, but the
487 code for backspace is alright, you can put this in
488 your .vimrc: >
489 :fixdel
490< This works no matter what the actual code for
491 backspace is.
492
493 If the backspace key terminal code is wrong you can
494 use this: >
495 :if &term == "termname"
496 : set t_kb=^V<BS>
497 : fixdel
498 :endif
499< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000500 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000501 with your terminal name.
502
503 If your <Delete> key sends a strange key sequence (not
504 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
505 :if &term == "termname"
506 : set t_kD=^V<Delete>
507 :endif
508< Where "^V" is CTRL-V and "<Delete>" is the delete key
509 (don't type eight characters!). Replace "termname"
510 with your terminal name.
511
512 *Linux-backspace*
513 Note about Linux: By default the backspace key
514 produces CTRL-?, which is wrong. You can fix it by
515 putting this line in your rc.local: >
516 echo "keycode 14 = BackSpace" | loadkeys
517<
518 *NetBSD-backspace*
519 Note about NetBSD: If your backspace doesn't produce
520 the right code, try this: >
521 xmodmap -e "keycode 22 = BackSpace"
522< If this works, add this in your .Xmodmap file: >
523 keysym 22 = BackSpace
524< You need to restart for this to take effect.
525
526==============================================================================
5272. Automatically setting options *auto-setting*
528
529Besides changing options with the ":set" command, there are three alternatives
530to set options automatically for one or more files:
531
5321. When starting Vim initializations are read from various places. See
533 |initialization|. Most of them are performed for all editing sessions,
534 and some of them depend on the directory where Vim is started.
535 You can create an initialization file with |:mkvimrc|, |:mkview| and
536 |:mksession|.
5372. If you start editing a new file, the automatic commands are executed.
538 This can be used to set options for files matching a particular pattern and
539 many other things. See |autocommand|.
5403. If you start editing a new file, and the 'modeline' option is on, a
541 number of lines at the beginning and end of the file are checked for
542 modelines. This is explained here.
543
544 *modeline* *vim:* *vi:* *ex:* *E520*
545There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100546 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100548[text{white}] empty or any text followed by at least one blank
549 character (<Space> or <Tab>); "ex:" always requires at
550 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200551{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200552[white] optional white space
553{options} a list of option settings, separated with white space
554 or ':', where each part between ':' is the argument
555 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556
Bram Moolenaar14b69452013-06-29 23:05:20 +0200557Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000558 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200559 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560
561The second form (this is compatible with some versions of Vi):
562
Bram Moolenaarade0d392020-01-21 22:33:58 +0100563 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
Bram Moolenaarade0d392020-01-21 22:33:58 +0100565[text{white}] empty or any text followed by at least one blank
566 character (<Space> or <Tab>); "ex:" always requires at
567 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200568{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
569[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200570se[t] the string "set " or "se " (note the space); When
571 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200572{options} a list of options, separated with white space, which
573 is the argument for a ":set" command
574: a colon
575[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576
Bram Moolenaar14b69452013-06-29 23:05:20 +0200577Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000578 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200579 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000580
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200581The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
582chance that a normal word like "lex:" is caught. There is one exception:
583"vi:" and "vim:" can also be at the start of the line (for compatibility with
584version 3.0). Using "ex:" at the start of the line will be ignored (this
585could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586
Hu Jialun9dcd3492021-08-28 20:42:50 +0200587If the modeline is disabled within a modeline, subsequent modelines will be
588ignored. This is to allow turning off modeline on a per-file basis. This is
589useful when a line looks like a modeline but isn't. For example, it would be
590good to start a YAML file containing strings like "vim:" with
591 # vim: nomodeline ~
592so as to avoid modeline misdetection. Following options on the same line
593after modeline deactivation, if any, are still evaluated (but you would
594normally not have any).
595
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596 *modeline-local*
597The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000598buffer and window that contain the file. Although it's possible to set global
599options from a modeline, this is unusual. If you have two windows open and
600the files in it set the same global option to a different value, the result
601depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000602
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000603When editing a file that was already loaded, only the window-local options
604from the modeline are used. Thus if you manually changed a buffer-local
605option after opening the file, it won't be changed if you edit the same buffer
606in another window. But window-local options will be set.
607
Bram Moolenaar071d4272004-06-13 20:20:40 +0000608 *modeline-version*
609If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200610number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 vim{vers}: version {vers} or later
612 vim<{vers}: version before {vers}
613 vim={vers}: version {vers}
614 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100615{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
616For example, to use a modeline only for Vim 7.0:
617 /* vim700: set foldmethod=marker */ ~
618To use a modeline for Vim after version 7.2:
619 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620There can be no blanks between "vim" and the ":".
621
622
623The number of lines that are checked can be set with the 'modelines' option.
624If 'modeline' is off or 'modelines' is 0 no lines are checked.
625
626Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000627like:
628 /* vi:ts=4: */ ~
629will give an error message for the trailing "*/". This line is OK:
630 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631
632If an error is detected the rest of the line is skipped.
633
634If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000635backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100636 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
637This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
638before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200639 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000641might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200642can be set. For some options a flag is set, so that when the value is used
643the |sandbox| is effective. Some options can only be set from the modeline
644when 'modelineexpr' is set (the default is off).
645
646Still, there is always a small risk that a modeline causes trouble. E.g.,
647when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
648So disable modelines before editing untrusted text. The mail ftplugin does
649this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650
651Hint: If you would like to do something else than setting an option, you could
652define an autocommand that checks the file for a specific string. For
653example: >
654 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
655And define a function SetVar() that does something with the line containing
656"VAR".
657
658==============================================================================
6593. Options summary *option-summary*
660
661In the list below all the options are mentioned with their full name and with
662an abbreviation if there is one. Both forms may be used.
663
664In this document when a boolean option is "set" that means that ":set option"
665is entered. When an option is "reset", ":set nooption" is used.
666
667For some options there are two default values: The "Vim default", which is
668used when 'compatible' is not set, and the "Vi default", which is used when
669'compatible' is set.
670
671Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000672are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673different value in each window. For example the 'list' option can be set in
674one window and reset in another for the same text, giving both types of view
675at the same time. There are a few options that are specific to a certain
676file. These can have a different value for each file or buffer. For example
677the 'textwidth' option can be 78 for a normal text file and 0 for a C
678program.
679
680 global one option for all buffers and windows
681 local to window each window has its own copy of this option
682 local to buffer each buffer has its own copy of this option
683
684When creating a new window the option values from the currently active window
685are used as a default value for the window-specific options. For the
686buffer-specific options this depends on the 's' and 'S' flags in the
687'cpoptions' option. If 's' is included (which is the default) the values for
688buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000689first entered. If 'S' is present the options are copied each time the buffer
690is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691present, the options are copied from the currently active buffer when the
692buffer is created.
693
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000694Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000696Not all options are supported in all versions. This depends on the supported
697features and sometimes on the system. A remark about this is in curly braces
698below. When an option is not supported it may still be set without getting an
699error, this is called a hidden option. You can't get the value of a hidden
700option though, it is not stored.
701
702To test if option "foo" can be used with ":set" use something like this: >
703 if exists('&foo')
704This also returns true for a hidden option. To test if option "foo" is really
705supported use something like this: >
706 if exists('+foo')
707<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708 *E355*
709A jump table for the options with a short description can be found at |Q_op|.
710
711 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100712'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714 {only available when compiled with the |+rightleft|
715 feature}
716 The ASCII code for the first letter of the Hebrew alphabet. The
717 routine that maps the keyboard in Hebrew mode, both in Insert mode
718 (when hkmap is set) and on the command-line (when hitting CTRL-_)
719 outputs the Hebrew characters in the range [aleph..aleph+26].
720 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
721 See |rileft.txt|.
722
723 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
724'allowrevins' 'ari' boolean (default off)
725 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726 {only available when compiled with the |+rightleft|
727 feature}
728 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
729 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
730 into reverse Insert mode, and don't know how to get out. See
731 'revins'.
732 NOTE: This option is reset when 'compatible' is set.
733
734 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
735'altkeymap' 'akm' boolean (default off)
736 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737 {only available when compiled with the |+farsi|
738 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100739 This option was for using Farsi, which has been removed. See
740 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741
742 *'ambiwidth'* *'ambw'*
743'ambiwidth' 'ambw' string (default: "single")
744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000745 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
746 Tells Vim what to do with characters with East Asian Width Class
747 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
748 letters, Cyrillic letters).
749
750 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000751 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 expected by most users.
753 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200754 *E834* *E835*
755 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100756 contains a character that would be double width. These errors may
757 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200758
759 The values are overruled for characters specified with
760 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761
762 There are a number of CJK fonts for which the width of glyphs for
763 those characters are solely based on how many octets they take in
764 legacy/traditional CJK encodings. In those encodings, Euro,
765 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000766 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000768 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 Vim is running inside a terminal (emulators) that uses a CJK font
770 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
771 this option should be set to "double" to match the width perceived
772 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100773 to be set to "double" under CJK MS-Windows when the system locale is
774 set to one of CJK locales. See Unicode Standard Annex #11
775 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100777 Vim may set this option automatically at startup time when Vim is
778 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200779 escape sequence to request cursor position report. The response can
780 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100781
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
783'antialias' 'anti' boolean (default: off)
784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200786 on macOS}
787 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
789 which can be easier to read at certain sizes on certain displays.
790 Setting this option can sometimes cause problems if 'guifont' is set
791 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100792 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793
794 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
795'autochdir' 'acd' boolean (default off)
796 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200797 {only available when compiled with it, use
798 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000799 When on, Vim will change the current working directory whenever you
800 open a file, switch buffers, delete a buffer or open/close a window.
801 It will change to the directory containing the file which was opened
802 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000803 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200805 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
806'autoshelldir' 'asd' boolean (default off)
807 global
808 When on, Vim will change the current working directory whenever you
809 change the directory of the shell running in a terminal window. You
810 need proper setting-up, so whenever the shell's pwd changes an OSC 7
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100811 escape sequence will be emitted. For example, on Linux, you can
812 source /etc/profile.d/vte.sh in your shell profile if you use bash or
813 zsh. For bash this should work (put it in a bash init file): >
814 if [[ -n "$VIM_TERMINAL" ]]; then
815 PROMPT_COMMAND='_vim_sync_PWD'
816 function _vim_sync_PWD() {
817 printf "\033]7;file://%s\033\\" "$PWD"
818 }
819 fi
820<
821 Or, in a zsh init file: >
822 if [[ -n "$VIM_TERMINAL" ]]; then
823 autoload -Uz add-zsh-hook
824 add-zsh-hook -Uz chpwd _vim_sync_PWD
825 function _vim_sync_PWD() {
826 printf "\033]7;file://%s\033\\" "$PWD"
827 }
828 fi
829<
830 In a fish init file: >
831 if test -n "$VIM_TERMINAL"
832 function _vim_sync_PWD --on-variable=PWD
833 printf "\033]7;file://%s\033\\" "$PWD"
834 end
835 end
836<
837 You can find an alternative method at |terminal-autoshelldir|.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000838 When the parsing of the OSC sequence fails you get *E1179* .
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200839
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
841'arabic' 'arab' boolean (default off)
842 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843 {only available when compiled with the |+arabic|
844 feature}
845 This option can be set to start editing Arabic text.
846 Setting this option will:
847 - Set the 'rightleft' option, unless 'termbidi' is set.
848 - Set the 'arabicshape' option, unless 'termbidi' is set.
849 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
850 between typing English and Arabic key mapping.
851 - Set the 'delcombine' option
852 Note that 'encoding' must be "utf-8" for working with Arabic text.
853
854 Resetting this option will:
855 - Reset the 'rightleft' option.
856 - Disable the use of 'keymap' (without changing its value).
857 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200858 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100859 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860 Also see |arabic.txt|.
861
862 *'arabicshape'* *'arshape'*
863 *'noarabicshape'* *'noarshape'*
864'arabicshape' 'arshape' boolean (default on)
865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866 {only available when compiled with the |+arabic|
867 feature}
868 When on and 'termbidi' is off, the required visual character
869 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200870 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871 one which encompasses:
872 a) the changing/morphing of characters based on their location
873 within a word (initial, medial, final and stand-alone).
874 b) the enabling of the ability to compose characters
875 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100876 When disabled the display shows each character's true stand-alone
877 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878 Arabic is a complex language which requires other settings, for
879 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100880 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000881
882 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
883'autoindent' 'ai' boolean (default off)
884 local to buffer
885 Copy indent from current line when starting a new line (typing <CR>
886 in Insert mode or when using the "o" or "O" command). If you do not
887 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000888 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
889 to another line has the same effect, unless the 'I' flag is included
890 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000891 When autoindent is on, formatting (with the "gq" command or when you
892 reach 'textwidth' in Insert mode) uses the indentation of the first
893 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000894 When 'smartindent' or 'cindent' is on the indent is changed in
895 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200896 The 'autoindent' option is reset when the 'paste' option is set and
897 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898
899 *'autoread'* *'ar'* *'noautoread'* *'noar'*
900'autoread' 'ar' boolean (default off)
901 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902 When a file has been detected to have been changed outside of Vim and
903 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200904 When the file has been deleted this is not done, so you have the text
905 from before it was deleted. When it appears again then it is read.
906 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907 If this option has a local value, use this command to switch back to
908 using the global value: >
909 :set autoread<
910<
911 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
912'autowrite' 'aw' boolean (default off)
913 global
914 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000915 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000916 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
917 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000918 to another file.
919 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000920 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921 Note that for some commands the 'autowrite' option is not used, see
922 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200923 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200924 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925
926 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
927'autowriteall' 'awa' boolean (default off)
928 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
930 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
931 Setting this option also implies that Vim behaves like 'autowrite' has
932 been set.
933
934 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200935'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 When set to "dark", Vim will try to use colors that look good on a
938 dark background. When set to "light", Vim will try to use colors that
939 look good on a light background. Any other value is illegal.
940 Vim tries to set the default value according to the terminal used.
941 This will not always be correct.
942 Setting this option does not change the background color, it tells Vim
943 what the background color looks like. For changing the background
944 color, see |:hi-normal|.
945
946 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000947 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000948 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100949 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000950 setting 'background' will cause the color scheme to be reloaded. If
951 the color scheme adjusts to the value of 'background' this will work.
952 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100953 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000954
955 When setting 'background' to the default value with: >
956 :set background&
957< Vim will guess the value. In the GUI this should work correctly,
958 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200959 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200960 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000961
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200962 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200963 color from the terminal. If the returned RGB value is dark/light and
964 'background' is not dark/light, 'background' will be set and the
965 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200966 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100967 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200968
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969 When starting the GUI, the default value for 'background' will be
970 "light". When the value is not set in the .gvimrc, and Vim detects
971 that the background is actually quite dark, 'background' is set to
972 "dark". But this happens only AFTER the .gvimrc file has been read
973 (because the window needs to be opened to find the actual background
974 color). To get around this, force the GUI window to be opened by
975 putting a ":gui" command in the .gvimrc file, before where the value
976 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200977
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100978 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200979 For other systems "dark" is used when 'term' is "linux",
980 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
981 background. Otherwise the default is "light".
982
Bram Moolenaarc572da52017-08-27 16:52:01 +0200983 The |:terminal| command and the |term_start()| function use the
984 'background' value to decide whether the terminal window will start
985 with a white or black background.
986
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987 Normally this option would be set in the .vimrc file. Possibly
988 depending on the terminal name. Example: >
989 :if &term == "pcterm"
990 : set background=dark
991 :endif
992< When this option is set, the default settings for the highlight groups
993 will change. To use other settings, place ":highlight" commands AFTER
994 the setting of the 'background' option.
995 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
996 to select the colors for syntax highlighting. After changing this
997 option, you must load syntax.vim again to see the result. This can be
998 done with ":syntax on".
999
1000 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001001'backspace' 'bs' string (default "", set to "indent,eol,start"
1002 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1005 mode. This is a list of items, separated by commas. Each item allows
1006 a way to backspace over something:
1007 value effect ~
1008 indent allow backspacing over autoindent
1009 eol allow backspacing over line breaks (join lines)
1010 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1011 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001012 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1013 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001014
Bram Moolenaar46eea442022-03-30 10:51:39 +01001015 When the value is empty, Vi compatible backspacing is used, none of
1016 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017
1018 For backwards compatibility with version 5.4 and earlier:
1019 value effect ~
1020 0 same as ":set backspace=" (Vi compatible)
1021 1 same as ":set backspace=indent,eol"
1022 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001023 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001024
1025 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1026 NOTE: This option is set to "" when 'compatible' is set.
1027
1028 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1029'backup' 'bk' boolean (default off)
1030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031 Make a backup before overwriting a file. Leave it around after the
1032 file has been successfully written. If you do not want to keep the
1033 backup file, but you do want a backup while the file is being
1034 written, reset this option and set the 'writebackup' option (this is
1035 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001036 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037 |backup-table| for more explanations.
1038 When the 'backupskip' pattern matches, a backup is not made anyway.
1039 When 'patchmode' is set, the backup may be renamed to become the
1040 oldest version of a file.
1041 NOTE: This option is reset when 'compatible' is set.
1042
1043 *'backupcopy'* *'bkc'*
1044'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001045 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001047 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048
1049 The main values are:
1050 "yes" make a copy of the file and overwrite the original one
1051 "no" rename the file and write a new one
1052 "auto" one of the previous, what works best
1053
1054 Extra values that can be combined with the ones above are:
1055 "breaksymlink" always break symlinks when writing
1056 "breakhardlink" always break hardlinks when writing
1057
1058 Making a copy and overwriting the original file:
1059 - Takes extra time to copy the file.
1060 + When the file has special attributes, is a (hard/symbolic) link or
1061 has a resource fork, all this is preserved.
1062 - When the file is a link the backup will have the name of the link,
1063 not of the real file.
1064
1065 Renaming the file and writing a new one:
1066 + It's fast.
1067 - Sometimes not all attributes of the file can be copied to the new
1068 file.
1069 - When the file is a link the new file will not be a link.
1070
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001071 The "auto" value is the middle way: When Vim sees that renaming the
1072 file is possible without side effects (the attributes can be passed on
1073 and the file is not a link) that is used. When problems are expected,
1074 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075
1076 The "breaksymlink" and "breakhardlink" values can be used in
1077 combination with any of "yes", "no" and "auto". When included, they
1078 force Vim to always break either symbolic or hard links by doing
1079 exactly what the "no" option does, renaming the original file to
1080 become the backup and writing a new file in its place. This can be
1081 useful for example in source trees where all the files are symbolic or
1082 hard links and any changes should stay in the local source tree, not
1083 be propagated back to the original source.
1084 *crontab*
1085 One situation where "no" and "auto" will cause problems: A program
1086 that opens a file, invokes Vim to edit that file, and then tests if
1087 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001088 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089 example.
1090
1091 When a copy is made, the original file is truncated and then filled
1092 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001093 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001094 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095 group of the backup is set to the group of the original file. If this
1096 fails, the protection bits for the group are made the same as for
1097 others.
1098
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001099 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001100 the same attributes of the original file, and the newly written file
1101 is owned by the current user. When the file was a (hard/symbolic)
1102 link, the new file will not! That's why the "auto" value doesn't
1103 rename when the file is a link. The owner and group of the newly
1104 written file will be set to the same ones as the original file, but
1105 the system may refuse to do this. In that case the "auto" value will
1106 again not rename the file.
1107
Bram Moolenaar036986f2017-03-16 17:41:02 +01001108 NOTE: This option is set to the Vi default value when 'compatible' is
1109 set and to the Vim default value when 'compatible' is reset.
1110
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111 *'backupdir'* *'bdir'*
1112'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001113 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114 for Unix: ".,~/tmp,~/")
1115 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 List of directories for the backup file, separated with commas.
1117 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001118 where this is possible. The directory must exist, Vim will not
1119 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001120 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001121 impossible!). Writing may fail because of this.
1122 - A directory "." means to put the backup file in the same directory
1123 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001124 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1125 the backup file relative to where the edited file is. The leading
1126 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127 ("." inside a directory name has no special meaning).
1128 - Spaces after the comma are ignored, other spaces are considered part
1129 of the directory name. To have a space at the start of a directory
1130 name, precede it with a backslash.
1131 - To include a comma in a directory name precede it with a backslash.
1132 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001133 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001134 the backup file name will be built from the complete path to the
1135 file with all path separators changed to percent '%' signs. This
1136 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001137 On Win32, it is also possible to end with "\\". However, When a
1138 separating comma is following, you must use "//", since "\\" will
1139 include the comma in the file name. Therefore it is recommended to
1140 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141 - Environment variables are expanded |:set_env|.
1142 - Careful with '\' characters, type one before a space, type two to
1143 get one in the option (see |option-backslash|), for example: >
1144 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1145< - For backwards compatibility with Vim version 3.0 a '>' at the start
1146 of the option is removed.
1147 See also 'backup' and 'writebackup' options.
1148 If you want to hide your backup files on Unix, consider this value: >
1149 :set backupdir=./.backup,~/.backup,.,/tmp
1150< You must create a ".backup" directory in each directory and in your
1151 home directory for this to work properly.
1152 The use of |:set+=| and |:set-=| is preferred when adding or removing
1153 directories from the list. This avoids problems when a future version
1154 uses another default.
1155 This option cannot be set from a |modeline| or in the |sandbox|, for
1156 security reasons.
1157
1158 *'backupext'* *'bex'* *E589*
1159'backupext' 'bex' string (default "~", for VMS: "_")
1160 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161 String which is appended to a file name to make the name of the
1162 backup file. The default is quite unusual, because this avoids
1163 accidentally overwriting existing files with a backup file. You might
1164 prefer using ".bak", but make sure that you don't have files with
1165 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001166 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001168 If you like to keep a lot of backups, you could use a BufWritePre
1169 autocommand to change 'backupext' just before writing the file to
1170 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001171 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001172< Use 'backupdir' to put the backup in a different directory.
1173
Bram Moolenaar071d4272004-06-13 20:20:40 +00001174 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001175'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1176 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1177 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001178 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 {not available when compiled without the |+wildignore|
1180 feature}
1181 A list of file patterns. When one of the patterns matches with the
1182 name of the file which is written, no backup file is created. Both
1183 the specified file name and the full path name of the file are used.
1184 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1185 Watch out for special characters, see |option-backslash|.
1186 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001187 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001188
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001189 WARNING: Not having a backup file means that when Vim fails to write
1190 your buffer correctly and then, for whatever reason, Vim exits, you
1191 lose both the original file and what you were writing. Only disable
1192 backups if you don't care about losing the file.
1193
Bram Moolenaar02467872007-05-06 13:22:01 +00001194 Note that environment variables are not expanded. If you want to use
1195 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001196 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001197
1198< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001199 backup would be made by renaming the original file crontab won't see
1200 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201
1202 *'balloondelay'* *'bdlay'*
1203'balloondelay' 'bdlay' number (default: 600)
1204 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205 {only available when compiled with the |+balloon_eval|
1206 feature}
1207 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1208
1209 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1210'ballooneval' 'beval' boolean (default off)
1211 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001212 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001213 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001214 Switch on the |balloon-eval| functionality for the GUI.
1215
1216 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1217 *'nobevalterm'*
1218'balloonevalterm' 'bevalterm' boolean (default off)
1219 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001220 {only available when compiled with the
1221 |+balloon_eval_term| feature}
1222 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001223
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001224 *'balloonexpr'* *'bexpr'*
1225'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001226 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001227 {only available when compiled with the |+balloon_eval|
1228 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001229 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001230 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1231 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001232
1233 v:beval_bufnr number of the buffer in which balloon is going to show
1234 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001235 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001236 v:beval_lnum line number
1237 v:beval_col column number (byte index)
1238 v:beval_text word under or after the mouse pointer
1239
Bram Moolenaar54775062019-07-31 21:07:14 +02001240 Instead of showing a balloon, which is limited to plain text, consider
1241 using a popup window, see |popup_beval_example|. A popup window can
1242 use highlighting and show a border.
1243
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001244 The evaluation of the expression must not have side effects!
1245 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001246 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001247 return 'Cursor is at line ' .. v:beval_lnum ..
1248 \ ', column ' .. v:beval_col ..
1249 \ ' of file ' .. bufname(v:beval_bufnr) ..
1250 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001251 endfunction
1252 set bexpr=MyBalloonExpr()
1253 set ballooneval
1254<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001255 Also see |balloon_show()|, it can be used if the content of the balloon
1256 is to be fetched asynchronously. In that case evaluating
1257 'balloonexpr' should result in an empty string. If you get a balloon
1258 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001259
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001260 NOTE: The balloon is displayed only if the cursor is on a text
1261 character. If the result of evaluating 'balloonexpr' is not empty,
1262 Vim does not try to send a message to an external debugger (Netbeans
1263 or Sun Workshop).
1264
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001265 If the expression starts with s: or |<SID>|, then it is replaced with
1266 the script ID (|local-function|). Example: >
1267 set bexpr=s:MyBalloonExpr()
1268 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001269< Otherwise, the expression is evaluated in the context of the script
1270 where the option was set, thus script-local items are available.
1271
Bram Moolenaar30b65812012-07-12 22:01:11 +02001272 The expression will be evaluated in the |sandbox| when set from a
1273 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001274 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001275
1276 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001277 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001278
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001279 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001280 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001281< When they are supported "\n" characters will start a new line. If the
1282 expression evaluates to a |List| this is equal to using each List item
1283 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001284 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001285
Bram Moolenaar165bc692015-07-21 17:53:25 +02001286 *'belloff'* *'bo'*
1287'belloff' 'bo' string (default "")
1288 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001289 Specifies for which events the bell will not be rung. It is a comma
1290 separated list of items. For each item that is present, the bell
1291 will be silenced. This is most useful to specify specific events in
1292 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001293 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001294
1295 item meaning when present ~
1296 all All events.
1297 backspace When hitting <BS> or <Del> and deleting results in an
1298 error.
1299 cursor Fail to move around using the cursor keys or
1300 <PageUp>/<PageDown> in |Insert-mode|.
1301 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1302 |i_CTRL-X_CTRL-T|.
1303 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1304 |i_CTRL-E|.
1305 ctrlg Unknown Char after <C-G> in Insert mode.
1306 error Other Error occurred (e.g. try to join last line)
1307 (mostly used in |Normal-mode| or |Cmdline-mode|).
1308 esc hitting <Esc> in |Normal-mode|.
1309 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001310 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001311 insertmode Pressing <Esc> in 'insertmode'.
1312 lang Calling the beep module for Lua/Mzscheme/TCL.
1313 mess No output available for |g<|.
1314 showmatch Error occurred for 'showmatch' function.
1315 operator Empty region error |cpo-E|.
1316 register Unknown register after <C-R> in |Insert-mode|.
1317 shell Bell from shell output |:!|.
1318 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001319 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001320 wildmode More matches in |cmdline-completion| available
1321 (depends on the 'wildmode' setting).
1322
Bram Moolenaar036986f2017-03-16 17:41:02 +01001323 This is most useful to fine tune when in Insert mode the bell should
1324 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001325 indicate that an error occurred. It can be silenced by adding the
1326 "error" keyword.
1327
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1329'binary' 'bin' boolean (default off)
1330 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331 This option should be set before editing a binary file. You can also
1332 use the |-b| Vim argument. When this option is switched on a few
1333 options will be changed (also when it already was on):
1334 'textwidth' will be set to 0
1335 'wrapmargin' will be set to 0
1336 'modeline' will be off
1337 'expandtab' will be off
1338 Also, 'fileformat' and 'fileformats' options will not be used, the
1339 file is read and written like 'fileformat' was "unix" (a single <NL>
1340 separates lines).
1341 The 'fileencoding' and 'fileencodings' options will not be used, the
1342 file is read without conversion.
1343 NOTE: When you start editing a(nother) file while the 'bin' option is
1344 on, settings from autocommands may change the settings again (e.g.,
1345 'textwidth'), causing trouble when editing. You might want to set
1346 'bin' again when the file has been loaded.
1347 The previous values of these options are remembered and restored when
1348 'bin' is switched from on to off. Each buffer has its own set of
1349 saved option values.
1350 To edit a file with 'binary' set you can use the |++bin| argument.
1351 This avoids you have to do ":set bin", which would have effect for all
1352 files you edit.
1353 When writing a file the <EOL> for the last line is only written if
1354 there was one in the original file (normally Vim appends an <EOL> to
1355 the last line if there is none; this would make the file longer). See
1356 the 'endofline' option.
1357
1358 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1359'bioskey' 'biosk' boolean (default on)
1360 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001361 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001362 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001363
1364 *'bomb'* *'nobomb'*
1365'bomb' boolean (default off)
1366 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 When writing a file and the following conditions are met, a BOM (Byte
1368 Order Mark) is prepended to the file:
1369 - this option is on
1370 - the 'binary' option is off
1371 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1372 endian variants.
1373 Some applications use the BOM to recognize the encoding of the file.
1374 Often used for UCS-2 files on MS-Windows. For other applications it
1375 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001376 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1378 check for the presence of the BOM is done and 'bomb' set accordingly.
1379 Unless 'binary' is set, it is removed from the first line, so that you
1380 don't see it when editing. When you don't change the options, the BOM
1381 will be restored when writing the file.
1382
1383 *'breakat'* *'brk'*
1384'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1385 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001386 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387 feature}
1388 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001389 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1390 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001392 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001393'breakindent' 'bri' boolean (default off)
1394 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001395 {not available when compiled without the |+linebreak|
1396 feature}
1397 Every wrapped line will continue visually indented (same amount of
1398 space as the beginning of that line), thus preserving horizontal blocks
1399 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001400 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001401
1402 *'breakindentopt'* *'briopt'*
1403'breakindentopt' 'briopt' string (default empty)
1404 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001405 {not available when compiled without the |+linebreak|
1406 feature}
1407 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001408 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001409 min:{n} Minimum text width that will be kept after
1410 applying 'breakindent', even if the resulting
1411 text should normally be narrower. This prevents
1412 text indented almost to the right window border
1413 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001414 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001415 shift:{n} After applying 'breakindent', the wrapped line's
1416 beginning will be shifted by the given number of
1417 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001418 indentation (negative) or emphasizing the line
1419 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001420 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001421 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001422 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001423 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001424 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001425 numbered or bulleted list (using the
1426 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001427 list:-1 Uses the length of a match with 'formatlistpat'
1428 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001429 (default: 0)
1430 column:{n} Indent at column {n}. Will overrule the other
1431 sub-options. Note: an additional indent may be
1432 added for the 'showbreak' setting.
1433 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001434
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001436'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001438 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001439 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001440 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001441 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001442 buffer Use the directory of the related buffer.
1443 current Use the current directory.
1444 {path} Use the specified directory
1445
1446 *'bufhidden'* *'bh'*
1447'bufhidden' 'bh' string (default: "")
1448 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001449 This option specifies what happens when a buffer is no longer
1450 displayed in a window:
1451 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001452 hide hide the buffer (don't unload it), even if 'hidden' is
1453 not set
1454 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001455 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001456 delete delete the buffer from the buffer list, even if
1457 'hidden' is set; the |:hide| command will also delete
1458 the buffer, making it behave like |:bdelete|
1459 wipe wipe the buffer from the buffer list, even if
1460 'hidden' is set; the |:hide| command will also wipe
1461 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001463 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001464 are lost without a warning. Also, these values may break autocommands
1465 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466 This option is used together with 'buftype' and 'swapfile' to specify
1467 special kinds of buffers. See |special-buffers|.
1468
1469 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1470'buflisted' 'bl' boolean (default: on)
1471 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001472 When this option is set, the buffer shows up in the buffer list. If
1473 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1474 This option is reset by Vim for buffers that are only used to remember
1475 a file name or marks. Vim sets it when starting to edit a buffer.
1476 But not when moving to a buffer with ":buffer".
1477
1478 *'buftype'* *'bt'* *E382*
1479'buftype' 'bt' string (default: "")
1480 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001481 The value of this option specifies the type of a buffer:
1482 <empty> normal buffer
1483 nofile buffer which is not related to a file and will not be
1484 written
1485 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001486 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001487 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001489 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490 help help buffer (you are not supposed to set this
1491 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001492 terminal buffer for a |terminal| (you are not supposed to set
1493 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001494 prompt buffer where only the last line can be edited, meant
1495 to be used by a plugin, see |prompt-buffer|
1496 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001497 popup buffer used in a popup window, see |popup|.
1498 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499
1500 This option is used together with 'bufhidden' and 'swapfile' to
1501 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001502 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503
1504 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001505 One such effect is that Vim will not check the timestamp of the file,
1506 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507
Bram Moolenaar280f1262006-01-30 00:14:18 +00001508 A "quickfix" buffer is only used for the error list and the location
1509 list. This value is set by the |:cwindow| and |:lwindow| commands and
1510 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511
1512 "nofile" and "nowrite" buffers are similar:
1513 both: The buffer is not to be written to disk, ":w" doesn't
1514 work (":w filename" does work though).
1515 both: The buffer is never considered to be |'modified'|.
1516 There is no warning when the changes will be lost, for
1517 example when you quit Vim.
1518 both: A swap file is only created when using too much memory
1519 (when 'swapfile' has been reset there is never a swap
1520 file).
1521 nofile only: The buffer name is fixed, it is not handled like a
1522 file name. It is not modified in response to a |:cd|
1523 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001524 both: When using ":e bufname" and already editing "bufname"
1525 the buffer is made empty and autocommands are
1526 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001527 *E676*
1528 "acwrite" implies that the buffer name is not related to a file, like
1529 "nofile", but it will be written. Thus, in contrast to "nofile" and
1530 "nowrite", ":w" does work and a modified buffer can't be abandoned
1531 without saving. For writing there must be matching |BufWriteCmd|,
1532 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533
1534 *'casemap'* *'cmp'*
1535'casemap' 'cmp' string (default: "internal,keepascii")
1536 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537 Specifies details about changing the case of letters. It may contain
1538 these words, separated by a comma:
1539 internal Use internal case mapping functions, the current
1540 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001541 matters when 'encoding' is a Unicode encoding,
1542 "latin1" or "iso-8859-15". When "internal" is
1543 omitted, the towupper() and towlower() system library
1544 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1546 case mapping, the current locale is not effective.
1547 This probably only matters for Turkish.
1548
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001549 *'cdhome'* *'cdh'*
1550'cdhome' 'cdh' boolean (default: off)
1551 global
1552 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1553 current working directory to the |$HOME| directory like in Unix.
1554 When off, those commands just print the current directory name.
1555 On Unix this option has no effect.
1556 NOTE: This option is reset when 'compatible' is set.
1557
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 *'cdpath'* *'cd'* *E344* *E346*
1559'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1560 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561 {not available when compiled without the
1562 |+file_in_path| feature}
1563 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001564 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1565 searched for has a relative path, not an absolute part starting with
1566 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567 The 'cdpath' option's value has the same form and semantics as
1568 |'path'|. Also see |file-searching|.
1569 The default value is taken from $CDPATH, with a "," prepended to look
1570 in the current directory first.
1571 If the default value taken from $CDPATH is not what you want, include
1572 a modified version of the following command in your vimrc file to
1573 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001574 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001575< This option cannot be set from a |modeline| or in the |sandbox|, for
1576 security reasons.
1577 (parts of 'cdpath' can be passed to the shell to expand file names).
1578
1579 *'cedit'*
1580'cedit' string (Vi default: "", Vim default: CTRL-F)
1581 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582 The key used in Command-line Mode to open the command-line window.
1583 The default is CTRL-F when 'compatible' is off.
1584 Only non-printable keys are allowed.
1585 The key can be specified as a single character, but it is difficult to
1586 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001587 :exe "set cedit=\<C-Y>"
1588 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589< |Nvi| also has this option, but it only uses the first character.
1590 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001591 NOTE: This option is set to the Vim default value when 'compatible'
1592 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001593
1594 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1595'charconvert' 'ccv' string (default "")
1596 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001597 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001598 An expression that is used for character encoding conversion. It is
1599 evaluated when a file that is to be read or has been written has a
1600 different encoding from what is desired.
1601 'charconvert' is not used when the internal iconv() function is
1602 supported and is able to do the conversion. Using iconv() is
1603 preferred, because it is much faster.
1604 'charconvert' is not used when reading stdin |--|, because there is no
1605 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001606 The expression must return zero, false or an empty string for success,
1607 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608 The possible encoding names encountered are in 'encoding'.
1609 Additionally, names given in 'fileencodings' and 'fileencoding' are
1610 used.
1611 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1612 is done internally by Vim, 'charconvert' is not used for this.
1613 'charconvert' is also used to convert the viminfo file, if the 'c'
1614 flag is present in 'viminfo'. Also used for Unicode conversion.
1615 Example: >
1616 set charconvert=CharConvert()
1617 fun CharConvert()
1618 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001619 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1620 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621 return v:shell_error
1622 endfun
1623< The related Vim variables are:
1624 v:charconvert_from name of the current encoding
1625 v:charconvert_to name of the desired encoding
1626 v:fname_in name of the input file
1627 v:fname_out name of the output file
1628 Note that v:fname_in and v:fname_out will never be the same.
1629 Note that v:charconvert_from and v:charconvert_to may be different
1630 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001631
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 Encryption is not done by Vim when using 'charconvert'. If you want
1633 to encrypt the file after conversion, 'charconvert' should take care
1634 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001635
1636 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1637 replaced with the script ID (|local-function|). Example: >
1638 set charconvert=s:MyConvert()
1639 set charconvert=<SID>SomeConvert()
1640< Otherwise the expression is evaluated in the context of the script
1641 where the option was set, thus script-local items are available.
1642
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643 This option cannot be set from a |modeline| or in the |sandbox|, for
1644 security reasons.
1645
1646 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1647'cindent' 'cin' boolean (default off)
1648 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001649 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650 that trigger reindenting in insert mode and 'cinoptions' to set your
1651 preferred indent style.
1652 If 'indentexpr' is not empty, it overrules 'cindent'.
1653 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1654 the "=" operator indents using this algorithm rather than calling an
1655 external program.
1656 See |C-indenting|.
1657 When you don't like the way 'cindent' works, try the 'smartindent'
1658 option or 'indentexpr'.
1659 This option is not used when 'paste' is set.
1660 NOTE: This option is reset when 'compatible' is set.
1661
1662 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001663'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 A list of keys that, when typed in Insert mode, cause reindenting of
1666 the current line. Only used if 'cindent' is on and 'indentexpr' is
1667 empty.
1668 For the format of this option see |cinkeys-format|.
1669 See |C-indenting|.
1670
1671 *'cinoptions'* *'cino'*
1672'cinoptions' 'cino' string (default "")
1673 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1675 program. See |cinoptions-values| for the values of this option, and
1676 |C-indenting| for info on C indenting in general.
1677
1678
1679 *'cinwords'* *'cinw'*
1680'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1681 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001682 These keywords start an extra indent in the next line when
1683 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1684 an appropriate place (inside {}).
1685 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1686 matter, include the keyword both the uppercase and lowercase:
1687 "if,If,IF".
1688
Tom Praschan3506cf32022-04-07 12:39:08 +01001689 *'cinscopedecls'* *'cinsd'*
1690'cinscopedecls' 'cinsd' string (default "public,protected,private")
1691 local to buffer
Tom Praschan3506cf32022-04-07 12:39:08 +01001692 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1693 Useful e.g. for working with the Qt framework that defines additional
1694 scope declarations "signals", "public slots" and "private slots": >
1695 set cinscopedecls+=signals,public\ slots,private\ slots
1696
1697< *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001698'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1699 for X-windows, "" otherwise)
1700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701 {only in GUI versions or when the |+xterm_clipboard|
1702 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001703 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001704 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001705 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001706 prepend, e.g.: >
1707 set clipboard^=unnamed
1708< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001710 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 unnamed When included, Vim will use the clipboard register '*'
1712 for all yank, delete, change and put operations which
1713 would normally go to the unnamed register. When a
1714 register is explicitly specified, it will always be
1715 used regardless of whether "unnamed" is in 'clipboard'
1716 or not. The clipboard register can always be
1717 explicitly accessed using the "* notation. Also see
1718 |gui-clipboard|.
1719
Bram Moolenaar30b65812012-07-12 22:01:11 +02001720 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001721 unnamedplus A variant of the "unnamed" flag which uses the
1722 clipboard register '+' (|quoteplus|) instead of
1723 register '*' for all yank, delete, change and put
1724 operations which would normally go to the unnamed
1725 register. When "unnamed" is also included to the
1726 option, yank operations (but not delete, change or
1727 put) will additionally copy the text into register
1728 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001729 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001730 Availability can be checked with: >
1731 if has('unnamedplus')
1732<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001733 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 autoselect Works like the 'a' flag in 'guioptions': If present,
1735 then whenever Visual mode is started, or the Visual
1736 area extended, Vim tries to become the owner of the
1737 windowing system's global selection or put the
1738 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001739 register "*. See |'go-a'| and |quotestar| for details.
1740 When the GUI is active, the 'a' flag in 'guioptions'
1741 is used, when the GUI is not active, this "autoselect"
1742 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743 Also applies to the modeless selection.
1744
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001745 *clipboard-autoselectplus*
1746 autoselectplus Like "autoselect" but using the + register instead of
1747 the * register. Compare to the 'P' flag in
1748 'guioptions'.
1749
1750 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751 autoselectml Like "autoselect", but for the modeless selection
1752 only. Compare to the 'A' flag in 'guioptions'.
1753
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001754 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001755 html When the clipboard contains HTML, use this when
1756 pasting. When putting text on the clipboard, mark it
1757 as HTML. This works to copy rendered HTML from
1758 Firefox, paste it as raw HTML in Vim, select the HTML
1759 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001760 You probably want to add this only temporarily,
1761 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001762 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001763
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001764 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001765 exclude:{pattern}
1766 Defines a pattern that is matched against the name of
1767 the terminal 'term'. If there is a match, no
1768 connection will be made to the X server. This is
1769 useful in this situation:
1770 - Running Vim in a console.
1771 - $DISPLAY is set to start applications on another
1772 display.
1773 - You do not want to connect to the X server in the
1774 console, but do want this in a terminal emulator.
1775 To never connect to the X server use: >
1776 exclude:.*
1777< This has the same effect as using the |-X| argument.
1778 Note that when there is no connection to the X server
1779 the window title won't be restored and the clipboard
1780 cannot be accessed.
1781 The value of 'magic' is ignored, {pattern} is
1782 interpreted as if 'magic' was on.
1783 The rest of the option value will be used for
1784 {pattern}, this must be the last entry.
1785
1786 *'cmdheight'* *'ch'*
1787'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001788 global or local to tab page
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789 Number of screen lines to use for the command-line. Helps avoiding
1790 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001791 The value of this option is stored with the tab page, so that each tab
1792 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001793
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001794 When 'cmdheight' is zero, there is no command-line unless it is being
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01001795 used. Some informative messages will not be displayed, any other
1796 messages will cause the |hit-enter| prompt.
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001797
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 *'cmdwinheight'* *'cwh'*
1799'cmdwinheight' 'cwh' number (default 7)
1800 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 Number of screen lines to use for the command-line window. |cmdwin|
1802
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001803 *'colorcolumn'* *'cc'*
1804'colorcolumn' 'cc' string (default "")
1805 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001806 {not available when compiled without the |+syntax|
1807 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001808 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001809 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1810 text. Will make screen redrawing slower.
1811 The screen column can be an absolute number, or a number preceded with
1812 '+' or '-', which is added to or subtracted from 'textwidth'. >
1813
1814 :set cc=+1 " highlight column after 'textwidth'
1815 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1816 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1817<
1818 When 'textwidth' is zero then the items with '-' and '+' are not used.
1819 A maximum of 256 columns are highlighted.
1820
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 *'columns'* *'co'* *E594*
1822'columns' 'co' number (default 80 or terminal width)
1823 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001825 initialization and does not have to be set by hand. Also see
1826 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001827 When Vim is running in the GUI or in a resizable window, setting this
1828 option will cause the window size to be changed. When you only want
1829 to use the size for the GUI, put the command in your |gvimrc| file.
1830 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001831 number of columns of the display, the display may be messed up. For
1832 the GUI it is always possible and Vim limits the number of columns to
1833 what fits on the screen. You can use this command to get the widest
1834 window possible: >
1835 :set columns=9999
1836< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837
1838 *'comments'* *'com'* *E524* *E525*
1839'comments' 'com' string (default
1840 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1841 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001842 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843 |format-comments|. See |option-backslash| about using backslashes to
1844 insert a space.
1845
1846 *'commentstring'* *'cms'* *E537*
1847'commentstring' 'cms' string (default "/*%s*/")
1848 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001849 {not available when compiled without the |+folding|
1850 feature}
1851 A template for a comment. The "%s" in the value is replaced with the
1852 comment text. Currently only used to add markers for folding, see
1853 |fold-marker|.
1854
1855 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001856'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001857 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 This option has the effect of making Vim either more Vi-compatible, or
1860 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001861
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001863 other options are also changed as a side effect.
1864 NOTE: Setting or resetting this option can have a lot of unexpected
1865 effects: Mappings are interpreted in another way, undo behaves
1866 differently, etc. If you set this option in your vimrc file, you
1867 should probably put it at the very start.
1868
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869 By default this option is on and the Vi defaults are used for the
1870 options. This default was chosen for those people who want to use Vim
1871 just like Vi, and don't even (want to) know about the 'compatible'
1872 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001873 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001874 this option is switched off, and all options that have not been
1875 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001876 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001877 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001878 happen for the system-wide vimrc or gvimrc file, nor for a file given
1879 with the |-u| argument). Also see |compatible-default| and
1880 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881 You can also set this option with the "-C" argument, and reset it with
1882 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001883 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001884
Bram Moolenaar214641f2017-03-05 17:04:09 +01001885 When this option is set, numerous other options are set to make Vim as
1886 Vi-compatible as possible. When this option is unset, various options
1887 are set to make Vim more useful. The table below lists all the
1888 options affected.
1889 The {?} column indicates when the options are affected:
1890 + Means that the option is set to the value given in {set value} when
1891 'compatible' is set.
1892 & Means that the option is set to the value given in {set value} when
1893 'compatible' is set AND is set to its Vim default value when
1894 'compatible' is unset.
1895 - Means the option is NOT changed when setting 'compatible' but IS
1896 set to its Vim default when 'compatible' is unset.
1897 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001898
Bram Moolenaar036986f2017-03-16 17:41:02 +01001899 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001900
1901 'allowrevins' + off no CTRL-_ command
1902 'antialias' + off don't use antialiased fonts
1903 'arabic' + off reset arabic-related options
1904 'arabicshape' + on correct character shapes
1905 'backspace' + "" normal backspace
1906 'backup' + off no backup file
1907 'backupcopy' & Unix: "yes" backup file is a copy
1908 else: "auto" copy or rename backup file
1909 'balloonexpr' + "" text to show in evaluation balloon
1910 'breakindent' + off don't indent when wrapping lines
1911 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001912 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001913 'cindent' + off no C code indentation
1914 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1915 'copyindent' + off don't copy indent structure
1916 'cpoptions' & (all flags) Vi-compatible flags
1917 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001918 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001919 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001920 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001921 'cscopeverbose' + off see |cscopeverbose|
1922 'delcombine' + off unicode: delete whole char combination
1923 'digraph' + off no digraphs
1924 'esckeys' & off no <Esc>-keys in Insert mode
1925 'expandtab' + off tabs not expanded to spaces
1926 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001927 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001928 'formatexpr' + "" use 'formatprg' for auto-formatting
1929 'formatoptions' & "vt" Vi compatible formatting
1930 'gdefault' + off no default 'g' flag for ":s"
1931 'history' & 0 no commandline history
1932 'hkmap' + off no Hebrew keyboard mapping
1933 'hkmapp' + off no phonetic Hebrew keyboard mapping
1934 'hlsearch' + off no highlighting of search matches
1935 'incsearch' + off no incremental searching
1936 'indentexpr' + "" no indenting by expression
1937 'insertmode' + off do not start in Insert mode
1938 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001939 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001940 'joinspaces' + on insert 2 spaces after period
1941 'modeline' & off no modelines
1942 'more' & off no pauses in listings
1943 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1944 'numberwidth' & 8 min number of columns for line number
1945 'preserveindent'+ off don't preserve current indent structure
1946 when changing it
1947 'revins' + off no reverse insert
1948 'ruler' + off no ruler
1949 'scrolljump' + 1 no jump scroll
1950 'scrolloff' + 0 no scroll offset
1951 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1952 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001953 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001954 'showcmd' & off command characters not shown
1955 'showmode' & off current mode not shown
1956 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1957 'smartcase' + off no automatic ignore case switch
1958 'smartindent' + off no smart indentation
1959 'smarttab' + off no smart tab size
1960 'softtabstop' + 0 tabs are always 'tabstop' positions
1961 'startofline' + on goto startofline with some commands
1962 'tagcase' & "followic" 'ignorecase' when searching tags file
1963 'tagrelative' & off tag file names are not relative
1964 'termguicolors' + off don't use highlight-(guifg|guibg)
1965 'textauto' & off no automatic textmode detection
1966 'textwidth' + 0 no automatic line wrap
1967 'tildeop' + off tilde is not an operator
1968 'ttimeout' + off no terminal timeout
1969 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001970 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001971 'virtualedit' + "" cursor can only be placed on characters
1972 'whichwrap' & "" left-right movements don't wrap
1973 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001975 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976
1977 *'complete'* *'cpt'* *E535*
1978'complete' 'cpt' string (default: ".,w,b,u,t,i")
1979 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980 This option specifies how keyword completion |ins-completion| works
1981 when CTRL-P or CTRL-N are used. It is also used for whole-line
1982 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001983 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001984 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001985 w scan buffers from other windows
1986 b scan other loaded buffers that are in the buffer list
1987 u scan the unloaded buffers that are in the buffer list
1988 U scan the buffers that are not in the buffer list
1989 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001990 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001991 k{dict} scan the file {dict}. Several "k" flags can be given,
1992 patterns are valid too. For example: >
1993 :set cpt=k/usr/dict/*,k~/spanish
1994< s scan the files given with the 'thesaurus' option
1995 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1996 are valid too.
1997 i scan current and included files
1998 d scan current and included files for defined name or macro
1999 |i_CTRL-X_CTRL-D|
2000 ] tag completion
2001 t same as "]"
2002
2003 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2004 not executed, this may lead to unexpected completions from some files
2005 (gzipped files for example). Unloaded buffers are not scanned for
2006 whole-line completion.
2007
2008 The default is ".,w,b,u,t,i", which means to scan:
2009 1. the current buffer
2010 2. buffers in other windows
2011 3. other loaded buffers
2012 4. unloaded buffers
2013 5. tags
2014 6. included files
2015
2016 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002017 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2018 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002020 *'completefunc'* *'cfu'*
2021'completefunc' 'cfu' string (default: empty)
2022 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002023 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002024 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002025 This option specifies a function to be used for Insert mode completion
2026 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002027 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002028 invoked and what it should return. The value can be the name of a
2029 function, a |lambda| or a |Funcref|. See |option-value-function| for
2030 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002031 This option cannot be set from a |modeline| or in the |sandbox|, for
2032 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002033
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002034 *'completeslash'* *'csl'*
2035'completeslash' 'csl' string (default: "")
2036 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002037 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002038 When this option is set it overrules 'shellslash' for completion:
2039 - When this option is set to "slash", a forward slash is used for path
2040 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002041 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002042 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002043 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002044 - When this option is empty, same character is used as for
2045 'shellslash'.
2046 For Insert mode completion the buffer-local value is used. For
2047 command line completion the global value is used.
2048
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002049 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002050'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002051 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002052 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002053 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002054
2055 menu Use a popup menu to show the possible completions. The
2056 menu is only shown when there is more than one match and
2057 sufficient colors are available. |ins-completion-menu|
2058
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002059 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002060 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002061 match, e.g., what file it comes from.
2062
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002063 longest Only insert the longest common text of the matches. If
2064 the menu is displayed you can use CTRL-L to add more
2065 characters. Whether case is ignored depends on the kind
2066 of completion. For buffer text the 'ignorecase' option is
2067 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002068
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002069 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002070 completion in the preview window. Only works in
2071 combination with "menu" or "menuone".
2072
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002073 popup Show extra information about the currently selected
2074 completion in a popup window. Only works in combination
2075 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002076 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002077 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002078
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002079 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002080 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002081 |CompleteChanged| autocommand to fetch the info and call
2082 |popup_show()| once the popup has been filled.
2083 See the example at |complete-popuphidden|.
2084 {only works when compiled with the |+textprop| feature}
2085
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002086 noinsert Do not insert any text for a match until the user selects
2087 a match from the menu. Only works in combination with
2088 "menu" or "menuone". No effect if "longest" is present.
2089
2090 noselect Do not select a match in the menu, force the user to
2091 select one from the menu. Only works in combination with
2092 "menu" or "menuone".
2093
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002094
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002095 *'completepopup'* *'cpp'*
2096'completepopup' 'cpp' string (default empty)
2097 global
2098 {not available when compiled without the |+textprop|
2099 or |+quickfix| feature}
2100 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002101 properties of the info popup when it is created. If an info popup
2102 window already exists it is closed, so that the option value is
2103 applied when it is created again.
2104 You can also use |popup_findinfo()| and then set properties for an
2105 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002106
2107
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002108 *'concealcursor'* *'cocu'*
2109'concealcursor' 'cocu' string (default: "")
2110 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002111 {not available when compiled without the |+conceal|
2112 feature}
2113 Sets the modes in which text in the cursor line can also be concealed.
2114 When the current mode is listed then concealing happens just like in
2115 other lines.
2116 n Normal mode
2117 v Visual mode
2118 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002119 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002120
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002121 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002122 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002123 are moving around text is concealed, but when starting to insert text
2124 or selecting a Visual area the concealed text is displayed, so that
2125 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002126 Keep in mind that the cursor position is not always where it's
2127 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002128
2129
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002130 *'conceallevel'* *'cole'*
2131'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002132 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002133 {not available when compiled without the |+conceal|
2134 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002135 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2136 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002137
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002138 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002139 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002140 1 Each block of concealed text is replaced with one
2141 character. If the syntax item does not have a custom
2142 replacement character defined (see |:syn-cchar|) the
2143 character defined in 'listchars' is used (default is a
2144 space).
2145 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002146 2 Concealed text is completely hidden unless it has a
2147 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002148 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002149 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002150
Bram Moolenaara7781e02010-07-19 20:13:22 +02002151 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002152 edit and copy the text. This can be changed with the 'concealcursor'
2153 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002154
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2156'confirm' 'cf' boolean (default off)
2157 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158 When 'confirm' is on, certain operations that would normally
2159 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2160 instead raise a |dialog| asking if you wish to save the current
2161 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2162 If 'confirm' is off you can still activate confirmation for one
2163 command only (this is most useful in mappings) with the |:confirm|
2164 command.
2165 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2166
2167 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2168'conskey' 'consk' boolean (default off)
2169 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002170 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171
2172 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2173'copyindent' 'ci' boolean (default off)
2174 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002175 Copy the structure of the existing lines indent when autoindenting a
2176 new line. Normally the new indent is reconstructed by a series of
2177 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2178 in which case only spaces are used). Enabling this option makes the
2179 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002180 existing line. 'expandtab' has no effect on these characters, a Tab
2181 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002183 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184 Also see 'preserveindent'.
2185
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002186 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187'cpoptions' 'cpo' string (Vim default: "aABceFs",
2188 Vi default: all flags)
2189 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002191 this indicates Vi-compatible behavior. This is used for things where
2192 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193 'cpoptions' stands for "compatible-options".
2194 Commas can be added for readability.
2195 To avoid problems with flags that are added in the future, use the
2196 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002197
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198 NOTE: This option is set to the Vi default value when 'compatible' is
2199 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002200
2201 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2202 is saved, 'cpoptions' is set to the Vim default, and the saved value
2203 is restored at the end of the script. Changes to the value of
2204 'cpoptions' will be applied to the saved value, but keep in mind that
2205 removing a flag that is not present when 'cpoptions' is changed has no
2206 effect. In the |.vimrc| file the value is not restored, thus using
2207 `vim9script` in the |.vimrc| file results in using the Vim default.
2208
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002209 NOTE: This option is set to the POSIX default value at startup when
2210 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002211 variable exists |posix|. This means Vim tries to behave like the
2212 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213
2214 contains behavior ~
2215 *cpo-a*
2216 a When included, a ":read" command with a file name
2217 argument will set the alternate file name for the
2218 current window.
2219 *cpo-A*
2220 A When included, a ":write" command with a file name
2221 argument will set the alternate file name for the
2222 current window.
2223 *cpo-b*
2224 b "\|" in a ":map" command is recognized as the end of
2225 the map command. The '\' is included in the mapping,
2226 the text after the '|' is interpreted as the next
2227 command. Use a CTRL-V instead of a backslash to
2228 include the '|' in the mapping. Applies to all
2229 mapping, abbreviation, menu and autocmd commands.
2230 See also |map_bar|.
2231 *cpo-B*
2232 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002233 abbreviations, user commands and the "to" part of the
2234 menu commands. Remove this flag to be able to use a
2235 backslash like a CTRL-V. For example, the command
2236 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237 'B' included: "\^[" (^[ is a real <Esc>)
2238 'B' excluded: "<Esc>" (5 characters)
2239 ('<' excluded in both cases)
2240 *cpo-c*
2241 c Searching continues at the end of any match at the
2242 cursor position, but not further than the start of the
2243 next line. When not present searching continues
2244 one character from the cursor position. With 'c'
2245 "abababababab" only gets three matches when repeating
2246 "/abab", without 'c' there are five matches.
2247 *cpo-C*
2248 C Do not concatenate sourced lines that start with a
2249 backslash. See |line-continuation|.
2250 *cpo-d*
2251 d Using "./" in the 'tags' option doesn't mean to use
2252 the tags file relative to the current file, but the
2253 tags file in the current directory.
2254 *cpo-D*
2255 D Can't use CTRL-K to enter a digraph after Normal mode
2256 commands with a character argument, like |r|, |f| and
2257 |t|.
2258 *cpo-e*
2259 e When executing a register with ":@r", always add a
2260 <CR> to the last line, also when the register is not
2261 linewise. If this flag is not present, the register
2262 is not linewise and the last line does not end in a
2263 <CR>, then the last line is put on the command-line
2264 and can be edited before hitting <CR>.
2265 *cpo-E*
2266 E It is an error when using "y", "d", "c", "g~", "gu" or
2267 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002268 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002269 This makes "y0" fail in the first column.
2270 *cpo-f*
2271 f When included, a ":read" command with a file name
2272 argument will set the file name for the current buffer,
2273 if the current buffer doesn't have a file name yet.
2274 *cpo-F*
2275 F When included, a ":write" command with a file name
2276 argument will set the file name for the current
2277 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002278 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 *cpo-g*
2280 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002281 *cpo-H*
2282 H When using "I" on a line with only blanks, insert
2283 before the last blank. Without this flag insert after
2284 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285 *cpo-i*
2286 i When included, interrupting the reading of a file will
2287 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002288 *cpo-I*
2289 I When moving the cursor up or down just after inserting
2290 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291 *cpo-j*
2292 j When joining lines, only add two spaces after a '.',
2293 not after '!' or '?'. Also see 'joinspaces'.
2294 *cpo-J*
2295 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002296 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297 white space.
2298 *cpo-k*
2299 k Disable the recognition of raw key codes in
2300 mappings, abbreviations, and the "to" part of menu
2301 commands. For example, if <Key> sends ^[OA (where ^[
2302 is <Esc>), the command ":map X ^[OA" results in X
2303 being mapped to:
2304 'k' included: "^[OA" (3 characters)
2305 'k' excluded: "<Key>" (one key code)
2306 Also see the '<' flag below.
2307 *cpo-K*
2308 K Don't wait for a key code to complete when it is
2309 halfway a mapping. This breaks mapping <F1><F1> when
2310 only part of the second <F1> has been read. It
2311 enables cancelling the mapping by typing <F1><Esc>.
2312 *cpo-l*
2313 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002314 literally, only "\]", "\^", "\-" and "\\" are special.
2315 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2317 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002318 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002319 *cpo-L*
2320 L When the 'list' option is set, 'wrapmargin',
2321 'textwidth', 'softtabstop' and Virtual Replace mode
2322 (see |gR|) count a <Tab> as two characters, instead of
2323 the normal behavior of a <Tab>.
2324 *cpo-m*
2325 m When included, a showmatch will always wait half a
2326 second. When not included, a showmatch will wait half
2327 a second or until a character is typed. |'showmatch'|
2328 *cpo-M*
2329 M When excluded, "%" matching will take backslashes into
2330 account. Thus in "( \( )" and "\( ( \)" the outer
2331 parenthesis match. When included "%" ignores
2332 backslashes, which is Vi compatible.
2333 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002334 n When included, the column used for 'number' and
2335 'relativenumber' will also be used for text of wrapped
2336 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337 *cpo-o*
2338 o Line offset to search command is not remembered for
2339 next search.
2340 *cpo-O*
2341 O Don't complain if a file is being overwritten, even
2342 when it didn't exist when editing it. This is a
2343 protection against a file unexpectedly created by
2344 someone else. Vi didn't complain about this.
2345 *cpo-p*
2346 p Vi compatible Lisp indenting. When not present, a
2347 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002348 *cpo-P*
2349 P When included, a ":write" command that appends to a
2350 file will set the file name for the current buffer, if
2351 the current buffer doesn't have a file name yet and
2352 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002353 *cpo-q*
2354 q When joining multiple lines leave the cursor at the
2355 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356 *cpo-r*
2357 r Redo ("." command) uses "/" to repeat a search
2358 command, instead of the actually used search string.
2359 *cpo-R*
2360 R Remove marks from filtered lines. Without this flag
2361 marks are kept like |:keepmarks| was used.
2362 *cpo-s*
2363 s Set buffer options when entering the buffer for the
2364 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002365 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366 set when the buffer is created.
2367 *cpo-S*
2368 S Set buffer options always when entering a buffer
2369 (except 'readonly', 'fileformat', 'filetype' and
2370 'syntax'). This is the (most) Vi compatible setting.
2371 The options are set to the values in the current
2372 buffer. When you change an option and go to another
2373 buffer, the value is copied. Effectively makes the
2374 buffer options global to all buffers.
2375
2376 's' 'S' copy buffer options
2377 no no when buffer created
2378 yes no when buffer first entered (default)
2379 X yes each time when buffer entered (vi comp.)
2380 *cpo-t*
2381 t Search pattern for the tag command is remembered for
2382 "n" command. Otherwise Vim only puts the pattern in
2383 the history for search pattern, but doesn't change the
2384 last used search pattern.
2385 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002386 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 *cpo-v*
2388 v Backspaced characters remain visible on the screen in
2389 Insert mode. Without this flag the characters are
2390 erased from the screen right away. With this flag the
2391 screen newly typed text overwrites backspaced
2392 characters.
2393 *cpo-w*
2394 w When using "cw" on a blank character, only change one
2395 character and not all blanks until the start of the
2396 next word.
2397 *cpo-W*
2398 W Don't overwrite a readonly file. When omitted, ":w!"
2399 overwrites a readonly file, if possible.
2400 *cpo-x*
2401 x <Esc> on the command-line executes the command-line.
2402 The default in Vim is to abandon the command-line,
2403 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002404 *cpo-X*
2405 X When using a count with "R" the replaced text is
2406 deleted only once. Also when repeating "R" with "."
2407 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002408 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002409 y A yank command can be redone with ".". Think twice if
2410 you really want to use this, it may break some
2411 plugins, since most people expect "." to only repeat a
2412 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002413 *cpo-Z*
2414 Z When using "w!" while the 'readonly' option is set,
2415 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002416 *cpo-!*
2417 ! When redoing a filter command, use the last used
2418 external command, whatever it was. Otherwise the last
2419 used -filter- command is used.
2420 *cpo-$*
2421 $ When making a change to one line, don't redisplay the
2422 line, but put a '$' at the end of the changed text.
2423 The changed text will be overwritten when you type the
2424 new text. The line is redisplayed if you type any
2425 command that moves the cursor from the insertion
2426 point.
2427 *cpo-%*
2428 % Vi-compatible matching is done for the "%" command.
2429 Does not recognize "#if", "#endif", etc.
2430 Does not recognize "/*" and "*/".
2431 Parens inside single and double quotes are also
2432 counted, causing a string that contains a paren to
2433 disturb the matching. For example, in a line like
2434 "if (strcmp("foo(", s))" the first paren does not
2435 match the last one. When this flag is not included,
2436 parens inside single and double quotes are treated
2437 specially. When matching a paren outside of quotes,
2438 everything inside quotes is ignored. When matching a
2439 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002440 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002441 This flag is also used for other features, such as
2442 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002443 *cpo--*
2444 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002445 it would go above the first line or below the last
2446 line. Without it the cursor moves to the first or
2447 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002448 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002449 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002450 *cpo-+*
2451 + When included, a ":write file" command will reset the
2452 'modified' flag of the buffer, even though the buffer
2453 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002454 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455 * Use ":*" in the same way as ":@". When not included,
2456 ":*" is an alias for ":'<,'>", select the Visual area.
2457 *cpo-<*
2458 < Disable the recognition of special key codes in |<>|
2459 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002460 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002461 ":map X <Tab>" results in X being mapped to:
2462 '<' included: "<Tab>" (5 characters)
2463 '<' excluded: "^I" (^I is a real <Tab>)
2464 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002465 *cpo->*
2466 > When appending to a register, put a line break before
2467 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002468 *cpo-;*
2469 ; When using |,| or |;| to repeat the last |t| search
2470 and the cursor is right in front of the searched
2471 character, the cursor won't move. When not included,
2472 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002473 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002474
2475 POSIX flags. These are not included in the Vi default value, except
2476 when $VIM_POSIX was set on startup. |posix|
2477
2478 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002479 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002480 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002481 *cpo-&*
2482 & When ":preserve" was used keep the swap file when
2483 exiting normally while this buffer is still loaded.
2484 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002485 *cpo-\*
2486 \ Backslash in a [] range in a search pattern is taken
2487 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002488 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2489 '\' excluded: "/[ \-]" finds <Space> and '-'
2490 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002491 *cpo-/*
2492 / When "%" is used as the replacement string in a |:s|
2493 command, use the previous replacement string. |:s%|
2494 *cpo-{*
2495 { The |{| and |}| commands also stop at a "{" character
2496 at the start of a line.
2497 *cpo-.*
2498 . The ":chdir" and ":cd" commands fail if the current
2499 buffer is modified, unless ! is used. Vim doesn't
2500 need this, since it remembers the full path of an
2501 opened file.
2502 *cpo-bar*
2503 | The value of the $LINES and $COLUMNS environment
2504 variables overrule the terminal size values obtained
2505 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002506
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002508 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002509'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002510 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002511 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002512 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002513 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002514 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002515 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002516 blowfish Blowfish method. Medium strong encryption but it has
2517 an implementation flaw. Requires Vim 7.3 or later,
2518 files can NOT be read by Vim 7.2 and older. This adds
2519 a "seed" to the file, every time you write the file
2520 the encrypted bytes will be different.
2521 *blowfish2*
2522 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002523 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002524 and older. This adds a "seed" to the file, every time
2525 you write the file the encrypted bytes will be
2526 different. The whole undo file is encrypted, not just
2527 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002528 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002529 *E1197* *E1198* *E1199* *E1200* *E1201*
2530 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2531 Code. Medium strong till strong encryption.
2532 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002533 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002534 It adds a seed and a message authentication code (MAC)
2535 to the file. This needs at least a Vim 8.2.3022 to
2536 read the encrypted file.
2537 Encryption of swap files is not supported, therefore
2538 no swap file will be used when xchacha20 encryption is
2539 enabled.
2540 Encryption of undo files is not yet supported,
2541 therefore no undo file will currently be written.
2542 CURRENTLY EXPERIMENTAL: Files written with this method
2543 might have to be read back with the same version of
2544 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002545
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002546 You should use "blowfish2", also to re-encrypt older files.
2547
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002548 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002549 to the detected method of the file being read. Thus if you write it
2550 without changing 'cryptmethod' the same method will be used.
2551 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002552 explicitly write it, you don't get a warning unless there are other
2553 modifications. Also see |:X|.
2554
2555 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002556 the value "blowfish2". When setting the local value to an empty
2557 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002558
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002559 When a new encryption method is added in a later version of Vim, and
2560 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002561 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002562
2563
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 *'cscopepathcomp'* *'cspc'*
2565'cscopepathcomp' 'cspc' number (default 0)
2566 global
2567 {not available when compiled without the |+cscope|
2568 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569 Determines how many components of the path to show in a list of tags.
2570 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002571 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572
2573 *'cscopeprg'* *'csprg'*
2574'cscopeprg' 'csprg' string (default "cscope")
2575 global
2576 {not available when compiled without the |+cscope|
2577 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 Specifies the command to execute cscope. See |cscopeprg|.
2579 This option cannot be set from a |modeline| or in the |sandbox|, for
2580 security reasons.
2581
2582 *'cscopequickfix'* *'csqf'*
2583'cscopequickfix' 'csqf' string (default "")
2584 global
2585 {not available when compiled without the |+cscope|
2586 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002587 Specifies whether to use quickfix window to show cscope results.
2588 See |cscopequickfix|.
2589
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002590 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002591'cscoperelative' 'csre' boolean (default off)
2592 global
2593 {not available when compiled without the |+cscope|
2594 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002595 In the absence of a prefix (-P) for cscope. setting this option enables
2596 to use the basename of cscope.out path as the prefix.
2597 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002598 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002599
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2601'cscopetag' 'cst' boolean (default off)
2602 global
2603 {not available when compiled without the |+cscope|
2604 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605 Use cscope for tag commands. See |cscope-options|.
2606 NOTE: This option is reset when 'compatible' is set.
2607
2608 *'cscopetagorder'* *'csto'*
2609'cscopetagorder' 'csto' number (default 0)
2610 global
2611 {not available when compiled without the |+cscope|
2612 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002613 Determines the order in which ":cstag" performs a search. See
2614 |cscopetagorder|.
2615 NOTE: This option is set to 0 when 'compatible' is set.
2616
2617 *'cscopeverbose'* *'csverb'*
2618 *'nocscopeverbose'* *'nocsverb'*
2619'cscopeverbose' 'csverb' boolean (default off)
2620 global
2621 {not available when compiled without the |+cscope|
2622 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002623 Give messages when adding a cscope database. See |cscopeverbose|.
2624 NOTE: This option is reset when 'compatible' is set.
2625
Bram Moolenaar860cae12010-06-05 23:22:07 +02002626 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2627'cursorbind' 'crb' boolean (default off)
2628 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002629 When this option is set, as the cursor in the current
2630 window moves other cursorbound windows (windows that also have
2631 this option set) move their cursors to the corresponding line and
2632 column. This option is useful for viewing the
2633 differences between two versions of a file (see 'diff'); in diff mode,
2634 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002635 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002636
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002637
2638 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2639'cursorcolumn' 'cuc' boolean (default off)
2640 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002641 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002642 feature}
2643 Highlight the screen column of the cursor with CursorColumn
2644 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2645 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002646 If you only want the highlighting in the current window you can use
2647 these autocommands: >
2648 au WinLeave * set nocursorline nocursorcolumn
2649 au WinEnter * set cursorline cursorcolumn
2650<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002651
2652 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2653'cursorline' 'cul' boolean (default off)
2654 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002655 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002656 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002657 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2658 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002659 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002660 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002661
2662
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002663 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002664'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002665 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002666 {not available when compiled without the |+syntax|
2667 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002668 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002669 Valid values:
2670 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002671 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002672 "screenline" Highlight only the screen line of the cursor with
2673 CursorLine |hl-CursorLine|.
2674 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002675 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002676
2677 Special value:
2678 "both" Alias for the values "line,number".
2679
2680 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002681
2682
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 *'debug'*
2684'debug' string (default "")
2685 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002686 These values can be used:
2687 msg Error messages that would otherwise be omitted will be given
2688 anyway.
2689 throw Error messages that would otherwise be omitted will be given
2690 anyway and also throw an exception and set |v:errmsg|.
2691 beep A message will be given when otherwise only a beep would be
2692 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002693 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002694 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2695 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696
2697 *'define'* *'def'*
2698'define' 'def' string (default "^\s*#\s*define")
2699 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002700 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 pattern, just like for the "/" command. This option is used for the
2702 commands like "[i" and "[d" |include-search|. The 'isident' option is
2703 used to recognize the defined name after the match:
2704 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2705 See |option-backslash| about inserting backslashes to include a space
2706 or backslash.
2707 The default value is for C programs. For C++ this value would be
2708 useful, to include const type declarations: >
2709 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002710< You can also use "\ze" just before the name and continue the pattern
2711 to check what is following. E.g. for Javascript, if a function is
2712 defined with "func_name = function(args)": >
2713 ^\s*\ze\i\+\s*=\s*function(
2714< If the function is defined with "func_name : function() {...": >
2715 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002717 To avoid that use `:let` with a single quote string: >
2718 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002719<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720
2721 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2722'delcombine' 'deco' boolean (default off)
2723 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 If editing Unicode and this option is set, backspace and Normal mode
2725 "x" delete each combining character on its own. When it is off (the
2726 default) the character along with its combining characters are
2727 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002728 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002729
2730 This is useful for Arabic, Hebrew and many other languages where one
2731 may have combining characters overtop of base characters, and want
2732 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002733 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002734
2735 *'dictionary'* *'dict'*
2736'dictionary' 'dict' string (default "")
2737 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738 List of file names, separated by commas, that are used to lookup words
2739 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2740 contain a list of words. This can be one word per line, or several
2741 words per line, separated by non-keyword characters (white space is
2742 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002743
2744 When this option is empty or an entry "spell" is present, and spell
2745 checking is enabled, words in the word lists for the currently active
2746 'spelllang' are used. See |spell|.
2747
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002748 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 after a comma are ignored, otherwise spaces are included in the file
2750 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002751 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 Where to find a list of words?
2753 - On FreeBSD, there is the file "/usr/share/dict/words".
2754 - In the Simtel archive, look in the "msdos/linguist" directory.
2755 - In "miscfiles" of the GNU collection.
2756 The use of |:set+=| and |:set-=| is preferred when adding or removing
2757 directories from the list. This avoids problems when a future version
2758 uses another default.
2759 Backticks cannot be used in this option for security reasons.
2760
2761 *'diff'* *'nodiff'*
2762'diff' boolean (default off)
2763 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002764 {not available when compiled without the |+diff|
2765 feature}
2766 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002767 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768
2769 *'dex'* *'diffexpr'*
2770'diffexpr' 'dex' string (default "")
2771 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 {not available when compiled without the |+diff|
2773 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002774 Expression which is evaluated to obtain a diff file (either ed-style
2775 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776 This option cannot be set from a |modeline| or in the |sandbox|, for
2777 security reasons.
2778
2779 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002780'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782 {not available when compiled without the |+diff|
2783 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002784 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785 All are optional. Items must be separated by a comma.
2786
2787 filler Show filler lines, to keep the text
2788 synchronized with a window that has inserted
2789 lines at the same position. Mostly useful
2790 when windows are side-by-side and 'scrollbind'
2791 is set.
2792
2793 context:{n} Use a context of {n} lines between a change
2794 and a fold that contains unchanged lines.
2795 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002796 When using zero the context is actually one,
2797 since folds require a line in between, also
2798 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799 See |fold-diff|.
2800
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002801 iblank Ignore changes where lines are all blank. Adds
2802 the "-B" flag to the "diff" command if
2803 'diffexpr' is empty. Check the documentation
2804 of the "diff" command for what this does
2805 exactly.
2806 NOTE: the diff windows will get out of sync,
2807 because no differences between blank lines are
2808 taken into account.
2809
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810 icase Ignore changes in case of text. "a" and "A"
2811 are considered the same. Adds the "-i" flag
2812 to the "diff" command if 'diffexpr' is empty.
2813
2814 iwhite Ignore changes in amount of white space. Adds
2815 the "-b" flag to the "diff" command if
2816 'diffexpr' is empty. Check the documentation
2817 of the "diff" command for what this does
2818 exactly. It should ignore adding trailing
2819 white space, but not leading white space.
2820
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002821 iwhiteall Ignore all white space changes. Adds
2822 the "-w" flag to the "diff" command if
2823 'diffexpr' is empty. Check the documentation
2824 of the "diff" command for what this does
2825 exactly.
2826
2827 iwhiteeol Ignore white space changes at end of line.
2828 Adds the "-Z" flag to the "diff" command if
2829 'diffexpr' is empty. Check the documentation
2830 of the "diff" command for what this does
2831 exactly.
2832
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002833 horizontal Start diff mode with horizontal splits (unless
2834 explicitly specified otherwise).
2835
2836 vertical Start diff mode with vertical splits (unless
2837 explicitly specified otherwise).
2838
Bram Moolenaarc8234772019-11-10 21:00:27 +01002839 closeoff When a window is closed where 'diff' is set
2840 and there is only one window remaining in the
2841 same tab page with 'diff' set, execute
2842 `:diffoff` in that window. This undoes a
2843 `:diffsplit` command.
2844
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002845 hiddenoff Do not use diff mode for a buffer when it
2846 becomes hidden.
2847
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002848 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2849 starting diff mode. Without this 2 is used.
2850
Bram Moolenaar4223d432021-02-10 13:18:17 +01002851 followwrap Follow the 'wrap' option and leave as it is.
2852
Bram Moolenaare828b762018-09-10 17:51:58 +02002853 internal Use the internal diff library. This is
2854 ignored when 'diffexpr' is set. *E960*
2855 When running out of memory when writing a
2856 buffer this item will be ignored for diffs
2857 involving that buffer. Set the 'verbose'
2858 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859
Bram Moolenaare828b762018-09-10 17:51:58 +02002860 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002861 Use the indent heuristic for the internal
2862 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002863
2864 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002865 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002866 algorithms are:
2867 myers the default algorithm
2868 minimal spend extra time to generate the
2869 smallest possible diff
2870 patience patience diff algorithm
2871 histogram histogram diff algorithm
2872
2873 Examples: >
2874 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002876 :set diffopt=internal,filler,foldcolumn:3
2877 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878<
2879 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2880'digraph' 'dg' boolean (default off)
2881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 {not available when compiled without the |+digraphs|
2883 feature}
2884 Enable the entering of digraphs in Insert mode with {char1} <BS>
2885 {char2}. See |digraphs|.
2886 NOTE: This option is reset when 'compatible' is set.
2887
2888 *'directory'* *'dir'*
2889'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002890 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 for Unix: ".,~/tmp,/var/tmp,/tmp")
2892 global
2893 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002894 Recommended value: ".,~/vimswap//" - this will put the swap file next
2895 to the edited file if possible, and in your personal swap directory
2896 otherwise. Make sure "~/vimswap//" is only readable for you.
2897
2898 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899 - The swap file will be created in the first directory where this is
2900 possible.
2901 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002902 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903 - A directory "." means to put the swap file in the same directory as
2904 the edited file. On Unix, a dot is prepended to the file name, so
2905 it doesn't show in a directory listing. On MS-Windows the "hidden"
2906 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002907 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2908 the swap file relative to where the edited file is. The leading "."
2909 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002910 - For Unix and Win32, if a directory ends in two path separators "//",
2911 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002912 with all path separators replaced by percent '%' signs (including
2913 the colon following the drive letter on Win32). This will ensure
2914 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002915 On Win32, it is also possible to end with "\\". However, When a
2916 separating comma is following, you must use "//", since "\\" will
2917 include the comma in the file name. Therefore it is recommended to
2918 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 - Spaces after the comma are ignored, other spaces are considered part
2920 of the directory name. To have a space at the start of a directory
2921 name, precede it with a backslash.
2922 - To include a comma in a directory name precede it with a backslash.
2923 - A directory name may end in an ':' or '/'.
2924 - Environment variables are expanded |:set_env|.
2925 - Careful with '\' characters, type one before a space, type two to
2926 get one in the option (see |option-backslash|), for example: >
2927 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2928< - For backwards compatibility with Vim version 3.0 a '>' at the start
2929 of the option is removed.
2930 Using "." first in the list is recommended. This means that editing
2931 the same file twice will result in a warning. Using "/tmp" on Unix is
2932 discouraged: When the system crashes you lose the swap file.
2933 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002934 choice than "/tmp". But others on the computer may be able to see the
2935 files, and it can contain a lot of files, your swap files get lost in
2936 the crowd. That is why a "tmp" directory in your home directory is
2937 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002938 The use of |:set+=| and |:set-=| is preferred when adding or removing
2939 directories from the list. This avoids problems when a future version
2940 uses another default.
2941 This option cannot be set from a |modeline| or in the |sandbox|, for
2942 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943
2944 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002945'display' 'dy' string (default "", set to "truncate" in
2946 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002948 Change the way text is displayed. This is comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949 flags:
2950 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002951 in a window will be displayed. "@@@" is put in the
2952 last columns of the last screen line to indicate the
2953 rest of the line is not displayed.
2954 truncate Like "lastline", but "@@@" is displayed in the first
2955 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 uhex Show unprintable characters hexadecimal as <xx>
2957 instead of using ^C and ~C.
2958
Bram Moolenaard0796902016-09-16 20:02:31 +02002959 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002960 doesn't fit is replaced with "@" lines.
2961
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 *'eadirection'* *'ead'*
2963'eadirection' 'ead' string (default "both")
2964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 Tells when the 'equalalways' option applies:
2966 ver vertically, width of windows is not affected
2967 hor horizontally, height of windows is not affected
2968 both width and height of windows is affected
2969
2970 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2971'edcompatible' 'ed' boolean (default off)
2972 global
2973 Makes the 'g' and 'c' flags of the ":substitute" command to be
2974 toggled each time the flag is given. See |complex-change|. See
2975 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002976 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002977 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978
Bram Moolenaar03413f42016-04-12 21:07:15 +02002979 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002980'emoji' 'emo' boolean (default: on)
2981 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002982 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002983 This excludes "text emoji" characters, which are normally displayed as
2984 single width. Unfortunately there is no good specification for this
2985 and it has been determined on trial-and-error basis. Use the
2986 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002987
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002989'encoding' 'enc' string (default for MS-Windows: "utf-8",
2990 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 Sets the character encoding used inside Vim. It applies to text in
2993 the buffers, registers, Strings in expressions, text stored in the
2994 viminfo file, etc. It sets the kind of characters which Vim can work
2995 with. See |encoding-names| for the possible values.
2996
2997 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002998 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003000 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001
Bram Moolenaar865242e2010-07-14 21:12:05 +02003002 This option cannot be set from a |modeline|. It would most likely
3003 corrupt the text.
3004
Bram Moolenaar3df01732017-02-17 22:47:16 +01003005 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3006 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 'encoding', "utf-8" is the natural choice for the environment and
3008 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003009 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010 versions, and to avoid changing the encoding of newly created files
3011 without your knowledge (in case 'fileencodings' is empty).
3012
3013 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003014 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 iconv() or as specified with 'charconvert'.
3016
Bram Moolenaar207f0092020-08-30 17:20:20 +02003017 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003018 can use: >
3019 if has("multi_byte_encoding")
3020<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 Normally 'encoding' will be equal to your current locale. This will
3022 be the default if Vim recognizes your environment settings. If
3023 'encoding' is not set to the current locale, 'termencoding' must be
3024 set to convert typed and displayed text. See |encoding-table|.
3025
3026 When you set this option, it fires the |EncodingChanged| autocommand
3027 event so that you can set up fonts if necessary.
3028
3029 When the option is set, the value is converted to lowercase. Thus
3030 you can set it with uppercase values too. Underscores are translated
3031 to '-' signs.
3032 When the encoding is recognized, it is changed to the standard name.
3033 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3034 "iso-8859-2" and "utf8" becomes "utf-8".
3035
3036 Note: "latin1" is also used when the encoding could not be detected.
3037 This only works when editing files in the same encoding! When the
3038 actual character set is not latin1, make sure 'fileencoding' and
3039 'fileencodings' are empty. When conversion is needed, switch to using
3040 utf-8.
3041
3042 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3043 You don't notice this while editing, but it does matter for the
3044 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3045 setting 'encoding' to one of these values instead of utf-8 only has
3046 effect for encoding used for files when 'fileencoding' is empty.
3047
Bram Moolenaar661b1822005-07-28 22:36:45 +00003048 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3049 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050
3051 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3052'endofline' 'eol' boolean (default on)
3053 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003055 is on, or 'fixeol' option is off, no <EOL> will be written for the
3056 last line in the file. This option is automatically set or reset when
3057 starting to edit a new file, depending on whether file has an <EOL>
3058 for the last line in the file. Normally you don't have to set or
3059 reset this option.
3060 When 'binary' is off and 'fixeol' is on the value is not used when
3061 writing the file. When 'binary' is on or 'fixeol' is off it is used
3062 to remember the presence of a <EOL> for the last line in the file, so
3063 that when you write the file the situation from the original file can
3064 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003065
3066 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3067'equalalways' 'ea' boolean (default on)
3068 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003070 splitting or closing a window. This also happens the moment the
3071 option is switched on. When off, splitting a window will reduce the
3072 size of the current window and leave the other windows the same. When
3073 closing a window the extra lines are given to the window next to it
3074 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 When mixing vertically and horizontally split windows, a minimal size
3076 is computed and some windows may be larger if there is room. The
3077 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003078 Changing the height and width of a window can be avoided by setting
3079 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003080 If a window size is specified when creating a new window sizes are
3081 currently not equalized (it's complicated, but may be implemented in
3082 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083
3084 *'equalprg'* *'ep'*
3085'equalprg' 'ep' string (default "")
3086 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003088 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003089 or 'indentexpr'. When Vim was compiled without internal formatting,
3090 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003091 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003092 about including spaces and backslashes.
3093 This option cannot be set from a |modeline| or in the |sandbox|, for
3094 security reasons.
3095
3096 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3097'errorbells' 'eb' boolean (default off)
3098 global
3099 Ring the bell (beep or screen flash) for error messages. This only
3100 makes a difference for error messages, the bell will be used always
3101 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003102 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003103 screen flash or do nothing. See 'belloff' to finetune when to ring the
3104 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105
3106 *'errorfile'* *'ef'*
3107'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3108 others: "errors.err")
3109 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 {not available when compiled without the |+quickfix|
3111 feature}
3112 Name of the errorfile for the QuickFix mode (see |:cf|).
3113 When the "-q" command-line argument is used, 'errorfile' is set to the
3114 following argument. See |-q|.
3115 NOT used for the ":make" command. See 'makeef' for that.
3116 Environment variables are expanded |:set_env|.
3117 See |option-backslash| about including spaces and backslashes.
3118 This option cannot be set from a |modeline| or in the |sandbox|, for
3119 security reasons.
3120
3121 *'errorformat'* *'efm'*
3122'errorformat' 'efm' string (default is very long)
3123 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124 {not available when compiled without the |+quickfix|
3125 feature}
3126 Scanf-like description of the format for the lines in the error file
3127 (see |errorformat|).
3128
3129 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3130'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3131 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132 Function keys that start with an <Esc> are recognized in Insert
3133 mode. When this option is off, the cursor and function keys cannot be
3134 used in Insert mode if they start with an <Esc>. The advantage of
3135 this is that the single <Esc> is recognized immediately, instead of
3136 after one second. Instead of resetting this option, you might want to
3137 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3138 when 'esckeys' is off, you can still map anything, but the cursor keys
3139 won't work by default.
3140 NOTE: This option is set to the Vi default value when 'compatible' is
3141 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003142 NOTE: when this option is off then the |modifyOtherKeys| functionality
3143 is disabled while in Insert mode to avoid ending Insert mode with any
3144 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145
3146 *'eventignore'* *'ei'*
3147'eventignore' 'ei' string (default "")
3148 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003150 When set to "all" or when "all" is one of the items, all autocommand
3151 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003152 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 :set ei=WinEnter,WinLeave
3154<
3155 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3156'expandtab' 'et' boolean (default off)
3157 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003159 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3161 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003162 This option is reset when the 'paste' option is set and restored when
3163 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 NOTE: This option is reset when 'compatible' is set.
3165
3166 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3167'exrc' 'ex' boolean (default off)
3168 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003170 directory.
3171
3172 Setting this option is a potential security leak. E.g., consider
3173 unpacking a package or fetching files from github, a .vimrc in there
3174 might be a trojan horse. BETTER NOT SET THIS OPTION!
3175 Instead, define an autocommand in your .vimrc to set options for a
3176 matching directory.
3177
3178 If you do switch this option on you should also consider setting the
3179 'secure' option (see |initialization|).
3180 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 This option cannot be set from a |modeline| or in the |sandbox|, for
3182 security reasons.
3183
3184 *'fileencoding'* *'fenc'* *E213*
3185'fileencoding' 'fenc' string (default: "")
3186 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003188
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003190 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 When 'fileencoding' is empty, the same value as 'encoding' will be
3192 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003193 No error will be given when the value is set, only when it is used,
3194 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003195 Conversion will also be done when 'encoding' and 'fileencoding' are
3196 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3197 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003199 'encoding' is "utf-8" or another Unicode encoding, conversion
3200 is most likely done in a way that the reverse conversion
3201 results in the same text. When 'encoding' is not "utf-8" some
3202 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003203
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 See 'encoding' for the possible values. Additionally, values may be
3205 specified that can be handled by the converter, see
3206 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003207
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 When reading a file 'fileencoding' will be set from 'fileencodings'.
3209 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003210 'fileencoding', use the |++enc| argument. One exception: when
3211 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003212 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003213
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3215 When the option is set, the value is converted to lowercase. Thus
3216 you can set it with uppercase values too. '_' characters are
3217 replaced with '-'. If a name is recognized from the list for
3218 'encoding', it is replaced by the standard name. For example
3219 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003220
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 When this option is set, after starting to edit a file, the 'modified'
3222 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003223
3224 Keep in mind that changing 'fenc' from a modeline happens
3225 AFTER the text has been read, thus it applies to when the file will be
3226 written. If you do set 'fenc' in a modeline, you might want to set
3227 'nomodified' to avoid not being able to ":q".
3228
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 This option can not be changed when 'modifiable' is off.
3230
3231 *'fe'*
3232 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003233 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 old short name was 'fe', which is no longer used.
3235
3236 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003237'fileencodings' 'fencs' string (default: "ucs-bom",
3238 "ucs-bom,utf-8,default,latin1" when
3239 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 This is a list of character encodings considered when starting to edit
3242 an existing file. When a file is read, Vim tries to use the first
3243 mentioned character encoding. If an error is detected, the next one
3244 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003245 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 an empty string, which means the value of 'encoding' is used.
3247 WARNING: Conversion can cause loss of information! When
3248 'encoding' is "utf-8" (or one of the other Unicode variants)
3249 conversion is most likely done in a way that the reverse
3250 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003251 "utf-8" some non-ASCII characters may be lost! You can use
3252 the |++bad| argument to specify what is done with characters
3253 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254 For an empty file or a file with only ASCII characters most encodings
3255 will work and the first entry of 'fileencodings' will be used (except
3256 "ucs-bom", which requires the BOM to be present). If you prefer
3257 another encoding use an BufReadPost autocommand event to test if your
3258 preferred encoding is to be used. Example: >
3259 au BufReadPost * if search('\S', 'w') == 0 |
3260 \ set fenc=iso-2022-jp | endif
3261< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3262 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003263 When the |++enc| argument is used then the value of 'fileencodings' is
3264 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003265 Note that 'fileencodings' is not used for a new file, the global value
3266 of 'fileencoding' is used instead. You can set it with: >
3267 :setglobal fenc=iso-8859-2
3268< This means that a non-existing file may get a different encoding than
3269 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 The special value "ucs-bom" can be used to check for a Unicode BOM
3271 (Byte Order Mark) at the start of the file. It must not be preceded
3272 by "utf-8" or another Unicode encoding for this to work properly.
3273 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3274 because Vim cannot detect an error, thus the encoding is always
3275 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003276 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003277 environment. On MS-Windows this is the system encoding. Otherwise
3278 this is the default value for 'encoding'. It is useful when
3279 'encoding' is set to "utf-8" and your environment uses a non-latin1
3280 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003281 When 'encoding' is "utf-8" and a file contains an illegal byte
3282 sequence it won't be recognized as UTF-8. You can use the |8g8|
3283 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 WRONG VALUES: WHAT'S WRONG:
3285 latin1,utf-8 "latin1" will always be used
3286 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3287 file
3288 cp1250,latin1 "cp1250" will always be used
3289 If 'fileencodings' is empty, 'fileencoding' is not modified.
3290 See 'fileencoding' for the possible values.
3291 Setting this option does not have an effect until the next time a file
3292 is read.
3293
3294 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003295'fileformat' 'ff' string (MS-Windows default: "dos",
3296 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 This gives the <EOL> of the current buffer, which is used for
3299 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003300 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 unix <NL>
3302 mac <CR>
3303 When "dos" is used, CTRL-Z at the end of a file is ignored.
3304 See |file-formats| and |file-read|.
3305 For the character encoding of the file see 'fileencoding'.
3306 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003307 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 This option is set automatically when starting to edit a file and
3309 'fileformats' is not empty and 'binary' is off.
3310 When this option is set, after starting to edit a file, the 'modified'
3311 option is set, because the file would be different when written.
3312 This option can not be changed when 'modifiable' is off.
3313 For backwards compatibility: When this option is set to "dos",
3314 'textmode' is set, otherwise 'textmode' is reset.
3315
3316 *'fileformats'* *'ffs'*
3317'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003318 Vim+Vi MS-Windows: "dos,unix",
3319 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 Vi Cygwin: "unix,dos",
3321 Vi others: "")
3322 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323 This gives the end-of-line (<EOL>) formats that will be tried when
3324 starting to edit a new buffer and when reading a file into an existing
3325 buffer:
3326 - When empty, the format defined with 'fileformat' will be used
3327 always. It is not set automatically.
3328 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003329 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 'fileformats' name will be used when a file is read into an existing
3331 buffer, no matter what 'fileformat' for that buffer is set to.
3332 - When more than one name is present, separated by commas, automatic
3333 <EOL> detection will be done when reading a file. When starting to
3334 edit a file, a check is done for the <EOL>:
3335 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3336 'fileformat' is set to "dos".
3337 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003338 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003340 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3341 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003342 This means that "mac" is only chosen when:
3343 "unix" is not present or no <NL> is found in the file, and
3344 "dos" is not present or no <CR><NL> is found in the file.
3345 Except: if "unix" was chosen, but there is a <CR> before
3346 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003347 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348 4. If 'fileformat' is still not set, the first name from
3349 'fileformats' is used.
3350 When reading a file into an existing buffer, the same is done, but
3351 this happens like 'fileformat' has been set appropriately for that
3352 file only, the option is not changed.
3353 When 'binary' is set, the value of 'fileformats' is not used.
3354
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003355 When Vim starts up with an empty buffer the first item is used. You
3356 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003357
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3359 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3360 done:
3361 - When 'fileformats' is empty, there is no automatic detection. Dos
3362 format will be used.
3363 - When 'fileformats' is set to one or more names, automatic detection
3364 is done. This is based on the first <NL> in the file: If there is a
3365 <CR> in front of it, Dos format is used, otherwise Unix format is
3366 used.
3367 Also see |file-formats|.
3368 For backwards compatibility: When this option is set to an empty
3369 string or one format (no comma is included), 'textauto' is reset,
3370 otherwise 'textauto' is set.
3371 NOTE: This option is set to the Vi default value when 'compatible' is
3372 set and to the Vim default value when 'compatible' is reset.
3373
Bram Moolenaarbf884932013-04-05 22:26:15 +02003374 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3375'fileignorecase' 'fic' boolean (default on for systems where case in file
3376 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003377 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003378 When set case is ignored when using file names and directories.
3379 See 'wildignorecase' for only ignoring case when doing completion.
3380
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 *'filetype'* *'ft'*
3382'filetype' 'ft' string (default: "")
3383 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 When this option is set, the FileType autocommand event is triggered.
3385 All autocommands that match with the value of this option will be
3386 executed. Thus the value of 'filetype' is used in place of the file
3387 name.
3388 Otherwise this option does not always reflect the current file type.
3389 This option is normally set when the file type is detected. To enable
3390 this use the ":filetype on" command. |:filetype|
3391 Setting this option to a different value is most useful in a modeline,
3392 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003393 Example, for in an IDL file:
3394 /* vim: set filetype=idl : */ ~
3395 |FileType| |filetypes|
3396 When a dot appears in the value then this separates two filetype
3397 names. Example:
3398 /* vim: set filetype=c.doxygen : */ ~
3399 This will use the "c" filetype first, then the "doxygen" filetype.
3400 This works both for filetype plugins and for syntax files. More than
3401 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 This option is not copied to another buffer, independent of the 's' or
3403 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003404 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405
3406 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003407'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003408 global or local to window |global-local|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003409 {not available when compiled without the |+folding|
3410 feature}
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003411 Characters to fill the statuslines, vertical separators and special
3412 lines in the window.
3413 It is a comma-separated list of items. Each item has a name, a colon
3414 and the value of that item:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003416 item name default Used for ~
3417 stl ' ' or '^' statusline of the current window
3418 stlnc ' ' or '=' statusline of the non-current windows
3419 vert '|' vertical separators |:vsplit|
3420 fold '-' filling 'foldtext'
3421 foldopen '-' mark the beginning of a fold
3422 foldclose '+' show a closed fold
3423 foldsep '|' open fold middle character
3424 diff '-' deleted lines of the 'diff' option
3425 eob '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003427 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003428 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 otherwise.
3430
3431 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003432 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433< This is similar to the default, except that these characters will also
3434 be used when there is highlighting.
3435
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003436 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3437 single-byte and multibyte characters are supported. But double-width
3438 characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003439
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003441 item name highlight group ~
3442 stl StatusLine |hl-StatusLine|
3443 stlnc StatusLineNC |hl-StatusLineNC|
3444 vert VertSplit |hl-VertSplit|
3445 fold Folded |hl-Folded|
3446 diff DiffDelete |hl-DiffDelete|
3447 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003449 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3450'fixendofline' 'fixeol' boolean (default on)
3451 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003452 When writing a file and this option is on, <EOL> at the end of file
3453 will be restored if missing. Turn this option off if you want to
3454 preserve the situation from the original file.
3455 When the 'binary' option is set the value of this option doesn't
3456 matter.
3457 See the 'endofline' option.
3458
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003460'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462 {only available when compiled with the |+rightleft|
3463 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003464 This option was for using Farsi, which has been removed. See
3465 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466
3467 *'foldclose'* *'fcl'*
3468'foldclose' 'fcl' string (default "")
3469 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470 {not available when compiled without the |+folding|
3471 feature}
3472 When set to "all", a fold is closed when the cursor isn't in it and
3473 its level is higher than 'foldlevel'. Useful if you want folds to
3474 automatically close when moving out of them.
3475
3476 *'foldcolumn'* *'fdc'*
3477'foldcolumn' 'fdc' number (default 0)
3478 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 {not available when compiled without the |+folding|
3480 feature}
3481 When non-zero, a column with the specified width is shown at the side
3482 of the window which indicates open and closed folds. The maximum
3483 value is 12.
3484 See |folding|.
3485
3486 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3487'foldenable' 'fen' boolean (default on)
3488 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 {not available when compiled without the |+folding|
3490 feature}
3491 When off, all folds are open. This option can be used to quickly
3492 switch between showing all text unfolded and viewing the text with
3493 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003494 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 'foldenable' is off.
3496 This option is set by commands that create a new fold or close a fold.
3497 See |folding|.
3498
3499 *'foldexpr'* *'fde'*
3500'foldexpr' 'fde' string (default: "0")
3501 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003503 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003505 for each line to obtain its fold level. The context is set to the
3506 script where 'foldexpr' was set, script-local items can be accessed.
3507 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003508
Bram Moolenaar30b65812012-07-12 22:01:11 +02003509 The expression will be evaluated in the |sandbox| if set from a
3510 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003511 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003512 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003513
3514 It is not allowed to change text or jump to another window while
3515 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516
3517 *'foldignore'* *'fdi'*
3518'foldignore' 'fdi' string (default: "#")
3519 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 {not available when compiled without the |+folding|
3521 feature}
3522 Used only when 'foldmethod' is "indent". Lines starting with
3523 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003524 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 The default "#" works well for C programs. See |fold-indent|.
3526
3527 *'foldlevel'* *'fdl'*
3528'foldlevel' 'fdl' number (default: 0)
3529 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 {not available when compiled without the |+folding|
3531 feature}
3532 Sets the fold level: Folds with a higher level will be closed.
3533 Setting this option to zero will close all folds. Higher numbers will
3534 close fewer folds.
3535 This option is set by commands like |zm|, |zM| and |zR|.
3536 See |fold-foldlevel|.
3537
3538 *'foldlevelstart'* *'fdls'*
3539'foldlevelstart' 'fdls' number (default: -1)
3540 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 {not available when compiled without the |+folding|
3542 feature}
3543 Sets 'foldlevel' when starting to edit another buffer in a window.
3544 Useful to always start editing with all folds closed (value zero),
3545 some folds closed (one) or no folds closed (99).
3546 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003547 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 ignores this option and closes all folds.
3549 It is also done before BufReadPre autocommands, to allow an autocmd to
3550 overrule the 'foldlevel' value for specific files.
3551 When the value is negative, it is not used.
3552
3553 *'foldmarker'* *'fmr'* *E536*
3554'foldmarker' 'fmr' string (default: "{{{,}}}")
3555 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556 {not available when compiled without the |+folding|
3557 feature}
3558 The start and end marker used when 'foldmethod' is "marker". There
3559 must be one comma, which separates the start and end marker. The
3560 marker is a literal string (a regular expression would be too slow).
3561 See |fold-marker|.
3562
3563 *'foldmethod'* *'fdm'*
3564'foldmethod' 'fdm' string (default: "manual")
3565 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 {not available when compiled without the |+folding|
3567 feature}
3568 The kind of folding used for the current window. Possible values:
3569 |fold-manual| manual Folds are created manually.
3570 |fold-indent| indent Lines with equal indent form a fold.
3571 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3572 |fold-marker| marker Markers are used to specify folds.
3573 |fold-syntax| syntax Syntax highlighting items specify folds.
3574 |fold-diff| diff Fold text that is not changed.
3575
3576 *'foldminlines'* *'fml'*
3577'foldminlines' 'fml' number (default: 1)
3578 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579 {not available when compiled without the |+folding|
3580 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003581 Sets the number of screen lines above which a fold can be displayed
3582 closed. Also for manually closed folds. With the default value of
3583 one a fold can only be closed if it takes up two or more screen lines.
3584 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003585 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 "zc" to close a fold, which is displayed open because it's smaller
3587 than 'foldminlines', a following "zc" may close a containing fold.
3588
3589 *'foldnestmax'* *'fdn'*
3590'foldnestmax' 'fdn' number (default: 20)
3591 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 {not available when compiled without the |+folding|
3593 feature}
3594 Sets the maximum nesting of folds for the "indent" and "syntax"
3595 methods. This avoids that too many folds will be created. Using more
3596 than 20 doesn't work, because the internal limit is 20.
3597
3598 *'foldopen'* *'fdo'*
3599'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3600 search,tag,undo")
3601 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602 {not available when compiled without the |+folding|
3603 feature}
3604 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003605 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003607 NOTE: When the command is part of a mapping this option is not used.
3608 Add the |zv| command to the mapping to get the same effect.
3609 (rationale: the mapping may want to control opening folds itself)
3610
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 item commands ~
3612 all any
3613 block "(", "{", "[[", "[{", etc.
3614 hor horizontal movements: "l", "w", "fx", etc.
3615 insert any command in Insert mode
3616 jump far jumps: "G", "gg", etc.
3617 mark jumping to a mark: "'m", CTRL-O, etc.
3618 percent "%"
3619 quickfix ":cn", ":crew", ":make", etc.
3620 search search for a pattern: "/", "n", "*", "gd", etc.
3621 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003622 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003623 tag jumping to a tag: ":ta", CTRL-T, etc.
3624 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 When a movement command is used for an operator (e.g., "dl" or "y%")
3626 this option is not used. This means the operator will include the
3627 whole closed fold.
3628 Note that vertical movements are not here, because it would make it
3629 very difficult to move onto a closed fold.
3630 In insert mode the folds containing the cursor will always be open
3631 when text is inserted.
3632 To close folds you can re-apply 'foldlevel' with the |zx| command or
3633 set the 'foldclose' option to "all".
3634
3635 *'foldtext'* *'fdt'*
3636'foldtext' 'fdt' string (default: "foldtext()")
3637 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 {not available when compiled without the |+folding|
3639 feature}
3640 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003641 fold. The context is set to the script where 'foldexpr' was set,
3642 script-local items can be accessed. See |fold-foldtext| for the
3643 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644
Bram Moolenaar30b65812012-07-12 22:01:11 +02003645 The expression will be evaluated in the |sandbox| if set from a
3646 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003647 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003648
3649 It is not allowed to change text or jump to another window while
3650 evaluating 'foldtext' |textlock|.
3651
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003652 *'formatexpr'* *'fex'*
3653'formatexpr' 'fex' string (default "")
3654 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003655 {not available when compiled without the |+eval|
3656 feature}
3657 Expression which is evaluated to format a range of lines for the |gq|
3658 operator or automatic formatting (see 'formatoptions'). When this
3659 option is empty 'formatprg' is used.
3660
3661 The |v:lnum| variable holds the first line to be formatted.
3662 The |v:count| variable holds the number of lines to be formatted.
3663 The |v:char| variable holds the character that is going to be
3664 inserted if the expression is being evaluated due to
3665 automatic formatting. This can be empty. Don't insert
3666 it yet!
3667
3668 Example: >
3669 :set formatexpr=mylang#Format()
3670< This will invoke the mylang#Format() function in the
3671 autoload/mylang.vim file in 'runtimepath'. |autoload|
3672
3673 The expression is also evaluated when 'textwidth' is set and adding
3674 text beyond that limit. This happens under the same conditions as
3675 when internal formatting is used. Make sure the cursor is kept in the
3676 same spot relative to the text then! The |mode()| function will
3677 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003678
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003679 When the expression evaluates to non-zero Vim will fall back to using
3680 the internal format mechanism.
3681
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003682 If the expression starts with s: or |<SID>|, then it is replaced with
3683 the script ID (|local-function|). Example: >
3684 set formatexpr=s:MyFormatExpr()
3685 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003686< Otherwise, the expression is evaluated in the context of the script
3687 where the option was set, thus script-local items are available.
3688
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003689 The expression will be evaluated in the |sandbox| when set from a
3690 modeline, see |sandbox-option|. That stops the option from working,
3691 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003692 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003693 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003694
Bram Moolenaar86b68352004-12-27 21:59:20 +00003695 *'formatlistpat'* *'flp'*
3696'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3697 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003698 A pattern that is used to recognize a list header. This is used for
3699 the "n" flag in 'formatoptions'.
3700 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003701 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003702 while still checking more characters. There must be a character
3703 following the pattern, when it matches the whole line it is handled
3704 like there is no match.
3705 The default recognizes a number, followed by an optional punctuation
3706 character and white space.
3707
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003708 *'formatoptions'* *'fo'*
3709'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3710 local to buffer
3711 This is a sequence of letters which describes how automatic
3712 formatting is to be done. See |fo-table|. When the 'paste' option is
3713 on, no formatting is done (like 'formatoptions' is empty). Commas can
3714 be inserted for readability.
3715 To avoid problems with flags that are added in the future, use the
3716 "+=" and "-=" feature of ":set" |add-option-flags|.
3717 NOTE: This option is set to the Vi default value when 'compatible' is
3718 set and to the Vim default value when 'compatible' is reset.
3719
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 *'formatprg'* *'fp'*
3721'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003722 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003724 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003726 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003727 If the 'formatexpr' option is not empty it will be used instead.
3728 Otherwise, if 'formatprg' option is an empty string, the internal
3729 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003730 Environment variables are expanded |:set_env|. See |option-backslash|
3731 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003732 This option cannot be set from a |modeline| or in the |sandbox|, for
3733 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734
Bram Moolenaard94464e2015-11-02 15:28:18 +01003735 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003736'fsync' 'fs' boolean (default on)
3737 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003738 When on, the library function fsync() will be called after writing a
3739 file. This will flush a file to disk, ensuring that it is safely
3740 written even on filesystems which do metadata-only journaling. This
3741 will force the harddrive to spin up on Linux systems running in laptop
3742 mode, so it may be undesirable in some situations. Be warned that
3743 turning this off increases the chances of data loss after a crash. On
3744 systems without an fsync() implementation, this variable is always
3745 off.
3746 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003747 'fsync' also applies to |writefile()| (unless a flag is used to
3748 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003749 This option cannot be set from a |modeline| or in the |sandbox|, for
3750 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003751
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3753'gdefault' 'gd' boolean (default off)
3754 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 When on, the ":substitute" flag 'g' is default on. This means that
3756 all matches in a line are substituted instead of one. When a 'g' flag
3757 is given to a ":substitute" command, this will toggle the substitution
3758 of all or one match. See |complex-change|.
3759
3760 command 'gdefault' on 'gdefault' off ~
3761 :s/// subst. all subst. one
3762 :s///g subst. one subst. all
3763 :s///gg subst. all subst. one
3764
3765 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003766 DEPRECATED: Setting this option may break plugins that are not aware
3767 of this option. Also, many users get confused that adding the /g flag
3768 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003769 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770
3771 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003772'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 Format to recognize for the ":grep" command output.
3775 This is a scanf-like string that uses the same format as the
3776 'errorformat' option: see |errorformat|.
3777
3778 *'grepprg'* *'gp'*
3779'grepprg' 'gp' string (default "grep -n ",
3780 Unix: "grep -n $* /dev/null",
3781 Win32: "findstr /n" or "grep -n",
3782 VMS: "SEARCH/NUMBERS ")
3783 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003784 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 and '#' characters, which are expanded like when used in a command-
3786 line. The placeholder "$*" is allowed to specify where the arguments
3787 will be included. Environment variables are expanded |:set_env|. See
3788 |option-backslash| about including spaces and backslashes.
3789 When your "grep" accepts the "-H" argument, use this to make ":grep"
3790 also work well with a single file: >
3791 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003792< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003793 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3794 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003795 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 apply equally to 'grepprg'.
3797 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3798 otherwise it's "grep -n".
3799 This option cannot be set from a |modeline| or in the |sandbox|, for
3800 security reasons.
3801
3802 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3803'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3804 ve:ver35-Cursor,
3805 o:hor50-Cursor,
3806 i-ci:ver25-Cursor/lCursor,
3807 r-cr:hor20-Cursor/lCursor,
3808 sm:block-Cursor
3809 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003810 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 "n-v-c:block,o:hor50,i-ci:hor15,
3812 r-cr:hor30,sm:block")
3813 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003815 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003817 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003818 height of the cursor can be changed. This can be done by specifying a
3819 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003820 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3821 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003823 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 mode-list and an argument-list:
3825 mode-list:argument-list,mode-list:argument-list,..
3826 The mode-list is a dash separated list of these modes:
3827 n Normal mode
3828 v Visual mode
3829 ve Visual mode with 'selection' "exclusive" (same as 'v',
3830 if not specified)
3831 o Operator-pending mode
3832 i Insert mode
3833 r Replace mode
3834 c Command-line Normal (append) mode
3835 ci Command-line Insert mode
3836 cr Command-line Replace mode
3837 sm showmatch in Insert mode
3838 a all modes
3839 The argument-list is a dash separated list of these arguments:
3840 hor{N} horizontal bar, {N} percent of the character height
3841 ver{N} vertical bar, {N} percent of the character width
3842 block block cursor, fills the whole character
3843 [only one of the above three should be present]
3844 blinkwait{N} *cursor-blinking*
3845 blinkon{N}
3846 blinkoff{N}
3847 blink times for cursor: blinkwait is the delay before
3848 the cursor starts blinking, blinkon is the time that
3849 the cursor is shown and blinkoff is the time that the
3850 cursor is not shown. The times are in msec. When one
3851 of the numbers is zero, there is no blinking. The
3852 default is: "blinkwait700-blinkon400-blinkoff250".
3853 These numbers are used for a missing entry. This
3854 means that blinking is enabled by default. To switch
3855 blinking off you can use "blinkon0". The cursor only
3856 blinks when Vim is waiting for input, not while
3857 executing a command.
3858 To make the cursor blink in an xterm, see
3859 |xterm-blink|.
3860 {group-name}
3861 a highlight group name, that sets the color and font
3862 for the cursor
3863 {group-name}/{group-name}
3864 Two highlight group names, the first is used when
3865 no language mappings are used, the other when they
3866 are. |language-mapping|
3867
3868 Examples of parts:
3869 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3870 block cursor with colors from the "nCursor"
3871 highlight group
3872 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3873 In Insert and Command-line Insert mode, use a
3874 30% vertical bar cursor with colors from the
3875 "iCursor" highlight group. Blink a bit
3876 faster.
3877
3878 The 'a' mode is different. It will set the given argument-list for
3879 all modes. It does not reset anything to defaults. This can be used
3880 to do a common setting for all modes. For example, to switch off
3881 blinking: "a:blinkon0"
3882
3883 Examples of cursor highlighting: >
3884 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3885 :highlight Cursor gui=NONE guifg=bg guibg=fg
3886<
3887 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003888 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889'guifont' 'gfn' string (default "")
3890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891 {only available when compiled with GUI enabled}
3892 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003893 In its simplest form the value is just one font name.
3894 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895
3896 *'guifontset'* *'gfs'*
3897 *E250* *E252* *E234* *E597* *E598*
3898'guifontset' 'gfs' string (default "")
3899 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 {only available when compiled with GUI enabled and
3901 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003902 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 When not empty, specifies two (or more) fonts to be used. The first
3904 one for normal English, the second one for your special language. See
3905 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003906
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3908'guifontwide' 'gfw' string (default "")
3909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 {only available when compiled with GUI enabled}
3911 When not empty, specifies a comma-separated list of fonts to be used
3912 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003913 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003914
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 *'guiheadroom'* *'ghr'*
3916'guiheadroom' 'ghr' number (default 50)
3917 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003918 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 The number of pixels subtracted from the screen height when fitting
3920 the GUI window on the screen. Set this before the GUI is started,
3921 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003922 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 lines will be left for window decorations and other items on the
3924 screen. Set it to a negative value to allow windows taller than the
3925 screen.
3926
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003927 *'guiligatures'* *'gli'* *E1243*
3928'guiligatures' 'gli' string (default "")
3929 global
3930 {only for GTK GUI}
3931 List of ASCII characters that, when combined together, can create more
3932 complex shapes. Each character must be a printable ASCII character
3933 with a value in the 32-127 range.
3934 Example: >
3935 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3936< Changing this option updates screen output immediately. Set it to an
3937 empty string to disable ligatures.
3938
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003940'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3941 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003942 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003943 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003946 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947 sequence of letters which describes what components and options of the
3948 GUI should be used.
3949 To avoid problems with flags that are added in the future, use the
3950 "+=" and "-=" feature of ":set" |add-option-flags|.
3951
Bram Moolenaar13568252018-03-16 20:46:58 +01003952 Valid characters are as follows:
3953 *'go-!'*
3954 '!' External commands are executed in a terminal window. Without
3955 this flag the MS-Windows GUI will open a console window to
3956 execute the command. The Unix GUI will simulate a dumb
3957 terminal to list the command output.
3958 The terminal window will be positioned at the bottom, and grow
3959 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003960 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 'a' Autoselect: If present, then whenever VISUAL mode is started,
3962 or the Visual area extended, Vim tries to become the owner of
3963 the windowing system's global selection. This means that the
3964 Visually highlighted text is available for pasting into other
3965 applications as well as into Vim itself. When the Visual mode
3966 ends, possibly due to an operation on the text, or when an
3967 application wants to paste the selection, the highlighted text
3968 is automatically yanked into the "* selection register.
3969 Thus the selection is still available for pasting into other
3970 applications after the VISUAL mode has ended.
3971 If not present, then Vim won't become the owner of the
3972 windowing system's global selection unless explicitly told to
3973 by a yank or delete operation for the "* register.
3974 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003975 *'go-P'*
3976 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003977 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003978 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003979 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 applies to the modeless selection.
3981
3982 'guioptions' autoselect Visual autoselect modeless ~
3983 "" - -
3984 "a" yes yes
3985 "A" - yes
3986 "aA" yes yes
3987
Bram Moolenaar02467872007-05-06 13:22:01 +00003988 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989 'c' Use console dialogs instead of popup dialogs for simple
3990 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003991 *'go-d'*
3992 'd' Use dark theme variant if available. Currently only works for
3993 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003994 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003995 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003996 'guitablabel' can be used to change the text in the labels.
3997 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003998 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003999 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004000 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 'f' Foreground: Don't use fork() to detach the GUI from the shell
4002 where it was started. Use this for programs that wait for the
4003 editor to finish (e.g., an e-mail program). Alternatively you
4004 can use "gvim -f" or ":gui -f" to start the GUI in the
4005 foreground. |gui-fork|
4006 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004007 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004008 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4010 corner of the window. It's black&white on non-GTK, because of
4011 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004012 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004014 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004015 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004017 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004019 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004020 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 'g' Grey menu items: Make menu items that are not active grey. If
4022 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004023 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024 't' Include tearoff menu items. Currently only works for Win32,
4025 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004026 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004027 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4028 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004029 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004031 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 'R' Right-hand scrollbar is present when there is a vertically
4033 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004034 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004036 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 'L' Left-hand scrollbar is present when there is a vertically
4038 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004039 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4041 the longest visible line, or on the cursor line if the 'h'
4042 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004043 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 'h' Limit horizontal scrollbar size to the length of the cursor
4045 line. Reduces computations. |gui-horiz-scroll|
4046
4047 And yes, you may even have scrollbars on the left AND the right if
4048 you really want to :-). See |gui-scrollbars| for more information.
4049
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004050 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051 'v' Use a vertical button layout for dialogs. When not included,
4052 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004053 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004054 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 'p' Use Pointer callbacks for X11 GUI. This is required for some
4056 window managers. If the cursor is not blinking or hollow at
4057 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004058 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004060 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004061 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004062 *'go-k'*
4063 'k' Keep the GUI window size when adding/removing a scrollbar, or
4064 toolbar, tabline, etc. Instead, the behavior is similar to
4065 when the window is maximized and will adjust 'lines' and
4066 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004067 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004068 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004069
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070 *'guipty'* *'noguipty'*
4071'guipty' boolean (default on)
4072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 {only available when compiled with GUI enabled}
4074 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4075 I/O to/from shell commands. See |gui-pty|.
4076
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004077 *'guitablabel'* *'gtl'*
4078'guitablabel' 'gtl' string (default empty)
4079 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004080 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004081 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004082 pages line. When empty and when the result is empty Vim will use a
4083 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004084
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004085 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004086 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004087 The expression will be evaluated in the |sandbox| when set from a
4088 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004089 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004090
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004091 Only used when the GUI tab pages line is displayed. 'e' must be
4092 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4093 used.
4094
Bram Moolenaar57657d82006-04-21 22:12:41 +00004095 *'guitabtooltip'* *'gtt'*
4096'guitabtooltip' 'gtt' string (default empty)
4097 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004098 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004099 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004100 pages line. When empty Vim will use a default tooltip.
4101 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004102 You can include a line break. Simplest method is to use |:let|: >
4103 :let &guitabtooltip = "line one\nline two"
4104<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004105
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004107'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004108 (others) "$VIMRUNTIME/doc/help.txt")
4109 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004110 Name of the main help file. All distributed help files should be
4111 placed together in one directory. Additionally, all "doc" directories
4112 in 'runtimepath' will be used.
4113 Environment variables are expanded |:set_env|. For example:
4114 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004115 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 spaces and backslashes.
4117 This option cannot be set from a |modeline| or in the |sandbox|, for
4118 security reasons.
4119
4120 *'helpheight'* *'hh'*
4121'helpheight' 'hh' number (default 20)
4122 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 Minimal initial height of the help window when it is opened with the
4124 ":help" command. The initial height of the help window is half of the
4125 current window, or (when the 'ea' option is on) the same as other
4126 windows. When the height is less than 'helpheight', the height is
4127 set to 'helpheight'. Set to zero to disable.
4128
4129 *'helplang'* *'hlg'*
4130'helplang' 'hlg' string (default: messages language or empty)
4131 global
4132 {only available when compiled with the |+multi_lang|
4133 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004134 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 for which the desired help can be found. The English help will always
4136 be used as a last resort. You can add "en" to prefer English over
4137 another language, but that will only find tags that exist in that
4138 language and not in the English help.
4139 Example: >
4140 :set helplang=de,it
4141< This will first search German, then Italian and finally English help
4142 files.
4143 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4144 try to find the tag in the current language before using this option.
4145 See |help-translated|.
4146
4147 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4148'hidden' 'hid' boolean (default off)
4149 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150 When off a buffer is unloaded when it is |abandon|ed. When on a
4151 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4152 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004153
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004155 hidden even if the 'hidden' option is off when these three are true:
4156 - the buffer is modified
4157 - 'autowrite' is off or writing is not possible
4158 - the '!' flag was used
4159 Also see |windows.txt|.
4160
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004161 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 This option is set for one command with ":hide {command}" |:hide|.
4163 WARNING: It's easy to forget that you have changes in hidden buffers.
4164 Think twice when using ":q!" or ":qa!".
4165
4166 *'highlight'* *'hl'*
4167'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004168 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4169 d:Directory,e:ErrorMsg,i:IncSearch,
4170 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004171 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004172 N:CursorLineNr,r:Question,s:StatusLine,
4173 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004174 v:Visual,V:VisualNOS,w:WarningMsg,
4175 W:WildMenu,f:Folded,F:FoldColumn,
4176 A:DiffAdd,C:DiffChange,D:DiffDelete,
4177 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004178 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004179 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004180 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4181 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004182 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004183 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004186 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004188 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004190 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4191 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 characters from 'showbreak'
4193 |hl-Directory| d directories in CTRL-D listing and other special
4194 things in listings
4195 |hl-ErrorMsg| e error messages
4196 h (obsolete, ignored)
4197 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004198 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4200 |hl-MoreMsg| m |more-prompt|
4201 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004202 |hl-LineNr| n line number for ":number" and ":#" commands, and
4203 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004204 |hl-LineNrAbove| a line number above the cursor for when the
4205 'relativenumber' option is set.
4206 |hl-LineNrBelow| b line number below the cursor for when the
4207 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004208 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4209 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 |hl-Question| r |hit-enter| prompt and yes/no questions
4211 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004212 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4214 |hl-VertSplit| c column used to separate vertically split windows
4215 |hl-Visual| v Visual mode
4216 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4217 Selection" Only X11 Gui's |gui-x11| and
4218 |xterm-clipboard|.
4219 |hl-WarningMsg| w warning messages
4220 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4221 |hl-Folded| f line used for closed folds
4222 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004223 |hl-DiffAdd| A added line in diff mode
4224 |hl-DiffChange| C changed line in diff mode
4225 |hl-DiffDelete| D deleted line in diff mode
4226 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004228 |hl-Conceal| - the placeholders used for concealed characters
4229 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004230 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004231 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004232 |hl-SpellRare| R rare word |spell|
4233 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004234 |hl-Pmenu| + popup menu normal line
4235 |hl-PmenuSel| = popup menu selected line
4236 |hl-PmenuSbar| x popup menu scrollbar
4237 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238
4239 The display modes are:
4240 r reverse (termcap entry "mr" and "me")
4241 i italic (termcap entry "ZH" and "ZR")
4242 b bold (termcap entry "md" and "me")
4243 s standout (termcap entry "so" and "se")
4244 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004245 c undercurl (termcap entry "Us" and "Ce")
4246 2 double underline (termcap entry "Ds" and "Ce")
4247 d dotted underline (termcap entry "ds" and "Ce")
4248 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004249 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 n no highlighting
4251 - no highlighting
4252 : use a highlight group
4253 The default is used for occasions that are not included.
4254 If you want to change what the display modes do, see |dos-colors|
4255 for an example.
4256 When using the ':' display mode, this must be followed by the name of
4257 a highlight group. A highlight group can be used to define any type
4258 of highlighting, including using color. See |:highlight| on how to
4259 define one. The default uses a different group for each occasion.
4260 See |highlight-default| for the default highlight groups.
4261
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004263'history' 'hi' number (Vim default: 50, Vi default: 0,
4264 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004265 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004267 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004269 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270 NOTE: This option is set to the Vi default value when 'compatible' is
4271 set and to the Vim default value when 'compatible' is reset.
4272
4273 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4274'hkmap' 'hk' boolean (default off)
4275 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 {only available when compiled with the |+rightleft|
4277 feature}
4278 When on, the keyboard is mapped for the Hebrew character set.
4279 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4280 toggle this option. See |rileft.txt|.
4281 NOTE: This option is reset when 'compatible' is set.
4282
4283 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4284'hkmapp' 'hkp' boolean (default off)
4285 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286 {only available when compiled with the |+rightleft|
4287 feature}
4288 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4289 This is useful if you have a non-Hebrew keyboard.
4290 See |rileft.txt|.
4291 NOTE: This option is reset when 'compatible' is set.
4292
Bram Moolenaar036986f2017-03-16 17:41:02 +01004293 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4294'hlsearch' 'hls' boolean (default off)
4295 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004296 {not available when compiled without the
4297 |+extra_search| feature}
4298 When there is a previous search pattern, highlight all its matches.
4299 The type of highlighting used can be set with the 'l' occasion in the
4300 'highlight' option. This uses the "Search" highlight group by
4301 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004302 are not applied. If the "CurSearch" highlight group is set then the
4303 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004304 See also: 'incsearch' and |:match|.
4305 When you get bored looking at the highlighted matches, you can turn it
4306 off with |:nohlsearch|. This does not change the option value, as
4307 soon as you use a search command, the highlighting comes back.
4308 'redrawtime' specifies the maximum time spent on finding matches.
4309 When the search pattern can match an end-of-line, Vim will try to
4310 highlight all of the matched text. However, this depends on where the
4311 search starts. This will be the first line in the window or the first
4312 line below a closed fold. A match in a previous line which is not
4313 drawn may not continue in a newly drawn line.
4314 You can specify whether the highlight status is restored on startup
4315 with the 'h' flag in 'viminfo' |viminfo-h|.
4316 NOTE: This option is reset when 'compatible' is set.
4317
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 *'icon'* *'noicon'*
4319'icon' boolean (default off, on when title can be restored)
4320 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321 When on, the icon text of the window will be set to the value of
4322 'iconstring' (if it is not empty), or to the name of the file
4323 currently being edited. Only the last part of the name is used.
4324 Overridden by the 'iconstring' option.
4325 Only works if the terminal supports setting window icons (currently
4326 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4327 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4328 builtin termcap).
4329 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004330 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004331 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004332 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333
4334 *'iconstring'*
4335'iconstring' string (default "")
4336 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 When this option is not empty, it will be used for the icon text of
4338 the window. This happens only when the 'icon' option is on.
4339 Only works if the terminal supports setting window icon text
4340 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004341 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342 When Vim was compiled with HAVE_X11 defined, the original icon will be
4343 restored if possible |X11|.
4344 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004345 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004347 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004348 {not available when compiled without the |+statusline| feature}
4349
4350 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4351'ignorecase' 'ic' boolean (default off)
4352 global
4353 Ignore case in search patterns. Also used when searching in the tags
4354 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004355 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356 Can be overruled by using "\c" or "\C" in the pattern, see
4357 |/ignorecase|.
4358
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004359 *'imactivatefunc'* *'imaf'*
4360'imactivatefunc' 'imaf' string (default "")
4361 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004362 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004363 activate or deactivate the Input Method. The value can be the name of
4364 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4365 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004366 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004367 The expression will be evaluated in the |sandbox| when set from a
4368 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004369
4370 Example: >
4371 function ImActivateFunc(active)
4372 if a:active
4373 ... do something
4374 else
4375 ... do something
4376 endif
4377 " return value is not used
4378 endfunction
4379 set imactivatefunc=ImActivateFunc
4380<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 *'imactivatekey'* *'imak'*
4382'imactivatekey' 'imak' string (default "")
4383 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004385 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 Specifies the key that your Input Method in X-Windows uses for
4387 activation. When this is specified correctly, vim can fully control
4388 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4389 You can't use this option to change the activation key, the option
4390 tells Vim what the key is.
4391 Format:
4392 [MODIFIER_FLAG-]KEY_STRING
4393
4394 These characters can be used for MODIFIER_FLAG (case is ignored):
4395 S Shift key
4396 L Lock key
4397 C Control key
4398 1 Mod1 key
4399 2 Mod2 key
4400 3 Mod3 key
4401 4 Mod4 key
4402 5 Mod5 key
4403 Combinations are allowed, for example "S-C-space" or "SC-space" are
4404 both shift+ctrl+space.
4405 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4406
4407 Example: >
4408 :set imactivatekey=S-space
4409< "S-space" means shift+space. This is the activation key for kinput2 +
4410 canna (Japanese), and ami (Korean).
4411
4412 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4413'imcmdline' 'imc' boolean (default off)
4414 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004415 When set the Input Method is always on when starting to edit a command
4416 line, unless entering a search pattern (see 'imsearch' for that).
4417 Setting this option is useful when your input method allows entering
4418 English characters directly, e.g., when it's used to type accented
4419 characters with dead keys.
4420
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004421 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4423 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 When set the Input Method is never used. This is useful to disable
4425 the IM when it doesn't work properly.
4426 Currently this option is on by default for SGI/IRIX machines. This
4427 may change in later releases.
4428
4429 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004430'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432 Specifies whether :lmap or an Input Method (IM) is to be used in
4433 Insert mode. Valid values:
4434 0 :lmap is off and IM is off
4435 1 :lmap is ON and IM is off
4436 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004437 To always reset the option to zero when leaving Insert mode with <Esc>
4438 this can be used: >
4439 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4440< This makes :lmap and IM turn off automatically when leaving Insert
4441 mode.
4442 Note that this option changes when using CTRL-^ in Insert mode
4443 |i_CTRL-^|.
4444 The value is set to 1 when setting 'keymap' to a valid keymap name.
4445 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004446 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447 methods. Use 'imdisable' to disable XIM then.
4448
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004449 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004450 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004451 |+multi_byte_ime| or |global-ime|.
4452
Bram Moolenaar071d4272004-06-13 20:20:40 +00004453 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004454'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 Specifies whether :lmap or an Input Method (IM) is to be used when
4457 entering a search pattern. Valid values:
4458 -1 the value of 'iminsert' is used, makes it look like
4459 'iminsert' is also used when typing a search pattern
4460 0 :lmap is off and IM is off
4461 1 :lmap is ON and IM is off
4462 2 :lmap is off and IM is ON
4463 Note that this option changes when using CTRL-^ in Command-line mode
4464 |c_CTRL-^|.
4465 The value is set to 1 when it is not -1 and setting the 'keymap'
4466 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004467 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468 methods. Use 'imdisable' to disable XIM then.
4469
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004470 *'imstatusfunc'* *'imsf'*
4471'imstatusfunc' 'imsf' string (default "")
4472 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004473 This option specifies a function that is called to obtain the status
4474 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004475 The value can be the name of a function, a |lambda| or a |Funcref|.
4476 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004477 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004478
4479 Example: >
4480 function ImStatusFunc()
4481 let is_active = ...do something
4482 return is_active ? 1 : 0
4483 endfunction
4484 set imstatusfunc=ImStatusFunc
4485<
4486 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004487 The expression will be evaluated in the |sandbox| when set from a
4488 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004489
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004490 *'imstyle'* *'imst'*
4491'imstyle' 'imst' number (default 1)
4492 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004493 {only available when compiled with |+xim| and
4494 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004495 This option specifies the input style of Input Method:
4496 0 use on-the-spot style
4497 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004498 See: |xim-input-style|
4499
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004500 For a long time on-the-spot style had been used in the GTK version of
4501 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004502 |single-repeat|, etc. Therefore over-the-spot style becomes the
4503 default now. This should work fine for most people, however if you
4504 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004505 The expression will be evaluated in the |sandbox| when set from a
4506 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004507
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 *'include'* *'inc'*
4509'include' 'inc' string (default "^\s*#\s*include")
4510 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511 {not available when compiled without the
4512 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004513 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 pattern, just like for the "/" command (See |pattern|). The default
4515 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004516 "]I", "[d", etc.
4517 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004518 comes after the matched pattern. But if "\zs" appears in the pattern
4519 then the text matched from "\zs" to the end, or until "\ze" if it
4520 appears, is used as the file name. Use this to include characters
4521 that are not in 'isfname', such as a space. You can then use
4522 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004523 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524
4525 *'includeexpr'* *'inex'*
4526'includeexpr' 'inex' string (default "")
4527 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004529 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004531 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532 :set includeexpr=substitute(v:fname,'\\.','/','g')
4533< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004534
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004536 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 Also used for |<cfile>|.
4538
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004539 If the expression starts with s: or |<SID>|, then it is replaced with
4540 the script ID (|local-function|). Example: >
4541 set includeexpr=s:MyIncludeExpr(v:fname)
4542 set includeexpr=<SID>SomeIncludeExpr(v:fname)
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004543< Otherwise, the expression is evaluated in the context of the script
4544 where the option was set, thus script-local items are available.
4545
Bram Moolenaar30b65812012-07-12 22:01:11 +02004546 The expression will be evaluated in the |sandbox| when set from a
4547 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004548 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004549
4550 It is not allowed to change text or jump to another window while
4551 evaluating 'includeexpr' |textlock|.
4552
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004554'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004555 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004558 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004559 While typing a search command, show where the pattern, as it was typed
4560 so far, matches. The matched string is highlighted. If the pattern
4561 is invalid or not found, nothing is shown. The screen will be updated
4562 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004563 Also applies to the pattern in commands: >
4564 :global
4565 :lvimgrep
4566 :lvimgrepadd
4567 :smagic
4568 :snomagic
4569 :sort
4570 :substitute
4571 :vglobal
4572 :vimgrep
4573 :vimgrepadd
4574< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004575 original position when no match is found and when pressing <Esc>. You
4576 still need to finish the search command with <Enter> to move the
4577 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004578 You can use the CTRL-G and CTRL-T keys to move to the next and
4579 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004580 When compiled with the |+reltime| feature Vim only searches for about
4581 half a second. With a complicated pattern and/or a lot of text the
4582 match may not be found. This is to avoid that Vim hangs while you
4583 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004584 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004585 When 'hlsearch' is on, all matched strings are highlighted too while
4586 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004587 If you don't want to turn 'hlsearch' on, but want to highlight all
4588 matches while searching, you can turn on and off 'hlsearch' with
4589 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004590 augroup vimrc-incsearch-highlight
4591 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004592 autocmd CmdlineEnter /,\? :set hlsearch
4593 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004594 augroup END
4595<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004596 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004597 to the command line. If 'ignorecase' and 'smartcase' are set and the
4598 command line has no uppercase characters, the added character is
4599 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004600 CTRL-R CTRL-W can be used to add the word at the end of the current
4601 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 NOTE: This option is reset when 'compatible' is set.
4603
4604 *'indentexpr'* *'inde'*
4605'indentexpr' 'inde' string (default "")
4606 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004607 {not available when compiled without the |+eval|
4608 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 Expression which is evaluated to obtain the proper indent for a line.
4610 It is used when a new line is created, for the |=| operator and
4611 in Insert mode as specified with the 'indentkeys' option.
4612 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004613 'smartindent' indenting. When 'lisp' is set, this option is
4614 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 When 'paste' is set this option is not used for indenting.
4616 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004617 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004619
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004620 If the expression starts with s: or |<SID>|, then it is replaced with
4621 the script ID (|local-function|). Example: >
4622 set indentexpr=s:MyIndentExpr()
4623 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004624< Otherwise, the expression is evaluated in the context of the script
4625 where the option was set, thus script-local items are available.
4626
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 The expression must return the number of spaces worth of indent. It
4628 can return "-1" to keep the current indent (this means 'autoindent' is
4629 used for the indent).
4630 Functions useful for computing the indent are |indent()|, |cindent()|
4631 and |lispindent()|.
4632 The evaluation of the expression must not have side effects! It must
4633 not change the text, jump to another window, etc. Afterwards the
4634 cursor position is always restored, thus the cursor may be moved.
4635 Normally this option would be set to call a function: >
4636 :set indentexpr=GetMyIndent()
4637< Error messages will be suppressed, unless the 'debug' option contains
4638 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004639 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004640 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641
Bram Moolenaar30b65812012-07-12 22:01:11 +02004642 The expression will be evaluated in the |sandbox| when set from a
4643 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004644 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004645
4646 It is not allowed to change text or jump to another window while
4647 evaluating 'indentexpr' |textlock|.
4648
4649
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004651'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 A list of keys that, when typed in Insert mode, cause reindenting of
4654 the current line. Only happens if 'indentexpr' isn't empty.
4655 The format is identical to 'cinkeys', see |indentkeys-format|.
4656 See |C-indenting| and |indent-expression|.
4657
4658 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4659'infercase' 'inf' boolean (default off)
4660 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004661 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004662 'ignorecase' is also on, the case of the match is adjusted depending
4663 on the typed text. If the typed text contains a lowercase letter
4664 where the match has an upper case letter, the completed part is made
4665 lowercase. If the typed text has no lowercase letters and the match
4666 has a lowercase letter where the typed text has an uppercase letter,
4667 and there is a letter before it, the completed part is made uppercase.
4668 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669
4670 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4671'insertmode' 'im' boolean (default off)
4672 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 Makes Vim work in a way that Insert mode is the default mode. Useful
4674 if you want to use Vim as a modeless editor. Used for |evim|.
4675 These Insert mode commands will be useful:
4676 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004677 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 this is a mapping, it is executed as if 'insertmode' was off.
4679 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004681 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4682 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004683
4684 These items change when 'insertmode' is set:
4685 - when starting to edit of a file, Vim goes to Insert mode.
4686 - <Esc> in Insert mode is a no-op and beeps.
4687 - <Esc> in Normal mode makes Vim go to Insert mode.
4688 - CTRL-L in Insert mode is a command, it is not inserted.
4689 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4690 However, when <Esc> is used inside a mapping, it behaves like
4691 'insertmode' was not set. This was done to be able to use the same
4692 mappings with 'insertmode' set or not set.
4693 When executing commands with |:normal| 'insertmode' is not used.
4694
4695 NOTE: This option is reset when 'compatible' is set.
4696
4697 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004698'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004699 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4700 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4701 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4702 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4703 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 The characters specified by this option are included in file names and
4706 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004707 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004708 Multi-byte characters 256 and above are always included, only the
4709 characters up to 255 are specified with this option.
4710 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004711 Think twice before adding white space to this option. Although a
4712 space may appear inside a file name, the effect will be that Vim
4713 doesn't know where a file name starts or ends when doing completion.
4714 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715
4716 Note that on systems using a backslash as path separator, Vim tries to
4717 do its best to make it work as you would expect. That is a bit
4718 tricky, since Vi originally used the backslash to escape special
4719 characters. Vim will not remove a backslash in front of a normal file
4720 name character on these systems, but it will on Unix and alikes. The
4721 '&' and '^' are not included by default, because these are special for
4722 cmd.exe.
4723
4724 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004725 Each part can be a single character number or a range. A range is two
4726 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727 decimal number between 0 and 255 or the ASCII character itself (does
4728 not work for digits). Example:
4729 "_,-,128-140,#-43" (include '_' and '-' and the range
4730 128 to 140 and '#' to 43)
4731 If a part starts with '^', the following character number or range
4732 will be excluded from the option. The option is interpreted from left
4733 to right. Put the excluded character after the range where it is
4734 included. To include '^' itself use it as the last character of the
4735 option or the end of a range. Example:
4736 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4737 If the character is '@', all characters where isalpha() returns TRUE
4738 are included. Normally these are the characters a to z and A to Z,
4739 plus accented characters. To include '@' itself use "@-@". Examples:
4740 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004741 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742 "a-z,A-Z,@-@" All letters plus the '@' character.
4743 A comma can be included by using it where a character number is
4744 expected. Example:
4745 "48-57,,,_" Digits, comma and underscore.
4746 A comma can be excluded by prepending a '^'. Example:
4747 " -~,^,,9" All characters from space to '~', excluding
4748 comma, plus <Tab>.
4749 See |option-backslash| about including spaces and backslashes.
4750
4751 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004752'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 "@,48-57,_,128-167,224-235"
4754 otherwise: "@,48-57,_,192-255")
4755 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 The characters given by this option are included in identifiers.
4757 Identifiers are used in recognizing environment variables and after a
4758 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004759 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004760 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004762 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4764
4765 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004766'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 "@,48-57,_,128-167,224-235"
4768 otherwise: "@,48-57,_,192-255"
4769 Vi default: "@,48-57,_")
4770 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004772 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004773 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004774 characters above 255 check the "word" character class (any character
4775 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004776 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777 For a help file it is set to all non-blank printable characters except
4778 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4779 command).
4780 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004781 This option also influences syntax highlighting, unless the syntax
4782 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 NOTE: This option is set to the Vi default value when 'compatible' is
4784 set and to the Vim default value when 'compatible' is reset.
4785
4786 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004787'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 "@,~-255"; otherwise: "@,161-255")
4789 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790 The characters given by this option are displayed directly on the
4791 screen. It is also used for "\p" in a |pattern|. The characters from
4792 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4793 even when they are not included in 'isprint' or excluded. See
4794 'isfname' for a description of the format of this option.
4795
4796 Non-printable characters are displayed with two characters:
4797 0 - 31 "^@" - "^_"
4798 32 - 126 always single characters
4799 127 "^?"
4800 128 - 159 "~@" - "~_"
4801 160 - 254 "| " - "|~"
4802 255 "~?"
4803 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4804 displayed as <xx>, with the hexadecimal value of the byte.
4805 When 'display' contains "uhex" all unprintable characters are
4806 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004807 The SpecialKey highlighting will be used for unprintable characters.
4808 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809
4810 Multi-byte characters 256 and above are always included, only the
4811 characters up to 255 are specified with this option. When a character
4812 is printable but it is not available in the current font, a
4813 replacement character will be shown.
4814 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4815 There is no option to specify these characters.
4816
4817 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4818'joinspaces' 'js' boolean (default on)
4819 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 Insert two spaces after a '.', '?' and '!' with a join command.
4821 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4822 Otherwise only one space is inserted.
4823 NOTE: This option is set when 'compatible' is set.
4824
4825 *'key'*
4826'key' string (default "")
4827 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004828 {only available when compiled with the |+cryptv|
4829 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004831 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 Careful: Do not set the key value by hand, someone might see the typed
4833 key. Use the |:X| command. But you can make 'key' empty: >
4834 :set key=
4835< It is not possible to get the value of this option with ":set key" or
4836 "echo &key". This is to avoid showing it to someone who shouldn't
4837 know. It also means you cannot see it yourself once you have set it,
4838 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004839 You can use "&key" in an expression to detect whether encryption is
4840 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841
4842 *'keymap'* *'kmp'* *E544*
4843'keymap' 'kmp' string (default "")
4844 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 {only available when compiled with the |+keymap|
4846 feature}
4847 Name of a keyboard mapping. See |mbyte-keymap|.
4848 Setting this option to a valid keymap name has the side effect of
4849 setting 'iminsert' to one, so that the keymap becomes effective.
4850 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004851 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852
4853 *'keymodel'* *'km'*
4854'keymodel' 'km' string (default "")
4855 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004856 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857 can do. These values can be used:
4858 startsel Using a shifted special key starts selection (either
4859 Select mode or Visual mode, depending on "key" being
4860 present in 'selectmode').
4861 stopsel Using a not-shifted special key stops selection.
4862 Special keys in this context are the cursor keys, <End>, <Home>,
4863 <PageUp> and <PageDown>.
4864 The 'keymodel' option is set by the |:behave| command.
4865
4866 *'keywordprg'* *'kp'*
4867'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004868 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870 Program to use for the |K| command. Environment variables are
4871 expanded |:set_env|. ":help" may be used to access the Vim internal
4872 help. (Note that previously setting the global option to the empty
4873 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004874 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01004875 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004876 When "man", "man -s" or an Ex command is used, Vim will automatically
4877 translate a count for the "K" command and pass it as the first
4878 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879 See |option-backslash| about including spaces and backslashes.
4880 Example: >
4881 :set keywordprg=man\ -s
4882< This option cannot be set from a |modeline| or in the |sandbox|, for
4883 security reasons.
4884
4885 *'langmap'* *'lmap'* *E357* *E358*
4886'langmap' 'lmap' string (default "")
4887 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888 {only available when compiled with the |+langmap|
4889 feature}
4890 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004891 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004892 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893 care of translating these special characters to the original meaning
4894 of the key. This means you don't have to change the keyboard mode to
4895 be able to execute Normal mode commands.
4896 This is the opposite of the 'keymap' option, where characters are
4897 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004898 Also consider setting 'langremap' to off, to prevent 'langmap' from
4899 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004900 This option cannot be set from a |modeline| or in the |sandbox|, for
4901 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004902
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004903 Example (for Greek, in UTF-8): *greek* >
4904 :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 +00004905< Example (exchanges meaning of z and y for commands): >
4906 :set langmap=zy,yz,ZY,YZ
4907<
4908 The 'langmap' option is a list of parts, separated with commas. Each
4909 part can be in one of two forms:
4910 1. A list of pairs. Each pair is a "from" character immediately
4911 followed by the "to" character. Examples: "aA", "aAbBcC".
4912 2. A list of "from" characters, a semi-colon and a list of "to"
4913 characters. Example: "abc;ABC"
4914 Example: "aA,fgh;FGH,cCdDeE"
4915 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004916 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917
4918 This will allow you to activate vim actions without having to switch
4919 back and forth between the languages. Your language characters will
4920 be understood as normal vim English characters (according to the
4921 langmap mappings) in the following cases:
4922 o Normal/Visual mode (commands, buffer/register names, user mappings)
4923 o Insert/Replace Mode: Register names after CTRL-R
4924 o Insert/Replace Mode: Mappings
4925 Characters entered in Command-line mode will NOT be affected by
4926 this option. Note that this option can be changed at any time
4927 allowing to switch between mappings for different languages/encodings.
4928 Use a mapping to avoid having to type it each time!
4929
4930 *'langmenu'* *'lm'*
4931'langmenu' 'lm' string (default "")
4932 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004933 {only available when compiled with the |+menu| and
4934 |+multi_lang| features}
4935 Language to use for menu translation. Tells which file is loaded
4936 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004937 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938< (without the spaces). For example, to always use the Dutch menus, no
4939 matter what $LANG is set to: >
4940 :set langmenu=nl_NL.ISO_8859-1
4941< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004942 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943 If your $LANG is set to a non-English language but you do want to use
4944 the English menus: >
4945 :set langmenu=none
4946< This option must be set before loading menus, switching on filetype
4947 detection or syntax highlighting. Once the menus are defined setting
4948 this option has no effect. But you could do this: >
4949 :source $VIMRUNTIME/delmenu.vim
4950 :set langmenu=de_DE.ISO_8859-1
4951 :source $VIMRUNTIME/menu.vim
4952< Warning: This deletes all menus that you defined yourself!
4953
Bram Moolenaard94464e2015-11-02 15:28:18 +01004954 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004955'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004956 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004957 {only available when compiled with the |+langmap|
4958 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004959 This is just like 'langremap' but with the value inverted. It only
4960 exists for backwards compatibility. When setting 'langremap' then
4961 'langnoremap' is set to the inverted value, and the other way around.
4962
4963 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004964'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004965 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004966 {only available when compiled with the |+langmap|
4967 feature}
4968 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004969 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004970 'langmap' disables some of your mappings, try resetting this option.
4971 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004972 that works for you to avoid mappings to break.
4973
Bram Moolenaar071d4272004-06-13 20:20:40 +00004974 *'laststatus'* *'ls'*
4975'laststatus' 'ls' number (default 1)
4976 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977 The value of this option influences when the last window will have a
4978 status line:
4979 0: never
4980 1: only if there are at least two windows
4981 2: always
4982 The screen looks nicer with a status line if you have several
4983 windows, but it takes another screen line. |status-line|
4984
4985 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4986'lazyredraw' 'lz' boolean (default off)
4987 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 When this option is set, the screen will not be redrawn while
4989 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004990 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01004992 This may occasionally cause display errors. It is only meant to be set
4993 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01004994 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995
4996 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4997'linebreak' 'lbr' boolean (default off)
4998 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004999 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005001 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005002 than at the last character that fits on the screen. Unlike
5003 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005004 it only affects the way the file is displayed, not its contents.
5005 If 'breakindent' is set, line is visually indented. Then, the value
5006 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005007 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008 Note that <Tab> characters after an <EOL> are mostly not displayed
5009 with the right amount of white space.
5010
5011 *'lines'* *E593*
5012'lines' number (default 24 or terminal height)
5013 global
5014 Number of lines of the Vim window.
5015 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005016 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005017 When Vim is running in the GUI or in a resizable window, setting this
5018 option will cause the window size to be changed. When you only want
5019 to use the size for the GUI, put the command in your |gvimrc| file.
5020 Vim limits the number of lines to what fits on the screen. You can
5021 use this command to get the tallest window possible: >
5022 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005023< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005024 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025 When you set this option and Vim is unable to change the physical
5026 number of lines of the display, the display may be messed up.
5027
5028 *'linespace'* *'lsp'*
5029'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031 {only in the GUI}
5032 Number of pixel lines inserted between characters. Useful if the font
5033 uses the full character cell height, making lines touch each other.
5034 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005035 With some fonts there can be too much room between lines (to have
5036 space for ascents and descents). Then it makes sense to set
5037 'linespace' to a negative value. This may cause display problems
5038 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039
5040 *'lisp'* *'nolisp'*
5041'lisp' boolean (default off)
5042 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 Lisp mode: When <Enter> is typed in insert mode set the indent for
5044 the next line to Lisp standards (well, sort of). Also happens with
5045 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5046 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5047 better. Also see 'lispwords'.
5048 The '-' character is included in keyword characters. Redefines the
5049 "=" operator to use this same indentation algorithm rather than
5050 calling an external program if 'equalprg' is empty.
5051 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052
5053 *'lispwords'* *'lw'*
5054'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005055 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005056 Comma-separated list of words that influence the Lisp indenting when
5057 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058
5059 *'list'* *'nolist'*
5060'list' boolean (default off)
5061 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005062 List mode: By default show tabs as CTRL-I is displayed, display $
5063 after end of line. Useful to see the difference between tabs and
5064 spaces and for trailing blanks. Further changed by the 'listchars'
5065 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005066
5067 The cursor is displayed at the start of the space a Tab character
5068 occupies, not at the end as usual in Normal mode. To get this cursor
5069 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005070 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005071<
5072 Note that list mode will also affect formatting (set with 'textwidth'
5073 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 changing the way tabs are displayed.
5075
5076 *'listchars'* *'lcs'*
5077'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005078 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005079 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005080 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005081 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 eol:c Character to show at the end of each line. When
5083 omitted, there is no extra character at the end of the
5084 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005085 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005086 tab:xy[z] Two or three characters to be used to show a tab.
5087 The third character is optional.
5088
5089 tab:xy The 'x' is always used, then 'y' as many times as will
5090 fit. Thus "tab:>-" displays:
5091 >
5092 >-
5093 >--
5094 etc.
5095
5096 tab:xyz The 'z' is always used, then 'x' is prepended, and
5097 then 'y' is used as many times as will fit. Thus
5098 "tab:<->" displays:
5099 >
5100 <>
5101 <->
5102 <-->
5103 etc.
5104
5105 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005106 *lcs-space*
5107 space:c Character to show for a space. When omitted, spaces
5108 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005109 *lcs-multispace*
5110 multispace:c...
5111 One or more characters to use cyclically to show for
5112 multiple consecutive spaces. Overrides the "space"
5113 setting, except for single spaces. When omitted, the
5114 "space" setting is used. For example,
5115 `:set listchars=multispace:---+` shows ten consecutive
5116 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005117 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005118 *lcs-lead*
5119 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005120 leading spaces are blank. Overrides the "space" and
5121 "multispace" settings for leading spaces. You can
5122 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005123 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005124< *lcs-leadmultispace*
5125 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005126 Like the |lcs-multispace| value, but for leading
5127 spaces only. Also overrides |lcs-lead| for leading
5128 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005129 `:set listchars=leadmultispace:---+` shows ten
5130 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005131 ---+---+--XXX ~
5132 Where "XXX" denotes the first non-blank characters in
5133 the line.
5134 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005135 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005136 trailing spaces are blank. Overrides the "space" and
5137 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005138 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139 extends:c Character to show in the last column, when 'wrap' is
5140 off and the line continues beyond the right of the
5141 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005142 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005143 precedes:c Character to show in the first visible column of the
5144 physical line, when there is text preceding the
5145 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005146 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005147 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005148 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005149 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005150 nbsp:c Character to show for a non-breakable space character
5151 (0xA0 (160 decimal) and U+202F). Left blank when
5152 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005154 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005156 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005158 Each character can be specified as hex: >
5159 set listchars=eol:\\x24
5160 set listchars=eol:\\u21b5
5161 set listchars=eol:\\U000021b5
5162< Note that a double backslash is used. The number of hex characters
5163 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5164
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165 Examples: >
5166 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005167 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 :set lcs=extends:>,precedes:<
5169< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005170 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5171 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005172 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173
5174 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5175'loadplugins' 'lpl' boolean (default on)
5176 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177 When on the plugin scripts are loaded when starting up |load-plugins|.
5178 This option can be reset in your |vimrc| file to disable the loading
5179 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005180 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5181 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182
Bram Moolenaard94464e2015-11-02 15:28:18 +01005183 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005184'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005185 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005186 {only available when compiled with the |+lua/dyn|
5187 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005188 Specifies the name of the Lua shared library. The default is
5189 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005190 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005191 This option cannot be set from a |modeline| or in the |sandbox|, for
5192 security reasons.
5193
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005194 *'macatsui'* *'nomacatsui'*
5195'macatsui' boolean (default on)
5196 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005197 {not supported}
5198 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005199
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 *'magic'* *'nomagic'*
5201'magic' boolean (default on)
5202 global
5203 Changes the special characters that can be used in search patterns.
5204 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005205 WARNING: Switching this option off most likely breaks plugins! That
5206 is because many patterns assume it's on and will fail when it's off.
5207 Only switch it off when working with old Vi scripts. In any other
5208 situation write patterns that work when 'magic' is on. Include "\M"
5209 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005210 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5211 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212
5213 *'makeef'* *'mef'*
5214'makeef' 'mef' string (default: "")
5215 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216 {not available when compiled without the |+quickfix|
5217 feature}
5218 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5219 and the |:grep| command.
5220 When it is empty, an internally generated temp file will be used.
5221 When "##" is included, it is replaced by a number to make the name
5222 unique. This makes sure that the ":make" command doesn't overwrite an
5223 existing file.
5224 NOT used for the ":cf" command. See 'errorfile' for that.
5225 Environment variables are expanded |:set_env|.
5226 See |option-backslash| about including spaces and backslashes.
5227 This option cannot be set from a |modeline| or in the |sandbox|, for
5228 security reasons.
5229
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005230 *'makeencoding'* *'menc'*
5231'makeencoding' 'menc' string (default "")
5232 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005233 Encoding used for reading the output of external commands. When empty,
5234 encoding is not converted.
5235 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5236 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5237 and `:laddfile`.
5238
5239 This would be mostly useful when you use MS-Windows and set 'encoding'
5240 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5241 'makeencoding' to "char" has the same effect as setting to the system
5242 locale encoding. Example: >
5243 :set encoding=utf-8
5244 :set makeencoding=char " system locale is used
5245<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005246 *'makeprg'* *'mp'*
5247'makeprg' 'mp' string (default "make", VMS: "MMS")
5248 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005249 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005250 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5251 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005252 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005253 Environment variables are expanded |:set_env|. See |option-backslash|
5254 about including spaces and backslashes.
5255 Note that a '|' must be escaped twice: once for ":set" and once for
5256 the interpretation of a command. When you use a filter called
5257 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005258 :set makeprg=gmake\ \\\|\ myfilter
5259< The placeholder "$*" can be given (even multiple times) to specify
5260 where the arguments will be included, for example: >
5261 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5262< This option cannot be set from a |modeline| or in the |sandbox|, for
5263 security reasons.
5264
5265 *'matchpairs'* *'mps'*
5266'matchpairs' 'mps' string (default "(:),{:},[:]")
5267 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005269 other.
5270 Only character pairs are allowed that are different, thus you cannot
5271 jump between two double quotes.
5272 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005273 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005274 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275 :set mps+=<:>
5276
5277< A more exotic example, to jump between the '=' and ';' in an
5278 assignment, useful for languages like C and Java: >
5279 :au FileType c,cpp,java set mps+==:;
5280
5281< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005282 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283
5284 *'matchtime'* *'mat'*
5285'matchtime' 'mat' number (default 5)
5286 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287 Tenths of a second to show the matching paren, when 'showmatch' is
5288 set. Note that this is not in milliseconds, like other options that
5289 set a time. This is to be compatible with Nvi.
5290
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005291 *'maxcombine'* *'mco'*
5292'maxcombine' 'mco' number (default 2)
5293 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005294 The maximum number of combining characters supported for displaying.
5295 Only used when 'encoding' is "utf-8".
5296 The default is OK for most languages. Hebrew may require 4.
5297 Maximum value is 6.
5298 Even when this option is set to 2 you can still edit text with more
5299 combining characters, you just can't see them. Use |g8| or |ga|.
5300 See |mbyte-combining|.
5301
Bram Moolenaar071d4272004-06-13 20:20:40 +00005302 *'maxfuncdepth'* *'mfd'*
5303'maxfuncdepth' 'mfd' number (default 100)
5304 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005305 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005306 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005307 Maximum depth of function calls for user functions. This normally
5308 catches endless recursion. When using a recursive function with
5309 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5310 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005311 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005312 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313 See also |:function|.
5314
5315 *'maxmapdepth'* *'mmd'* *E223*
5316'maxmapdepth' 'mmd' number (default 1000)
5317 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318 Maximum number of times a mapping is done without resulting in a
5319 character to be used. This normally catches endless mappings, like
5320 ":map x y" with ":map y x". It still does not catch ":map g wg",
5321 because the 'w' is used before the next mapping is done. See also
5322 |key-mapping|.
5323
5324 *'maxmem'* *'mm'*
5325'maxmem' 'mm' number (default between 256 to 5120 (system
5326 dependent) or half the amount of memory
5327 available)
5328 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005329 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5330 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005331 other memory to be freed.
5332 The maximum usable value is about 2000000. Use this to work without a
5333 limit.
5334 The value is ignored when 'swapfile' is off.
5335 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005336
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005337 *'maxmempattern'* *'mmp'*
5338'maxmempattern' 'mmp' number (default 1000)
5339 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005340 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005341 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005342 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005343 When Vim runs into the limit it gives an error message and mostly
5344 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005345 Running into the limit often means that the pattern is very
5346 inefficient or too complex. This may already happen with the pattern
5347 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005348 Might also happen on redraw, when syntax rules try to match a complex
5349 text structure.
5350 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5351 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005352
Bram Moolenaar071d4272004-06-13 20:20:40 +00005353 *'maxmemtot'* *'mmt'*
5354'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5355 dependent) or half the amount of memory
5356 available)
5357 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005358 Maximum amount of memory in Kbyte to use for all buffers together.
5359 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005360 without a limit.
5361 On 64 bit machines higher values might work. But hey, do you really
5362 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005363 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005364 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005365 Buffers with 'swapfile' off still count to the total amount of memory
5366 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005367 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005368
5369 *'menuitems'* *'mis'*
5370'menuitems' 'mis' number (default 25)
5371 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 {not available when compiled without the |+menu|
5373 feature}
5374 Maximum number of items to use in a menu. Used for menus that are
5375 generated from a list of items, e.g., the Buffers menu. Changing this
5376 option has no direct effect, the menu must be refreshed first.
5377
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005378 *'mkspellmem'* *'msm'*
5379'mkspellmem' 'msm' string (default "460000,2000,500")
5380 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005381 {not available when compiled without the |+syntax|
5382 feature}
5383 Parameters for |:mkspell|. This tunes when to start compressing the
5384 word tree. Compression can be slow when there are many words, but
5385 it's needed to avoid running out of memory. The amount of memory used
5386 per word depends very much on how similar the words are, that's why
5387 this tuning is complicated.
5388
5389 There are three numbers, separated by commas:
5390 {start},{inc},{added}
5391
5392 For most languages the uncompressed word tree fits in memory. {start}
5393 gives the amount of memory in Kbyte that can be used before any
5394 compression is done. It should be a bit smaller than the amount of
5395 memory that is available to Vim.
5396
5397 When going over the {start} limit the {inc} number specifies the
5398 amount of memory in Kbyte that can be allocated before another
5399 compression is done. A low number means compression is done after
5400 less words are added, which is slow. A high number means more memory
5401 will be allocated.
5402
5403 After doing compression, {added} times 1024 words can be added before
5404 the {inc} limit is ignored and compression is done when any extra
5405 amount of memory is needed. A low number means there is a smaller
5406 chance of hitting the {inc} limit, less memory is used but it's
5407 slower.
5408
5409 The languages for which these numbers are important are Italian and
5410 Hungarian. The default works for when you have about 512 Mbyte. If
5411 you have 1 Gbyte you could use: >
5412 :set mkspellmem=900000,3000,800
5413< If you have less than 512 Mbyte |:mkspell| may fail for some
5414 languages, no matter what you set 'mkspellmem' to.
5415
Bram Moolenaar07607392019-05-26 19:20:43 +02005416 This option cannot be set from a |modeline| or in the |sandbox|.
5417
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005419'modeline' 'ml' boolean (Vim default: on (off for root),
5420 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005421 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005422 If 'modeline' is on 'modelines' gives the number of lines that is
5423 checked for set commands. If 'modeline' is off or 'modelines' is zero
5424 no lines are checked. See |modeline|.
5425
5426 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5427'modelineexpr' 'mle' boolean (default: off)
5428 global
5429 When on allow some options that are an expression to be set in the
5430 modeline. Check the option for whether it is affected by
5431 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005432 This option cannot be set from a |modeline| or in the |sandbox|, for
5433 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005434
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435 *'modelines'* *'mls'*
5436'modelines' 'mls' number (default 5)
5437 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005438 If 'modeline' is on 'modelines' gives the number of lines that is
5439 checked for set commands. If 'modeline' is off or 'modelines' is zero
5440 no lines are checked. See |modeline|.
5441 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5442 set and to the Vim default value when 'compatible' is reset.
5443
5444 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005445 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446'modifiable' 'ma' boolean (default on)
5447 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448 When off the buffer contents cannot be changed. The 'fileformat' and
5449 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005450 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451
5452 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5453'modified' 'mod' boolean (default off)
5454 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455 When on, the buffer is considered to be modified. This option is set
5456 when:
5457 1. A change was made to the text since it was last written. Using the
5458 |undo| command to go back to the original text will reset the
5459 option. But undoing changes that were made before writing the
5460 buffer will set the option again, since the text is different from
5461 when it was written.
5462 2. 'fileformat' or 'fileencoding' is different from its original
5463 value. The original value is set when the buffer is read or
5464 written. A ":set nomodified" command also resets the original
5465 values to the current values and the 'modified' option will be
5466 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005467 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005468 This option is not set when a change is made to the buffer as the
5469 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5470 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5471 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005472 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5473 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005474 Note that the text may actually be the same, e.g. 'modified' is set
5475 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476
5477 *'more'* *'nomore'*
5478'more' boolean (Vim default: on, Vi default: off)
5479 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480 When on, listings pause when the whole screen is filled. You will get
5481 the |more-prompt|. When this option is off there are no pauses, the
5482 listing continues until finished.
5483 NOTE: This option is set to the Vi default value when 'compatible' is
5484 set and to the Vim default value when 'compatible' is reset.
5485
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005486 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005487'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005488 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005490 Enable the use of the mouse. Works for most terminals (xterm, Win32
5491 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5492 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5493 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005494 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495 v Visual mode
5496 i Insert mode
5497 c Command-line mode
5498 h all previous modes when editing a help file
5499 a all previous modes
5500 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005501 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005502 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005503< If your terminal can't overrule the mouse events going to the
5504 application, use: >
5505 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005506< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005507 back to Vim using the mouse events.
5508 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5509 "xterm".
5510
5511 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512 modeless selection. This doesn't move the text cursor.
5513
5514 See |mouse-using|. Also see |'clipboard'|.
5515
5516 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005517 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005518 the mouse buttons can still be used by keeping the shift key pressed.
5519 Also see the 'clipboard' option.
5520
5521 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5522'mousefocus' 'mousef' boolean (default off)
5523 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 {only works in the GUI}
5525 The window that the mouse pointer is on is automatically activated.
5526 When changing the window layout or window focus in another way, the
5527 mouse pointer is moved to the window with keyboard focus. Off is the
5528 default because it makes using the pull down menus a little goofy, as
5529 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005530 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005531 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532
5533 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5534'mousehide' 'mh' boolean (default on)
5535 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005536 {only works in the GUI}
5537 When on, the mouse pointer is hidden when characters are typed.
5538 The mouse pointer is restored when the mouse is moved.
5539
5540 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005541'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005542 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543 Sets the model to use for the mouse. The name mostly specifies what
5544 the right mouse button is used for:
5545 extend Right mouse button extends a selection. This works
5546 like in an xterm.
5547 popup Right mouse button pops up a menu. The shifted left
5548 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005549 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005550 popup_setpos Like "popup", but the cursor will be moved to the
5551 position where the mouse was clicked, and thus the
5552 selected operation will act upon the clicked object.
5553 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005554 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005555 course, that right clicking outside a selection will
5556 end Visual mode.
5557 Overview of what button does what for each model:
5558 mouse extend popup(_setpos) ~
5559 left click place cursor place cursor
5560 left drag start selection start selection
5561 shift-left search word extend selection
5562 right click extend selection popup menu (place cursor)
5563 right drag extend selection -
5564 middle click paste paste
5565
5566 In the "popup" model the right mouse button produces a pop-up menu.
5567 You need to define this first, see |popup-menu|.
5568
5569 Note that you can further refine the meaning of buttons with mappings.
5570 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5571 selection (because that's handled in the GUI code directly).
5572
5573 The 'mousemodel' option is set by the |:behave| command.
5574
Ernie Raelc4cb5442022-04-03 15:47:28 +01005575 *'mousemoveevent'* *'mousemev'*
5576'mousemoveevent' 'mousemev' boolean (default off)
5577 global
5578 {only works in the GUI}
5579 When on, mouse move events are delivered to the input queue and are
5580 available for mapping. The default, off, avoids the mouse movement
5581 overhead except when needed. See |gui-mouse-mapping|.
5582 Warning: Setting this option can make pending mappings to be aborted
5583 when the mouse is moved.
5584 Currently only works in the GUI, may be made to work in a terminal
5585 later.
5586
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005588'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5589 vs:leftright,vd:lrsizing,m:no,
5590 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005592 {only available when compiled with the |+mouseshape|
5593 feature}
5594 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005595 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005596 like used for 'guicursor'. Each part consist of a mode/location-list
5597 and an argument-list:
5598 mode-list:shape,mode-list:shape,..
5599 The mode-list is a dash separated list of these modes/locations:
5600 In a normal window: ~
5601 n Normal mode
5602 v Visual mode
5603 ve Visual mode with 'selection' "exclusive" (same as 'v',
5604 if not specified)
5605 o Operator-pending mode
5606 i Insert mode
5607 r Replace mode
5608
5609 Others: ~
5610 c appending to the command-line
5611 ci inserting in the command-line
5612 cr replacing in the command-line
5613 m at the 'Hit ENTER' or 'More' prompts
5614 ml idem, but cursor in the last line
5615 e any mode, pointer below last window
5616 s any mode, pointer on a status line
5617 sd any mode, while dragging a status line
5618 vs any mode, pointer on a vertical separator line
5619 vd any mode, while dragging a vertical separator line
5620 a everywhere
5621
5622 The shape is one of the following:
5623 avail name looks like ~
5624 w x arrow Normal mouse pointer
5625 w x blank no pointer at all (use with care!)
5626 w x beam I-beam
5627 w x updown up-down sizing arrows
5628 w x leftright left-right sizing arrows
5629 w x busy The system's usual busy pointer
5630 w x no The system's usual 'no input' pointer
5631 x udsizing indicates up-down resizing
5632 x lrsizing indicates left-right resizing
5633 x crosshair like a big thin +
5634 x hand1 black hand
5635 x hand2 white hand
5636 x pencil what you write with
5637 x question big ?
5638 x rightup-arrow arrow pointing right-up
5639 w x up-arrow arrow pointing up
5640 x <number> any X11 pointer number (see X11/cursorfont.h)
5641
5642 The "avail" column contains a 'w' if the shape is available for Win32,
5643 x for X11.
5644 Any modes not specified or shapes not available use the normal mouse
5645 pointer.
5646
5647 Example: >
5648 :set mouseshape=s:udsizing,m:no
5649< will make the mouse turn to a sizing arrow over the status lines and
5650 indicate no input when the hit-enter prompt is displayed (since
5651 clicking the mouse has no effect in this state.)
5652
5653 *'mousetime'* *'mouset'*
5654'mousetime' 'mouset' number (default 500)
5655 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005656 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005657 time in msec between two mouse clicks for the second click to be
5658 recognized as a multi click.
5659
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005660 *'mzschemedll'*
5661'mzschemedll' string (default depends on the build)
5662 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005663 {only available when compiled with the |+mzscheme/dyn|
5664 feature}
5665 Specifies the name of the MzScheme shared library. The default is
5666 DYNAMIC_MZSCH_DLL which was specified at compile time.
5667 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005668 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005669 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005670 This option cannot be set from a |modeline| or in the |sandbox|, for
5671 security reasons.
5672
5673 *'mzschemegcdll'*
5674'mzschemegcdll' string (default depends on the build)
5675 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005676 {only available when compiled with the |+mzscheme/dyn|
5677 feature}
5678 Specifies the name of the MzScheme GC shared library. The default is
5679 DYNAMIC_MZGC_DLL which was specified at compile time.
5680 The value can be equal to 'mzschemedll' if it includes the GC code.
5681 Environment variables are expanded |:set_env|.
5682 This option cannot be set from a |modeline| or in the |sandbox|, for
5683 security reasons.
5684
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005685 *'mzquantum'* *'mzq'*
5686'mzquantum' 'mzq' number (default 100)
5687 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005688 {not available when compiled without the |+mzscheme|
5689 feature}
5690 The number of milliseconds between polls for MzScheme threads.
5691 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005692 NOTE: This option is set to the Vim default value when 'compatible'
5693 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005694
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005696'nrformats' 'nf' string (default "bin,octal,hex",
5697 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 This defines what bases Vim will consider for numbers when using the
5700 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5701 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005702 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005704 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005705 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005707 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708 considered to be hexadecimal. Example: Using CTRL-X on
5709 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005710 bin If included, numbers starting with "0b" or "0B" will be
5711 considered to be binary. Example: Using CTRL-X on
5712 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005713 unsigned If included, numbers are recognized as unsigned. Thus a
5714 leading dash or negative sign won't be considered as part of
5715 the number. Examples:
5716 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5717 (without "unsigned" it would become "9-2021").
5718 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5719 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005720 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5721 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 Numbers which simply begin with a digit in the range 1-9 are always
5723 considered decimal. This also happens for numbers that are not
5724 recognized as octal or hex.
5725
5726 *'number'* *'nu'* *'nonumber'* *'nonu'*
5727'number' 'nu' boolean (default off)
5728 local to window
5729 Print the line number in front of each line. When the 'n' option is
5730 excluded from 'cpoptions' a wrapped line will not use the column of
5731 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005732 The 'numberwidth' option can be used to set the room used for the line
5733 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 When a long, wrapped line doesn't start with the first character, '-'
5735 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005736 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5737 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005738 *number_relativenumber*
5739 The 'relativenumber' option changes the displayed number to be
5740 relative to the cursor. Together with 'number' there are these
5741 four combinations (cursor in line 3):
5742
Bram Moolenaar3848e002016-03-19 18:42:29 +01005743 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005744 'nornu' 'nornu' 'rnu' 'rnu'
5745
5746 |apple | 1 apple | 2 apple | 2 apple
5747 |pear | 2 pear | 1 pear | 1 pear
5748 |nobody | 3 nobody | 0 nobody |3 nobody
5749 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005751 *'numberwidth'* *'nuw'*
5752'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5753 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005754 {only available when compiled with the |+linebreak|
5755 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005756 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005757 when the 'number' or 'relativenumber' option is set or printing lines
5758 with a line number. Since one space is always between the number and
5759 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005760 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005761 fit the highest line number in the buffer respectively the number of
5762 rows in the window, depending on whether 'number' or 'relativenumber'
5763 is set. Thus with the Vim default of 4 there is room for a line number
5764 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005765 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005766 NOTE: This option is set to the Vi default value when 'compatible' is
5767 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005768
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005769 *'omnifunc'* *'ofu'*
5770'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005771 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005772 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005773 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005774 This option specifies a function to be used for Insert mode omni
5775 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005776 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005777 invoked and what it should return. The value can be the name of a
5778 function, a |lambda| or a |Funcref|. See |option-value-function| for
5779 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005780 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005781 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005782 This option cannot be set from a |modeline| or in the |sandbox|, for
5783 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005784
5785
Bram Moolenaar02467872007-05-06 13:22:01 +00005786 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005787'opendevice' 'odev' boolean (default off)
5788 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005789 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005790 Enable reading and writing from devices. This may get Vim stuck on a
5791 device that can be opened but doesn't actually do the I/O. Therefore
5792 it is off by default.
5793 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5794 result in editing a device.
5795
5796
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005797 *'operatorfunc'* *'opfunc'*
5798'operatorfunc' 'opfunc' string (default: empty)
5799 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005800 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005801 See |:map-operator| for more info and an example. The value can be
5802 the name of a function, a |lambda| or a |Funcref|. See
5803 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005804
5805 This option cannot be set from a |modeline| or in the |sandbox|, for
5806 security reasons.
5807
5808
Bram Moolenaar251e1912011-06-19 05:09:16 +02005809 *'osfiletype'* *'oft'*
5810'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005811 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005812 This option was supported on RISC OS, which has been removed.
5813
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005815 *'packpath'* *'pp'*
5816'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005817 Directories used to find packages. See |packages|.
5818
5819
Bram Moolenaar071d4272004-06-13 20:20:40 +00005820 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005821'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005822 global
5823 Specifies the nroff macros that separate paragraphs. These are pairs
5824 of two letters (see |object-motions|).
5825
5826 *'paste'* *'nopaste'*
5827'paste' boolean (default off)
5828 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005829 Put Vim in Paste mode. This is useful if you want to cut or copy
5830 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831 unexpected effects.
5832 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005833 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005834 knows about pasting and will mostly do the right thing without 'paste'
5835 being set. The same is true for a terminal where Vim handles the
5836 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005837 This option is reset when starting the GUI. Thus if you set it in
5838 your .vimrc it will work in a terminal, but not in the GUI. Setting
5839 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5840 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841 When the 'paste' option is switched on (also when it was already on):
5842 - mapping in Insert mode and Command-line mode is disabled
5843 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005844 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005845 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005846 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005847 - 'revins' is reset
5848 - 'ruler' is reset
5849 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005850 - 'smarttab' is reset
5851 - 'softtabstop' is set to 0
5852 - 'textwidth' is set to 0
5853 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005854 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005855 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005857 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005858 - 'indentexpr'
5859 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005860 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861 NOTE: When you start editing another file while the 'paste' option is
5862 on, settings from the modelines or autocommands may change the
5863 settings again, causing trouble when pasting text. You might want to
5864 set the 'paste' option again.
5865 When the 'paste' option is reset the mentioned options are restored to
5866 the value before the moment 'paste' was switched from off to on.
5867 Resetting 'paste' before ever setting it does not have any effect.
5868 Since mapping doesn't work while 'paste' is active, you need to use
5869 the 'pastetoggle' option to toggle the 'paste' option with some key.
5870
5871 *'pastetoggle'* *'pt'*
5872'pastetoggle' 'pt' string (default "")
5873 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874 When non-empty, specifies the key sequence that toggles the 'paste'
5875 option. This is like specifying a mapping: >
5876 :map {keys} :set invpaste<CR>
5877< Where {keys} is the value of 'pastetoggle'.
5878 The difference is that it will work even when 'paste' is set.
5879 'pastetoggle' works in Insert mode and Normal mode, but not in
5880 Command-line mode.
5881 Mappings are checked first, thus overrule 'pastetoggle'. However,
5882 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5883 this: >
5884 :map <F10> :set paste<CR>
5885 :map <F11> :set nopaste<CR>
5886 :imap <F10> <C-O>:set paste<CR>
5887 :imap <F11> <nop>
5888 :set pastetoggle=<F11>
5889< This will make <F10> start paste mode and <F11> stop paste mode.
5890 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5891 mode everything is inserted literally, except the 'pastetoggle' key
5892 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005893 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894
5895 *'pex'* *'patchexpr'*
5896'patchexpr' 'pex' string (default "")
5897 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005898 {not available when compiled without the |+diff|
5899 feature}
5900 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005901 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902
Bram Moolenaardbc28022014-07-26 13:40:44 +02005903 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904'patchmode' 'pm' string (default "")
5905 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005906 When non-empty the oldest version of a file is kept. This can be used
5907 to keep the original version of a file if you are changing files in a
5908 source distribution. Only the first time that a file is written a
5909 copy of the original file will be kept. The name of the copy is the
5910 name of the original file with the string in the 'patchmode' option
5911 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005912 ".orig" or ".org". 'backupdir' must not be empty for this to work
5913 (Detail: The backup file is renamed to the patchmode file after the
5914 new file has been successfully written, that's why it must be possible
5915 to write a backup file). If there was no file to be backed up, an
5916 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917 When the 'backupskip' pattern matches, a patchmode file is not made.
5918 Using 'patchmode' for compressed files appends the extension at the
5919 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5920 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005921 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005922
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005923 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005924'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 other systems: ".,,")
5926 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005928 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5929 provided that the file being searched for has a relative path (not
5930 starting with "/", "./" or "../"). The directories in the 'path'
5931 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005932 - Use commas to separate directory names: >
5933 :set path=.,/usr/local/include,/usr/include
5934< - Spaces can also be used to separate directory names (for backwards
5935 compatibility with version 3.0). To have a space in a directory
5936 name, precede it with an extra backslash, and escape the space: >
5937 :set path=.,/dir/with\\\ space
5938< - To include a comma in a directory name precede it with an extra
5939 backslash: >
5940 :set path=.,/dir/with\\,comma
5941< - To search relative to the directory of the current file, use: >
5942 :set path=.
5943< - To search in the current directory use an empty string between two
5944 commas: >
5945 :set path=,,
5946< - A directory name may end in a ':' or '/'.
5947 - Environment variables are expanded |:set_env|.
5948 - When using |netrw.vim| URLs can be used. For example, adding
5949 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005950 - Search upwards and downwards in a directory tree using "*", "**" and
5951 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005952 {not available when compiled without the |+path_extra| feature}
5953 - Careful with '\' characters, type two to get one in the option: >
5954 :set path=.,c:\\include
5955< Or just use '/' instead: >
5956 :set path=.,c:/include
5957< Don't forget "." or files won't even be found in the same directory as
5958 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005959 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005960 it is something like 256 or 1024 characters.
5961 You can check if all the include files are found, using the value of
5962 'path', see |:checkpath|.
5963 The use of |:set+=| and |:set-=| is preferred when adding or removing
5964 directories from the list. This avoids problems when a future version
5965 uses another default. To remove the current directory use: >
5966 :set path-=
5967< To add the current directory use: >
5968 :set path+=
5969< To use an environment variable, you probably need to replace the
5970 separator. Here is an example to append $INCL, in which directory
5971 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005972 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005973< Replace the ';' with a ':' or whatever separator is used. Note that
5974 this doesn't work when $INCL contains a comma or white space.
5975
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005976 *'perldll'*
5977'perldll' string (default depends on the build)
5978 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005979 {only available when compiled with the |+perl/dyn|
5980 feature}
5981 Specifies the name of the Perl shared library. The default is
5982 DYNAMIC_PERL_DLL, which was specified at compile time.
5983 Environment variables are expanded |:set_env|.
5984 This option cannot be set from a |modeline| or in the |sandbox|, for
5985 security reasons.
5986
Bram Moolenaar071d4272004-06-13 20:20:40 +00005987 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5988'preserveindent' 'pi' boolean (default off)
5989 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005990 When changing the indent of the current line, preserve as much of the
5991 indent structure as possible. Normally the indent is replaced by a
5992 series of tabs followed by spaces as required (unless |'expandtab'| is
5993 enabled, in which case only spaces are used). Enabling this option
5994 means the indent will preserve as many existing characters as possible
5995 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005996 'expandtab' does not apply to the preserved white space, a Tab remains
5997 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005998 NOTE: When using ">>" multiple times the resulting indent is a mix of
5999 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006000 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001 Also see 'copyindent'.
6002 Use |:retab| to clean up white space.
6003
6004 *'previewheight'* *'pvh'*
6005'previewheight' 'pvh' number (default 12)
6006 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006007 {not available when compiled without the |+quickfix|
6008 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006010 commands. Used for |CTRL-W_}| when no count is given. Not used when
6011 'previewpopup' is set.
6012
6013 *'previewpopup'* *'pvp'*
6014'previewpopup' 'pvp' string (default empty)
6015 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006016 {not available when compiled without the |+textprop|
6017 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006018 When not empty a popup window is used for commands that would open a
6019 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006020 Not used for the insert completion info, add "popup" to
6021 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006022
6023 *'previewwindow'* *'nopreviewwindow'*
6024 *'pvw'* *'nopvw'* *E590*
6025'previewwindow' 'pvw' boolean (default off)
6026 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006027 {not available when compiled without the |+quickfix|
6028 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006029 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006030 set. It's normally not set directly, but by using one of the commands
6031 |:ptag|, |:pedit|, etc.
6032
6033 *'printdevice'* *'pdev'*
6034'printdevice' 'pdev' string (default empty)
6035 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036 {only available when compiled with the |+printer|
6037 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006038 The name of the printer to be used for |:hardcopy|.
6039 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006040 This option cannot be set from a |modeline| or in the |sandbox|, for
6041 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042
Bram Moolenaar8299df92004-07-10 09:47:34 +00006043 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006044'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046 {only available when compiled with the |+printer|
6047 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006048 Sets the character encoding used when printing.
6049 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050
6051 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006052'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006053 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054 {only available when compiled with the |+printer|
6055 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006056 Expression used to print the PostScript produced with |:hardcopy|.
6057 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006058 This option cannot be set from a |modeline| or in the |sandbox|, for
6059 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006060
Bram Moolenaar8299df92004-07-10 09:47:34 +00006061 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006062'printfont' 'pfn' string (default "courier")
6063 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006064 {only available when compiled with the |+printer|
6065 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006066 The name of the font that will be used for |:hardcopy|.
6067 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006068
6069 *'printheader'* *'pheader'*
6070'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006072 {only available when compiled with the |+printer|
6073 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006074 The format of the header produced in |:hardcopy| output.
6075 See |pheader-option|.
6076
6077 *'printmbcharset'* *'pmbcs'*
6078'printmbcharset' 'pmbcs' string (default "")
6079 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006080 {only available when compiled with the |+printer|
6081 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006082 The CJK character set to be used for CJK output from |:hardcopy|.
6083 See |pmbcs-option|.
6084
6085 *'printmbfont'* *'pmbfn'*
6086'printmbfont' 'pmbfn' string (default "")
6087 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006088 {only available when compiled with the |+printer|
6089 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006090 List of font names to be used for CJK output from |:hardcopy|.
6091 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006092
6093 *'printoptions'* *'popt'*
6094'printoptions' 'popt' string (default "")
6095 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006097 List of items that control the format of the output of |:hardcopy|.
6098 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006099
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006100 *'prompt'* *'noprompt'*
6101'prompt' boolean (default on)
6102 global
6103 When on a ":" prompt is used in Ex mode.
6104
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006105 *'pumheight'* *'ph'*
6106'pumheight' 'ph' number (default 0)
6107 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006108 Determines the maximum number of items to show in the popup menu for
6109 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006110 |ins-completion-menu|.
6111
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006112 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006113'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006114 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006115 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006116 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006117
Bram Moolenaard94464e2015-11-02 15:28:18 +01006118 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006119'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006120 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006121 {only available when compiled with the |+python/dyn|
6122 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006123 Specifies the name of the Python 2.x shared library. The default is
6124 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006125 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006126 This option cannot be set from a |modeline| or in the |sandbox|, for
6127 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006128
Bram Moolenaar94073162018-01-31 21:49:05 +01006129 *'pythonhome'*
6130'pythonhome' string (default "")
6131 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006132 {only available when compiled with the |+python/dyn|
6133 feature}
6134 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6135 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6136 which was specified at compile time, will be used for the Python 2.x
6137 home directory.
6138 Environment variables are expanded |:set_env|.
6139 This option cannot be set from a |modeline| or in the |sandbox|, for
6140 security reasons.
6141
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006142 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006143'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006144 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006145 {only available when compiled with the |+python3/dyn|
6146 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006147 Specifies the name of the Python 3 shared library. The default is
6148 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006149 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006150 This option cannot be set from a |modeline| or in the |sandbox|, for
6151 security reasons.
6152
Bram Moolenaar94073162018-01-31 21:49:05 +01006153 *'pythonthreehome'*
6154'pythonthreehome' string (default "")
6155 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006156 {only available when compiled with the |+python3/dyn|
6157 feature}
6158 Specifies the name of the Python 3 home directory. When
6159 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6160 PYTHON3_HOME, which was specified at compile time, will be used for
6161 the Python 3 home directory.
6162 Environment variables are expanded |:set_env|.
6163 This option cannot be set from a |modeline| or in the |sandbox|, for
6164 security reasons.
6165
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006166 *'pyxversion'* *'pyx'*
6167'pyxversion' 'pyx' number (default depends on the build)
6168 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006169 {only available when compiled with the |+python| or
6170 the |+python3| feature}
6171 Specifies the python version used for pyx* functions and commands
6172 |python_x|. The default value is as follows:
6173
6174 Compiled with Default ~
6175 |+python| and |+python3| 0
6176 only |+python| 2
6177 only |+python3| 3
6178
6179 Available values are 0, 2 and 3.
6180 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6181 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6182 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6183 to 2 if Python 2 is available.
6184 See also: |has-pythonx|
6185
6186 If Vim is compiled with only |+python| or |+python3| setting
6187 'pyxversion' has no effect. The pyx* functions and commands are
6188 always the same as the compiled version.
6189
6190 This option cannot be set from a |modeline| or in the |sandbox|, for
6191 security reasons.
6192
Bram Moolenaar858ba062020-05-31 23:11:59 +02006193 *'quickfixtextfunc'* *'qftf'*
6194'quickfixtextfunc' 'qftf' string (default "")
6195 global
6196 {only available when compiled with the |+quickfix|
6197 feature}
6198 This option specifies a function to be used to get the text to display
6199 in the quickfix and location list windows. This can be used to
6200 customize the information displayed in the quickfix or location window
6201 for each entry in the corresponding quickfix or location list. See
6202 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006203 function and an example. The value can be the name of a function, a
6204 |lambda| or a |Funcref|. See |option-value-function| for more
6205 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006206
6207 This option cannot be set from a |modeline| or in the |sandbox|, for
6208 security reasons.
6209
Bram Moolenaar677ee682005-01-27 14:41:15 +00006210 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006211'quoteescape' 'qe' string (default "\")
6212 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006213 The characters that are used to escape quotes in a string. Used for
6214 objects like a', a" and a` |a'|.
6215 When one of the characters in this option is found inside a string,
6216 the following character will be skipped. The default value makes the
6217 text "foo\"bar\\" considered to be one string.
6218
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6220'readonly' 'ro' boolean (default off)
6221 local to buffer
6222 If on, writes fail unless you use a '!'. Protects you from
6223 accidentally overwriting a file. Default on when Vim is started
6224 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006225 When using ":w!" the 'readonly' option is reset for the current
6226 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006227 When using the ":view" command the 'readonly' option is set for the
6228 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006229 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006230
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006231 *'redrawtime'* *'rdt'*
6232'redrawtime' 'rdt' number (default 2000)
6233 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006234 {only available when compiled with the |+reltime|
6235 feature}
6236 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006237 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006238 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006239 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006240 matches will be highlighted.
6241 For syntax highlighting the time applies per window. When over the
6242 limit syntax highlighting is disabled until |CTRL-L| is used.
6243 This is used to avoid that Vim hangs when using a very complicated
6244 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006245
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006246 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006247'regexpengine' 're' number (default 0)
6248 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006249 This selects the default regexp engine. |two-engines|
6250 The possible values are:
6251 0 automatic selection
6252 1 old engine
6253 2 NFA engine
6254 Note that when using the NFA engine and the pattern contains something
6255 that is not supported the pattern will not match. This is only useful
6256 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006257 Using automatic selection enables Vim to switch the engine, if the
6258 default engine becomes too costly. E.g., when the NFA engine uses too
6259 many states. This should prevent Vim from hanging on a combination of
6260 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006261
Bram Moolenaar64486672010-05-16 15:46:46 +02006262 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6263'relativenumber' 'rnu' boolean (default off)
6264 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006265 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006266 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006267 precede some vertical motion commands (e.g. j k + -) with, without
6268 having to calculate it yourself. Especially useful in combination with
6269 other commands (e.g. y d c < > gq gw =).
6270 When the 'n' option is excluded from 'cpoptions' a wrapped
6271 line will not use the column of line numbers (this is the default when
6272 'compatible' isn't set).
6273 The 'numberwidth' option can be used to set the room used for the line
6274 number.
6275 When a long, wrapped line doesn't start with the first character, '-'
6276 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006277 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6278 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006279
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006280 The number in front of the cursor line also depends on the value of
6281 'number', see |number_relativenumber| for all combinations of the two
6282 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006283
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284 *'remap'* *'noremap'*
6285'remap' boolean (default on)
6286 global
6287 Allows for mappings to work recursively. If you do not want this for
6288 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006289 NOTE: To avoid portability problems with Vim scripts, always keep
6290 this option at the default "on". Only switch it off when working with
6291 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006292
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006293 *'renderoptions'* *'rop'*
6294'renderoptions' 'rop' string (default: empty)
6295 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006296 {only available when compiled with GUI and DIRECTX on
6297 MS-Windows}
6298 Select a text renderer and set its options. The options depend on the
6299 renderer.
6300
6301 Syntax: >
6302 set rop=type:{renderer}(,{name}:{value})*
6303<
6304 Currently, only one optional renderer is available.
6305
6306 render behavior ~
6307 directx Vim will draw text using DirectX (DirectWrite). It makes
6308 drawn glyphs more beautiful than default GDI.
6309 It requires 'encoding' is "utf-8", and only works on
6310 MS-Windows Vista or newer version.
6311
6312 Options:
6313 name meaning type value ~
6314 gamma gamma float 1.0 - 2.2 (maybe)
6315 contrast enhancedContrast float (unknown)
6316 level clearTypeLevel float (unknown)
6317 geom pixelGeometry int 0 - 2 (see below)
6318 renmode renderingMode int 0 - 6 (see below)
6319 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006320 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006321
Bram Moolenaar92467d32017-12-05 13:22:16 +01006322 See this URL for detail (except for scrlines):
6323 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006324
6325 For geom: structure of a device pixel.
6326 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6327 1 - DWRITE_PIXEL_GEOMETRY_RGB
6328 2 - DWRITE_PIXEL_GEOMETRY_BGR
6329
6330 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006331 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006332
6333 For renmode: method of rendering glyphs.
6334 0 - DWRITE_RENDERING_MODE_DEFAULT
6335 1 - DWRITE_RENDERING_MODE_ALIASED
6336 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6337 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6338 4 - DWRITE_RENDERING_MODE_NATURAL
6339 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6340 6 - DWRITE_RENDERING_MODE_OUTLINE
6341
6342 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006343 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006344
6345 For taamode: antialiasing mode used for drawing text.
6346 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6347 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6348 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6349 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6350
6351 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006352 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6353
Bram Moolenaara338adc2018-01-31 20:51:47 +01006354 For scrlines:
6355 This was used for optimizing scrolling behavior, however this
6356 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006357
6358 Example: >
6359 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006360 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006361 set rop=type:directx
6362<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006363 If select a raster font (Courier, Terminal or FixedSys which
6364 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006365 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006366
6367 NOTE: It is known that some fonts and options combination
6368 causes trouble on drawing glyphs.
6369
Bram Moolenaar92467d32017-12-05 13:22:16 +01006370 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006371 special made fonts (True-Type fonts which includes only
6372 bitmap glyphs).
6373 - 'taamode:3' will not work with some vector fonts.
6374
6375 NOTE: With this option, you can display colored emoji
6376 (emoticon) in Windows 8.1 or later. To display colored emoji,
6377 there are some conditions which you should notice.
6378
6379 - If your font includes non-colored emoji already, it will
6380 be used.
6381 - If your font doesn't have emoji, the system chooses an
6382 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6383 will be used.
6384 - When this alternative font didn't have fixed width glyph,
6385 emoji might be rendered beyond the bounding box of drawing
6386 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006387
6388 Other render types are currently not supported.
6389
Bram Moolenaar071d4272004-06-13 20:20:40 +00006390 *'report'*
6391'report' number (default 2)
6392 global
6393 Threshold for reporting number of lines changed. When the number of
6394 changed lines is more than 'report' a message will be given for most
6395 ":" commands. If you want it always, set 'report' to 0.
6396 For the ":substitute" command the number of substitutions is used
6397 instead of the number of lines.
6398
6399 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6400'restorescreen' 'rs' boolean (default on)
6401 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006402 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006403 When set, the screen contents is restored when exiting Vim. This also
6404 happens when executing external commands.
6405
6406 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6407 options in your .vimrc. To disable restoring:
6408 set t_ti= t_te=
6409 To enable restoring (for an xterm):
6410 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6411 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6412
6413 *'revins'* *'ri'* *'norevins'* *'nori'*
6414'revins' 'ri' boolean (default off)
6415 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416 {only available when compiled with the |+rightleft|
6417 feature}
6418 Inserting characters in Insert mode will work backwards. See "typing
6419 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6420 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006421 NOTE: This option is reset when 'compatible' is set.
6422 This option is reset when 'paste' is set and restored when 'paste' is
6423 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006424
6425 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6426'rightleft' 'rl' boolean (default off)
6427 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006428 {only available when compiled with the |+rightleft|
6429 feature}
6430 When on, display orientation becomes right-to-left, i.e., characters
6431 that are stored in the file appear from the right to the left.
6432 Using this option, it is possible to edit files for languages that
6433 are written from the right to the left such as Hebrew and Arabic.
6434 This option is per window, so it is possible to edit mixed files
6435 simultaneously, or to view the same file in both ways (this is
6436 useful whenever you have a mixed text file with both right-to-left
6437 and left-to-right strings so that both sets are displayed properly
6438 in different windows). Also see |rileft.txt|.
6439
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006440 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441'rightleftcmd' 'rlc' string (default "search")
6442 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443 {only available when compiled with the |+rightleft|
6444 feature}
6445 Each word in this option enables the command line editing to work in
6446 right-to-left mode for a group of commands:
6447
6448 search "/" and "?" commands
6449
6450 This is useful for languages such as Hebrew, Arabic and Farsi.
6451 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6452
Bram Moolenaard94464e2015-11-02 15:28:18 +01006453 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006454'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006455 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006456 {only available when compiled with the |+ruby/dyn|
6457 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006458 Specifies the name of the Ruby shared library. The default is
6459 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006460 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006461 This option cannot be set from a |modeline| or in the |sandbox|, for
6462 security reasons.
6463
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006465'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006466 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 {not available when compiled without the
6468 |+cmdline_info| feature}
6469 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006470 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006471 text in the file is shown on the far right:
6472 Top first line is visible
6473 Bot last line is visible
6474 All first and last line are visible
6475 45% relative position in the file
6476 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006477 Each window has its own ruler. If a window has a status line, the
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01006478 ruler is shown there. If a window doesn't have a status line and
6479 'cmdheight' is zero, the ruler is not shown. Otherwise it is shown in
6480 the last line of the screen. If the statusline is given by
6481 'statusline' (i.e. not empty), this option takes precedence over
zeertzjq75020942022-07-31 11:37:20 +01006482 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006484 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006485 the text column (byte number) and the screen column are shown,
6486 separated with a dash.
6487 For an empty line "0-1" is shown.
6488 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006489 This option is reset when 'paste' is set and restored when 'paste' is
6490 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491 If you don't want to see the ruler all the time but want to know where
6492 you are, use "g CTRL-G" |g_CTRL-G|.
6493 NOTE: This option is reset when 'compatible' is set.
6494
6495 *'rulerformat'* *'ruf'*
6496'rulerformat' 'ruf' string (default empty)
6497 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 {not available when compiled without the |+statusline|
6499 feature}
6500 When this option is not empty, it determines the content of the ruler
6501 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006502 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006503 This option cannot be set in a modeline when 'modelineexpr' is off.
6504
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505 The default ruler width is 17 characters. To make the ruler 15
6506 characters wide, put "%15(" at the start and "%)" at the end.
6507 Example: >
6508 :set rulerformat=%15(%c%V\ %p%%%)
6509<
6510 *'runtimepath'* *'rtp'* *vimfiles*
6511'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006512 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513 $VIM/vimfiles,
6514 $VIMRUNTIME,
6515 $VIM/vimfiles/after,
6516 $HOME/.vim/after"
6517 Amiga: "home:vimfiles,
6518 $VIM/vimfiles,
6519 $VIMRUNTIME,
6520 $VIM/vimfiles/after,
6521 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006522 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006523 $VIM/vimfiles,
6524 $VIMRUNTIME,
6525 $VIM/vimfiles/after,
6526 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006527 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528 $VIMRUNTIME,
6529 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006530 Haiku: "$BE_USER_SETTINGS/vim,
6531 $VIM/vimfiles,
6532 $VIMRUNTIME,
6533 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006534 $BE_USER_SETTINGS/vim/after"
6535 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 $VIM/vimfiles,
6537 $VIMRUNTIME,
6538 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006539 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541 This is a list of directories which will be searched for runtime
6542 files:
6543 filetype.vim filetypes by file name |new-filetype|
6544 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006545 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 colors/ color scheme files |:colorscheme|
6547 compiler/ compiler files |:compiler|
6548 doc/ documentation |write-local-help|
6549 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006550 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006551 indent/ indent scripts |indent-expression|
6552 keymap/ key mapping files |mbyte-keymap|
6553 lang/ menu translations |:menutrans|
6554 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006555 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556 plugin/ plugin scripts |write-plugin|
6557 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006558 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 syntax/ syntax files |mysyntaxfile|
6560 tutor/ files for vimtutor |tutor|
6561
6562 And any other file searched for with the |:runtime| command.
6563
6564 The defaults for most systems are setup to search five locations:
6565 1. In your home directory, for your personal preferences.
6566 2. In a system-wide Vim directory, for preferences from the system
6567 administrator.
6568 3. In $VIMRUNTIME, for files distributed with Vim.
6569 *after-directory*
6570 4. In the "after" directory in the system-wide Vim directory. This is
6571 for the system administrator to overrule or add to the distributed
6572 defaults (rarely needed)
6573 5. In the "after" directory in your home directory. This is for
6574 personal preferences to overrule or add to the distributed defaults
6575 or system-wide settings (rarely needed).
6576
Bram Moolenaard0796902016-09-16 20:02:31 +02006577 More entries are added when using |packages|. If it gets very long
6578 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6579 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006580
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6582 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006583 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584 wildcards.
6585 See |:runtime|.
6586 Example: >
6587 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6588< This will use the directory "~/vimruntime" first (containing your
6589 personal Vim runtime files), then "/mygroup/vim" (shared between a
6590 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6591 files).
6592 You probably should always include $VIMRUNTIME somewhere, to use the
6593 distributed runtime files. You can put a directory before $VIMRUNTIME
6594 to find files which replace a distributed runtime files. You can put
6595 a directory after $VIMRUNTIME to find files which add to distributed
6596 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006597 When Vim is started with |--clean| the home directory entries are not
6598 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 This option cannot be set from a |modeline| or in the |sandbox|, for
6600 security reasons.
6601
6602 *'scroll'* *'scr'*
6603'scroll' 'scr' number (default: half the window height)
6604 local to window
6605 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6606 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006607 changes. This may happen when enabling the |status-line| or
6608 'tabline' option after setting the 'scroll' option.
6609 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006610 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006611 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006612
6613 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6614'scrollbind' 'scb' boolean (default off)
6615 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 See also |scroll-binding|. When this option is set, the current
6617 window scrolls as other scrollbind windows (windows that also have
6618 this option set) scroll. This option is useful for viewing the
6619 differences between two versions of a file, see 'diff'.
6620 See |'scrollopt'| for options that determine how this option should be
6621 interpreted.
6622 This option is mostly reset when splitting a window to edit another
6623 file. This means that ":split | edit file" results in two windows
6624 with scroll-binding, but ":split file" does not.
6625
Bram Moolenaarae20f342019-11-05 21:09:23 +01006626 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6627'scrollfocus' 'scf' boolean (default off)
6628 global
6629 {only for MS-Windows GUI}
6630 When using the scroll wheel and this option is set, the window under
6631 the mouse pointer is scrolled. With this option off the current
6632 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006633 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006634
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 *'scrolljump'* *'sj'*
6636'scrolljump' 'sj' number (default 1)
6637 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638 Minimal number of lines to scroll when the cursor gets off the
6639 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6640 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006641 When set to a negative number from -1 to -100 this is used as the
6642 percentage of the window height. Thus -50 scrolls half the window
6643 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 NOTE: This option is set to 1 when 'compatible' is set.
6645
6646 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006647'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006648 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 Minimal number of screen lines to keep above and below the cursor.
6650 This will make some context visible around where you are working. If
6651 you set it to a very large value (999) the cursor line will always be
6652 in the middle of the window (except at the start or end of the file or
6653 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006654 After using the local value, go back the global value with one of
6655 these two: >
6656 setlocal scrolloff<
6657 setlocal scrolloff=-1
6658< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006659 NOTE: This option is set to 0 when 'compatible' is set.
6660
6661 *'scrollopt'* *'sbo'*
6662'scrollopt' 'sbo' string (default "ver,jump")
6663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006665 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6666 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 The following words are available:
6668 ver Bind vertical scrolling for 'scrollbind' windows
6669 hor Bind horizontal scrolling for 'scrollbind' windows
6670 jump Applies to the offset between two windows for vertical
6671 scrolling. This offset is the difference in the first
6672 displayed line of the bound windows. When moving
6673 around in a window, another 'scrollbind' window may
6674 reach a position before the start or after the end of
6675 the buffer. The offset is not changed though, when
6676 moving back the 'scrollbind' window will try to scroll
6677 to the desired position when possible.
6678 When now making that window the current one, two
6679 things can be done with the relative offset:
6680 1. When "jump" is not included, the relative offset is
6681 adjusted for the scroll position in the new current
6682 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006683 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 2. When "jump" is included, the other windows are
6685 scrolled to keep the same relative offset. When
6686 going back to the other window, it still uses the
6687 same relative offset.
6688 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006689 When 'diff' mode is active there always is vertical scroll binding,
6690 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006691
6692 *'sections'* *'sect'*
6693'sections' 'sect' string (default "SHNHH HUnhsh")
6694 global
6695 Specifies the nroff macros that separate sections. These are pairs of
6696 two letters (See |object-motions|). The default makes a section start
6697 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6698
6699 *'secure'* *'nosecure'* *E523*
6700'secure' boolean (default off)
6701 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 When on, ":autocmd", shell and write commands are not allowed in
6703 ".vimrc" and ".exrc" in the current directory and map commands are
6704 displayed. Switch it off only if you know that you will not run into
6705 problems, or when the 'exrc' option is off. On Unix this option is
6706 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006707 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 'secure' at the end of your ~/.vimrc then.
6709 This option cannot be set from a |modeline| or in the |sandbox|, for
6710 security reasons.
6711
6712 *'selection'* *'sel'*
6713'selection' 'sel' string (default "inclusive")
6714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 This option defines the behavior of the selection. It is only used
6716 in Visual and Select mode.
6717 Possible values:
6718 value past line inclusive ~
6719 old no yes
6720 inclusive yes yes
6721 exclusive yes no
6722 "past line" means that the cursor is allowed to be positioned one
6723 character past the line.
6724 "inclusive" means that the last character of the selection is included
6725 in an operation. For example, when "x" is used to delete the
6726 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006727 When "old" is used and 'virtualedit' allows the cursor to move past
6728 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729 Note that when "exclusive" is used and selecting from the end
6730 backwards, you cannot include the last character of a line, when
6731 starting in Normal mode and 'virtualedit' empty.
6732
6733 The 'selection' option is set by the |:behave| command.
6734
6735 *'selectmode'* *'slm'*
6736'selectmode' 'slm' string (default "")
6737 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006738 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006739 Select mode instead of Visual mode, when a selection is started.
6740 Possible values:
6741 mouse when using the mouse
6742 key when using shifted special keys
6743 cmd when using "v", "V" or CTRL-V
6744 See |Select-mode|.
6745 The 'selectmode' option is set by the |:behave| command.
6746
6747 *'sessionoptions'* *'ssop'*
6748'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006749 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006751 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752 feature}
6753 Changes the effect of the |:mksession| command. It is a comma
6754 separated list of words. Each word enables saving and restoring
6755 something:
6756 word save and restore ~
6757 blank empty windows
6758 buffers hidden and unloaded buffers, not just those in windows
6759 curdir the current directory
6760 folds manually created folds, opened/closed folds and local
6761 fold options
6762 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006763 and contain at least one lowercase letter. Only
6764 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006765 help the help window
6766 localoptions options and mappings local to a window or buffer (not
6767 global values for local options)
6768 options all options and mappings (also global values for local
6769 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006770 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006771 resize size of the Vim window: 'lines' and 'columns'
6772 sesdir the directory in which the session file is located
6773 will become the current directory (useful with
6774 projects accessed over a network from different
6775 systems)
6776 slash backslashes in file names replaced with forward
6777 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006778 tabpages all tab pages; without this only the current tab page
6779 is restored, so that you can make a session for each
6780 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006781 terminal include terminal windows where the command can be
6782 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 unix with Unix end-of-line format (single <NL>), even when
6784 on Windows or DOS
6785 winpos position of the whole Vim window
6786 winsize window sizes
6787
6788 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006789 When neither "curdir" nor "sesdir" is included, file names are stored
6790 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006791 If you leave out "options" many things won't work well after restoring
6792 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793 "slash" and "unix" are useful on Windows when sharing session files
6794 with Unix. The Unix version of Vim cannot source dos format scripts,
6795 but the Windows version of Vim can source unix format scripts.
6796
6797 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006798'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 global
6800 Name of the shell to use for ! and :! commands. When changing the
6801 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6802 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006803 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006804 See |option-backslash| about including spaces and backslashes.
6805 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006806
Bram Moolenaara2baa732022-02-04 16:09:54 +00006807 In |restricted-mode| shell commands will not be possible. This mode
6808 is used if the value of $SHELL ends in "false" or "nologin".
6809
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006810 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006811 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6813< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006814 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006815 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006816 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006818 Example with escaped space (Vim will do this when initializing the
6819 option from $SHELL): >
6820 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006821< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006822 backslashes are consumed by `:set`.
6823
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 Under MS-Windows, when the executable ends in ".com" it must be
6825 included. Thus setting the shell to "command.com" or "4dos.com"
6826 works, but "command" and "4dos" do not work for all commands (e.g.,
6827 filtering).
6828 For unknown reasons, when using "4dos.com" the current directory is
6829 changed to "C:\". To avoid this set 'shell' like this: >
6830 :set shell=command.com\ /c\ 4dos
6831< This option cannot be set from a |modeline| or in the |sandbox|, for
6832 security reasons.
6833
6834 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006835'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006836 Win32, when 'shell' contains "powershell":
6837 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006838 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006841 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6842 For MS-Windows, the default is set according to the value of 'shell',
6843 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006844 On Unix it can have more than one flag. Each white space separated
6845 part is passed as an argument to the shell command.
6846 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006847 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848 This option cannot be set from a |modeline| or in the |sandbox|, for
6849 security reasons.
6850
6851 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006852'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6853 "2>&1| tee", or
6854 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856 {not available when compiled without the |+quickfix|
6857 feature}
6858 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006859 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 including spaces and backslashes.
6861 The name of the temporary file can be represented by "%s" if necessary
6862 (the file name is appended automatically if no %s appears in the value
6863 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006864 For the Amiga the default is ">". For MS-Windows using powershell the
6865 default is "2>&1 | Out-File -Encoding default", otherwise the default
6866 is ">%s 2>&1". The output is directly saved in a file and not echoed
6867 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006868 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869 in a file and echoed to the screen. If the 'shell' option is "csh" or
6870 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006871 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006872 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6873 means that stderr is also included. Before using the 'shell' option a
6874 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006875 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6876 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 The initialization of this option is done after reading the ".vimrc"
6878 and the other initializations, so that when the 'shell' option is set
6879 there, the 'shellpipe' option changes automatically, unless it was
6880 explicitly set before.
6881 When 'shellpipe' is set to an empty string, no redirection of the
6882 ":make" output will be done. This is useful if you use a 'makeprg'
6883 that writes to 'makeef' by itself. If you want no piping, but do
6884 want to include the 'makeef', set 'shellpipe' to a single space.
6885 Don't forget to precede the space with a backslash: ":set sp=\ ".
6886 In the future pipes may be used for filtering and this option will
6887 become obsolete (at least for Unix).
6888 This option cannot be set from a |modeline| or in the |sandbox|, for
6889 security reasons.
6890
6891 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006892'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 Quoting character(s), put around the command passed to the shell, for
6895 the "!" and ":!" commands. The redirection is kept outside of the
6896 quoting. See 'shellxquote' to include the redirection. It's
6897 probably not useful to set both options.
6898 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006899 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006900 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901 This option cannot be set from a |modeline| or in the |sandbox|, for
6902 security reasons.
6903
6904 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006905'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6906 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908 String to be used to put the output of a filter command in a temporary
6909 file. See also |:!|. See |option-backslash| about including spaces
6910 and backslashes.
6911 The name of the temporary file can be represented by "%s" if necessary
6912 (the file name is appended automatically if no %s appears in the value
6913 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006914 The default is ">". For Unix, if the 'shell' option is "csh" or
6915 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006916 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006917 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6918 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006919 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6920 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006921 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6922 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923 The initialization of this option is done after reading the ".vimrc"
6924 and the other initializations, so that when the 'shell' option is set
6925 there, the 'shellredir' option changes automatically unless it was
6926 explicitly set before.
6927 In the future pipes may be used for filtering and this option will
6928 become obsolete (at least for Unix).
6929 This option cannot be set from a |modeline| or in the |sandbox|, for
6930 security reasons.
6931
6932 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6933'shellslash' 'ssl' boolean (default off)
6934 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006935 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006936 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006937 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006938 powershell.exe. Backward slashes can still be typed, but they are
6939 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 Note that setting or resetting this option has no effect for some
6941 existing file names, thus this option needs to be set before opening
6942 any file for best results. This might change in the future.
6943 'shellslash' only works when a backslash can be used as a path
6944 separator. To test if this is so use: >
6945 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006946< Also see 'completeslash'.
6947
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006948 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6949'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6950 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006951 When on, use temp files for shell commands. When off use a pipe.
6952 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006953 Currently a pipe is only supported on Unix and MS-Windows 2K and
6954 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006955 :if has("filterpipe")
6956< The advantage of using a pipe is that nobody can read the temp file
6957 and the 'shell' command does not need to support redirection.
6958 The advantage of using a temp file is that the file type and encoding
6959 can be detected.
6960 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6961 |FilterWritePost| autocommands event are not triggered when
6962 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006963 The `system()` function does not respect this option and always uses
6964 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006965 NOTE: This option is set to the Vim default value when 'compatible'
6966 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006967
Bram Moolenaar071d4272004-06-13 20:20:40 +00006968 *'shelltype'* *'st'*
6969'shelltype' 'st' number (default 0)
6970 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006971 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972 On the Amiga this option influences the way how the commands work
6973 which use a shell.
6974 0 and 1: always use the shell
6975 2 and 3: use the shell only to filter lines
6976 4 and 5: use shell only for ':sh' command
6977 When not using the shell, the command is executed directly.
6978
6979 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6980 1 and 3: use "shell cmd" to start external commands
6981
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006982 *'shellxescape'* *'sxe'*
6983'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006984 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006985 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006986 When 'shellxquote' is set to "(" then the characters listed in this
6987 option will be escaped with a '^' character. This makes it possible
6988 to execute most external commands with cmd.exe.
6989
Bram Moolenaar071d4272004-06-13 20:20:40 +00006990 *'shellxquote'* *'sxq'*
6991'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006992 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006993 for Win32, when 'shell' is
6994 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006995 for Win32, when 'shell' contains "sh"
6996 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006997 for Unix, when using system(): "\"")
6998 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999 Quoting character(s), put around the command passed to the shell, for
7000 the "!" and ":!" commands. Includes the redirection. See
7001 'shellquote' to exclude the redirection. It's probably not useful
7002 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007003 When the value is '(' then ')' is appended. When the value is '"('
7004 then ')"' is appended.
7005 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007006 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007007 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7008 pwsh.exe which automatically strips off the first and last quote on a
7009 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7010 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007011 'shell', to reduce the need to set this option by the user. See
7012 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 This option cannot be set from a |modeline| or in the |sandbox|, for
7014 security reasons.
7015
7016 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7017'shiftround' 'sr' boolean (default off)
7018 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019 Round indent to multiple of 'shiftwidth'. Applies to > and <
7020 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7021 a multiple of 'shiftwidth' (this is Vi compatible).
7022 NOTE: This option is reset when 'compatible' is set.
7023
7024 *'shiftwidth'* *'sw'*
7025'shiftwidth' 'sw' number (default 8)
7026 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007027 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007029 When zero the 'ts' value will be used. Use the |shiftwidth()|
7030 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031
7032 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007033'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7034 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007036 This option helps to avoid all the |hit-enter| prompts caused by file
7037 messages, for example with CTRL-G, and to avoid some other messages.
7038 It is a list of flags:
7039 flag meaning when present ~
7040 f use "(3 of 5)" instead of "(file 3 of 5)"
7041 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02007042 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 m use "[+]" instead of "[Modified]"
7044 n use "[New]" instead of "[New File]"
7045 r use "[RO]" instead of "[readonly]"
7046 w use "[w]" instead of "written" for file write message
7047 and "[a]" instead of "appended" for ':w >> file' command
7048 x use "[dos]" instead of "[dos format]", "[unix]" instead of
7049 "[unix format]" and "[mac]" instead of "[mac format]".
7050 a all of the above abbreviations
7051
7052 o overwrite message for writing a file with subsequent message
7053 for reading a file (useful for ":wn" or when 'autowrite' on)
7054 O message for reading a file overwrites any previous message.
7055 Also for quickfix message (e.g., ":cn").
7056 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02007057 hit TOP, continuing at BOTTOM" messages; when using the search
7058 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059 t truncate file message at the start if it is too long to fit
7060 on the command-line, "<" will appear in the left most column.
7061 Ignored in Ex mode.
7062 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00007063 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007064 Ignored in Ex mode.
7065 W don't give "written" or "[w]" when writing a file
7066 A don't give the "ATTENTION" message when an existing swap file
7067 is found.
7068 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02007069 c don't give |ins-completion-menu| messages. For example,
7070 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
7071 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01007072 q use "recording" instead of "recording @a"
7073 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02007074 was used for the command; note that this also affects messages
7075 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007076 S do not show search count message when searching, e.g.
7077 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078
7079 This gives you the opportunity to avoid that a change between buffers
7080 requires you to hit <Enter>, but still gives as useful a message as
7081 possible for the space available. To get the whole message that you
7082 would have got with 'shm' empty, use ":file!"
7083 Useful values:
7084 shm= No abbreviation of message.
7085 shm=a Abbreviation, but no loss of information.
7086 shm=at Abbreviation, and truncate message when necessary.
7087
7088 NOTE: This option is set to the Vi default value when 'compatible' is
7089 set and to the Vim default value when 'compatible' is reset.
7090
7091 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7092'shortname' 'sn' boolean (default off)
7093 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094 Filenames are assumed to be 8 characters plus one extension of 3
7095 characters. Multiple dots in file names are not allowed. When this
7096 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007097 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007098 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007099 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100
7101 *'showbreak'* *'sbr'* *E595*
7102'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007103 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007104 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 feature}
7106 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007107 values are "> " or "+++ ": >
7108 :set showbreak=>\
7109< Note the backslash to escape the trailing space. It's easier like
7110 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007111 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007112< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 comma (in a future version the comma might be used to separate the
7114 part that is shown at the end and at the start of a line).
7115 The characters are highlighted according to the '@' flag in
7116 'highlight'.
7117 Note that tabs after the showbreak will be displayed differently.
7118 If you want the 'showbreak' to appear in between line numbers, add the
7119 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007120 A window-local value overrules a global value. If the global value is
7121 set and you want no value in the current window use NONE: >
7122 :setlocal showbreak=NONE
7123<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007125'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7126 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007127 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 {not available when compiled without the
7129 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007130 Show (partial) command in the last line of the screen. Set this
7131 option off if your terminal is slow.
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01007132 The option has no effect when 'cmdheight' is zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 In Visual mode the size of the selected area is shown:
7134 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007135 If the number of bytes is different it is also displayed: "2-6"
7136 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007138 - When selecting a block, the size in screen characters:
7139 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007140 NOTE: This option is set to the Vi default value when 'compatible' is
7141 set and to the Vim default value when 'compatible' is reset.
7142
7143 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7144'showfulltag' 'sft' boolean (default off)
7145 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 When completing a word in insert mode (see |ins-completion|) from the
7147 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007148 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 matched a C function, you can see a template for what arguments are
7150 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007151 Note that this doesn't work well together with having "longest" in
7152 'completeopt', because the completion from the search pattern may not
7153 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154
7155 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7156'showmatch' 'sm' boolean (default off)
7157 global
7158 When a bracket is inserted, briefly jump to the matching one. The
7159 jump is only done if the match can be seen on the screen. The time to
7160 show the match can be set with 'matchtime'.
7161 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007162 seen or not).
7163 This option is reset when 'paste' is set and restored when 'paste' is
7164 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 When the 'm' flag is not included in 'cpoptions', typing a character
7166 will immediately move the cursor back to where it belongs.
7167 See the "sm" field in 'guicursor' for setting the cursor shape and
7168 blinking when showing the match.
7169 The 'matchpairs' option can be used to specify the characters to show
7170 matches for. 'rightleft' and 'revins' are used to look for opposite
7171 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007172 Also see the matchparen plugin for highlighting the match when moving
7173 around |pi_paren.txt|.
7174 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175
7176 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7177'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7178 global
7179 If in Insert, Replace or Visual mode put a message on the last line.
7180 Use the 'M' flag in 'highlight' to set the type of highlighting for
7181 this message.
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01007182 The option has no effect when 'cmdheight' is zero.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007183 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007184 doesn't mean XIM is really active, especially when 'imactivatekey' is
7185 not set.
7186 NOTE: This option is set to the Vi default value when 'compatible' is
7187 set and to the Vim default value when 'compatible' is reset.
7188
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007189 *'showtabline'* *'stal'*
7190'showtabline' 'stal' number (default 1)
7191 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007192 The value of this option specifies when the line with tab page labels
7193 will be displayed:
7194 0: never
7195 1: only if there are at least two tab pages
7196 2: always
7197 This is both for the GUI and non-GUI implementation of the tab pages
7198 line.
7199 See |tab-page| for more information about tab pages.
7200
Bram Moolenaar071d4272004-06-13 20:20:40 +00007201 *'sidescroll'* *'ss'*
7202'sidescroll' 'ss' number (default 0)
7203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007204 The minimal number of columns to scroll horizontally. Used only when
7205 the 'wrap' option is off and the cursor is moved off of the screen.
7206 When it is zero the cursor will be put in the middle of the screen.
7207 When using a slow terminal set it to a large number or 0. When using
7208 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7209 commands.
7210
7211 *'sidescrolloff'* *'siso'*
7212'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007213 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007214 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007215 right of the cursor if 'nowrap' is set. Setting this option to a
7216 value greater than 0 while having |'sidescroll'| also at a non-zero
7217 value makes some context visible in the line you are scrolling in
7218 horizontally (except at beginning of the line). Setting this option
7219 to a large value (like 999) has the effect of keeping the cursor
7220 horizontally centered in the window, as long as one does not come too
7221 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007222 After using the local value, go back the global value with one of
7223 these two: >
7224 setlocal sidescrolloff<
7225 setlocal sidescrolloff=-1
7226< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007227
7228 Example: Try this together with 'sidescroll' and 'listchars' as
7229 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007230 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231
7232 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7233 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007234<
7235 *'signcolumn'* *'scl'*
7236'signcolumn' 'scl' string (default "auto")
7237 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007238 {not available when compiled without the |+signs|
7239 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007240 Whether or not to draw the signcolumn. Valid values are:
7241 "auto" only when there is a sign to display
7242 "no" never
7243 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007244 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007245 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246
7247
7248 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7249'smartcase' 'scs' boolean (default off)
7250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007251 Override the 'ignorecase' option if the search pattern contains upper
7252 case characters. Only used when the search pattern is typed and
7253 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007254 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7256 recalling the search pattern from history and hitting <Enter>.
7257 NOTE: This option is reset when 'compatible' is set.
7258
7259 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7260'smartindent' 'si' boolean (default off)
7261 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007262 Do smart autoindenting when starting a new line. Works for C-like
7263 programs, but can also be used for other languages. 'cindent' does
7264 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007265 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007266 setting 'si' has no effect. 'indentexpr' is a more advanced
7267 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 Normally 'autoindent' should also be on when using 'smartindent'.
7269 An indent is automatically inserted:
7270 - After a line ending in '{'.
7271 - After a line starting with a keyword from 'cinwords'.
7272 - Before a line starting with '}' (only with the "O" command).
7273 When typing '}' as the first character in a new line, that line is
7274 given the same indent as the matching '{'.
7275 When typing '#' as the first character in a new line, the indent for
7276 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007277 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7279 When using the ">>" command, lines starting with '#' are not shifted
7280 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007281 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007282 This option is reset when 'paste' is set and restored when 'paste' is
7283 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284
7285 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7286'smarttab' 'sta' boolean (default off)
7287 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007289 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7290 <BS> will delete a 'shiftwidth' worth of space at the start of the
7291 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007292 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007293 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7294 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007295 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007297 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007298 This option is reset when 'paste' is set and restored when 'paste' is
7299 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300 NOTE: This option is reset when 'compatible' is set.
7301
7302 *'softtabstop'* *'sts'*
7303'softtabstop' 'sts' number (default 0)
7304 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007305 Number of spaces that a <Tab> counts for while performing editing
7306 operations, like inserting a <Tab> or using <BS>. It "feels" like
7307 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7308 used. This is useful to keep the 'ts' setting at its standard value
7309 of 8, while being able to edit like it is set to 'sts'. However,
7310 commands like "x" still work on the actual characters.
7311 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007312 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007313 'softtabstop' is set to 0 when the 'paste' option is set and restored
7314 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007315 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7316 spaces is minimized by using <Tab>s.
7317 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7318 set.
7319 NOTE: This option is set to 0 when 'compatible' is set.
7320
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007321 If Vim is compiled with the |+vartabs| feature then the value of
7322 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7323 anything other than an empty string.
7324
Bram Moolenaar217ad922005-03-20 22:37:15 +00007325 *'spell'* *'nospell'*
7326'spell' boolean (default off)
7327 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007328 {not available when compiled without the |+syntax|
7329 feature}
7330 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007331 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007332
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007333 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007334'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007335 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007336 {not available when compiled without the |+syntax|
7337 feature}
7338 Pattern to locate the end of a sentence. The following word will be
7339 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007340 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007341 When this check is not wanted make this option empty.
7342 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007343 Be careful with special characters, see |option-backslash| about
7344 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007345 To set this option automatically depending on the language, see
7346 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007347
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007348 *'spellfile'* *'spf'*
7349'spellfile' 'spf' string (default empty)
7350 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007351 {not available when compiled without the |+syntax|
7352 feature}
7353 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007354 commands. It must end in ".{encoding}.add". You need to include the
7355 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007356 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007357 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007358 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007359 |zg| and |zw| commands can be used to access each. This allows using
7360 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007361 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007362 you: Using the first directory in 'runtimepath' that is writable. If
7363 there is no "spell" directory yet it will be created. For the file
7364 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007365 ignoring the region.
7366 The resulting ".spl" file will be used for spell checking, it does not
7367 have to appear in 'spelllang'.
7368 Normally one file is used for all regions, but you can add the region
7369 name if you want to. However, it will then only be used when
7370 'spellfile' is set to it, for entries in 'spelllang' only files
7371 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007372 This option cannot be set from a |modeline| or in the |sandbox|, for
7373 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007374
Bram Moolenaar217ad922005-03-20 22:37:15 +00007375 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007376'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007377 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007378 {not available when compiled without the |+syntax|
7379 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007380 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007381 on spellchecking will be done for these languages. Example: >
7382 set spelllang=en_us,nl,medical
7383< This means US English, Dutch and medical words are recognized. Words
7384 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007385 The word list name must consist of alphanumeric characters, a dash or
7386 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007387 recommended to separate the two letter language name from a
7388 specification. Thus "en-rare" is used for rare English words.
7389 A region name must come last and have the form "_xx", where "xx" is
7390 the two-letter, lower case region name. You can use more than one
7391 region by listing them: "en_us,en_ca" supports both US and Canadian
7392 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007393 Britain. (Note: currently en_au and en_nz dictionaries are older than
7394 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007395 If the name "cjk" is included East Asian characters are excluded from
7396 spell checking. This is useful when editing text that also has Asian
7397 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007398 Note that the "medical" dictionary does not exist, it is just an
7399 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007400 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007401 As a special case the name of a .spl file can be given as-is. The
7402 first "_xx" in the name is removed and used as the region name
7403 (_xx is an underscore, two letters and followed by a non-letter).
7404 This is mainly for testing purposes. You must make sure the correct
7405 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007406 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007407 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7408 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007409 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007410
Bram Moolenaar98692072006-02-04 00:57:42 +00007411 If the |spellfile.vim| plugin is active and you use a language name
7412 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7413 will ask you if you want to download the file.
7414
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007415 After this option has been set successfully, Vim will source the files
7416 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007417 up to the first character that is not an ASCII letter or number and
7418 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007419
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007420 *'spelloptions'* *'spo'*
7421'spelloptions' 'spo' string (default "")
7422 local to buffer
7423 {not available when compiled without the |+syntax|
7424 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007425 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007426 camel When a word is CamelCased, assume "Cased" is a
7427 separate word: every upper-case character in a word
7428 that comes after a lower case character indicates the
7429 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007430
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007431 *'spellsuggest'* *'sps'*
7432'spellsuggest' 'sps' string (default "best")
7433 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007434 {not available when compiled without the |+syntax|
7435 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007436 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007437 the |spellsuggest()| function. This is a comma-separated list of
7438 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007439
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007440 best Internal method that works best for English. Finds
7441 changes like "fast" and uses a bit of sound-a-like
7442 scoring to improve the ordering.
7443
7444 double Internal method that uses two methods and mixes the
7445 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007446 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007447 word. That only works when the language specifies
7448 sound folding. Can be slow and doesn't always give
7449 better results.
7450
7451 fast Internal method that only checks for simple changes:
7452 character inserts/deletes/swaps. Works well for
7453 simple typing mistakes.
7454
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007455 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007456 Not used for |spellsuggest()|. The number of
7457 suggestions is never more than the value of 'lines'
7458 minus two.
7459
Bram Moolenaar585ee072022-01-29 11:22:17 +00007460 timeout:{millisec} Limit the time searching for suggestions to
7461 {millisec} milli seconds. Applies to the following
7462 methods. When omitted the limit is 5000. When
7463 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007464 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007465
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007466 file:{filename} Read file {filename}, which must have two columns,
7467 separated by a slash. The first column contains the
7468 bad word, the second column the suggested good word.
7469 Example:
7470 theribal/terrible ~
7471 Use this for common mistakes that do not appear at the
7472 top of the suggestion list with the internal methods.
7473 Lines without a slash are ignored, use this for
7474 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007475 The word in the second column must be correct,
7476 otherwise it will not be used. Add the word to an
7477 ".add" file if it is currently flagged as a spelling
7478 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007479 The file is used for all languages.
7480
7481 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7482 trouble with spaces. |v:val| holds the badly spelled
7483 word. The expression must evaluate to a List of
7484 Lists, each with a suggestion and a score.
7485 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007486 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007487 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007488 internal methods use. A lower score is better.
7489 This may invoke |spellsuggest()| if you temporarily
7490 set 'spellsuggest' to exclude the "expr:" part.
7491 Errors are silently ignored, unless you set the
7492 'verbose' option to a non-zero value.
7493
7494 Only one of "best", "double" or "fast" may be used. The others may
7495 appear several times in any order. Example: >
7496 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7497<
7498 This option cannot be set from a |modeline| or in the |sandbox|, for
7499 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007500
7501
Bram Moolenaar071d4272004-06-13 20:20:40 +00007502 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7503'splitbelow' 'sb' boolean (default off)
7504 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 When on, splitting a window will put the new window below the current
7506 one. |:split|
7507
7508 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7509'splitright' 'spr' boolean (default off)
7510 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511 When on, splitting a window will put the new window right of the
7512 current one. |:vsplit|
7513
7514 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7515'startofline' 'sol' boolean (default on)
7516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007518 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007519 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007520 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007521 with a linewise operator, with "%" with a count and to buffer changing
7522 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7523 only has a line number, e.g., ":25" or ":+".
7524 In case of buffer changing commands the cursor is placed at the column
7525 where it was the last time the buffer was edited.
7526 NOTE: This option is set when 'compatible' is set.
7527
Bram Moolenaar00654022011-02-25 14:42:19 +01007528 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007530 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 {not available when compiled without the |+statusline|
7532 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007533 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007534 Also see |status-line|.
7535
7536 The option consists of printf style '%' items interspersed with
7537 normal text. Each status line item is of the form:
7538 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007539 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007540 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007541
Bram Moolenaar238a5642006-02-21 22:12:05 +00007542 When the option starts with "%!" then it is used as an expression,
7543 evaluated and the result is used as the option value. Example: >
7544 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007545< The *g:statusline_winid* variable will be set to the |window-ID| of the
7546 window that the status line belongs to.
7547 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007548 Note that the "%!" expression is evaluated in the context of the
7549 current window and buffer, while %{} items are evaluated in the
7550 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007551
7552 When there is error while evaluating the option then it will be made
7553 empty to avoid further errors. Otherwise screen updating would loop.
7554
Bram Moolenaar071d4272004-06-13 20:20:40 +00007555 Note that the only effect of 'ruler' when this option is set (and
7556 'laststatus' is 2) is controlling the output of |CTRL-G|.
7557
7558 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007559 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007561 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 minwid Minimum width of the item, padding as set by '-' & '0'.
7563 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007564 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007565 on the left for text items. Numeric items will be
7566 shifted down to maxwid-2 digits followed by '>'number
7567 where number is the amount of missing digits, much like
7568 an exponential notation.
7569 item A one letter code as described below.
7570
7571 Following is a description of the possible statusline items. The
7572 second character in "item" is the type:
7573 N for number
7574 S for string
7575 F for flags as described below
7576 - not applicable
7577
7578 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007579 f S Path to the file in the buffer, as typed or relative to current
7580 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581 F S Full path to the file in the buffer.
7582 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007583 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007585 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007587 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007589 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007590 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007591 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007593 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007594 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7595 being used: "<keymap>"
7596 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007597 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007598 B N As above, in hexadecimal.
7599 o N Byte number in file of byte under cursor, first byte is 1.
7600 Mnemonic: Offset from start of file (with one added)
7601 {not available when compiled without |+byte_offset| feature}
7602 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007603 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007604 l N Line number.
7605 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007606 c N Column number (byte index).
7607 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007608 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609 p N Percentage through file in lines as in |CTRL-G|.
7610 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007611 percentage described for 'ruler'. Always 3 in length, unless
7612 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007613 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007615 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007616 Note that there is no '%' before the closing '}'. The
7617 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007618 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007619 {% - This is almost same as { except the result of the expression is
7620 re-evaluated as a statusline format string. Thus if the
7621 return value of expr contains % items they will get expanded.
7622 The expression can contain the } character, the end of
7623 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007624 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007625 func! Stl_filename() abort
7626 return "%t"
7627 endfunc
7628< `stl=%{Stl_filename()}` results in `"%t"`
7629 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007630 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007631 ( - Start of item group. Can be used for setting the width and
7632 alignment of a section. Must be followed by %) somewhere.
7633 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007634 T N For 'tabline': start of tab page N label. Use %T after the last
7635 label. This information is used for mouse clicks.
7636 X N For 'tabline': start of close tab N label. Use %X after the
7637 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7638 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639 < - Where to truncate line if too long. Default is at the start.
7640 No width fields allowed.
7641 = - Separation point between left and right aligned items.
7642 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007643 # - Set highlight group. The name must follow and then a # again.
7644 Thus use %#HLname# for highlight group HLname. The same
7645 highlighting is used, also for the statusline of non-current
7646 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007648 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 The difference between User{N} and StatusLine will be applied
7650 to StatusLineNC for the statusline of non-current windows.
7651 The number N must be between 1 and 9. See |hl-User1..9|
7652
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007653 When displaying a flag, Vim removes the leading comma, if any, when
7654 that flag comes right after plaintext. This will make a nice display
7655 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007656
Bram Moolenaar582fd852005-03-28 20:58:01 +00007657 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007658 not set) and a minwid is not set for the group, the whole group will
7659 become empty. This will make a group like the following disappear
7660 completely from the statusline when none of the flags are set. >
7661 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007662< Beware that an expression is evaluated each and every time the status
7663 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007664 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007665 While evaluating %{} the current buffer and current window will be set
7666 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007667 currently being drawn. The expression will evaluate in this context.
7668 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7669 real current buffer and "g:actual_curwin" to the |window-ID| of the
7670 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007671
Bram Moolenaar30b65812012-07-12 22:01:11 +02007672 The 'statusline' option will be evaluated in the |sandbox| if set from
7673 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007674 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007675
7676 It is not allowed to change text or jump to another window while
7677 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007678
7679 If the statusline is not updated when you want it (e.g., after setting
7680 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007681 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007683 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684 Otherwise the result is taken as flag text and applied to the rules
7685 described above.
7686
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007687 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007688 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007689 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690
7691 Examples:
7692 Emulate standard status line with 'ruler' set >
7693 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7694< Similar, but add ASCII value of char under the cursor (like "ga") >
7695 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7696< Display byte count and byte value, modified flag in red. >
7697 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7698 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7699< Display a ,GZ flag if a compressed file is loaded >
7700 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7701< In the |:autocmd|'s: >
7702 :let b:gzflag = 1
7703< And: >
7704 :unlet b:gzflag
7705< And define this function: >
7706 :function VarExists(var, val)
7707 : if exists(a:var) | return a:val | else | return '' | endif
7708 :endfunction
7709<
7710 *'suffixes'* *'su'*
7711'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7712 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007713 Files with these suffixes get a lower priority when multiple files
7714 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007715 suffixes. Spaces after the comma are ignored. A dot is also seen as
7716 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007717 separator, precede it with a backslash (see |option-backslash| about
7718 including spaces and backslashes).
7719 See 'wildignore' for completely ignoring files.
7720 The use of |:set+=| and |:set-=| is preferred when adding or removing
7721 suffixes from the list. This avoids problems when a future version
7722 uses another default.
7723
7724 *'suffixesadd'* *'sua'*
7725'suffixesadd' 'sua' string (default "")
7726 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007727 {not available when compiled without the
7728 |+file_in_path| feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007729 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007730 file for the "gf", "[I", etc. commands. Example: >
7731 :set suffixesadd=.java
7732<
7733 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7734'swapfile' 'swf' boolean (default on)
7735 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007736 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007737 swapfile is not wanted for a specific buffer. For example, with
7738 confidential information that even root must not be able to access.
7739 Careful: All text will be in memory:
7740 - Don't use this for big files.
7741 - Recovery will be impossible!
7742 A swapfile will only be present when |'updatecount'| is non-zero and
7743 'swapfile' is set.
7744 When 'swapfile' is reset, the swap file for the current buffer is
7745 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7746 non-zero, a swap file is immediately created.
7747 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007748 If you want to open a new buffer without creating a swap file for it,
7749 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007750 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007751
7752 This option is used together with 'bufhidden' and 'buftype' to
7753 specify special kinds of buffers. See |special-buffers|.
7754
7755 *'swapsync'* *'sws'*
7756'swapsync' 'sws' string (default "fsync")
7757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007759 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760 When this option is empty parts of the swap file may be in memory and
7761 not written to disk. When the system crashes you may lose more work.
7762 On Unix the system does a sync now and then without Vim asking for it,
7763 so the disadvantage of setting this option off is small. On some
7764 systems the swap file will not be written at all. For a unix system
7765 setting it to "sync" will use the sync() call instead of the default
7766 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007767 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768
7769 *'switchbuf'* *'swb'*
7770'switchbuf' 'swb' string (default "")
7771 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007772 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007773 Mostly for |quickfix| commands some values are also used for other
7774 commands, as mentioned below.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007775 Possible values (comma-separated list):
Bram Moolenaar071d4272004-06-13 20:20:40 +00007776 useopen If included, jump to the first open window that
7777 contains the specified buffer (if there is one).
7778 Otherwise: Do not examine other windows.
7779 This setting is checked with |quickfix| commands, when
7780 jumping to errors (":cc", ":cn", "cp", etc.). It is
7781 also used in all buffer related split commands, for
7782 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007783 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007784 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007785 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007786 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007787 Otherwise: do not split, use current window (when used
7788 in the quickfix window: the previously used window or
7789 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007790 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007791 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007792 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007793 uselast If included, jump to the previously used window when
7794 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007795
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007796 *'synmaxcol'* *'smc'*
7797'synmaxcol' 'smc' number (default 3000)
7798 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007799 {not available when compiled without the |+syntax|
7800 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007801 Maximum column in which to search for syntax items. In long lines the
7802 text after this column is not highlighted and following lines may not
7803 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007804 This helps to avoid very slow redrawing for an XML file that is one
7805 long line.
7806 Set to zero to remove the limit.
7807
Bram Moolenaar071d4272004-06-13 20:20:40 +00007808 *'syntax'* *'syn'*
7809'syntax' 'syn' string (default empty)
7810 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811 {not available when compiled without the |+syntax|
7812 feature}
7813 When this option is set, the syntax with this name is loaded, unless
7814 syntax highlighting has been switched off with ":syntax off".
7815 Otherwise this option does not always reflect the current syntax (the
7816 b:current_syntax variable does).
7817 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007818 not automatically recognized. Example, in an IDL file:
7819 /* vim: set syntax=idl : */ ~
7820 When a dot appears in the value then this separates two filetype
7821 names. Example:
7822 /* vim: set syntax=c.doxygen : */ ~
7823 This will use the "c" syntax first, then the "doxygen" syntax.
7824 Note that the second one must be prepared to be loaded as an addition,
7825 otherwise it will be skipped. More than one dot may appear.
7826 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 :set syntax=OFF
7828< To switch syntax highlighting on according to the current value of the
7829 'filetype' option: >
7830 :set syntax=ON
7831< What actually happens when setting the 'syntax' option is that the
7832 Syntax autocommand event is triggered with the value as argument.
7833 This option is not copied to another buffer, independent of the 's' or
7834 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007835 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007836
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007837 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007838'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007839 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00007840 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007841 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007842 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007843
7844 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007845 option and only when there is no GUI tab line. When 'e' is in
7846 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007847 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007848
7849 The value is evaluated like with 'statusline'. You can use
7850 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007851 the text to be displayed. Use "%1T" for the first label, "%2T" for
7852 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007853
Bram Moolenaare12bab32019-01-08 22:02:56 +01007854 When changing something that is used in 'tabline' that does not
7855 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007856 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007857
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007858 Keep in mind that only one of the tab pages is the current one, others
7859 are invisible and you can't jump to their windows.
7860
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007861
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007862 *'tabpagemax'* *'tpm'*
7863'tabpagemax' 'tpm' number (default 10)
7864 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007865 Maximum number of tab pages to be opened by the |-p| command line
7866 argument or the ":tab all" command. |tabpage|
7867
7868
7869 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007870'tabstop' 'ts' number (default 8)
7871 local to buffer
7872 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007873 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007874
7875 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007876 appear wrong in many places, e.g., when printing it.
7877 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878
7879 There are four main ways to use tabs in Vim:
7880 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7881 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007882 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 behave like a tab appears every 4 (or 3) characters.
7884 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7885 'expandtab'. This way you will always insert spaces. The
7886 formatting will never be messed up when 'tabstop' is changed.
7887 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007888 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 works when using Vim to edit the file.
7890 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7891 'noexpandtab'. This should then work (for initial indents only)
7892 for any tabstop setting that people use. It might be nice to have
7893 tabs after the first non-blank inserted as spaces if you do this
7894 though. Otherwise aligned comments will be wrong when 'tabstop' is
7895 changed.
7896
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007897 If Vim is compiled with the |+vartabs| feature then the value of
7898 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7899 than an empty string.
7900
Bram Moolenaar071d4272004-06-13 20:20:40 +00007901 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7902'tagbsearch' 'tbs' boolean (default on)
7903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007904 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007905 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007906 searching makes searching for a tag a LOT faster, but a linear search
7907 will find more tags if the tags file wasn't properly sorted.
7908 Vim normally assumes that your tags files are sorted, or indicate that
7909 they are not sorted. Only when this is not the case does the
7910 'tagbsearch' option need to be switched off.
7911
7912 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007913 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 certain files, or retry all files with a linear search. When
7915 'tagbsearch' is off, only a linear search is done.
7916
7917 Linear searching is done anyway, for one file, when Vim finds a line
7918 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007919 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007920< [The whitespace before and after the '0' must be a single <Tab>]
7921
7922 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007923 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007924 instead of a normal tag name, a retry is done with a linear search.
7925 Tags in unsorted tags files, and matches with different case will only
7926 be found in the retry.
7927
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007928 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007929 linear search can be avoided when case is ignored. Use a value of '2'
7930 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7931 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00007932 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
7933 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
7934 used for this as well. Note that case must be folded to uppercase for
7935 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007936
7937 By default, tag searches are case-sensitive. Case is ignored when
7938 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7939 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007940 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7941 'tagcase' is "smart", and the pattern contains only lowercase
7942 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007943
7944 When 'tagbsearch' is off, tags searching is slower when a full match
7945 exists, but faster when no full match exists. Tags in unsorted tags
7946 files may only be found with 'tagbsearch' off.
7947 When the tags file is not sorted, or sorted in a wrong way (not on
7948 ASCII byte value), 'tagbsearch' should be off, or the line given above
7949 must be included in the tags file.
7950 This option doesn't affect commands that find all matching tags (e.g.,
7951 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007953 *'tagcase'* *'tc'*
7954'tagcase' 'tc' string (default "followic")
7955 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007956 This option specifies how case is handled when searching the tags
7957 file:
7958 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007959 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007960 ignore Ignore case
7961 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007962 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007963 NOTE: This option is set to the Vi default value when 'compatible' is
7964 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007965
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007966 *'tagfunc'* *'tfu'*
7967'tagfunc' 'tfu' string (default: empty)
7968 local to buffer
7969 {not available when compiled without the |+eval|
7970 feature}
7971 This option specifies a function to be used to perform tag searches.
7972 The function gets the tag pattern and should return a List of matching
7973 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007974 function and an example. The value can be the name of a function, a
7975 |lambda| or a |Funcref|. See |option-value-function| for more
7976 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007977
Bram Moolenaar071d4272004-06-13 20:20:40 +00007978 *'taglength'* *'tl'*
7979'taglength' 'tl' number (default 0)
7980 global
7981 If non-zero, tags are significant up to this number of characters.
7982
7983 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7984'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7985 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007986 If on and using a tags file in another directory, file names in that
7987 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 NOTE: This option is set to the Vi default value when 'compatible' is
7989 set and to the Vim default value when 'compatible' is reset.
7990
7991 *'tags'* *'tag'* *E433*
7992'tags' 'tag' string (default "./tags,tags", when compiled with
7993 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7994 global or local to buffer |global-local|
7995 Filenames for the tag command, separated by spaces or commas. To
7996 include a space or comma in a file name, precede it with a backslash
7997 (see |option-backslash| about including spaces and backslashes).
7998 When a file name starts with "./", the '.' is replaced with the path
7999 of the current file. But only when the 'd' flag is not included in
8000 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8001 |tags-option|.
8002 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008003 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8004 find all files named "tags" below "/lib". The filename itself cannot
8005 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
8006 files called "tags?". {not available when compiled without the
8007 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008008 The |tagfiles()| function can be used to get a list of the file names
8009 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008010 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8011 files are also supported. They are automatically recognized. The
8012 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8013 differences are ignored (MS-Windows). |emacs-tags|
8014 The use of |:set+=| and |:set-=| is preferred when adding or removing
8015 file names from the list. This avoids problems when a future version
8016 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017
8018 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8019'tagstack' 'tgst' boolean (default on)
8020 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008021 When on, the |tagstack| is used normally. When off, a ":tag" or
8022 ":tselect" command with an argument will not push the tag onto the
8023 tagstack. A following ":tag" without an argument, a ":pop" command or
8024 any other command that uses the tagstack will use the unmodified
8025 tagstack, but does change the pointer to the active entry.
8026 Resetting this option is useful when using a ":tag" command in a
8027 mapping which should not change the tagstack.
8028
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008029 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008030'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008031 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008032 {only available when compiled with the |+tcl/dyn|
8033 feature}
8034 Specifies the name of the Tcl shared library. The default is
8035 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008036 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008037 This option cannot be set from a |modeline| or in the |sandbox|, for
8038 security reasons.
8039
Bram Moolenaar071d4272004-06-13 20:20:40 +00008040 *'term'* *E529* *E530* *E531*
8041'term' string (default is $TERM, if that fails:
8042 in the GUI: "builtin_gui"
8043 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008044 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008045 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008046 on Unix: "ansi"
8047 on VMS: "ansi"
8048 on Win 32: "win32")
8049 global
8050 Name of the terminal. Used for choosing the terminal control
8051 characters. Environment variables are expanded |:set_env|.
8052 For example: >
8053 :set term=$TERM
8054< See |termcap|.
8055
8056 *'termbidi'* *'tbidi'*
8057 *'notermbidi'* *'notbidi'*
8058'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8059 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060 {only available when compiled with the |+arabic|
8061 feature}
8062 The terminal is in charge of Bi-directionality of text (as specified
8063 by Unicode). The terminal is also expected to do the required shaping
8064 that some languages (such as Arabic) require.
8065 Setting this option implies that 'rightleft' will not be set when
8066 'arabic' is set and the value of 'arabicshape' will be ignored.
8067 Note that setting 'termbidi' has the immediate effect that
8068 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8069 This option is reset when the GUI is started.
8070 For further details see |arabic.txt|.
8071
8072 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008073'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008075 Encoding used for the terminal. This specifies what character
8076 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008077 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008078 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008079 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008080 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008081 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8082 Any attempts to set a different value will be rejected, and an error
8083 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008084 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085 because the Win32 system always passes Unicode characters.
8086 When empty, the same encoding is used as for the 'encoding' option.
8087 This is the normal value.
8088 Not all combinations for 'termencoding' and 'encoding' are valid. See
8089 |encoding-table|.
8090 The value for this option must be supported by internal conversions or
8091 iconv(). When this is not possible no conversion will be done and you
8092 will probably experience problems with non-ASCII characters.
8093 Example: You are working with the locale set to euc-jp (Japanese) and
8094 want to edit a UTF-8 file: >
8095 :let &termencoding = &encoding
8096 :set encoding=utf-8
8097< You need to do this when your system has no locale support for UTF-8.
8098
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008099 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008100'termguicolors' 'tgc' boolean (default off)
8101 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008102 {not available when compiled without the
8103 |+termguicolors| feature}
8104 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008105 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008106
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008107 Requires a ISO-8613-3 compatible terminal. If setting this option
8108 does not work (produces a colorless UI) reading |xterm-true-color|
8109 might help.
8110
8111 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8112 is required. Use this check to find out: >
8113 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008114< This requires Vim to be built with the |+vtp| feature.
8115
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008116 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008117
8118 When using Vim with Windows Terminal, the background of Windows
8119 Terminal is normally filled with the Vim background color. Setting
8120 'termguicolors' and the guibg of the Normal highlight group to NONE
8121 will make the background transparent: >
8122 :hi Normal guibg=NONE
8123<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008124 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008125
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008126 *'termwinkey'* *'twk'*
8127'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008128 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008129 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008130 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008131 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008132 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008133< The string must be one key stroke but can be multiple bytes.
8134 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008135 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008136 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008137
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008138 *'termwinscroll'* *'twsl'*
8139'termwinscroll' 'twsl' number (default 10000)
8140 local to buffer
8141 {not available when compiled without the
8142 |+terminal| feature}
8143 Number of scrollback lines to keep. When going over this limit the
8144 first 10% of the scrollback lines are deleted. This is just to reduce
8145 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008146 Also used as a limit for text sent to the terminal in one write,
8147 multiplied by the number of columns times 3 (average number of bytes
8148 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008149
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008150 *'termwinsize'* *'tws'*
8151'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008152 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008153 Size used when opening the |terminal| window. Format:
8154 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008155 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008156 - When set with a "x" (e.g., "24x80") the terminal size is not
8157 adjusted to the window size. If the window is smaller only the
8158 top-left part is displayed.
8159 - When set with a "*" (e.g., "10*50") the terminal size follows the
8160 window size, but will not be smaller than the specified rows and/or
8161 columns.
8162 - When rows is zero then use the height of the window.
8163 - When columns is zero then use the width of the window.
8164 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008165 - Can be overruled in the |term_start()| options with "term_rows" and
8166 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008167
8168 Examples:
8169 "30x0" uses 30 rows and the current window width.
8170 "20*0" uses at least 20 rows and the current window width.
8171 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008172 Note that the command running in the terminal window may still change
8173 the size of the terminal. In that case the Vim window will be
8174 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008175
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008176 *'termwintype'* *'twt'*
8177'termwintype' 'twt' string (default "")
8178 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008179 {only available when compiled with the |terminal|
8180 feature on MS-Windows}
8181 Specify the virtual console (pty) used when opening the terminal
8182 window.
8183
8184 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008185 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008186 "winpty" use winpty, fail if not supported
8187 "conpty" use |ConPTY|, fail if not supported
8188
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008189 |ConPTY| support depends on the platform. Windows 10 October 2018
8190 Update is the first version that supports ConPTY, however it is still
8191 considered unstable. ConPTY might become stable in the next release
8192 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008193 supported then you cannot open a terminal window.
8194
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195 *'terse'* *'noterse'*
8196'terse' boolean (default off)
8197 global
8198 When set: Add 's' flag to 'shortmess' option (this makes the message
8199 for a search that hits the start or end of the file not being
8200 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8201 shortens a lot of messages}
8202
8203 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8204'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8205 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008206 This option is obsolete. Use 'fileformats'.
8207 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8208 set to the default value for the current system. When 'textauto' is
8209 reset, 'fileformats' is made empty.
8210 NOTE: This option is set to the Vi default value when 'compatible' is
8211 set and to the Vim default value when 'compatible' is reset.
8212
8213 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008214'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008215 others: default off)
8216 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 This option is obsolete. Use 'fileformat'.
8218 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8219 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8220 "unix".
8221
8222 *'textwidth'* *'tw'*
8223'textwidth' 'tw' number (default 0)
8224 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008225 Maximum width of text that is being inserted. A longer line will be
8226 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008227 this.
8228 'textwidth' is set to 0 when the 'paste' option is set and restored
8229 when 'paste' is reset.
8230 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008231 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008232 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008233 NOTE: This option is set to 0 when 'compatible' is set.
8234
8235 *'thesaurus'* *'tsr'*
8236'thesaurus' 'tsr' string (default "")
8237 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008238 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008239 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8240 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008241
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008242 This option is not used if 'thesaurusfunc' is set, either for the
8243 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008244
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008245 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008246 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008247 name. See |option-backslash| about using backslashes. The use of
8248 |:set+=| and |:set-=| is preferred when adding or removing directories
8249 from the list. This avoids problems when a future version uses
8250 another default. Backticks cannot be used in this option for security
8251 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008252
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008253 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008254'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008255 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008256 {not available when compiled without the |+eval|
8257 feature}
8258 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008259 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008260 The value can be the name of a function, a |lambda| or a |Funcref|.
8261 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008262
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008263 This option cannot be set from a |modeline| or in the |sandbox|, for
8264 security reasons.
8265
Bram Moolenaar071d4272004-06-13 20:20:40 +00008266 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8267'tildeop' 'top' boolean (default off)
8268 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008269 When on: The tilde command "~" behaves like an operator.
8270 NOTE: This option is reset when 'compatible' is set.
8271
8272 *'timeout'* *'to'* *'notimeout'* *'noto'*
8273'timeout' 'to' boolean (default on)
8274 global
8275 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008276'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008277 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008278 These two options together determine the behavior when part of a
8279 mapped key sequence or keyboard code has been received:
8280
8281 'timeout' 'ttimeout' action ~
8282 off off do not time out
8283 on on or off time out on :mappings and key codes
8284 off on time out on key codes
8285
8286 If both options are off, Vim will wait until either the complete
8287 mapping or key sequence has been received, or it is clear that there
8288 is no mapping or key sequence for the received characters. For
8289 example: if you have mapped "vl" and Vim has received 'v', the next
8290 character is needed to see if the 'v' is followed by an 'l'.
8291 When one of the options is on, Vim will wait for about 1 second for
8292 the next character to arrive. After that the already received
8293 characters are interpreted as single characters. The waiting time can
8294 be changed with the 'timeoutlen' option.
8295 On slow terminals or very busy systems timing out may cause
8296 malfunctioning cursor keys. If both options are off, Vim waits
8297 forever after an entered <Esc> if there are key codes that start
8298 with <Esc>. You will have to type <Esc> twice. If you do not have
8299 problems with key codes, but would like to have :mapped key
8300 sequences not timing out in 1 second, set the 'ttimeout' option and
8301 reset the 'timeout' option.
8302
8303 NOTE: 'ttimeout' is reset when 'compatible' is set.
8304
8305 *'timeoutlen'* *'tm'*
8306'timeoutlen' 'tm' number (default 1000)
8307 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008308
Bram Moolenaar071d4272004-06-13 20:20:40 +00008309 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008310'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312 The time in milliseconds that is waited for a key code or mapped key
8313 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8314 when part of a command has been typed.
8315 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8316 different timeout value for key codes is desired set 'ttimeoutlen' to
8317 a non-negative number.
8318
8319 ttimeoutlen mapping delay key code delay ~
8320 < 0 'timeoutlen' 'timeoutlen'
8321 >= 0 'timeoutlen' 'ttimeoutlen'
8322
8323 The timeout only happens when the 'timeout' and 'ttimeout' options
8324 tell so. A useful setting would be >
8325 :set timeout timeoutlen=3000 ttimeoutlen=100
8326< (time out on mapping after three seconds, time out on key codes after
8327 a tenth of a second).
8328
8329 *'title'* *'notitle'*
8330'title' boolean (default off, on when title can be restored)
8331 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008332 When on, the title of the window will be set to the value of
8333 'titlestring' (if it is not empty), or to:
8334 filename [+=-] (path) - VIM
8335 Where:
8336 filename the name of the file being edited
8337 - indicates the file cannot be modified, 'ma' off
8338 + indicates the file was modified
8339 = indicates the file is read-only
8340 =+ indicates the file is read-only and modified
8341 (path) is the path of the file being edited
8342 - VIM the server name |v:servername| or "VIM"
8343 Only works if the terminal supports setting window titles
8344 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008345 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008346 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8347 *X11*
8348 When Vim was compiled with HAVE_X11 defined, the original title will
8349 be restored if possible. The output of ":version" will include "+X11"
8350 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8351 works for the icon name |'icon'|.
8352 But: When Vim was started with the |-X| argument, restoring the title
8353 will not work (except in the GUI).
8354 If the title cannot be restored, it is set to the value of 'titleold'.
8355 You might want to restore the title outside of Vim then.
8356 When using an xterm from a remote machine you can use this command:
8357 rsh machine_name xterm -display $DISPLAY &
8358 then the WINDOWID environment variable should be inherited and the
8359 title of the window should change back to what it should be after
8360 exiting Vim.
8361
8362 *'titlelen'*
8363'titlelen' number (default 85)
8364 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008366 title. When the title is longer, only the end of the path name is
8367 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368 Using a percentage makes this adapt to the width of the window. But
8369 it won't work perfectly, because the actual number of characters
8370 available also depends on the font used and other things in the title
8371 bar. When 'titlelen' is zero the full path is used. Otherwise,
8372 values from 1 to 30000 percent can be used.
8373 'titlelen' is also used for the 'titlestring' option.
8374
8375 *'titleold'*
8376'titleold' string (default "Thanks for flying Vim")
8377 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378 This option will be used for the window title when exiting Vim if the
8379 original title cannot be restored. Only happens if 'title' is on or
8380 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008381 This option cannot be set from a |modeline| or in the |sandbox|, for
8382 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008383 *'titlestring'*
8384'titlestring' string (default "")
8385 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 When this option is not empty, it will be used for the title of the
8387 window. This happens only when the 'title' option is on.
8388 Only works if the terminal supports setting window titles (currently
8389 Amiga console, Win32 console, all GUI versions and terminals with a
8390 non-empty 't_ts' option).
8391 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008392 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008393
Bram Moolenaar071d4272004-06-13 20:20:40 +00008394 When this option contains printf-style '%' items, they will be
8395 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008396 This option cannot be set in a modeline when 'modelineexpr' is off.
8397
Bram Moolenaar071d4272004-06-13 20:20:40 +00008398 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008399 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8401< The value of 'titlelen' is used to align items in the middle or right
8402 of the available space.
8403 Some people prefer to have the file name first: >
8404 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8405< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008406 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407 separating space only when needed.
8408 NOTE: Use of special characters in 'titlestring' may cause the display
8409 to be garbled (e.g., when it contains a CR or NL character).
8410 {not available when compiled without the |+statusline| feature}
8411
8412 *'toolbar'* *'tb'*
8413'toolbar' 'tb' string (default "icons,tooltips")
8414 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008415 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008416 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008417 possible values are:
8418 icons Toolbar buttons are shown with icons.
8419 text Toolbar buttons shown with text.
8420 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008421 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422 tooltips Tooltips are active for toolbar buttons.
8423 Tooltips refer to the popup help text which appears after the mouse
8424 cursor is placed over a toolbar button for a brief moment.
8425
8426 If you want the toolbar to be shown with icons as well as text, do the
8427 following: >
8428 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008429< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008430 will show icons if both are requested.
8431
8432 If none of the strings specified in 'toolbar' are valid or if
8433 'toolbar' is empty, this option is ignored. If you want to disable
8434 the toolbar, you need to set the 'guioptions' option. For example: >
8435 :set guioptions-=T
8436< Also see |gui-toolbar|.
8437
8438 *'toolbariconsize'* *'tbis'*
8439'toolbariconsize' 'tbis' string (default "small")
8440 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008441 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008443 tiny Use tiny icons.
8444 small Use small icons (default).
8445 medium Use medium-sized icons.
8446 large Use large icons.
8447 huge Use even larger icons.
8448 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008450 the current theme. Common dimensions are giant=48x48, huge=32x32,
8451 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452
8453 If 'toolbariconsize' is empty, the global default size as determined
8454 by user preferences or the current theme is used.
8455
8456 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8457'ttybuiltin' 'tbi' boolean (default on)
8458 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008459 When on, the builtin termcaps are searched before the external ones.
8460 When off the builtin termcaps are searched after the external ones.
8461 When this option is changed, you should set the 'term' option next for
8462 the change to take effect, for example: >
8463 :set notbi term=$TERM
8464< See also |termcap|.
8465 Rationale: The default for this option is "on", because the builtin
8466 termcap entries are generally better (many systems contain faulty
8467 xterm entries...).
8468
8469 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8470'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8471 sun-cmd, screen, rxvt, dtterm or
8472 iris-ansi; also on when running Vim in
8473 a DOS console)
8474 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008475 Indicates a fast terminal connection. More characters will be sent to
8476 the screen for redrawing, instead of using insert/delete line
8477 commands. Improves smoothness of redrawing when there are multiple
8478 windows and the terminal does not support a scrolling region.
8479 Also enables the extra writing of characters at the end of each screen
8480 line for lines that wrap. This helps when using copy/paste with the
8481 mouse in an xterm and other terminals.
8482
8483 *'ttymouse'* *'ttym'*
8484'ttymouse' 'ttym' string (default depends on 'term')
8485 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008486 {only in Unix and VMS, doesn't work in the GUI; not
8487 available when compiled without |+mouse|}
8488 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008489 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008490 *xterm-mouse*
8491 xterm xterm-like mouse handling. The mouse generates
8492 "<Esc>[Mscr", where "scr" is three bytes:
8493 "s" = button state
8494 "c" = column plus 33
8495 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008496 This only works up to 223 columns! See "dec",
8497 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008498 xterm2 Works like "xterm", but with the xterm reporting the
8499 mouse position while the mouse is dragged. This works
8500 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008501 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502 work. See below for how Vim detects this
8503 automatically.
8504 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008505 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008506 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008507 for the row and column. No other mouse events are
8508 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008509 *dec-mouse*
8510 dec DEC terminal mouse handling. The mouse generates a
8511 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008512 This is also available for an Xterm, if it was
8513 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008514 *jsbterm-mouse*
8515 jsbterm JSB term mouse handling.
8516 *pterm-mouse*
8517 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008518 *urxvt-mouse*
8519 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008520 The mouse works only if the terminal supports this
8521 encoding style, but it does not have 223 columns limit
8522 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008523 *sgr-mouse*
8524 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008525 mouse reporting. The mouse works even in columns
8526 beyond 223. This option is backward compatible with
8527 "xterm2" because it can also decode "xterm2" style
8528 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529
8530 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008531 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8532 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008533 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8534 recognized, if enabled at compile time. DEC terminal mouse codes
8535 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008536 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8537 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008538 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008539 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8540 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8541 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008542 Additionally, if vim is compiled with the |+termresponse| feature and
8543 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008544 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008546 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8547 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8548 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008549 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8550 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008551 :set t_RV=
8552<
8553 *'ttyscroll'* *'tsl'*
8554'ttyscroll' 'tsl' number (default 999)
8555 global
8556 Maximum number of lines to scroll the screen. If there are more lines
8557 to scroll the window is redrawn. For terminals where scrolling is
8558 very slow and redrawing is not slow this can be set to a small number,
8559 e.g., 3, to speed up displaying.
8560
8561 *'ttytype'* *'tty'*
8562'ttytype' 'tty' string (default from $TERM)
8563 global
8564 Alias for 'term', see above.
8565
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008566 *'undodir'* *'udir'*
8567'undodir' 'udir' string (default ".")
8568 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008569 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008570 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008571 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008572 "." means using the directory of the file. The undo file name for
8573 "file.txt" is ".file.txt.un~".
8574 For other directories the file name is the full path of the edited
8575 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008576 When writing: The first directory that exists is used. "." always
8577 works, no directories after "." will be used for writing.
8578 When reading all entries are tried to find an undo file. The first
8579 undo file that exists is used. When it cannot be read an error is
8580 given, no further entry is used.
8581 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008582 This option cannot be set from a |modeline| or in the |sandbox|, for
8583 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008584
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008585 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008586'undofile' 'udf' boolean (default off)
8587 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008588 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008589 When on, Vim automatically saves undo history to an undo file when
8590 writing a buffer to a file, and restores undo history from the same
8591 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008592 The directory where the undo file is stored is specified by 'undodir'.
8593 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008594 The undo file is not read when 'undoreload' causes the buffer from
8595 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008596 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008597 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008598
Bram Moolenaar071d4272004-06-13 20:20:40 +00008599 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008600'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008601 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008602 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008603 is kept in memory, higher numbers will cause more memory to be used.
8604 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008605 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8606 itself: >
8607 set ul=0
8608< But you can also get Vi compatibility by including the 'u' flag in
8609 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008610 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008611 Set to -1 for no undo at all. You might want to do this only for the
8612 current buffer: >
8613 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008614< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008615
8616 The local value is set to -123456 when the global value is to be used.
8617
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008618 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008620 *'undoreload'* *'ur'*
8621'undoreload' 'ur' number (default 10000)
8622 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008623 Save the whole buffer for undo when reloading it. This applies to the
8624 ":e!" command and reloading for when the buffer changed outside of
8625 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008626 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008627 of lines is smaller than the value of this option.
8628 Set this option to zero to disable undo for a reload.
8629
8630 When saving undo for a reload, any undo file is not read.
8631
8632 Note that this causes the whole buffer to be stored in memory. Set
8633 this option to a lower value if you run out of memory.
8634
Bram Moolenaar071d4272004-06-13 20:20:40 +00008635 *'updatecount'* *'uc'*
8636'updatecount' 'uc' number (default: 200)
8637 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008638 After typing this many characters the swap file will be written to
8639 disk. When zero, no swap file will be created at all (see chapter on
8640 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8641 Vim with the "-n" option, see |startup|. When editing in readonly
8642 mode this option will be initialized to 10000.
8643 The swapfile can be disabled per buffer with |'swapfile'|.
8644 When 'updatecount' is set from zero to non-zero, swap files are
8645 created for all buffers that have 'swapfile' set. When 'updatecount'
8646 is set to zero, existing swap files are not deleted.
8647 Also see |'swapsync'|.
8648 This option has no meaning in buffers where |'buftype'| is "nofile"
8649 or "nowrite".
8650
8651 *'updatetime'* *'ut'*
8652'updatetime' 'ut' number (default 4000)
8653 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654 If this many milliseconds nothing is typed the swap file will be
8655 written to disk (see |crash-recovery|). Also used for the
8656 |CursorHold| autocommand event.
8657
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008658 *'varsofttabstop'* *'vsts'*
8659'varsofttabstop' 'vsts' string (default "")
8660 local to buffer
8661 {only available when compiled with the |+vartabs|
8662 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008663 A list of the number of spaces that a <Tab> counts for while editing,
8664 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8665 width <Tab>s are being inserted, while in fact a mixture of spaces
8666 and <Tab>s is used. Tab widths are separated with commas, with the
8667 final value applying to all subsequent tabs.
8668
8669 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008670 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008671 to use the following: >
8672 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008673< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8674 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008675
8676 Note that the value of |'softtabstop'| will be ignored while
8677 'varsofttabstop' is set.
8678
8679 *'vartabstop'* *'vts'*
8680'vartabstop' 'vts' string (default "")
8681 local to buffer
8682 {only available when compiled with the |+vartabs|
8683 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008684 A list of the number of spaces that a <Tab> in the file counts for,
8685 separated by commas. Each value corresponds to one tab, with the
8686 final value applying to all subsequent tabs. For example: >
8687 :set vartabstop=4,20,10,8
8688< This will make the first tab 4 spaces wide, the second 20 spaces,
8689 the third 10 spaces, and all following tabs 8 spaces.
8690
8691 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8692 is set.
8693
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694 *'verbose'* *'vbs'*
8695'verbose' 'vbs' number (default 0)
8696 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697 When bigger than zero, Vim will give messages about what it is doing.
8698 Currently, these messages are given:
8699 >= 1 When the viminfo file is read or written.
8700 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008701 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008702 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008703 >= 8 Files for which a group of autocommands is executed.
8704 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008705 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008706 >= 12 Every executed function.
8707 >= 13 When an exception is thrown, caught, finished, or discarded.
8708 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008709 >= 15 Every executed Ex command from a script (truncated at 200
8710 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008711 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008712
8713 This option can also be set with the "-V" argument. See |-V|.
8714 This option is also set by the |:verbose| command.
8715
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008716 When the 'verbosefile' option is set then the verbose messages are not
8717 displayed.
8718
8719 *'verbosefile'* *'vfile'*
8720'verbosefile' 'vfile' string (default empty)
8721 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008722 When not empty all messages are written in a file with this name.
8723 When the file exists messages are appended.
8724 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008725 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008726 Setting 'verbosefile' to a new value is like making it empty first.
8727 The difference with |:redir| is that verbose messages are not
8728 displayed when 'verbosefile' is set.
8729
Bram Moolenaar071d4272004-06-13 20:20:40 +00008730 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008731'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 "$VIM/vimfiles/view",
8733 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008734 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008735 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008737 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 feature}
8739 Name of the directory where to store files for |:mkview|.
8740 This option cannot be set from a |modeline| or in the |sandbox|, for
8741 security reasons.
8742
8743 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008744'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008746 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008747 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008748 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008749 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008750 word save and restore ~
8751 cursor cursor position in file and in window
8752 folds manually created folds, opened/closed folds and local
8753 fold options
8754 options options and mappings local to a window or buffer (not
8755 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008756 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008757 slash backslashes in file names replaced with forward
8758 slashes
8759 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008760 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008761 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008762
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008763 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008765 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008766
8767 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008768'viminfo' 'vi' string (Vi default: "", Vim default for
8769 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008770 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8771 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008772 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008773 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 feature}
8775 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008776 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8777 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008778 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008779 consisting of a single character identifying the particular parameter,
8780 followed by a number or string which specifies the value of that
8781 parameter. If a particular character is left out, then the default
8782 value is used for that parameter. The following is a list of the
8783 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008785 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008786 ! When included, save and restore global variables that start
8787 with an uppercase letter, and don't contain a lowercase
8788 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008789 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008790 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008791 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008792 " Maximum number of lines saved for each register. Old name of
8793 the '<' item, with the disadvantage that you need to put a
8794 backslash before the ", otherwise it will be recognized as the
8795 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008796 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008797 % When included, save and restore the buffer list. If Vim is
8798 started with a file name argument, the buffer list is not
8799 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008800 buffer list is restored from the viminfo file. Quickfix
8801 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8802 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008803 When followed by a number, the number specifies the maximum
8804 number of buffers that are stored. Without a number all
8805 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008806 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008807 ' Maximum number of previously edited files for which the marks
8808 are remembered. This parameter must always be included when
8809 'viminfo' is non-empty.
8810 Including this item also means that the |jumplist| and the
8811 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008812 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008813 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008814 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008815 patterns are also saved. When not included, the value of
8816 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008817 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008819 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008820 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008821 < Maximum number of lines saved for each register. If zero then
8822 registers are not saved. When not included, all lines are
8823 saved. '"' is the old name for this item.
8824 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008825 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008827 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008828 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008829 c When included, convert the text in the viminfo file from the
8830 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008831 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008832 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008833 f Whether file marks need to be stored. If zero, file marks ('0
8834 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008835 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008836 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008837 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 h Disable the effect of 'hlsearch' when loading the viminfo
8839 file. When not included, it depends on whether ":nohlsearch"
8840 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008841 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008842 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008843 the 'n'. Must be at the end of the option! If the
8844 'viminfofile' option is set, that file name overrides the one
8845 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008846 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008847 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008848 r Removable media. The argument is a string (up to the next
8849 ','). This parameter can be given several times. Each
8850 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008851 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008852 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8853 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8854 ignored. Maximum length of each 'r' argument is 50
8855 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008856 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008857 s Maximum size of an item in Kbyte. If zero then registers are
8858 not saved. Currently only applies to registers. The default
8859 "s10" will exclude registers with more than 10 Kbyte of text.
8860 Also see the '<' item above: line count limit.
8861
8862 Example: >
8863 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8864<
8865 '50 Marks will be remembered for the last 50 files you
8866 edited.
8867 <1000 Contents of registers (up to 1000 lines each) will be
8868 remembered.
8869 s100 Registers with more than 100 Kbyte text are skipped.
8870 :0 Command-line history will not be saved.
8871 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8872 no / Since '/' is not specified, the default will be used,
8873 that is, save all of the search history, and also the
8874 previous search and substitute patterns.
8875 no % The buffer list will not be saved nor read back.
8876 no h 'hlsearch' highlighting will be restored.
8877
8878 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8879 load the contents of the file, this is not done automatically.
8880
8881 This option cannot be set from a |modeline| or in the |sandbox|, for
8882 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008883 NOTE: This option is set to the Vim default value when 'compatible'
8884 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008885
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008886 *'viminfofile'* *'vif'*
8887'viminfofile' 'vif' string (default: "")
8888 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008889 {not available when compiled without the |+viminfo|
8890 feature}
8891 When non-empty, overrides the file name used for viminfo.
8892 When equal to "NONE" no viminfo file will be read or written.
8893 This option can be set with the |-i| command line flag. The |--clean|
8894 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008895 This option cannot be set from a |modeline| or in the |sandbox|, for
8896 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008897
Bram Moolenaar071d4272004-06-13 20:20:40 +00008898 *'virtualedit'* *'ve'*
8899'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008900 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008901 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008902 block Allow virtual editing in Visual block mode.
8903 insert Allow virtual editing in Insert mode.
8904 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008905 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008906 none When used as the local value, do not allow virtual
8907 editing even when the global value is set. When used
8908 as the global value, "none" is the same as "".
8909 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008910
Bram Moolenaar071d4272004-06-13 20:20:40 +00008911 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008912 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008913 of the line. Useful for selecting a rectangle in Visual mode and
8914 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008915 "onemore" is not the same, it will only allow moving the cursor just
8916 after the last character of the line. This makes some commands more
8917 consistent. Previously the cursor was always past the end of the line
8918 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008919 break some plugins or Vim scripts. For example because |l| can move
8920 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008921 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008922 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008923 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008924 It doesn't make sense to combine "all" with "onemore", but you will
8925 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008926 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008927 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008928
8929 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8930'visualbell' 'vb' boolean (default off)
8931 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008932 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008933 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008934 use: >
8935 :set vb t_vb=
8936< If you want a short flash, you can use this on many terminals: >
8937 :set vb t_vb=[?5h$<100>[?5l
8938< Here $<100> specifies the time, you can use a smaller or bigger value
8939 to get a shorter or longer flash.
8940
8941 Note: Vim will limit the bell to once per half a second. This avoids
8942 having to wait for the flashing to finish when there are lots of
8943 bells, e.g. on key repeat. This also happens without 'visualbell'
8944 set.
8945
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8947 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8948 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008949
8950 Note: When the GUI starts, 't_vb' is reset to its default value. You
8951 might want to set it again in your |gvimrc|.
8952
Bram Moolenaar071d4272004-06-13 20:20:40 +00008953 Does not work on the Amiga, you always get a screen flash.
8954 Also see 'errorbells'.
8955
8956 *'warn'* *'nowarn'*
8957'warn' boolean (default on)
8958 global
8959 Give a warning message when a shell command is used while the buffer
8960 has been changed.
8961
8962 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8963'weirdinvert' 'wiv' boolean (default off)
8964 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008965 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008966 It is provided for backwards compatibility with version 4.x.
8967 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8968 vice versa. Has no effect when the GUI is running.
8969
8970 *'whichwrap'* *'ww'*
8971'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8972 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008973 Allow specified keys that move the cursor left/right to move to the
8974 previous/next line when the cursor is on the first/last character in
8975 the line. Concatenate characters to allow this for these keys:
8976 char key mode ~
8977 b <BS> Normal and Visual
8978 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008979 h "h" Normal and Visual (not recommended)
8980 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008981 < <Left> Normal and Visual
8982 > <Right> Normal and Visual
8983 ~ "~" Normal
8984 [ <Left> Insert and Replace
8985 ] <Right> Insert and Replace
8986 For example: >
8987 :set ww=<,>,[,]
8988< allows wrap only when cursor keys are used.
8989 When the movement keys are used in combination with a delete or change
8990 operator, the <EOL> also counts for a character. This makes "3h"
8991 different from "3dh" when the cursor crosses the end of a line. This
8992 is also true for "x" and "X", because they do the same as "dl" and
8993 "dh". If you use this, you may also want to use the mapping
8994 ":map <BS> X" to make backspace delete the character in front of the
8995 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008996 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008997 line (not an empty line) then it will not move to the next line. This
8998 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008999 NOTE: This option is set to the Vi default value when 'compatible' is
9000 set and to the Vim default value when 'compatible' is reset.
9001
9002 *'wildchar'* *'wc'*
9003'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005 Character you have to type to start wildcard expansion in the
9006 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009007 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009008 The character is not recognized when used inside a macro. See
9009 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009010 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009011 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009012 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013< NOTE: This option is set to the Vi default value when 'compatible' is
9014 set and to the Vim default value when 'compatible' is reset.
9015
9016 *'wildcharm'* *'wcm'*
9017'wildcharm' 'wcm' number (default: none (0))
9018 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009020 recognized when used inside a macro. You can find "spare" command-line
9021 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009022 you'll never actually type 'wildcharm', just use it in mappings that
9023 automatically invoke completion mode, e.g.: >
9024 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009025 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009026< Then after typing :ss you can use CTRL-P & CTRL-N.
9027
9028 *'wildignore'* *'wig'*
9029'wildignore' 'wig' string (default "")
9030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009031 {not available when compiled without the |+wildignore|
9032 feature}
9033 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009034 patterns is ignored when expanding |wildcards|, completing file or
9035 directory names, and influences the result of |expand()|, |glob()| and
9036 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009037 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9038 Also see 'suffixes'.
9039 Example: >
9040 :set wildignore=*.o,*.obj
9041< The use of |:set+=| and |:set-=| is preferred when adding or removing
9042 a pattern from the list. This avoids problems when a future version
9043 uses another default.
9044
Bram Moolenaar94950a92010-12-02 16:01:29 +01009045
Bram Moolenaar81af9252010-12-10 20:35:50 +01009046 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009047'wildignorecase' 'wic' boolean (default off)
9048 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009049 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009050 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009051 Does not apply when the shell is used to expand wildcards, which
9052 happens when there are special characters.
9053
9054
Bram Moolenaar071d4272004-06-13 20:20:40 +00009055 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009056'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009057 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009058 {not available if compiled without the |+wildmenu|
9059 feature}
9060 When 'wildmenu' is on, command-line completion operates in an enhanced
9061 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
9062 the possible matches are shown just above the command line, with the
9063 first match highlighted (overwriting the status line, if there is
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009064 one). This is the behavior without "pum" in 'wildoptions'.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009065 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009066 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9067 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9068 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009069 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009070 If there are more matches than can fit in the line, a ">" is shown on
9071 the right and/or a "<" is shown on the left. The status line scrolls
9072 as needed.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009073 When 'wildoptions' contains "pum", then the completion matches are
9074 shown in a popup menu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009075 The "wildmenu" mode is abandoned when a key is hit that is not used
9076 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009077 While the "wildmenu" is active, not using the popup menu, the
9078 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009079
9080 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9081 <Down> - in filename/menu name completion: move into a
9082 subdirectory or submenu.
9083 <CR> - in menu completion, when the cursor is just after a
9084 dot: move into a submenu.
9085 <Up> - in filename/menu name completion: move up into
9086 parent directory or parent menu.
9087
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009088 When using the popup menu for command line completion, the following
9089 keys have special meanings:
9090 <Down> - select next match (like CTRL-N)
9091 <Left> - in filename/menu name completion: move up into
9092 parent directory or parent menu.
9093 <Right> - in filename/menu name completion: move into a
9094 subdirectory or submenu.
9095 <Up> - select previous match (like CTRL-P)
9096 CTRL-E - end completion, go back to what was there before
9097 selecting a match.
9098 CTRL-N - go to the next entry
9099 CTRL-P - go to the previous entry
9100 CTRL-Y - accept the currently selected match and stop
9101 completion.
9102
Bram Moolenaar071d4272004-06-13 20:20:40 +00009103 This makes the menus accessible from the console |console-menus|.
9104
9105 If you prefer the <Left> and <Right> keys to move the cursor instead
9106 of selecting a different match, use this: >
9107 :cnoremap <Left> <Space><BS><Left>
9108 :cnoremap <Right> <Space><BS><Right>
9109<
9110 The "WildMenu" highlighting is used for displaying the current match
9111 |hl-WildMenu|.
9112
9113 *'wildmode'* *'wim'*
9114'wildmode' 'wim' string (Vim default: "full")
9115 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009116 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009117 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009118 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009119 first part specifies the behavior for the first use of 'wildchar',
9120 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009121
9122 Each part consists of a colon separated list consisting of the
9123 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009124 "" Complete only the first match.
9125 "full" Complete the next full match. After the last match,
9126 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009127 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009128 "longest" Complete till longest common string. If this doesn't
9129 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009130 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009131 "lastused" When completing buffer names and more than one buffer
9132 matches, sort buffers by time last used (other than
9133 the current buffer).
9134 When there is only a single match, it is fully completed in all cases.
9135
9136 Examples of useful colon-separated values:
9137 "longest:full" Like "longest", but also start 'wildmenu' if it is
9138 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009139 "list:full" When more than one match, list all matches and
9140 complete first match.
9141 "list:longest" When more than one match, list all matches and
9142 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009143 "list:lastused" When more than one buffer matches, list all matches
9144 and sort buffers by time last used (other than the
9145 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009146
9147 Examples: >
9148 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009149< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009150 :set wildmode=longest,full
9151< Complete longest common string, then each full match >
9152 :set wildmode=list:full
9153< List all matches and complete each full match >
9154 :set wildmode=list,full
9155< List all matches without completing, then each full match >
9156 :set wildmode=longest,list
9157< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009158 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009159
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009160 *'wildoptions'* *'wop'*
9161'wildoptions' 'wop' string (default "")
9162 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009163 {not available when compiled without the |+wildignore|
9164 feature}
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009165 A list of words that change how |cmdline-completion| is done.
9166 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009167 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009168 this value is specified, wildcard expansion will not
9169 be used for completion. The matches will be sorted by
9170 the "best match" rather than alphabetically sorted.
9171 This will find more matches than the wildcard
9172 expansion. Currently fuzzy matching based completion
9173 is not supported for file and directory names and
9174 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009175 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009176 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009177 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009178 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009179 is displayed per line. Often used tag kinds are:
9180 d #define
9181 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009182
Bram Moolenaar071d4272004-06-13 20:20:40 +00009183 *'winaltkeys'* *'wak'*
9184'winaltkeys' 'wak' string (default "menu")
9185 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009186 {only used in Win32, Motif, GTK and Photon GUI}
9187 Some GUI versions allow the access to menu entries by using the ALT
9188 key in combination with a character that appears underlined in the
9189 menu. This conflicts with the use of the ALT key for mappings and
9190 entering special characters. This option tells what to do:
9191 no Don't use ALT keys for menus. ALT key combinations can be
9192 mapped, but there is no automatic handling. This can then be
9193 done with the |:simalt| command.
9194 yes ALT key handling is done by the windowing system. ALT key
9195 combinations cannot be mapped.
9196 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009197 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009198 keys can be mapped.
9199 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9200 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009201 This option is not used for <F10>; on Win32 and with GTK <F10> will
9202 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009203
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009204 *'wincolor'* *'wcr'*
9205'wincolor' 'wcr' string (default empty)
9206 local to window
9207 Highlight group name to use for this window instead of the Normal
9208 color |hl-Normal|.
9209
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009210 *'window'* *'wi'*
9211'window' 'wi' number (default screen height - 1)
9212 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009213 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9214 window and the value is smaller than 'lines' minus one. The screen
9215 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009216 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9217 in a much smarter way, taking care of wrapping lines.
9218 When resizing the Vim window, the value is smaller than 1 or more than
9219 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009220 Note: Do not confuse this with the height of the Vim window, use
9221 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009222
Bram Moolenaar071d4272004-06-13 20:20:40 +00009223 *'winheight'* *'wh'* *E591*
9224'winheight' 'wh' number (default 1)
9225 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009226 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009227 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009228 focus goes to a window that is smaller, its size is increased, at the
9229 cost of the height of other windows.
9230 Set 'winheight' to a small number for normal editing.
9231 Set it to 999 to make the current window fill most of the screen.
9232 Other windows will be only 'winminheight' high. This has the drawback
9233 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9234 to create only two windows, set the option after startup is done,
9235 using the |VimEnter| event: >
9236 au VimEnter * set winheight=999
9237< Minimum value is 1.
9238 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009239 height of the current window.
9240 'winheight' applies to the current window. Use 'winminheight' to set
9241 the minimal height for other windows.
9242
9243 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9244'winfixheight' 'wfh' boolean (default off)
9245 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009246 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009247 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9248 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009249 The height may be changed anyway when running out of room.
9250
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009251 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9252'winfixwidth' 'wfw' boolean (default off)
9253 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009254 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009255 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009256 The width may be changed anyway when running out of room.
9257
Bram Moolenaar071d4272004-06-13 20:20:40 +00009258 *'winminheight'* *'wmh'*
9259'winminheight' 'wmh' number (default 1)
9260 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009261 The minimal height of a window, when it's not the current window.
9262 This is a hard minimum, windows will never become smaller.
9263 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9264 status bar) if necessary. They will return to at least one line when
9265 they become active (since the cursor has to have somewhere to go.)
9266 Use 'winheight' to set the minimal height of the current window.
9267 This option is only checked when making a window smaller. Don't use a
9268 large number, it will cause errors when opening more than a few
9269 windows. A value of 0 to 3 is reasonable.
9270
9271 *'winminwidth'* *'wmw'*
9272'winminwidth' 'wmw' number (default 1)
9273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009274 The minimal width of a window, when it's not the current window.
9275 This is a hard minimum, windows will never become smaller.
9276 When set to zero, windows may be "squashed" to zero columns (i.e. just
9277 a vertical separator) if necessary. They will return to at least one
9278 line when they become active (since the cursor has to have somewhere
9279 to go.)
9280 Use 'winwidth' to set the minimal width of the current window.
9281 This option is only checked when making a window smaller. Don't use a
9282 large number, it will cause errors when opening more than a few
9283 windows. A value of 0 to 12 is reasonable.
9284
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009285 *'winptydll'*
9286'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9287 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009288 {only available when compiled with the |terminal|
9289 feature on MS-Windows}
9290 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009291 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009292 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009293 a fallback.
9294 Environment variables are expanded |:set_env|.
9295 This option cannot be set from a |modeline| or in the |sandbox|, for
9296 security reasons.
9297
Bram Moolenaar071d4272004-06-13 20:20:40 +00009298 *'winwidth'* *'wiw'* *E592*
9299'winwidth' 'wiw' number (default 20)
9300 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009301 Minimal number of columns for the current window. This is not a hard
9302 minimum, Vim will use fewer columns if there is not enough room. If
9303 the current window is smaller, its size is increased, at the cost of
9304 the width of other windows. Set it to 999 to make the current window
9305 always fill the screen. Set it to a small number for normal editing.
9306 The width is not adjusted after one of the commands to change the
9307 width of the current window.
9308 'winwidth' applies to the current window. Use 'winminwidth' to set
9309 the minimal width for other windows.
9310
9311 *'wrap'* *'nowrap'*
9312'wrap' boolean (default on)
9313 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009314 This option changes how text is displayed. It doesn't change the text
9315 in the buffer, see 'textwidth' for that.
9316 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009317 displaying continues on the next line. When off lines will not wrap
9318 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009319 moved to a part that is not shown, the screen will scroll
9320 horizontally.
9321 The line will be broken in the middle of a word if necessary. See
9322 'linebreak' to get the break at a word boundary.
9323 To make scrolling horizontally a bit more useful, try this: >
9324 :set sidescroll=5
9325 :set listchars+=precedes:<,extends:>
9326< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009327 This option can't be set from a |modeline| when the 'diff' option is
9328 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009329
9330 *'wrapmargin'* *'wm'*
9331'wrapmargin' 'wm' number (default 0)
9332 local to buffer
9333 Number of characters from the right window border where wrapping
9334 starts. When typing text beyond this limit, an <EOL> will be inserted
9335 and inserting continues on the next line.
9336 Options that add a margin, such as 'number' and 'foldcolumn', cause
9337 the text width to be further reduced. This is Vi compatible.
9338 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009339 This option is set to 0 when 'paste' is set and restored when 'paste'
9340 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009341 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009342
9343 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9344'wrapscan' 'ws' boolean (default on) *E384* *E385*
9345 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009346 Searches wrap around the end of the file. Also applies to |]s| and
9347 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009348
9349 *'write'* *'nowrite'*
9350'write' boolean (default on)
9351 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009352 Allows writing files. When not set, writing a file is not allowed.
9353 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009354 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009355 argument. Filtering text is still possible, even though this requires
9356 writing a temporary file.
9357
9358 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9359'writeany' 'wa' boolean (default off)
9360 global
9361 Allows writing to any file with no need for "!" override.
9362
9363 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9364'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9365 otherwise)
9366 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009367 Make a backup before overwriting a file. The backup is removed after
9368 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009369 also on.
9370 WARNING: Switching this option off means that when Vim fails to write
9371 your buffer correctly and then, for whatever reason, Vim exits, you
9372 lose both the original file and what you were writing. Only reset
9373 this option if your file system is almost full and it makes the write
9374 fail (and make sure not to exit Vim until the write was successful).
9375 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009376 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009377 Depending on 'backupcopy' the backup is a new file or the original
9378 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009379 NOTE: This option is set to the default value when 'compatible' is
9380 set.
9381
9382 *'writedelay'* *'wd'*
9383'writedelay' 'wd' number (default 0)
9384 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009385 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009386 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009387 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009388
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009389 *'xtermcodes'* *'noxtermcodes'*
9390'xtermcodes' boolean (default on)
9391 global
9392 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009393 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009394 key codes and number of colors from the terminal. This takes care of
9395 various configuration options of the terminal that cannot be obtained
9396 from the termlib/terminfo entry, see |xterm-codes|.
9397 A side effect may be that t_Co changes and Vim will redraw the
9398 display.
9399
9400
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009401 vim:tw=78:ts=8:noet:ft=help:norl: