blob: 55c2146b92ac33e44cbfe067134f9fd77d5e7dd5 [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
811 escape sequence will be emitted. For example, on Linux, you can source
812 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000813 When the parsing of the OSC sequence fails you get *E1179* .
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200814
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
816'arabic' 'arab' boolean (default off)
817 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 {only available when compiled with the |+arabic|
819 feature}
820 This option can be set to start editing Arabic text.
821 Setting this option will:
822 - Set the 'rightleft' option, unless 'termbidi' is set.
823 - Set the 'arabicshape' option, unless 'termbidi' is set.
824 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
825 between typing English and Arabic key mapping.
826 - Set the 'delcombine' option
827 Note that 'encoding' must be "utf-8" for working with Arabic text.
828
829 Resetting this option will:
830 - Reset the 'rightleft' option.
831 - Disable the use of 'keymap' (without changing its value).
832 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200833 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100834 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 Also see |arabic.txt|.
836
837 *'arabicshape'* *'arshape'*
838 *'noarabicshape'* *'noarshape'*
839'arabicshape' 'arshape' boolean (default on)
840 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 {only available when compiled with the |+arabic|
842 feature}
843 When on and 'termbidi' is off, the required visual character
844 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200845 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 one which encompasses:
847 a) the changing/morphing of characters based on their location
848 within a word (initial, medial, final and stand-alone).
849 b) the enabling of the ability to compose characters
850 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100851 When disabled the display shows each character's true stand-alone
852 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 Arabic is a complex language which requires other settings, for
854 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100855 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856
857 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
858'autoindent' 'ai' boolean (default off)
859 local to buffer
860 Copy indent from current line when starting a new line (typing <CR>
861 in Insert mode or when using the "o" or "O" command). If you do not
862 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000863 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
864 to another line has the same effect, unless the 'I' flag is included
865 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000866 When autoindent is on, formatting (with the "gq" command or when you
867 reach 'textwidth' in Insert mode) uses the indentation of the first
868 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 When 'smartindent' or 'cindent' is on the indent is changed in
870 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200871 The 'autoindent' option is reset when the 'paste' option is set and
872 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873
874 *'autoread'* *'ar'* *'noautoread'* *'noar'*
875'autoread' 'ar' boolean (default off)
876 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877 When a file has been detected to have been changed outside of Vim and
878 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200879 When the file has been deleted this is not done, so you have the text
880 from before it was deleted. When it appears again then it is read.
881 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882 If this option has a local value, use this command to switch back to
883 using the global value: >
884 :set autoread<
885<
886 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
887'autowrite' 'aw' boolean (default off)
888 global
889 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000890 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000891 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
892 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000893 to another file.
894 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000895 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896 Note that for some commands the 'autowrite' option is not used, see
897 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200898 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200899 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900
901 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
902'autowriteall' 'awa' boolean (default off)
903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
905 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
906 Setting this option also implies that Vim behaves like 'autowrite' has
907 been set.
908
909 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200910'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912 When set to "dark", Vim will try to use colors that look good on a
913 dark background. When set to "light", Vim will try to use colors that
914 look good on a light background. Any other value is illegal.
915 Vim tries to set the default value according to the terminal used.
916 This will not always be correct.
917 Setting this option does not change the background color, it tells Vim
918 what the background color looks like. For changing the background
919 color, see |:hi-normal|.
920
921 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000922 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000923 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100924 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 setting 'background' will cause the color scheme to be reloaded. If
926 the color scheme adjusts to the value of 'background' this will work.
927 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100928 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929
930 When setting 'background' to the default value with: >
931 :set background&
932< Vim will guess the value. In the GUI this should work correctly,
933 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200934 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200935 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200937 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200938 color from the terminal. If the returned RGB value is dark/light and
939 'background' is not dark/light, 'background' will be set and the
940 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200941 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100942 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200943
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944 When starting the GUI, the default value for 'background' will be
945 "light". When the value is not set in the .gvimrc, and Vim detects
946 that the background is actually quite dark, 'background' is set to
947 "dark". But this happens only AFTER the .gvimrc file has been read
948 (because the window needs to be opened to find the actual background
949 color). To get around this, force the GUI window to be opened by
950 putting a ":gui" command in the .gvimrc file, before where the value
951 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200952
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100953 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200954 For other systems "dark" is used when 'term' is "linux",
955 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
956 background. Otherwise the default is "light".
957
Bram Moolenaarc572da52017-08-27 16:52:01 +0200958 The |:terminal| command and the |term_start()| function use the
959 'background' value to decide whether the terminal window will start
960 with a white or black background.
961
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962 Normally this option would be set in the .vimrc file. Possibly
963 depending on the terminal name. Example: >
964 :if &term == "pcterm"
965 : set background=dark
966 :endif
967< When this option is set, the default settings for the highlight groups
968 will change. To use other settings, place ":highlight" commands AFTER
969 the setting of the 'background' option.
970 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
971 to select the colors for syntax highlighting. After changing this
972 option, you must load syntax.vim again to see the result. This can be
973 done with ":syntax on".
974
975 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200976'backspace' 'bs' string (default "", set to "indent,eol,start"
977 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
980 mode. This is a list of items, separated by commas. Each item allows
981 a way to backspace over something:
982 value effect ~
983 indent allow backspacing over autoindent
984 eol allow backspacing over line breaks (join lines)
985 start allow backspacing over the start of insert; CTRL-W and CTRL-U
986 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200987 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
988 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989
Bram Moolenaar46eea442022-03-30 10:51:39 +0100990 When the value is empty, Vi compatible backspacing is used, none of
991 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992
993 For backwards compatibility with version 5.4 and earlier:
994 value effect ~
995 0 same as ":set backspace=" (Vi compatible)
996 1 same as ":set backspace=indent,eol"
997 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200998 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999
1000 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1001 NOTE: This option is set to "" when 'compatible' is set.
1002
1003 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1004'backup' 'bk' boolean (default off)
1005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006 Make a backup before overwriting a file. Leave it around after the
1007 file has been successfully written. If you do not want to keep the
1008 backup file, but you do want a backup while the file is being
1009 written, reset this option and set the 'writebackup' option (this is
1010 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001011 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 |backup-table| for more explanations.
1013 When the 'backupskip' pattern matches, a backup is not made anyway.
1014 When 'patchmode' is set, the backup may be renamed to become the
1015 oldest version of a file.
1016 NOTE: This option is reset when 'compatible' is set.
1017
1018 *'backupcopy'* *'bkc'*
1019'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001020 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001022 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023
1024 The main values are:
1025 "yes" make a copy of the file and overwrite the original one
1026 "no" rename the file and write a new one
1027 "auto" one of the previous, what works best
1028
1029 Extra values that can be combined with the ones above are:
1030 "breaksymlink" always break symlinks when writing
1031 "breakhardlink" always break hardlinks when writing
1032
1033 Making a copy and overwriting the original file:
1034 - Takes extra time to copy the file.
1035 + When the file has special attributes, is a (hard/symbolic) link or
1036 has a resource fork, all this is preserved.
1037 - When the file is a link the backup will have the name of the link,
1038 not of the real file.
1039
1040 Renaming the file and writing a new one:
1041 + It's fast.
1042 - Sometimes not all attributes of the file can be copied to the new
1043 file.
1044 - When the file is a link the new file will not be a link.
1045
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001046 The "auto" value is the middle way: When Vim sees that renaming the
1047 file is possible without side effects (the attributes can be passed on
1048 and the file is not a link) that is used. When problems are expected,
1049 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050
1051 The "breaksymlink" and "breakhardlink" values can be used in
1052 combination with any of "yes", "no" and "auto". When included, they
1053 force Vim to always break either symbolic or hard links by doing
1054 exactly what the "no" option does, renaming the original file to
1055 become the backup and writing a new file in its place. This can be
1056 useful for example in source trees where all the files are symbolic or
1057 hard links and any changes should stay in the local source tree, not
1058 be propagated back to the original source.
1059 *crontab*
1060 One situation where "no" and "auto" will cause problems: A program
1061 that opens a file, invokes Vim to edit that file, and then tests if
1062 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001063 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001064 example.
1065
1066 When a copy is made, the original file is truncated and then filled
1067 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001068 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001069 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 group of the backup is set to the group of the original file. If this
1071 fails, the protection bits for the group are made the same as for
1072 others.
1073
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001074 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 the same attributes of the original file, and the newly written file
1076 is owned by the current user. When the file was a (hard/symbolic)
1077 link, the new file will not! That's why the "auto" value doesn't
1078 rename when the file is a link. The owner and group of the newly
1079 written file will be set to the same ones as the original file, but
1080 the system may refuse to do this. In that case the "auto" value will
1081 again not rename the file.
1082
Bram Moolenaar036986f2017-03-16 17:41:02 +01001083 NOTE: This option is set to the Vi default value when 'compatible' is
1084 set and to the Vim default value when 'compatible' is reset.
1085
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 *'backupdir'* *'bdir'*
1087'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001088 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089 for Unix: ".,~/tmp,~/")
1090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091 List of directories for the backup file, separated with commas.
1092 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001093 where this is possible. The directory must exist, Vim will not
1094 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001095 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 impossible!). Writing may fail because of this.
1097 - A directory "." means to put the backup file in the same directory
1098 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001099 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1100 the backup file relative to where the edited file is. The leading
1101 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 ("." inside a directory name has no special meaning).
1103 - Spaces after the comma are ignored, other spaces are considered part
1104 of the directory name. To have a space at the start of a directory
1105 name, precede it with a backslash.
1106 - To include a comma in a directory name precede it with a backslash.
1107 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001108 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001109 the backup file name will be built from the complete path to the
1110 file with all path separators changed to percent '%' signs. This
1111 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001112 On Win32, it is also possible to end with "\\". However, When a
1113 separating comma is following, you must use "//", since "\\" will
1114 include the comma in the file name. Therefore it is recommended to
1115 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 - Environment variables are expanded |:set_env|.
1117 - Careful with '\' characters, type one before a space, type two to
1118 get one in the option (see |option-backslash|), for example: >
1119 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1120< - For backwards compatibility with Vim version 3.0 a '>' at the start
1121 of the option is removed.
1122 See also 'backup' and 'writebackup' options.
1123 If you want to hide your backup files on Unix, consider this value: >
1124 :set backupdir=./.backup,~/.backup,.,/tmp
1125< You must create a ".backup" directory in each directory and in your
1126 home directory for this to work properly.
1127 The use of |:set+=| and |:set-=| is preferred when adding or removing
1128 directories from the list. This avoids problems when a future version
1129 uses another default.
1130 This option cannot be set from a |modeline| or in the |sandbox|, for
1131 security reasons.
1132
1133 *'backupext'* *'bex'* *E589*
1134'backupext' 'bex' string (default "~", for VMS: "_")
1135 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136 String which is appended to a file name to make the name of the
1137 backup file. The default is quite unusual, because this avoids
1138 accidentally overwriting existing files with a backup file. You might
1139 prefer using ".bak", but make sure that you don't have files with
1140 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001141 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001143 If you like to keep a lot of backups, you could use a BufWritePre
1144 autocommand to change 'backupext' just before writing the file to
1145 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001146 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001147< Use 'backupdir' to put the backup in a different directory.
1148
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001150'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1151 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1152 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154 {not available when compiled without the |+wildignore|
1155 feature}
1156 A list of file patterns. When one of the patterns matches with the
1157 name of the file which is written, no backup file is created. Both
1158 the specified file name and the full path name of the file are used.
1159 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1160 Watch out for special characters, see |option-backslash|.
1161 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001162 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001163
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001164 WARNING: Not having a backup file means that when Vim fails to write
1165 your buffer correctly and then, for whatever reason, Vim exits, you
1166 lose both the original file and what you were writing. Only disable
1167 backups if you don't care about losing the file.
1168
Bram Moolenaar02467872007-05-06 13:22:01 +00001169 Note that environment variables are not expanded. If you want to use
1170 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001171 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001172
1173< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001174 backup would be made by renaming the original file crontab won't see
1175 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176
1177 *'balloondelay'* *'bdlay'*
1178'balloondelay' 'bdlay' number (default: 600)
1179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 {only available when compiled with the |+balloon_eval|
1181 feature}
1182 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1183
1184 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1185'ballooneval' 'beval' boolean (default off)
1186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001188 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001189 Switch on the |balloon-eval| functionality for the GUI.
1190
1191 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1192 *'nobevalterm'*
1193'balloonevalterm' 'bevalterm' boolean (default off)
1194 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001195 {only available when compiled with the
1196 |+balloon_eval_term| feature}
1197 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001199 *'balloonexpr'* *'bexpr'*
1200'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001201 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001202 {only available when compiled with the |+balloon_eval|
1203 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001204 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001205 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1206 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001207
1208 v:beval_bufnr number of the buffer in which balloon is going to show
1209 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001210 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001211 v:beval_lnum line number
1212 v:beval_col column number (byte index)
1213 v:beval_text word under or after the mouse pointer
1214
Bram Moolenaar54775062019-07-31 21:07:14 +02001215 Instead of showing a balloon, which is limited to plain text, consider
1216 using a popup window, see |popup_beval_example|. A popup window can
1217 use highlighting and show a border.
1218
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001219 The evaluation of the expression must not have side effects!
1220 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001221 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001222 return 'Cursor is at line ' .. v:beval_lnum ..
1223 \ ', column ' .. v:beval_col ..
1224 \ ' of file ' .. bufname(v:beval_bufnr) ..
1225 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001226 endfunction
1227 set bexpr=MyBalloonExpr()
1228 set ballooneval
1229<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001230 Also see |balloon_show()|, it can be used if the content of the balloon
1231 is to be fetched asynchronously. In that case evaluating
1232 'balloonexpr' should result in an empty string. If you get a balloon
1233 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001234
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001235 NOTE: The balloon is displayed only if the cursor is on a text
1236 character. If the result of evaluating 'balloonexpr' is not empty,
1237 Vim does not try to send a message to an external debugger (Netbeans
1238 or Sun Workshop).
1239
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001240 If the expression starts with s: or |<SID>|, then it is replaced with
1241 the script ID (|local-function|). Example: >
1242 set bexpr=s:MyBalloonExpr()
1243 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001244< Otherwise, the expression is evaluated in the context of the script
1245 where the option was set, thus script-local items are available.
1246
Bram Moolenaar30b65812012-07-12 22:01:11 +02001247 The expression will be evaluated in the |sandbox| when set from a
1248 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001249 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001250
1251 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001252 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001253
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001254 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001255 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001256< When they are supported "\n" characters will start a new line. If the
1257 expression evaluates to a |List| this is equal to using each List item
1258 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001259 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001260
Bram Moolenaar165bc692015-07-21 17:53:25 +02001261 *'belloff'* *'bo'*
1262'belloff' 'bo' string (default "")
1263 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001264 Specifies for which events the bell will not be rung. It is a comma
1265 separated list of items. For each item that is present, the bell
1266 will be silenced. This is most useful to specify specific events in
1267 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001268 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001269
1270 item meaning when present ~
1271 all All events.
1272 backspace When hitting <BS> or <Del> and deleting results in an
1273 error.
1274 cursor Fail to move around using the cursor keys or
1275 <PageUp>/<PageDown> in |Insert-mode|.
1276 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1277 |i_CTRL-X_CTRL-T|.
1278 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1279 |i_CTRL-E|.
1280 ctrlg Unknown Char after <C-G> in Insert mode.
1281 error Other Error occurred (e.g. try to join last line)
1282 (mostly used in |Normal-mode| or |Cmdline-mode|).
1283 esc hitting <Esc> in |Normal-mode|.
1284 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001285 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001286 insertmode Pressing <Esc> in 'insertmode'.
1287 lang Calling the beep module for Lua/Mzscheme/TCL.
1288 mess No output available for |g<|.
1289 showmatch Error occurred for 'showmatch' function.
1290 operator Empty region error |cpo-E|.
1291 register Unknown register after <C-R> in |Insert-mode|.
1292 shell Bell from shell output |:!|.
1293 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001294 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001295 wildmode More matches in |cmdline-completion| available
1296 (depends on the 'wildmode' setting).
1297
Bram Moolenaar036986f2017-03-16 17:41:02 +01001298 This is most useful to fine tune when in Insert mode the bell should
1299 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001300 indicate that an error occurred. It can be silenced by adding the
1301 "error" keyword.
1302
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1304'binary' 'bin' boolean (default off)
1305 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306 This option should be set before editing a binary file. You can also
1307 use the |-b| Vim argument. When this option is switched on a few
1308 options will be changed (also when it already was on):
1309 'textwidth' will be set to 0
1310 'wrapmargin' will be set to 0
1311 'modeline' will be off
1312 'expandtab' will be off
1313 Also, 'fileformat' and 'fileformats' options will not be used, the
1314 file is read and written like 'fileformat' was "unix" (a single <NL>
1315 separates lines).
1316 The 'fileencoding' and 'fileencodings' options will not be used, the
1317 file is read without conversion.
1318 NOTE: When you start editing a(nother) file while the 'bin' option is
1319 on, settings from autocommands may change the settings again (e.g.,
1320 'textwidth'), causing trouble when editing. You might want to set
1321 'bin' again when the file has been loaded.
1322 The previous values of these options are remembered and restored when
1323 'bin' is switched from on to off. Each buffer has its own set of
1324 saved option values.
1325 To edit a file with 'binary' set you can use the |++bin| argument.
1326 This avoids you have to do ":set bin", which would have effect for all
1327 files you edit.
1328 When writing a file the <EOL> for the last line is only written if
1329 there was one in the original file (normally Vim appends an <EOL> to
1330 the last line if there is none; this would make the file longer). See
1331 the 'endofline' option.
1332
1333 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1334'bioskey' 'biosk' boolean (default on)
1335 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001336 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001337 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001338
1339 *'bomb'* *'nobomb'*
1340'bomb' boolean (default off)
1341 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 When writing a file and the following conditions are met, a BOM (Byte
1343 Order Mark) is prepended to the file:
1344 - this option is on
1345 - the 'binary' option is off
1346 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1347 endian variants.
1348 Some applications use the BOM to recognize the encoding of the file.
1349 Often used for UCS-2 files on MS-Windows. For other applications it
1350 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001351 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1353 check for the presence of the BOM is done and 'bomb' set accordingly.
1354 Unless 'binary' is set, it is removed from the first line, so that you
1355 don't see it when editing. When you don't change the options, the BOM
1356 will be restored when writing the file.
1357
1358 *'breakat'* *'brk'*
1359'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1360 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001361 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362 feature}
1363 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001364 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1365 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001367 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001368'breakindent' 'bri' boolean (default off)
1369 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001370 {not available when compiled without the |+linebreak|
1371 feature}
1372 Every wrapped line will continue visually indented (same amount of
1373 space as the beginning of that line), thus preserving horizontal blocks
1374 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001375 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001376
1377 *'breakindentopt'* *'briopt'*
1378'breakindentopt' 'briopt' string (default empty)
1379 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001380 {not available when compiled without the |+linebreak|
1381 feature}
1382 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001383 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001384 min:{n} Minimum text width that will be kept after
1385 applying 'breakindent', even if the resulting
1386 text should normally be narrower. This prevents
1387 text indented almost to the right window border
1388 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001389 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001390 shift:{n} After applying 'breakindent', the wrapped line's
1391 beginning will be shifted by the given number of
1392 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001393 indentation (negative) or emphasizing the line
1394 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001395 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001396 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001397 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001398 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001399 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001400 numbered or bulleted list (using the
1401 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001402 list:-1 Uses the length of a match with 'formatlistpat'
1403 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001404 (default: 0)
1405 column:{n} Indent at column {n}. Will overrule the other
1406 sub-options. Note: an additional indent may be
1407 added for the 'showbreak' setting.
1408 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001409
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001411'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001413 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001414 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001415 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001416 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417 buffer Use the directory of the related buffer.
1418 current Use the current directory.
1419 {path} Use the specified directory
1420
1421 *'bufhidden'* *'bh'*
1422'bufhidden' 'bh' string (default: "")
1423 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 This option specifies what happens when a buffer is no longer
1425 displayed in a window:
1426 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001427 hide hide the buffer (don't unload it), even if 'hidden' is
1428 not set
1429 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001430 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001431 delete delete the buffer from the buffer list, even if
1432 'hidden' is set; the |:hide| command will also delete
1433 the buffer, making it behave like |:bdelete|
1434 wipe wipe the buffer from the buffer list, even if
1435 'hidden' is set; the |:hide| command will also wipe
1436 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001438 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001439 are lost without a warning. Also, these values may break autocommands
1440 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441 This option is used together with 'buftype' and 'swapfile' to specify
1442 special kinds of buffers. See |special-buffers|.
1443
1444 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1445'buflisted' 'bl' boolean (default: on)
1446 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 When this option is set, the buffer shows up in the buffer list. If
1448 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1449 This option is reset by Vim for buffers that are only used to remember
1450 a file name or marks. Vim sets it when starting to edit a buffer.
1451 But not when moving to a buffer with ":buffer".
1452
1453 *'buftype'* *'bt'* *E382*
1454'buftype' 'bt' string (default: "")
1455 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456 The value of this option specifies the type of a buffer:
1457 <empty> normal buffer
1458 nofile buffer which is not related to a file and will not be
1459 written
1460 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001461 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001462 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001464 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 help help buffer (you are not supposed to set this
1466 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001467 terminal buffer for a |terminal| (you are not supposed to set
1468 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001469 prompt buffer where only the last line can be edited, meant
1470 to be used by a plugin, see |prompt-buffer|
1471 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001472 popup buffer used in a popup window, see |popup|.
1473 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474
1475 This option is used together with 'bufhidden' and 'swapfile' to
1476 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001477 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001478
1479 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001480 One such effect is that Vim will not check the timestamp of the file,
1481 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001482
Bram Moolenaar280f1262006-01-30 00:14:18 +00001483 A "quickfix" buffer is only used for the error list and the location
1484 list. This value is set by the |:cwindow| and |:lwindow| commands and
1485 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486
1487 "nofile" and "nowrite" buffers are similar:
1488 both: The buffer is not to be written to disk, ":w" doesn't
1489 work (":w filename" does work though).
1490 both: The buffer is never considered to be |'modified'|.
1491 There is no warning when the changes will be lost, for
1492 example when you quit Vim.
1493 both: A swap file is only created when using too much memory
1494 (when 'swapfile' has been reset there is never a swap
1495 file).
1496 nofile only: The buffer name is fixed, it is not handled like a
1497 file name. It is not modified in response to a |:cd|
1498 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001499 both: When using ":e bufname" and already editing "bufname"
1500 the buffer is made empty and autocommands are
1501 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001502 *E676*
1503 "acwrite" implies that the buffer name is not related to a file, like
1504 "nofile", but it will be written. Thus, in contrast to "nofile" and
1505 "nowrite", ":w" does work and a modified buffer can't be abandoned
1506 without saving. For writing there must be matching |BufWriteCmd|,
1507 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508
1509 *'casemap'* *'cmp'*
1510'casemap' 'cmp' string (default: "internal,keepascii")
1511 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512 Specifies details about changing the case of letters. It may contain
1513 these words, separated by a comma:
1514 internal Use internal case mapping functions, the current
1515 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001516 matters when 'encoding' is a Unicode encoding,
1517 "latin1" or "iso-8859-15". When "internal" is
1518 omitted, the towupper() and towlower() system library
1519 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1521 case mapping, the current locale is not effective.
1522 This probably only matters for Turkish.
1523
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001524 *'cdhome'* *'cdh'*
1525'cdhome' 'cdh' boolean (default: off)
1526 global
1527 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1528 current working directory to the |$HOME| directory like in Unix.
1529 When off, those commands just print the current directory name.
1530 On Unix this option has no effect.
1531 NOTE: This option is reset when 'compatible' is set.
1532
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533 *'cdpath'* *'cd'* *E344* *E346*
1534'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1535 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 {not available when compiled without the
1537 |+file_in_path| feature}
1538 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001539 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1540 searched for has a relative path, not an absolute part starting with
1541 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 The 'cdpath' option's value has the same form and semantics as
1543 |'path'|. Also see |file-searching|.
1544 The default value is taken from $CDPATH, with a "," prepended to look
1545 in the current directory first.
1546 If the default value taken from $CDPATH is not what you want, include
1547 a modified version of the following command in your vimrc file to
1548 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001549 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550< This option cannot be set from a |modeline| or in the |sandbox|, for
1551 security reasons.
1552 (parts of 'cdpath' can be passed to the shell to expand file names).
1553
1554 *'cedit'*
1555'cedit' string (Vi default: "", Vim default: CTRL-F)
1556 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 The key used in Command-line Mode to open the command-line window.
1558 The default is CTRL-F when 'compatible' is off.
1559 Only non-printable keys are allowed.
1560 The key can be specified as a single character, but it is difficult to
1561 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001562 :exe "set cedit=\<C-Y>"
1563 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001564< |Nvi| also has this option, but it only uses the first character.
1565 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001566 NOTE: This option is set to the Vim default value when 'compatible'
1567 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568
1569 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1570'charconvert' 'ccv' string (default "")
1571 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001572 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573 An expression that is used for character encoding conversion. It is
1574 evaluated when a file that is to be read or has been written has a
1575 different encoding from what is desired.
1576 'charconvert' is not used when the internal iconv() function is
1577 supported and is able to do the conversion. Using iconv() is
1578 preferred, because it is much faster.
1579 'charconvert' is not used when reading stdin |--|, because there is no
1580 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001581 The expression must return zero, false or an empty string for success,
1582 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583 The possible encoding names encountered are in 'encoding'.
1584 Additionally, names given in 'fileencodings' and 'fileencoding' are
1585 used.
1586 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1587 is done internally by Vim, 'charconvert' is not used for this.
1588 'charconvert' is also used to convert the viminfo file, if the 'c'
1589 flag is present in 'viminfo'. Also used for Unicode conversion.
1590 Example: >
1591 set charconvert=CharConvert()
1592 fun CharConvert()
1593 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001594 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1595 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001596 return v:shell_error
1597 endfun
1598< The related Vim variables are:
1599 v:charconvert_from name of the current encoding
1600 v:charconvert_to name of the desired encoding
1601 v:fname_in name of the input file
1602 v:fname_out name of the output file
1603 Note that v:fname_in and v:fname_out will never be the same.
1604 Note that v:charconvert_from and v:charconvert_to may be different
1605 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001606
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 Encryption is not done by Vim when using 'charconvert'. If you want
1608 to encrypt the file after conversion, 'charconvert' should take care
1609 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001610
1611 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1612 replaced with the script ID (|local-function|). Example: >
1613 set charconvert=s:MyConvert()
1614 set charconvert=<SID>SomeConvert()
1615< Otherwise the expression is evaluated in the context of the script
1616 where the option was set, thus script-local items are available.
1617
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618 This option cannot be set from a |modeline| or in the |sandbox|, for
1619 security reasons.
1620
1621 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1622'cindent' 'cin' boolean (default off)
1623 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001624 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625 that trigger reindenting in insert mode and 'cinoptions' to set your
1626 preferred indent style.
1627 If 'indentexpr' is not empty, it overrules 'cindent'.
1628 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1629 the "=" operator indents using this algorithm rather than calling an
1630 external program.
1631 See |C-indenting|.
1632 When you don't like the way 'cindent' works, try the 'smartindent'
1633 option or 'indentexpr'.
1634 This option is not used when 'paste' is set.
1635 NOTE: This option is reset when 'compatible' is set.
1636
1637 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001638'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640 A list of keys that, when typed in Insert mode, cause reindenting of
1641 the current line. Only used if 'cindent' is on and 'indentexpr' is
1642 empty.
1643 For the format of this option see |cinkeys-format|.
1644 See |C-indenting|.
1645
1646 *'cinoptions'* *'cino'*
1647'cinoptions' 'cino' string (default "")
1648 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1650 program. See |cinoptions-values| for the values of this option, and
1651 |C-indenting| for info on C indenting in general.
1652
1653
1654 *'cinwords'* *'cinw'*
1655'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1656 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657 These keywords start an extra indent in the next line when
1658 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1659 an appropriate place (inside {}).
1660 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1661 matter, include the keyword both the uppercase and lowercase:
1662 "if,If,IF".
1663
Tom Praschan3506cf32022-04-07 12:39:08 +01001664 *'cinscopedecls'* *'cinsd'*
1665'cinscopedecls' 'cinsd' string (default "public,protected,private")
1666 local to buffer
Tom Praschan3506cf32022-04-07 12:39:08 +01001667 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1668 Useful e.g. for working with the Qt framework that defines additional
1669 scope declarations "signals", "public slots" and "private slots": >
1670 set cinscopedecls+=signals,public\ slots,private\ slots
1671
1672< *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1674 for X-windows, "" otherwise)
1675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676 {only in GUI versions or when the |+xterm_clipboard|
1677 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001678 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001679 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001680 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001681 prepend, e.g.: >
1682 set clipboard^=unnamed
1683< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001684
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001685 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 unnamed When included, Vim will use the clipboard register '*'
1687 for all yank, delete, change and put operations which
1688 would normally go to the unnamed register. When a
1689 register is explicitly specified, it will always be
1690 used regardless of whether "unnamed" is in 'clipboard'
1691 or not. The clipboard register can always be
1692 explicitly accessed using the "* notation. Also see
1693 |gui-clipboard|.
1694
Bram Moolenaar30b65812012-07-12 22:01:11 +02001695 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001696 unnamedplus A variant of the "unnamed" flag which uses the
1697 clipboard register '+' (|quoteplus|) instead of
1698 register '*' for all yank, delete, change and put
1699 operations which would normally go to the unnamed
1700 register. When "unnamed" is also included to the
1701 option, yank operations (but not delete, change or
1702 put) will additionally copy the text into register
1703 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001704 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001705 Availability can be checked with: >
1706 if has('unnamedplus')
1707<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001708 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 autoselect Works like the 'a' flag in 'guioptions': If present,
1710 then whenever Visual mode is started, or the Visual
1711 area extended, Vim tries to become the owner of the
1712 windowing system's global selection or put the
1713 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001714 register "*. See |'go-a'| and |quotestar| for details.
1715 When the GUI is active, the 'a' flag in 'guioptions'
1716 is used, when the GUI is not active, this "autoselect"
1717 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718 Also applies to the modeless selection.
1719
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001720 *clipboard-autoselectplus*
1721 autoselectplus Like "autoselect" but using the + register instead of
1722 the * register. Compare to the 'P' flag in
1723 'guioptions'.
1724
1725 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726 autoselectml Like "autoselect", but for the modeless selection
1727 only. Compare to the 'A' flag in 'guioptions'.
1728
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001729 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001730 html When the clipboard contains HTML, use this when
1731 pasting. When putting text on the clipboard, mark it
1732 as HTML. This works to copy rendered HTML from
1733 Firefox, paste it as raw HTML in Vim, select the HTML
1734 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001735 You probably want to add this only temporarily,
1736 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001737 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001738
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001739 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740 exclude:{pattern}
1741 Defines a pattern that is matched against the name of
1742 the terminal 'term'. If there is a match, no
1743 connection will be made to the X server. This is
1744 useful in this situation:
1745 - Running Vim in a console.
1746 - $DISPLAY is set to start applications on another
1747 display.
1748 - You do not want to connect to the X server in the
1749 console, but do want this in a terminal emulator.
1750 To never connect to the X server use: >
1751 exclude:.*
1752< This has the same effect as using the |-X| argument.
1753 Note that when there is no connection to the X server
1754 the window title won't be restored and the clipboard
1755 cannot be accessed.
1756 The value of 'magic' is ignored, {pattern} is
1757 interpreted as if 'magic' was on.
1758 The rest of the option value will be used for
1759 {pattern}, this must be the last entry.
1760
1761 *'cmdheight'* *'ch'*
1762'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001763 global or local to tab page
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764 Number of screen lines to use for the command-line. Helps avoiding
1765 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001766 The value of this option is stored with the tab page, so that each tab
1767 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001769 When 'cmdheight' is zero, there is no command-line unless it is being
1770 used. Any messages will cause the |hit-enter| prompt.
1771
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 *'cmdwinheight'* *'cwh'*
1773'cmdwinheight' 'cwh' number (default 7)
1774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001775 Number of screen lines to use for the command-line window. |cmdwin|
1776
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001777 *'colorcolumn'* *'cc'*
1778'colorcolumn' 'cc' string (default "")
1779 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001780 {not available when compiled without the |+syntax|
1781 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001782 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001783 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1784 text. Will make screen redrawing slower.
1785 The screen column can be an absolute number, or a number preceded with
1786 '+' or '-', which is added to or subtracted from 'textwidth'. >
1787
1788 :set cc=+1 " highlight column after 'textwidth'
1789 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1790 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1791<
1792 When 'textwidth' is zero then the items with '-' and '+' are not used.
1793 A maximum of 256 columns are highlighted.
1794
Bram Moolenaar071d4272004-06-13 20:20:40 +00001795 *'columns'* *'co'* *E594*
1796'columns' 'co' number (default 80 or terminal width)
1797 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001799 initialization and does not have to be set by hand. Also see
1800 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 When Vim is running in the GUI or in a resizable window, setting this
1802 option will cause the window size to be changed. When you only want
1803 to use the size for the GUI, put the command in your |gvimrc| file.
1804 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001805 number of columns of the display, the display may be messed up. For
1806 the GUI it is always possible and Vim limits the number of columns to
1807 what fits on the screen. You can use this command to get the widest
1808 window possible: >
1809 :set columns=9999
1810< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811
1812 *'comments'* *'com'* *E524* *E525*
1813'comments' 'com' string (default
1814 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1815 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001816 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817 |format-comments|. See |option-backslash| about using backslashes to
1818 insert a space.
1819
1820 *'commentstring'* *'cms'* *E537*
1821'commentstring' 'cms' string (default "/*%s*/")
1822 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 {not available when compiled without the |+folding|
1824 feature}
1825 A template for a comment. The "%s" in the value is replaced with the
1826 comment text. Currently only used to add markers for folding, see
1827 |fold-marker|.
1828
1829 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001830'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001831 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 This option has the effect of making Vim either more Vi-compatible, or
1834 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001835
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001837 other options are also changed as a side effect.
1838 NOTE: Setting or resetting this option can have a lot of unexpected
1839 effects: Mappings are interpreted in another way, undo behaves
1840 differently, etc. If you set this option in your vimrc file, you
1841 should probably put it at the very start.
1842
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843 By default this option is on and the Vi defaults are used for the
1844 options. This default was chosen for those people who want to use Vim
1845 just like Vi, and don't even (want to) know about the 'compatible'
1846 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001847 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001848 this option is switched off, and all options that have not been
1849 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001850 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001851 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001852 happen for the system-wide vimrc or gvimrc file, nor for a file given
1853 with the |-u| argument). Also see |compatible-default| and
1854 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855 You can also set this option with the "-C" argument, and reset it with
1856 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001857 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858
Bram Moolenaar214641f2017-03-05 17:04:09 +01001859 When this option is set, numerous other options are set to make Vim as
1860 Vi-compatible as possible. When this option is unset, various options
1861 are set to make Vim more useful. The table below lists all the
1862 options affected.
1863 The {?} column indicates when the options are affected:
1864 + Means that the option is set to the value given in {set value} when
1865 'compatible' is set.
1866 & Means that the option is set to the value given in {set value} when
1867 'compatible' is set AND is set to its Vim default value when
1868 'compatible' is unset.
1869 - Means the option is NOT changed when setting 'compatible' but IS
1870 set to its Vim default when 'compatible' is unset.
1871 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872
Bram Moolenaar036986f2017-03-16 17:41:02 +01001873 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001874
1875 'allowrevins' + off no CTRL-_ command
1876 'antialias' + off don't use antialiased fonts
1877 'arabic' + off reset arabic-related options
1878 'arabicshape' + on correct character shapes
1879 'backspace' + "" normal backspace
1880 'backup' + off no backup file
1881 'backupcopy' & Unix: "yes" backup file is a copy
1882 else: "auto" copy or rename backup file
1883 'balloonexpr' + "" text to show in evaluation balloon
1884 'breakindent' + off don't indent when wrapping lines
1885 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001886 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001887 'cindent' + off no C code indentation
1888 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1889 'copyindent' + off don't copy indent structure
1890 'cpoptions' & (all flags) Vi-compatible flags
1891 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001892 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001893 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001894 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001895 'cscopeverbose' + off see |cscopeverbose|
1896 'delcombine' + off unicode: delete whole char combination
1897 'digraph' + off no digraphs
1898 'esckeys' & off no <Esc>-keys in Insert mode
1899 'expandtab' + off tabs not expanded to spaces
1900 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001901 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001902 'formatexpr' + "" use 'formatprg' for auto-formatting
1903 'formatoptions' & "vt" Vi compatible formatting
1904 'gdefault' + off no default 'g' flag for ":s"
1905 'history' & 0 no commandline history
1906 'hkmap' + off no Hebrew keyboard mapping
1907 'hkmapp' + off no phonetic Hebrew keyboard mapping
1908 'hlsearch' + off no highlighting of search matches
1909 'incsearch' + off no incremental searching
1910 'indentexpr' + "" no indenting by expression
1911 'insertmode' + off do not start in Insert mode
1912 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001914 'joinspaces' + on insert 2 spaces after period
1915 'modeline' & off no modelines
1916 'more' & off no pauses in listings
1917 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1918 'numberwidth' & 8 min number of columns for line number
1919 'preserveindent'+ off don't preserve current indent structure
1920 when changing it
1921 'revins' + off no reverse insert
1922 'ruler' + off no ruler
1923 'scrolljump' + 1 no jump scroll
1924 'scrolloff' + 0 no scroll offset
1925 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1926 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001927 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001928 'showcmd' & off command characters not shown
1929 'showmode' & off current mode not shown
1930 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1931 'smartcase' + off no automatic ignore case switch
1932 'smartindent' + off no smart indentation
1933 'smarttab' + off no smart tab size
1934 'softtabstop' + 0 tabs are always 'tabstop' positions
1935 'startofline' + on goto startofline with some commands
1936 'tagcase' & "followic" 'ignorecase' when searching tags file
1937 'tagrelative' & off tag file names are not relative
1938 'termguicolors' + off don't use highlight-(guifg|guibg)
1939 'textauto' & off no automatic textmode detection
1940 'textwidth' + 0 no automatic line wrap
1941 'tildeop' + off tilde is not an operator
1942 'ttimeout' + off no terminal timeout
1943 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001944 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001945 'virtualedit' + "" cursor can only be placed on characters
1946 'whichwrap' & "" left-right movements don't wrap
1947 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001948 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001949 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950
1951 *'complete'* *'cpt'* *E535*
1952'complete' 'cpt' string (default: ".,w,b,u,t,i")
1953 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954 This option specifies how keyword completion |ins-completion| works
1955 when CTRL-P or CTRL-N are used. It is also used for whole-line
1956 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001957 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001958 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001959 w scan buffers from other windows
1960 b scan other loaded buffers that are in the buffer list
1961 u scan the unloaded buffers that are in the buffer list
1962 U scan the buffers that are not in the buffer list
1963 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001964 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 k{dict} scan the file {dict}. Several "k" flags can be given,
1966 patterns are valid too. For example: >
1967 :set cpt=k/usr/dict/*,k~/spanish
1968< s scan the files given with the 'thesaurus' option
1969 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1970 are valid too.
1971 i scan current and included files
1972 d scan current and included files for defined name or macro
1973 |i_CTRL-X_CTRL-D|
1974 ] tag completion
1975 t same as "]"
1976
1977 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1978 not executed, this may lead to unexpected completions from some files
1979 (gzipped files for example). Unloaded buffers are not scanned for
1980 whole-line completion.
1981
1982 The default is ".,w,b,u,t,i", which means to scan:
1983 1. the current buffer
1984 2. buffers in other windows
1985 3. other loaded buffers
1986 4. unloaded buffers
1987 5. tags
1988 6. included files
1989
1990 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001991 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1992 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001994 *'completefunc'* *'cfu'*
1995'completefunc' 'cfu' string (default: empty)
1996 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001997 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001998 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001999 This option specifies a function to be used for Insert mode completion
2000 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002001 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002002 invoked and what it should return. The value can be the name of a
2003 function, a |lambda| or a |Funcref|. See |option-value-function| for
2004 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002005 This option cannot be set from a |modeline| or in the |sandbox|, for
2006 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002007
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002008 *'completeslash'* *'csl'*
2009'completeslash' 'csl' string (default: "")
2010 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002011 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002012 When this option is set it overrules 'shellslash' for completion:
2013 - When this option is set to "slash", a forward slash is used for path
2014 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002015 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002016 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002017 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002018 - When this option is empty, same character is used as for
2019 'shellslash'.
2020 For Insert mode completion the buffer-local value is used. For
2021 command line completion the global value is used.
2022
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002023 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002024'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002025 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002026 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002027 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002028
2029 menu Use a popup menu to show the possible completions. The
2030 menu is only shown when there is more than one match and
2031 sufficient colors are available. |ins-completion-menu|
2032
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002033 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002034 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002035 match, e.g., what file it comes from.
2036
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002037 longest Only insert the longest common text of the matches. If
2038 the menu is displayed you can use CTRL-L to add more
2039 characters. Whether case is ignored depends on the kind
2040 of completion. For buffer text the 'ignorecase' option is
2041 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002042
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002043 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002044 completion in the preview window. Only works in
2045 combination with "menu" or "menuone".
2046
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002047 popup Show extra information about the currently selected
2048 completion in a popup window. Only works in combination
2049 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002050 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002051 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002052
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002053 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002054 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002055 |CompleteChanged| autocommand to fetch the info and call
2056 |popup_show()| once the popup has been filled.
2057 See the example at |complete-popuphidden|.
2058 {only works when compiled with the |+textprop| feature}
2059
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002060 noinsert Do not insert any text for a match until the user selects
2061 a match from the menu. Only works in combination with
2062 "menu" or "menuone". No effect if "longest" is present.
2063
2064 noselect Do not select a match in the menu, force the user to
2065 select one from the menu. Only works in combination with
2066 "menu" or "menuone".
2067
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002068
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002069 *'completepopup'* *'cpp'*
2070'completepopup' 'cpp' string (default empty)
2071 global
2072 {not available when compiled without the |+textprop|
2073 or |+quickfix| feature}
2074 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002075 properties of the info popup when it is created. If an info popup
2076 window already exists it is closed, so that the option value is
2077 applied when it is created again.
2078 You can also use |popup_findinfo()| and then set properties for an
2079 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002080
2081
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002082 *'concealcursor'* *'cocu'*
2083'concealcursor' 'cocu' string (default: "")
2084 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002085 {not available when compiled without the |+conceal|
2086 feature}
2087 Sets the modes in which text in the cursor line can also be concealed.
2088 When the current mode is listed then concealing happens just like in
2089 other lines.
2090 n Normal mode
2091 v Visual mode
2092 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002093 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002094
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002095 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002096 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002097 are moving around text is concealed, but when starting to insert text
2098 or selecting a Visual area the concealed text is displayed, so that
2099 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002100 Keep in mind that the cursor position is not always where it's
2101 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002102
2103
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002104 *'conceallevel'* *'cole'*
2105'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002106 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002107 {not available when compiled without the |+conceal|
2108 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002109 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2110 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002111
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002112 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002113 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002114 1 Each block of concealed text is replaced with one
2115 character. If the syntax item does not have a custom
2116 replacement character defined (see |:syn-cchar|) the
2117 character defined in 'listchars' is used (default is a
2118 space).
2119 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002120 2 Concealed text is completely hidden unless it has a
2121 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002122 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002123 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002124
Bram Moolenaara7781e02010-07-19 20:13:22 +02002125 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002126 edit and copy the text. This can be changed with the 'concealcursor'
2127 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002128
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2130'confirm' 'cf' boolean (default off)
2131 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132 When 'confirm' is on, certain operations that would normally
2133 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2134 instead raise a |dialog| asking if you wish to save the current
2135 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2136 If 'confirm' is off you can still activate confirmation for one
2137 command only (this is most useful in mappings) with the |:confirm|
2138 command.
2139 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2140
2141 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2142'conskey' 'consk' boolean (default off)
2143 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002144 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145
2146 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2147'copyindent' 'ci' boolean (default off)
2148 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 Copy the structure of the existing lines indent when autoindenting a
2150 new line. Normally the new indent is reconstructed by a series of
2151 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2152 in which case only spaces are used). Enabling this option makes the
2153 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002154 existing line. 'expandtab' has no effect on these characters, a Tab
2155 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002157 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158 Also see 'preserveindent'.
2159
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002160 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161'cpoptions' 'cpo' string (Vim default: "aABceFs",
2162 Vi default: all flags)
2163 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002165 this indicates Vi-compatible behavior. This is used for things where
2166 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167 'cpoptions' stands for "compatible-options".
2168 Commas can be added for readability.
2169 To avoid problems with flags that are added in the future, use the
2170 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002171
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172 NOTE: This option is set to the Vi default value when 'compatible' is
2173 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002174
2175 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2176 is saved, 'cpoptions' is set to the Vim default, and the saved value
2177 is restored at the end of the script. Changes to the value of
2178 'cpoptions' will be applied to the saved value, but keep in mind that
2179 removing a flag that is not present when 'cpoptions' is changed has no
2180 effect. In the |.vimrc| file the value is not restored, thus using
2181 `vim9script` in the |.vimrc| file results in using the Vim default.
2182
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002183 NOTE: This option is set to the POSIX default value at startup when
2184 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002185 variable exists |posix|. This means Vim tries to behave like the
2186 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187
2188 contains behavior ~
2189 *cpo-a*
2190 a When included, a ":read" command with a file name
2191 argument will set the alternate file name for the
2192 current window.
2193 *cpo-A*
2194 A When included, a ":write" command with a file name
2195 argument will set the alternate file name for the
2196 current window.
2197 *cpo-b*
2198 b "\|" in a ":map" command is recognized as the end of
2199 the map command. The '\' is included in the mapping,
2200 the text after the '|' is interpreted as the next
2201 command. Use a CTRL-V instead of a backslash to
2202 include the '|' in the mapping. Applies to all
2203 mapping, abbreviation, menu and autocmd commands.
2204 See also |map_bar|.
2205 *cpo-B*
2206 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002207 abbreviations, user commands and the "to" part of the
2208 menu commands. Remove this flag to be able to use a
2209 backslash like a CTRL-V. For example, the command
2210 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211 'B' included: "\^[" (^[ is a real <Esc>)
2212 'B' excluded: "<Esc>" (5 characters)
2213 ('<' excluded in both cases)
2214 *cpo-c*
2215 c Searching continues at the end of any match at the
2216 cursor position, but not further than the start of the
2217 next line. When not present searching continues
2218 one character from the cursor position. With 'c'
2219 "abababababab" only gets three matches when repeating
2220 "/abab", without 'c' there are five matches.
2221 *cpo-C*
2222 C Do not concatenate sourced lines that start with a
2223 backslash. See |line-continuation|.
2224 *cpo-d*
2225 d Using "./" in the 'tags' option doesn't mean to use
2226 the tags file relative to the current file, but the
2227 tags file in the current directory.
2228 *cpo-D*
2229 D Can't use CTRL-K to enter a digraph after Normal mode
2230 commands with a character argument, like |r|, |f| and
2231 |t|.
2232 *cpo-e*
2233 e When executing a register with ":@r", always add a
2234 <CR> to the last line, also when the register is not
2235 linewise. If this flag is not present, the register
2236 is not linewise and the last line does not end in a
2237 <CR>, then the last line is put on the command-line
2238 and can be edited before hitting <CR>.
2239 *cpo-E*
2240 E It is an error when using "y", "d", "c", "g~", "gu" or
2241 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002242 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243 This makes "y0" fail in the first column.
2244 *cpo-f*
2245 f When included, a ":read" command with a file name
2246 argument will set the file name for the current buffer,
2247 if the current buffer doesn't have a file name yet.
2248 *cpo-F*
2249 F When included, a ":write" command with a file name
2250 argument will set the file name for the current
2251 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002252 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 *cpo-g*
2254 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002255 *cpo-H*
2256 H When using "I" on a line with only blanks, insert
2257 before the last blank. Without this flag insert after
2258 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 *cpo-i*
2260 i When included, interrupting the reading of a file will
2261 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002262 *cpo-I*
2263 I When moving the cursor up or down just after inserting
2264 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 *cpo-j*
2266 j When joining lines, only add two spaces after a '.',
2267 not after '!' or '?'. Also see 'joinspaces'.
2268 *cpo-J*
2269 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002270 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002271 white space.
2272 *cpo-k*
2273 k Disable the recognition of raw key codes in
2274 mappings, abbreviations, and the "to" part of menu
2275 commands. For example, if <Key> sends ^[OA (where ^[
2276 is <Esc>), the command ":map X ^[OA" results in X
2277 being mapped to:
2278 'k' included: "^[OA" (3 characters)
2279 'k' excluded: "<Key>" (one key code)
2280 Also see the '<' flag below.
2281 *cpo-K*
2282 K Don't wait for a key code to complete when it is
2283 halfway a mapping. This breaks mapping <F1><F1> when
2284 only part of the second <F1> has been read. It
2285 enables cancelling the mapping by typing <F1><Esc>.
2286 *cpo-l*
2287 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002288 literally, only "\]", "\^", "\-" and "\\" are special.
2289 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2291 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002292 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293 *cpo-L*
2294 L When the 'list' option is set, 'wrapmargin',
2295 'textwidth', 'softtabstop' and Virtual Replace mode
2296 (see |gR|) count a <Tab> as two characters, instead of
2297 the normal behavior of a <Tab>.
2298 *cpo-m*
2299 m When included, a showmatch will always wait half a
2300 second. When not included, a showmatch will wait half
2301 a second or until a character is typed. |'showmatch'|
2302 *cpo-M*
2303 M When excluded, "%" matching will take backslashes into
2304 account. Thus in "( \( )" and "\( ( \)" the outer
2305 parenthesis match. When included "%" ignores
2306 backslashes, which is Vi compatible.
2307 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002308 n When included, the column used for 'number' and
2309 'relativenumber' will also be used for text of wrapped
2310 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002311 *cpo-o*
2312 o Line offset to search command is not remembered for
2313 next search.
2314 *cpo-O*
2315 O Don't complain if a file is being overwritten, even
2316 when it didn't exist when editing it. This is a
2317 protection against a file unexpectedly created by
2318 someone else. Vi didn't complain about this.
2319 *cpo-p*
2320 p Vi compatible Lisp indenting. When not present, a
2321 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002322 *cpo-P*
2323 P When included, a ":write" command that appends to a
2324 file will set the file name for the current buffer, if
2325 the current buffer doesn't have a file name yet and
2326 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002327 *cpo-q*
2328 q When joining multiple lines leave the cursor at the
2329 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002330 *cpo-r*
2331 r Redo ("." command) uses "/" to repeat a search
2332 command, instead of the actually used search string.
2333 *cpo-R*
2334 R Remove marks from filtered lines. Without this flag
2335 marks are kept like |:keepmarks| was used.
2336 *cpo-s*
2337 s Set buffer options when entering the buffer for the
2338 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002339 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002340 set when the buffer is created.
2341 *cpo-S*
2342 S Set buffer options always when entering a buffer
2343 (except 'readonly', 'fileformat', 'filetype' and
2344 'syntax'). This is the (most) Vi compatible setting.
2345 The options are set to the values in the current
2346 buffer. When you change an option and go to another
2347 buffer, the value is copied. Effectively makes the
2348 buffer options global to all buffers.
2349
2350 's' 'S' copy buffer options
2351 no no when buffer created
2352 yes no when buffer first entered (default)
2353 X yes each time when buffer entered (vi comp.)
2354 *cpo-t*
2355 t Search pattern for the tag command is remembered for
2356 "n" command. Otherwise Vim only puts the pattern in
2357 the history for search pattern, but doesn't change the
2358 last used search pattern.
2359 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002360 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361 *cpo-v*
2362 v Backspaced characters remain visible on the screen in
2363 Insert mode. Without this flag the characters are
2364 erased from the screen right away. With this flag the
2365 screen newly typed text overwrites backspaced
2366 characters.
2367 *cpo-w*
2368 w When using "cw" on a blank character, only change one
2369 character and not all blanks until the start of the
2370 next word.
2371 *cpo-W*
2372 W Don't overwrite a readonly file. When omitted, ":w!"
2373 overwrites a readonly file, if possible.
2374 *cpo-x*
2375 x <Esc> on the command-line executes the command-line.
2376 The default in Vim is to abandon the command-line,
2377 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002378 *cpo-X*
2379 X When using a count with "R" the replaced text is
2380 deleted only once. Also when repeating "R" with "."
2381 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002383 y A yank command can be redone with ".". Think twice if
2384 you really want to use this, it may break some
2385 plugins, since most people expect "." to only repeat a
2386 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002387 *cpo-Z*
2388 Z When using "w!" while the 'readonly' option is set,
2389 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 *cpo-!*
2391 ! When redoing a filter command, use the last used
2392 external command, whatever it was. Otherwise the last
2393 used -filter- command is used.
2394 *cpo-$*
2395 $ When making a change to one line, don't redisplay the
2396 line, but put a '$' at the end of the changed text.
2397 The changed text will be overwritten when you type the
2398 new text. The line is redisplayed if you type any
2399 command that moves the cursor from the insertion
2400 point.
2401 *cpo-%*
2402 % Vi-compatible matching is done for the "%" command.
2403 Does not recognize "#if", "#endif", etc.
2404 Does not recognize "/*" and "*/".
2405 Parens inside single and double quotes are also
2406 counted, causing a string that contains a paren to
2407 disturb the matching. For example, in a line like
2408 "if (strcmp("foo(", s))" the first paren does not
2409 match the last one. When this flag is not included,
2410 parens inside single and double quotes are treated
2411 specially. When matching a paren outside of quotes,
2412 everything inside quotes is ignored. When matching a
2413 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002414 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002415 This flag is also used for other features, such as
2416 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002417 *cpo--*
2418 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002419 it would go above the first line or below the last
2420 line. Without it the cursor moves to the first or
2421 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002422 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002423 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002424 *cpo-+*
2425 + When included, a ":write file" command will reset the
2426 'modified' flag of the buffer, even though the buffer
2427 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002428 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 * Use ":*" in the same way as ":@". When not included,
2430 ":*" is an alias for ":'<,'>", select the Visual area.
2431 *cpo-<*
2432 < Disable the recognition of special key codes in |<>|
2433 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002434 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002435 ":map X <Tab>" results in X being mapped to:
2436 '<' included: "<Tab>" (5 characters)
2437 '<' excluded: "^I" (^I is a real <Tab>)
2438 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002439 *cpo->*
2440 > When appending to a register, put a line break before
2441 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002442 *cpo-;*
2443 ; When using |,| or |;| to repeat the last |t| search
2444 and the cursor is right in front of the searched
2445 character, the cursor won't move. When not included,
2446 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002447 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002448
2449 POSIX flags. These are not included in the Vi default value, except
2450 when $VIM_POSIX was set on startup. |posix|
2451
2452 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002453 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002454 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002455 *cpo-&*
2456 & When ":preserve" was used keep the swap file when
2457 exiting normally while this buffer is still loaded.
2458 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002459 *cpo-\*
2460 \ Backslash in a [] range in a search pattern is taken
2461 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002462 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2463 '\' excluded: "/[ \-]" finds <Space> and '-'
2464 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002465 *cpo-/*
2466 / When "%" is used as the replacement string in a |:s|
2467 command, use the previous replacement string. |:s%|
2468 *cpo-{*
2469 { The |{| and |}| commands also stop at a "{" character
2470 at the start of a line.
2471 *cpo-.*
2472 . The ":chdir" and ":cd" commands fail if the current
2473 buffer is modified, unless ! is used. Vim doesn't
2474 need this, since it remembers the full path of an
2475 opened file.
2476 *cpo-bar*
2477 | The value of the $LINES and $COLUMNS environment
2478 variables overrule the terminal size values obtained
2479 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002480
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002482 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002483'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002484 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002485 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002486 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002487 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002488 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002489 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002490 blowfish Blowfish method. Medium strong encryption but it has
2491 an implementation flaw. Requires Vim 7.3 or later,
2492 files can NOT be read by Vim 7.2 and older. This adds
2493 a "seed" to the file, every time you write the file
2494 the encrypted bytes will be different.
2495 *blowfish2*
2496 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002497 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002498 and older. This adds a "seed" to the file, every time
2499 you write the file the encrypted bytes will be
2500 different. The whole undo file is encrypted, not just
2501 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002502 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002503 *E1197* *E1198* *E1199* *E1200* *E1201*
2504 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2505 Code. Medium strong till strong encryption.
2506 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002507 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002508 It adds a seed and a message authentication code (MAC)
2509 to the file. This needs at least a Vim 8.2.3022 to
2510 read the encrypted file.
2511 Encryption of swap files is not supported, therefore
2512 no swap file will be used when xchacha20 encryption is
2513 enabled.
2514 Encryption of undo files is not yet supported,
2515 therefore no undo file will currently be written.
2516 CURRENTLY EXPERIMENTAL: Files written with this method
2517 might have to be read back with the same version of
2518 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002519
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002520 You should use "blowfish2", also to re-encrypt older files.
2521
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002522 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002523 to the detected method of the file being read. Thus if you write it
2524 without changing 'cryptmethod' the same method will be used.
2525 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002526 explicitly write it, you don't get a warning unless there are other
2527 modifications. Also see |:X|.
2528
2529 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002530 the value "blowfish2". When setting the local value to an empty
2531 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002532
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002533 When a new encryption method is added in a later version of Vim, and
2534 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002535 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002536
2537
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538 *'cscopepathcomp'* *'cspc'*
2539'cscopepathcomp' 'cspc' number (default 0)
2540 global
2541 {not available when compiled without the |+cscope|
2542 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543 Determines how many components of the path to show in a list of tags.
2544 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002545 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002546
2547 *'cscopeprg'* *'csprg'*
2548'cscopeprg' 'csprg' string (default "cscope")
2549 global
2550 {not available when compiled without the |+cscope|
2551 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552 Specifies the command to execute cscope. See |cscopeprg|.
2553 This option cannot be set from a |modeline| or in the |sandbox|, for
2554 security reasons.
2555
2556 *'cscopequickfix'* *'csqf'*
2557'cscopequickfix' 'csqf' string (default "")
2558 global
2559 {not available when compiled without the |+cscope|
2560 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002561 Specifies whether to use quickfix window to show cscope results.
2562 See |cscopequickfix|.
2563
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002564 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002565'cscoperelative' 'csre' boolean (default off)
2566 global
2567 {not available when compiled without the |+cscope|
2568 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002569 In the absence of a prefix (-P) for cscope. setting this option enables
2570 to use the basename of cscope.out path as the prefix.
2571 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002572 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002573
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2575'cscopetag' 'cst' boolean (default off)
2576 global
2577 {not available when compiled without the |+cscope|
2578 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579 Use cscope for tag commands. See |cscope-options|.
2580 NOTE: This option is reset when 'compatible' is set.
2581
2582 *'cscopetagorder'* *'csto'*
2583'cscopetagorder' 'csto' number (default 0)
2584 global
2585 {not available when compiled without the |+cscope|
2586 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002587 Determines the order in which ":cstag" performs a search. See
2588 |cscopetagorder|.
2589 NOTE: This option is set to 0 when 'compatible' is set.
2590
2591 *'cscopeverbose'* *'csverb'*
2592 *'nocscopeverbose'* *'nocsverb'*
2593'cscopeverbose' 'csverb' boolean (default off)
2594 global
2595 {not available when compiled without the |+cscope|
2596 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597 Give messages when adding a cscope database. See |cscopeverbose|.
2598 NOTE: This option is reset when 'compatible' is set.
2599
Bram Moolenaar860cae12010-06-05 23:22:07 +02002600 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2601'cursorbind' 'crb' boolean (default off)
2602 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002603 When this option is set, as the cursor in the current
2604 window moves other cursorbound windows (windows that also have
2605 this option set) move their cursors to the corresponding line and
2606 column. This option is useful for viewing the
2607 differences between two versions of a file (see 'diff'); in diff mode,
2608 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002609 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002610
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002611
2612 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2613'cursorcolumn' 'cuc' boolean (default off)
2614 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002615 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002616 feature}
2617 Highlight the screen column of the cursor with CursorColumn
2618 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2619 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002620 If you only want the highlighting in the current window you can use
2621 these autocommands: >
2622 au WinLeave * set nocursorline nocursorcolumn
2623 au WinEnter * set cursorline cursorcolumn
2624<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002625
2626 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2627'cursorline' 'cul' boolean (default off)
2628 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002629 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002630 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002631 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2632 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002633 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002634 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002635
2636
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002637 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002638'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002639 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002640 {not available when compiled without the |+syntax|
2641 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002642 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002643 Valid values:
2644 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002645 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002646 "screenline" Highlight only the screen line of the cursor with
2647 CursorLine |hl-CursorLine|.
2648 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002649 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002650
2651 Special value:
2652 "both" Alias for the values "line,number".
2653
2654 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002655
2656
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657 *'debug'*
2658'debug' string (default "")
2659 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002660 These values can be used:
2661 msg Error messages that would otherwise be omitted will be given
2662 anyway.
2663 throw Error messages that would otherwise be omitted will be given
2664 anyway and also throw an exception and set |v:errmsg|.
2665 beep A message will be given when otherwise only a beep would be
2666 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002667 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002668 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2669 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670
2671 *'define'* *'def'*
2672'define' 'def' string (default "^\s*#\s*define")
2673 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002674 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 pattern, just like for the "/" command. This option is used for the
2676 commands like "[i" and "[d" |include-search|. The 'isident' option is
2677 used to recognize the defined name after the match:
2678 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2679 See |option-backslash| about inserting backslashes to include a space
2680 or backslash.
2681 The default value is for C programs. For C++ this value would be
2682 useful, to include const type declarations: >
2683 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002684< You can also use "\ze" just before the name and continue the pattern
2685 to check what is following. E.g. for Javascript, if a function is
2686 defined with "func_name = function(args)": >
2687 ^\s*\ze\i\+\s*=\s*function(
2688< If the function is defined with "func_name : function() {...": >
2689 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002691 To avoid that use `:let` with a single quote string: >
2692 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002693<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694
2695 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2696'delcombine' 'deco' boolean (default off)
2697 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698 If editing Unicode and this option is set, backspace and Normal mode
2699 "x" delete each combining character on its own. When it is off (the
2700 default) the character along with its combining characters are
2701 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002702 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703
2704 This is useful for Arabic, Hebrew and many other languages where one
2705 may have combining characters overtop of base characters, and want
2706 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002707 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708
2709 *'dictionary'* *'dict'*
2710'dictionary' 'dict' string (default "")
2711 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 List of file names, separated by commas, that are used to lookup words
2713 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2714 contain a list of words. This can be one word per line, or several
2715 words per line, separated by non-keyword characters (white space is
2716 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002717
2718 When this option is empty or an entry "spell" is present, and spell
2719 checking is enabled, words in the word lists for the currently active
2720 'spelllang' are used. See |spell|.
2721
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002722 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 after a comma are ignored, otherwise spaces are included in the file
2724 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002725 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002726 Where to find a list of words?
2727 - On FreeBSD, there is the file "/usr/share/dict/words".
2728 - In the Simtel archive, look in the "msdos/linguist" directory.
2729 - In "miscfiles" of the GNU collection.
2730 The use of |:set+=| and |:set-=| is preferred when adding or removing
2731 directories from the list. This avoids problems when a future version
2732 uses another default.
2733 Backticks cannot be used in this option for security reasons.
2734
2735 *'diff'* *'nodiff'*
2736'diff' boolean (default off)
2737 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738 {not available when compiled without the |+diff|
2739 feature}
2740 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002741 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742
2743 *'dex'* *'diffexpr'*
2744'diffexpr' 'dex' string (default "")
2745 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 {not available when compiled without the |+diff|
2747 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002748 Expression which is evaluated to obtain a diff file (either ed-style
2749 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 This option cannot be set from a |modeline| or in the |sandbox|, for
2751 security reasons.
2752
2753 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002754'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756 {not available when compiled without the |+diff|
2757 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002758 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 All are optional. Items must be separated by a comma.
2760
2761 filler Show filler lines, to keep the text
2762 synchronized with a window that has inserted
2763 lines at the same position. Mostly useful
2764 when windows are side-by-side and 'scrollbind'
2765 is set.
2766
2767 context:{n} Use a context of {n} lines between a change
2768 and a fold that contains unchanged lines.
2769 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002770 When using zero the context is actually one,
2771 since folds require a line in between, also
2772 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 See |fold-diff|.
2774
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002775 iblank Ignore changes where lines are all blank. Adds
2776 the "-B" flag to the "diff" command if
2777 'diffexpr' is empty. Check the documentation
2778 of the "diff" command for what this does
2779 exactly.
2780 NOTE: the diff windows will get out of sync,
2781 because no differences between blank lines are
2782 taken into account.
2783
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 icase Ignore changes in case of text. "a" and "A"
2785 are considered the same. Adds the "-i" flag
2786 to the "diff" command if 'diffexpr' is empty.
2787
2788 iwhite Ignore changes in amount of white space. Adds
2789 the "-b" flag to the "diff" command if
2790 'diffexpr' is empty. Check the documentation
2791 of the "diff" command for what this does
2792 exactly. It should ignore adding trailing
2793 white space, but not leading white space.
2794
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002795 iwhiteall Ignore all white space changes. Adds
2796 the "-w" flag to the "diff" command if
2797 'diffexpr' is empty. Check the documentation
2798 of the "diff" command for what this does
2799 exactly.
2800
2801 iwhiteeol Ignore white space changes at end of line.
2802 Adds the "-Z" 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
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002807 horizontal Start diff mode with horizontal splits (unless
2808 explicitly specified otherwise).
2809
2810 vertical Start diff mode with vertical splits (unless
2811 explicitly specified otherwise).
2812
Bram Moolenaarc8234772019-11-10 21:00:27 +01002813 closeoff When a window is closed where 'diff' is set
2814 and there is only one window remaining in the
2815 same tab page with 'diff' set, execute
2816 `:diffoff` in that window. This undoes a
2817 `:diffsplit` command.
2818
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002819 hiddenoff Do not use diff mode for a buffer when it
2820 becomes hidden.
2821
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002822 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2823 starting diff mode. Without this 2 is used.
2824
Bram Moolenaar4223d432021-02-10 13:18:17 +01002825 followwrap Follow the 'wrap' option and leave as it is.
2826
Bram Moolenaare828b762018-09-10 17:51:58 +02002827 internal Use the internal diff library. This is
2828 ignored when 'diffexpr' is set. *E960*
2829 When running out of memory when writing a
2830 buffer this item will be ignored for diffs
2831 involving that buffer. Set the 'verbose'
2832 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833
Bram Moolenaare828b762018-09-10 17:51:58 +02002834 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002835 Use the indent heuristic for the internal
2836 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002837
2838 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002839 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002840 algorithms are:
2841 myers the default algorithm
2842 minimal spend extra time to generate the
2843 smallest possible diff
2844 patience patience diff algorithm
2845 histogram histogram diff algorithm
2846
2847 Examples: >
2848 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002850 :set diffopt=internal,filler,foldcolumn:3
2851 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852<
2853 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2854'digraph' 'dg' boolean (default off)
2855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856 {not available when compiled without the |+digraphs|
2857 feature}
2858 Enable the entering of digraphs in Insert mode with {char1} <BS>
2859 {char2}. See |digraphs|.
2860 NOTE: This option is reset when 'compatible' is set.
2861
2862 *'directory'* *'dir'*
2863'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002864 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865 for Unix: ".,~/tmp,/var/tmp,/tmp")
2866 global
2867 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002868 Recommended value: ".,~/vimswap//" - this will put the swap file next
2869 to the edited file if possible, and in your personal swap directory
2870 otherwise. Make sure "~/vimswap//" is only readable for you.
2871
2872 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873 - The swap file will be created in the first directory where this is
2874 possible.
2875 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002876 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 - A directory "." means to put the swap file in the same directory as
2878 the edited file. On Unix, a dot is prepended to the file name, so
2879 it doesn't show in a directory listing. On MS-Windows the "hidden"
2880 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002881 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2882 the swap file relative to where the edited file is. The leading "."
2883 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002884 - For Unix and Win32, if a directory ends in two path separators "//",
2885 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002886 with all path separators replaced by percent '%' signs (including
2887 the colon following the drive letter on Win32). This will ensure
2888 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002889 On Win32, it is also possible to end with "\\". However, When a
2890 separating comma is following, you must use "//", since "\\" will
2891 include the comma in the file name. Therefore it is recommended to
2892 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 - Spaces after the comma are ignored, other spaces are considered part
2894 of the directory name. To have a space at the start of a directory
2895 name, precede it with a backslash.
2896 - To include a comma in a directory name precede it with a backslash.
2897 - A directory name may end in an ':' or '/'.
2898 - Environment variables are expanded |:set_env|.
2899 - Careful with '\' characters, type one before a space, type two to
2900 get one in the option (see |option-backslash|), for example: >
2901 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2902< - For backwards compatibility with Vim version 3.0 a '>' at the start
2903 of the option is removed.
2904 Using "." first in the list is recommended. This means that editing
2905 the same file twice will result in a warning. Using "/tmp" on Unix is
2906 discouraged: When the system crashes you lose the swap file.
2907 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002908 choice than "/tmp". But others on the computer may be able to see the
2909 files, and it can contain a lot of files, your swap files get lost in
2910 the crowd. That is why a "tmp" directory in your home directory is
2911 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912 The use of |:set+=| and |:set-=| is preferred when adding or removing
2913 directories from the list. This avoids problems when a future version
2914 uses another default.
2915 This option cannot be set from a |modeline| or in the |sandbox|, for
2916 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917
2918 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002919'display' 'dy' string (default "", set to "truncate" in
2920 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002922 Change the way text is displayed. This is comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 flags:
2924 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002925 in a window will be displayed. "@@@" is put in the
2926 last columns of the last screen line to indicate the
2927 rest of the line is not displayed.
2928 truncate Like "lastline", but "@@@" is displayed in the first
2929 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 uhex Show unprintable characters hexadecimal as <xx>
2931 instead of using ^C and ~C.
2932
Bram Moolenaard0796902016-09-16 20:02:31 +02002933 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002934 doesn't fit is replaced with "@" lines.
2935
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 *'eadirection'* *'ead'*
2937'eadirection' 'ead' string (default "both")
2938 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 Tells when the 'equalalways' option applies:
2940 ver vertically, width of windows is not affected
2941 hor horizontally, height of windows is not affected
2942 both width and height of windows is affected
2943
2944 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2945'edcompatible' 'ed' boolean (default off)
2946 global
2947 Makes the 'g' and 'c' flags of the ":substitute" command to be
2948 toggled each time the flag is given. See |complex-change|. See
2949 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002950 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002951 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952
Bram Moolenaar03413f42016-04-12 21:07:15 +02002953 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002954'emoji' 'emo' boolean (default: on)
2955 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002956 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002957 This excludes "text emoji" characters, which are normally displayed as
2958 single width. Unfortunately there is no good specification for this
2959 and it has been determined on trial-and-error basis. Use the
2960 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002961
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002963'encoding' 'enc' string (default for MS-Windows: "utf-8",
2964 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 Sets the character encoding used inside Vim. It applies to text in
2967 the buffers, registers, Strings in expressions, text stored in the
2968 viminfo file, etc. It sets the kind of characters which Vim can work
2969 with. See |encoding-names| for the possible values.
2970
2971 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002972 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002974 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975
Bram Moolenaar865242e2010-07-14 21:12:05 +02002976 This option cannot be set from a |modeline|. It would most likely
2977 corrupt the text.
2978
Bram Moolenaar3df01732017-02-17 22:47:16 +01002979 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2980 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 'encoding', "utf-8" is the natural choice for the environment and
2982 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002983 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 versions, and to avoid changing the encoding of newly created files
2985 without your knowledge (in case 'fileencodings' is empty).
2986
2987 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002988 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 iconv() or as specified with 'charconvert'.
2990
Bram Moolenaar207f0092020-08-30 17:20:20 +02002991 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002992 can use: >
2993 if has("multi_byte_encoding")
2994<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 Normally 'encoding' will be equal to your current locale. This will
2996 be the default if Vim recognizes your environment settings. If
2997 'encoding' is not set to the current locale, 'termencoding' must be
2998 set to convert typed and displayed text. See |encoding-table|.
2999
3000 When you set this option, it fires the |EncodingChanged| autocommand
3001 event so that you can set up fonts if necessary.
3002
3003 When the option is set, the value is converted to lowercase. Thus
3004 you can set it with uppercase values too. Underscores are translated
3005 to '-' signs.
3006 When the encoding is recognized, it is changed to the standard name.
3007 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3008 "iso-8859-2" and "utf8" becomes "utf-8".
3009
3010 Note: "latin1" is also used when the encoding could not be detected.
3011 This only works when editing files in the same encoding! When the
3012 actual character set is not latin1, make sure 'fileencoding' and
3013 'fileencodings' are empty. When conversion is needed, switch to using
3014 utf-8.
3015
3016 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3017 You don't notice this while editing, but it does matter for the
3018 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3019 setting 'encoding' to one of these values instead of utf-8 only has
3020 effect for encoding used for files when 'fileencoding' is empty.
3021
Bram Moolenaar661b1822005-07-28 22:36:45 +00003022 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3023 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024
3025 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3026'endofline' 'eol' boolean (default on)
3027 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003029 is on, or 'fixeol' option is off, no <EOL> will be written for the
3030 last line in the file. This option is automatically set or reset when
3031 starting to edit a new file, depending on whether file has an <EOL>
3032 for the last line in the file. Normally you don't have to set or
3033 reset this option.
3034 When 'binary' is off and 'fixeol' is on the value is not used when
3035 writing the file. When 'binary' is on or 'fixeol' is off it is used
3036 to remember the presence of a <EOL> for the last line in the file, so
3037 that when you write the file the situation from the original file can
3038 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039
3040 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3041'equalalways' 'ea' boolean (default on)
3042 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003044 splitting or closing a window. This also happens the moment the
3045 option is switched on. When off, splitting a window will reduce the
3046 size of the current window and leave the other windows the same. When
3047 closing a window the extra lines are given to the window next to it
3048 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 When mixing vertically and horizontally split windows, a minimal size
3050 is computed and some windows may be larger if there is room. The
3051 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003052 Changing the height and width of a window can be avoided by setting
3053 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003054 If a window size is specified when creating a new window sizes are
3055 currently not equalized (it's complicated, but may be implemented in
3056 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057
3058 *'equalprg'* *'ep'*
3059'equalprg' 'ep' string (default "")
3060 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003062 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003063 or 'indentexpr'. When Vim was compiled without internal formatting,
3064 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003065 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 about including spaces and backslashes.
3067 This option cannot be set from a |modeline| or in the |sandbox|, for
3068 security reasons.
3069
3070 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3071'errorbells' 'eb' boolean (default off)
3072 global
3073 Ring the bell (beep or screen flash) for error messages. This only
3074 makes a difference for error messages, the bell will be used always
3075 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003076 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003077 screen flash or do nothing. See 'belloff' to finetune when to ring the
3078 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079
3080 *'errorfile'* *'ef'*
3081'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3082 others: "errors.err")
3083 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 {not available when compiled without the |+quickfix|
3085 feature}
3086 Name of the errorfile for the QuickFix mode (see |:cf|).
3087 When the "-q" command-line argument is used, 'errorfile' is set to the
3088 following argument. See |-q|.
3089 NOT used for the ":make" command. See 'makeef' for that.
3090 Environment variables are expanded |:set_env|.
3091 See |option-backslash| about including spaces and backslashes.
3092 This option cannot be set from a |modeline| or in the |sandbox|, for
3093 security reasons.
3094
3095 *'errorformat'* *'efm'*
3096'errorformat' 'efm' string (default is very long)
3097 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098 {not available when compiled without the |+quickfix|
3099 feature}
3100 Scanf-like description of the format for the lines in the error file
3101 (see |errorformat|).
3102
3103 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3104'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 Function keys that start with an <Esc> are recognized in Insert
3107 mode. When this option is off, the cursor and function keys cannot be
3108 used in Insert mode if they start with an <Esc>. The advantage of
3109 this is that the single <Esc> is recognized immediately, instead of
3110 after one second. Instead of resetting this option, you might want to
3111 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3112 when 'esckeys' is off, you can still map anything, but the cursor keys
3113 won't work by default.
3114 NOTE: This option is set to the Vi default value when 'compatible' is
3115 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003116 NOTE: when this option is off then the |modifyOtherKeys| functionality
3117 is disabled while in Insert mode to avoid ending Insert mode with any
3118 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119
3120 *'eventignore'* *'ei'*
3121'eventignore' 'ei' string (default "")
3122 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003124 When set to "all" or when "all" is one of the items, all autocommand
3125 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003126 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 :set ei=WinEnter,WinLeave
3128<
3129 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3130'expandtab' 'et' boolean (default off)
3131 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003133 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3135 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003136 This option is reset when the 'paste' option is set and restored when
3137 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 NOTE: This option is reset when 'compatible' is set.
3139
3140 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3141'exrc' 'ex' boolean (default off)
3142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003144 directory.
3145
3146 Setting this option is a potential security leak. E.g., consider
3147 unpacking a package or fetching files from github, a .vimrc in there
3148 might be a trojan horse. BETTER NOT SET THIS OPTION!
3149 Instead, define an autocommand in your .vimrc to set options for a
3150 matching directory.
3151
3152 If you do switch this option on you should also consider setting the
3153 'secure' option (see |initialization|).
3154 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155 This option cannot be set from a |modeline| or in the |sandbox|, for
3156 security reasons.
3157
3158 *'fileencoding'* *'fenc'* *E213*
3159'fileencoding' 'fenc' string (default: "")
3160 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003162
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003164 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165 When 'fileencoding' is empty, the same value as 'encoding' will be
3166 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003167 No error will be given when the value is set, only when it is used,
3168 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003169 Conversion will also be done when 'encoding' and 'fileencoding' are
3170 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3171 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003173 'encoding' is "utf-8" or another Unicode encoding, conversion
3174 is most likely done in a way that the reverse conversion
3175 results in the same text. When 'encoding' is not "utf-8" some
3176 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003177
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 See 'encoding' for the possible values. Additionally, values may be
3179 specified that can be handled by the converter, see
3180 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003181
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 When reading a file 'fileencoding' will be set from 'fileencodings'.
3183 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003184 'fileencoding', use the |++enc| argument. One exception: when
3185 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003186 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003187
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3189 When the option is set, the value is converted to lowercase. Thus
3190 you can set it with uppercase values too. '_' characters are
3191 replaced with '-'. If a name is recognized from the list for
3192 'encoding', it is replaced by the standard name. For example
3193 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003194
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195 When this option is set, after starting to edit a file, the 'modified'
3196 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003197
3198 Keep in mind that changing 'fenc' from a modeline happens
3199 AFTER the text has been read, thus it applies to when the file will be
3200 written. If you do set 'fenc' in a modeline, you might want to set
3201 'nomodified' to avoid not being able to ":q".
3202
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 This option can not be changed when 'modifiable' is off.
3204
3205 *'fe'*
3206 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003207 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 old short name was 'fe', which is no longer used.
3209
3210 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003211'fileencodings' 'fencs' string (default: "ucs-bom",
3212 "ucs-bom,utf-8,default,latin1" when
3213 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 This is a list of character encodings considered when starting to edit
3216 an existing file. When a file is read, Vim tries to use the first
3217 mentioned character encoding. If an error is detected, the next one
3218 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003219 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 an empty string, which means the value of 'encoding' is used.
3221 WARNING: Conversion can cause loss of information! When
3222 'encoding' is "utf-8" (or one of the other Unicode variants)
3223 conversion is most likely done in a way that the reverse
3224 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003225 "utf-8" some non-ASCII characters may be lost! You can use
3226 the |++bad| argument to specify what is done with characters
3227 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 For an empty file or a file with only ASCII characters most encodings
3229 will work and the first entry of 'fileencodings' will be used (except
3230 "ucs-bom", which requires the BOM to be present). If you prefer
3231 another encoding use an BufReadPost autocommand event to test if your
3232 preferred encoding is to be used. Example: >
3233 au BufReadPost * if search('\S', 'w') == 0 |
3234 \ set fenc=iso-2022-jp | endif
3235< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3236 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003237 When the |++enc| argument is used then the value of 'fileencodings' is
3238 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003239 Note that 'fileencodings' is not used for a new file, the global value
3240 of 'fileencoding' is used instead. You can set it with: >
3241 :setglobal fenc=iso-8859-2
3242< This means that a non-existing file may get a different encoding than
3243 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 The special value "ucs-bom" can be used to check for a Unicode BOM
3245 (Byte Order Mark) at the start of the file. It must not be preceded
3246 by "utf-8" or another Unicode encoding for this to work properly.
3247 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3248 because Vim cannot detect an error, thus the encoding is always
3249 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003250 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003251 environment. On MS-Windows this is the system encoding. Otherwise
3252 this is the default value for 'encoding'. It is useful when
3253 'encoding' is set to "utf-8" and your environment uses a non-latin1
3254 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003255 When 'encoding' is "utf-8" and a file contains an illegal byte
3256 sequence it won't be recognized as UTF-8. You can use the |8g8|
3257 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258 WRONG VALUES: WHAT'S WRONG:
3259 latin1,utf-8 "latin1" will always be used
3260 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3261 file
3262 cp1250,latin1 "cp1250" will always be used
3263 If 'fileencodings' is empty, 'fileencoding' is not modified.
3264 See 'fileencoding' for the possible values.
3265 Setting this option does not have an effect until the next time a file
3266 is read.
3267
3268 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003269'fileformat' 'ff' string (MS-Windows default: "dos",
3270 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 This gives the <EOL> of the current buffer, which is used for
3273 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003274 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 unix <NL>
3276 mac <CR>
3277 When "dos" is used, CTRL-Z at the end of a file is ignored.
3278 See |file-formats| and |file-read|.
3279 For the character encoding of the file see 'fileencoding'.
3280 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003281 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 This option is set automatically when starting to edit a file and
3283 'fileformats' is not empty and 'binary' is off.
3284 When this option is set, after starting to edit a file, the 'modified'
3285 option is set, because the file would be different when written.
3286 This option can not be changed when 'modifiable' is off.
3287 For backwards compatibility: When this option is set to "dos",
3288 'textmode' is set, otherwise 'textmode' is reset.
3289
3290 *'fileformats'* *'ffs'*
3291'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003292 Vim+Vi MS-Windows: "dos,unix",
3293 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 Vi Cygwin: "unix,dos",
3295 Vi others: "")
3296 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 This gives the end-of-line (<EOL>) formats that will be tried when
3298 starting to edit a new buffer and when reading a file into an existing
3299 buffer:
3300 - When empty, the format defined with 'fileformat' will be used
3301 always. It is not set automatically.
3302 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003303 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304 'fileformats' name will be used when a file is read into an existing
3305 buffer, no matter what 'fileformat' for that buffer is set to.
3306 - When more than one name is present, separated by commas, automatic
3307 <EOL> detection will be done when reading a file. When starting to
3308 edit a file, a check is done for the <EOL>:
3309 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3310 'fileformat' is set to "dos".
3311 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003312 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003314 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3315 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003316 This means that "mac" is only chosen when:
3317 "unix" is not present or no <NL> is found in the file, and
3318 "dos" is not present or no <CR><NL> is found in the file.
3319 Except: if "unix" was chosen, but there is a <CR> before
3320 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003321 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 4. If 'fileformat' is still not set, the first name from
3323 'fileformats' is used.
3324 When reading a file into an existing buffer, the same is done, but
3325 this happens like 'fileformat' has been set appropriately for that
3326 file only, the option is not changed.
3327 When 'binary' is set, the value of 'fileformats' is not used.
3328
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003329 When Vim starts up with an empty buffer the first item is used. You
3330 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003331
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3333 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3334 done:
3335 - When 'fileformats' is empty, there is no automatic detection. Dos
3336 format will be used.
3337 - When 'fileformats' is set to one or more names, automatic detection
3338 is done. This is based on the first <NL> in the file: If there is a
3339 <CR> in front of it, Dos format is used, otherwise Unix format is
3340 used.
3341 Also see |file-formats|.
3342 For backwards compatibility: When this option is set to an empty
3343 string or one format (no comma is included), 'textauto' is reset,
3344 otherwise 'textauto' is set.
3345 NOTE: This option is set to the Vi default value when 'compatible' is
3346 set and to the Vim default value when 'compatible' is reset.
3347
Bram Moolenaarbf884932013-04-05 22:26:15 +02003348 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3349'fileignorecase' 'fic' boolean (default on for systems where case in file
3350 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003351 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003352 When set case is ignored when using file names and directories.
3353 See 'wildignorecase' for only ignoring case when doing completion.
3354
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 *'filetype'* *'ft'*
3356'filetype' 'ft' string (default: "")
3357 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 When this option is set, the FileType autocommand event is triggered.
3359 All autocommands that match with the value of this option will be
3360 executed. Thus the value of 'filetype' is used in place of the file
3361 name.
3362 Otherwise this option does not always reflect the current file type.
3363 This option is normally set when the file type is detected. To enable
3364 this use the ":filetype on" command. |:filetype|
3365 Setting this option to a different value is most useful in a modeline,
3366 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003367 Example, for in an IDL file:
3368 /* vim: set filetype=idl : */ ~
3369 |FileType| |filetypes|
3370 When a dot appears in the value then this separates two filetype
3371 names. Example:
3372 /* vim: set filetype=c.doxygen : */ ~
3373 This will use the "c" filetype first, then the "doxygen" filetype.
3374 This works both for filetype plugins and for syntax files. More than
3375 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 This option is not copied to another buffer, independent of the 's' or
3377 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003378 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379
3380 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003381'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003382 global or local to window |global-local|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003383 {not available when compiled without the |+folding|
3384 feature}
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003385 Characters to fill the statuslines, vertical separators and special
3386 lines in the window.
3387 It is a comma-separated list of items. Each item has a name, a colon
3388 and the value of that item:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003390 item name default Used for ~
3391 stl ' ' or '^' statusline of the current window
3392 stlnc ' ' or '=' statusline of the non-current windows
3393 vert '|' vertical separators |:vsplit|
3394 fold '-' filling 'foldtext'
3395 foldopen '-' mark the beginning of a fold
3396 foldclose '+' show a closed fold
3397 foldsep '|' open fold middle character
3398 diff '-' deleted lines of the 'diff' option
3399 eob '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003401 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003402 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 otherwise.
3404
3405 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003406 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407< This is similar to the default, except that these characters will also
3408 be used when there is highlighting.
3409
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003410 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3411 single-byte and multibyte characters are supported. But double-width
3412 characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003413
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003415 item name highlight group ~
3416 stl StatusLine |hl-StatusLine|
3417 stlnc StatusLineNC |hl-StatusLineNC|
3418 vert VertSplit |hl-VertSplit|
3419 fold Folded |hl-Folded|
3420 diff DiffDelete |hl-DiffDelete|
3421 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003422
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003423 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3424'fixendofline' 'fixeol' boolean (default on)
3425 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003426 When writing a file and this option is on, <EOL> at the end of file
3427 will be restored if missing. Turn this option off if you want to
3428 preserve the situation from the original file.
3429 When the 'binary' option is set the value of this option doesn't
3430 matter.
3431 See the 'endofline' option.
3432
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003434'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003436 {only available when compiled with the |+rightleft|
3437 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003438 This option was for using Farsi, which has been removed. See
3439 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440
3441 *'foldclose'* *'fcl'*
3442'foldclose' 'fcl' string (default "")
3443 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444 {not available when compiled without the |+folding|
3445 feature}
3446 When set to "all", a fold is closed when the cursor isn't in it and
3447 its level is higher than 'foldlevel'. Useful if you want folds to
3448 automatically close when moving out of them.
3449
3450 *'foldcolumn'* *'fdc'*
3451'foldcolumn' 'fdc' number (default 0)
3452 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 {not available when compiled without the |+folding|
3454 feature}
3455 When non-zero, a column with the specified width is shown at the side
3456 of the window which indicates open and closed folds. The maximum
3457 value is 12.
3458 See |folding|.
3459
3460 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3461'foldenable' 'fen' boolean (default on)
3462 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 {not available when compiled without the |+folding|
3464 feature}
3465 When off, all folds are open. This option can be used to quickly
3466 switch between showing all text unfolded and viewing the text with
3467 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003468 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 'foldenable' is off.
3470 This option is set by commands that create a new fold or close a fold.
3471 See |folding|.
3472
3473 *'foldexpr'* *'fde'*
3474'foldexpr' 'fde' string (default: "0")
3475 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003477 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003479 for each line to obtain its fold level. The context is set to the
3480 script where 'foldexpr' was set, script-local items can be accessed.
3481 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003482
Bram Moolenaar30b65812012-07-12 22:01:11 +02003483 The expression will be evaluated in the |sandbox| if set from a
3484 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003485 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003486 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003487
3488 It is not allowed to change text or jump to another window while
3489 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490
3491 *'foldignore'* *'fdi'*
3492'foldignore' 'fdi' string (default: "#")
3493 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494 {not available when compiled without the |+folding|
3495 feature}
3496 Used only when 'foldmethod' is "indent". Lines starting with
3497 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003498 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 The default "#" works well for C programs. See |fold-indent|.
3500
3501 *'foldlevel'* *'fdl'*
3502'foldlevel' 'fdl' number (default: 0)
3503 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 {not available when compiled without the |+folding|
3505 feature}
3506 Sets the fold level: Folds with a higher level will be closed.
3507 Setting this option to zero will close all folds. Higher numbers will
3508 close fewer folds.
3509 This option is set by commands like |zm|, |zM| and |zR|.
3510 See |fold-foldlevel|.
3511
3512 *'foldlevelstart'* *'fdls'*
3513'foldlevelstart' 'fdls' number (default: -1)
3514 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 {not available when compiled without the |+folding|
3516 feature}
3517 Sets 'foldlevel' when starting to edit another buffer in a window.
3518 Useful to always start editing with all folds closed (value zero),
3519 some folds closed (one) or no folds closed (99).
3520 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003521 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522 ignores this option and closes all folds.
3523 It is also done before BufReadPre autocommands, to allow an autocmd to
3524 overrule the 'foldlevel' value for specific files.
3525 When the value is negative, it is not used.
3526
3527 *'foldmarker'* *'fmr'* *E536*
3528'foldmarker' 'fmr' string (default: "{{{,}}}")
3529 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 {not available when compiled without the |+folding|
3531 feature}
3532 The start and end marker used when 'foldmethod' is "marker". There
3533 must be one comma, which separates the start and end marker. The
3534 marker is a literal string (a regular expression would be too slow).
3535 See |fold-marker|.
3536
3537 *'foldmethod'* *'fdm'*
3538'foldmethod' 'fdm' string (default: "manual")
3539 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 {not available when compiled without the |+folding|
3541 feature}
3542 The kind of folding used for the current window. Possible values:
3543 |fold-manual| manual Folds are created manually.
3544 |fold-indent| indent Lines with equal indent form a fold.
3545 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3546 |fold-marker| marker Markers are used to specify folds.
3547 |fold-syntax| syntax Syntax highlighting items specify folds.
3548 |fold-diff| diff Fold text that is not changed.
3549
3550 *'foldminlines'* *'fml'*
3551'foldminlines' 'fml' number (default: 1)
3552 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 {not available when compiled without the |+folding|
3554 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003555 Sets the number of screen lines above which a fold can be displayed
3556 closed. Also for manually closed folds. With the default value of
3557 one a fold can only be closed if it takes up two or more screen lines.
3558 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003559 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 "zc" to close a fold, which is displayed open because it's smaller
3561 than 'foldminlines', a following "zc" may close a containing fold.
3562
3563 *'foldnestmax'* *'fdn'*
3564'foldnestmax' 'fdn' number (default: 20)
3565 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 {not available when compiled without the |+folding|
3567 feature}
3568 Sets the maximum nesting of folds for the "indent" and "syntax"
3569 methods. This avoids that too many folds will be created. Using more
3570 than 20 doesn't work, because the internal limit is 20.
3571
3572 *'foldopen'* *'fdo'*
3573'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3574 search,tag,undo")
3575 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576 {not available when compiled without the |+folding|
3577 feature}
3578 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003579 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003581 NOTE: When the command is part of a mapping this option is not used.
3582 Add the |zv| command to the mapping to get the same effect.
3583 (rationale: the mapping may want to control opening folds itself)
3584
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 item commands ~
3586 all any
3587 block "(", "{", "[[", "[{", etc.
3588 hor horizontal movements: "l", "w", "fx", etc.
3589 insert any command in Insert mode
3590 jump far jumps: "G", "gg", etc.
3591 mark jumping to a mark: "'m", CTRL-O, etc.
3592 percent "%"
3593 quickfix ":cn", ":crew", ":make", etc.
3594 search search for a pattern: "/", "n", "*", "gd", etc.
3595 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003596 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597 tag jumping to a tag: ":ta", CTRL-T, etc.
3598 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 When a movement command is used for an operator (e.g., "dl" or "y%")
3600 this option is not used. This means the operator will include the
3601 whole closed fold.
3602 Note that vertical movements are not here, because it would make it
3603 very difficult to move onto a closed fold.
3604 In insert mode the folds containing the cursor will always be open
3605 when text is inserted.
3606 To close folds you can re-apply 'foldlevel' with the |zx| command or
3607 set the 'foldclose' option to "all".
3608
3609 *'foldtext'* *'fdt'*
3610'foldtext' 'fdt' string (default: "foldtext()")
3611 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 {not available when compiled without the |+folding|
3613 feature}
3614 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003615 fold. The context is set to the script where 'foldexpr' was set,
3616 script-local items can be accessed. See |fold-foldtext| for the
3617 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618
Bram Moolenaar30b65812012-07-12 22:01:11 +02003619 The expression will be evaluated in the |sandbox| if set from a
3620 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003621 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003622
3623 It is not allowed to change text or jump to another window while
3624 evaluating 'foldtext' |textlock|.
3625
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003626 *'formatexpr'* *'fex'*
3627'formatexpr' 'fex' string (default "")
3628 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003629 {not available when compiled without the |+eval|
3630 feature}
3631 Expression which is evaluated to format a range of lines for the |gq|
3632 operator or automatic formatting (see 'formatoptions'). When this
3633 option is empty 'formatprg' is used.
3634
3635 The |v:lnum| variable holds the first line to be formatted.
3636 The |v:count| variable holds the number of lines to be formatted.
3637 The |v:char| variable holds the character that is going to be
3638 inserted if the expression is being evaluated due to
3639 automatic formatting. This can be empty. Don't insert
3640 it yet!
3641
3642 Example: >
3643 :set formatexpr=mylang#Format()
3644< This will invoke the mylang#Format() function in the
3645 autoload/mylang.vim file in 'runtimepath'. |autoload|
3646
3647 The expression is also evaluated when 'textwidth' is set and adding
3648 text beyond that limit. This happens under the same conditions as
3649 when internal formatting is used. Make sure the cursor is kept in the
3650 same spot relative to the text then! The |mode()| function will
3651 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003652
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003653 When the expression evaluates to non-zero Vim will fall back to using
3654 the internal format mechanism.
3655
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003656 If the expression starts with s: or |<SID>|, then it is replaced with
3657 the script ID (|local-function|). Example: >
3658 set formatexpr=s:MyFormatExpr()
3659 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003660< Otherwise, the expression is evaluated in the context of the script
3661 where the option was set, thus script-local items are available.
3662
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003663 The expression will be evaluated in the |sandbox| when set from a
3664 modeline, see |sandbox-option|. That stops the option from working,
3665 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003666 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003667 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003668
Bram Moolenaar86b68352004-12-27 21:59:20 +00003669 *'formatlistpat'* *'flp'*
3670'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3671 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003672 A pattern that is used to recognize a list header. This is used for
3673 the "n" flag in 'formatoptions'.
3674 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003675 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003676 while still checking more characters. There must be a character
3677 following the pattern, when it matches the whole line it is handled
3678 like there is no match.
3679 The default recognizes a number, followed by an optional punctuation
3680 character and white space.
3681
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003682 *'formatoptions'* *'fo'*
3683'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3684 local to buffer
3685 This is a sequence of letters which describes how automatic
3686 formatting is to be done. See |fo-table|. When the 'paste' option is
3687 on, no formatting is done (like 'formatoptions' is empty). Commas can
3688 be inserted for readability.
3689 To avoid problems with flags that are added in the future, use the
3690 "+=" and "-=" feature of ":set" |add-option-flags|.
3691 NOTE: This option is set to the Vi default value when 'compatible' is
3692 set and to the Vim default value when 'compatible' is reset.
3693
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 *'formatprg'* *'fp'*
3695'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003696 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003698 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003700 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003701 If the 'formatexpr' option is not empty it will be used instead.
3702 Otherwise, if 'formatprg' option is an empty string, the internal
3703 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003704 Environment variables are expanded |:set_env|. See |option-backslash|
3705 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003706 This option cannot be set from a |modeline| or in the |sandbox|, for
3707 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708
Bram Moolenaard94464e2015-11-02 15:28:18 +01003709 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003710'fsync' 'fs' boolean (default on)
3711 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003712 When on, the library function fsync() will be called after writing a
3713 file. This will flush a file to disk, ensuring that it is safely
3714 written even on filesystems which do metadata-only journaling. This
3715 will force the harddrive to spin up on Linux systems running in laptop
3716 mode, so it may be undesirable in some situations. Be warned that
3717 turning this off increases the chances of data loss after a crash. On
3718 systems without an fsync() implementation, this variable is always
3719 off.
3720 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003721 'fsync' also applies to |writefile()| (unless a flag is used to
3722 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003723 This option cannot be set from a |modeline| or in the |sandbox|, for
3724 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003725
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3727'gdefault' 'gd' boolean (default off)
3728 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 When on, the ":substitute" flag 'g' is default on. This means that
3730 all matches in a line are substituted instead of one. When a 'g' flag
3731 is given to a ":substitute" command, this will toggle the substitution
3732 of all or one match. See |complex-change|.
3733
3734 command 'gdefault' on 'gdefault' off ~
3735 :s/// subst. all subst. one
3736 :s///g subst. one subst. all
3737 :s///gg subst. all subst. one
3738
3739 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003740 DEPRECATED: Setting this option may break plugins that are not aware
3741 of this option. Also, many users get confused that adding the /g flag
3742 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003743 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744
3745 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003746'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 Format to recognize for the ":grep" command output.
3749 This is a scanf-like string that uses the same format as the
3750 'errorformat' option: see |errorformat|.
3751
3752 *'grepprg'* *'gp'*
3753'grepprg' 'gp' string (default "grep -n ",
3754 Unix: "grep -n $* /dev/null",
3755 Win32: "findstr /n" or "grep -n",
3756 VMS: "SEARCH/NUMBERS ")
3757 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003758 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759 and '#' characters, which are expanded like when used in a command-
3760 line. The placeholder "$*" is allowed to specify where the arguments
3761 will be included. Environment variables are expanded |:set_env|. See
3762 |option-backslash| about including spaces and backslashes.
3763 When your "grep" accepts the "-H" argument, use this to make ":grep"
3764 also work well with a single file: >
3765 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003766< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003767 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3768 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003769 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 apply equally to 'grepprg'.
3771 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3772 otherwise it's "grep -n".
3773 This option cannot be set from a |modeline| or in the |sandbox|, for
3774 security reasons.
3775
3776 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3777'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3778 ve:ver35-Cursor,
3779 o:hor50-Cursor,
3780 i-ci:ver25-Cursor/lCursor,
3781 r-cr:hor20-Cursor/lCursor,
3782 sm:block-Cursor
3783 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003784 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 "n-v-c:block,o:hor50,i-ci:hor15,
3786 r-cr:hor30,sm:block")
3787 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003789 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003791 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003792 height of the cursor can be changed. This can be done by specifying a
3793 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003794 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3795 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003797 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 mode-list and an argument-list:
3799 mode-list:argument-list,mode-list:argument-list,..
3800 The mode-list is a dash separated list of these modes:
3801 n Normal mode
3802 v Visual mode
3803 ve Visual mode with 'selection' "exclusive" (same as 'v',
3804 if not specified)
3805 o Operator-pending mode
3806 i Insert mode
3807 r Replace mode
3808 c Command-line Normal (append) mode
3809 ci Command-line Insert mode
3810 cr Command-line Replace mode
3811 sm showmatch in Insert mode
3812 a all modes
3813 The argument-list is a dash separated list of these arguments:
3814 hor{N} horizontal bar, {N} percent of the character height
3815 ver{N} vertical bar, {N} percent of the character width
3816 block block cursor, fills the whole character
3817 [only one of the above three should be present]
3818 blinkwait{N} *cursor-blinking*
3819 blinkon{N}
3820 blinkoff{N}
3821 blink times for cursor: blinkwait is the delay before
3822 the cursor starts blinking, blinkon is the time that
3823 the cursor is shown and blinkoff is the time that the
3824 cursor is not shown. The times are in msec. When one
3825 of the numbers is zero, there is no blinking. The
3826 default is: "blinkwait700-blinkon400-blinkoff250".
3827 These numbers are used for a missing entry. This
3828 means that blinking is enabled by default. To switch
3829 blinking off you can use "blinkon0". The cursor only
3830 blinks when Vim is waiting for input, not while
3831 executing a command.
3832 To make the cursor blink in an xterm, see
3833 |xterm-blink|.
3834 {group-name}
3835 a highlight group name, that sets the color and font
3836 for the cursor
3837 {group-name}/{group-name}
3838 Two highlight group names, the first is used when
3839 no language mappings are used, the other when they
3840 are. |language-mapping|
3841
3842 Examples of parts:
3843 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3844 block cursor with colors from the "nCursor"
3845 highlight group
3846 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3847 In Insert and Command-line Insert mode, use a
3848 30% vertical bar cursor with colors from the
3849 "iCursor" highlight group. Blink a bit
3850 faster.
3851
3852 The 'a' mode is different. It will set the given argument-list for
3853 all modes. It does not reset anything to defaults. This can be used
3854 to do a common setting for all modes. For example, to switch off
3855 blinking: "a:blinkon0"
3856
3857 Examples of cursor highlighting: >
3858 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3859 :highlight Cursor gui=NONE guifg=bg guibg=fg
3860<
3861 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003862 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863'guifont' 'gfn' string (default "")
3864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 {only available when compiled with GUI enabled}
3866 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003867 In its simplest form the value is just one font name.
3868 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869
3870 *'guifontset'* *'gfs'*
3871 *E250* *E252* *E234* *E597* *E598*
3872'guifontset' 'gfs' string (default "")
3873 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 {only available when compiled with GUI enabled and
3875 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003876 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 When not empty, specifies two (or more) fonts to be used. The first
3878 one for normal English, the second one for your special language. See
3879 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003880
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3882'guifontwide' 'gfw' string (default "")
3883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 {only available when compiled with GUI enabled}
3885 When not empty, specifies a comma-separated list of fonts to be used
3886 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003887 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003888
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 *'guiheadroom'* *'ghr'*
3890'guiheadroom' 'ghr' number (default 50)
3891 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003892 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 The number of pixels subtracted from the screen height when fitting
3894 the GUI window on the screen. Set this before the GUI is started,
3895 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003896 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 lines will be left for window decorations and other items on the
3898 screen. Set it to a negative value to allow windows taller than the
3899 screen.
3900
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003901 *'guiligatures'* *'gli'* *E1243*
3902'guiligatures' 'gli' string (default "")
3903 global
3904 {only for GTK GUI}
3905 List of ASCII characters that, when combined together, can create more
3906 complex shapes. Each character must be a printable ASCII character
3907 with a value in the 32-127 range.
3908 Example: >
3909 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3910< Changing this option updates screen output immediately. Set it to an
3911 empty string to disable ligatures.
3912
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003914'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3915 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003916 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003917 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003920 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 sequence of letters which describes what components and options of the
3922 GUI should be used.
3923 To avoid problems with flags that are added in the future, use the
3924 "+=" and "-=" feature of ":set" |add-option-flags|.
3925
Bram Moolenaar13568252018-03-16 20:46:58 +01003926 Valid characters are as follows:
3927 *'go-!'*
3928 '!' External commands are executed in a terminal window. Without
3929 this flag the MS-Windows GUI will open a console window to
3930 execute the command. The Unix GUI will simulate a dumb
3931 terminal to list the command output.
3932 The terminal window will be positioned at the bottom, and grow
3933 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003934 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 'a' Autoselect: If present, then whenever VISUAL mode is started,
3936 or the Visual area extended, Vim tries to become the owner of
3937 the windowing system's global selection. This means that the
3938 Visually highlighted text is available for pasting into other
3939 applications as well as into Vim itself. When the Visual mode
3940 ends, possibly due to an operation on the text, or when an
3941 application wants to paste the selection, the highlighted text
3942 is automatically yanked into the "* selection register.
3943 Thus the selection is still available for pasting into other
3944 applications after the VISUAL mode has ended.
3945 If not present, then Vim won't become the owner of the
3946 windowing system's global selection unless explicitly told to
3947 by a yank or delete operation for the "* register.
3948 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003949 *'go-P'*
3950 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003951 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003952 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003953 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 applies to the modeless selection.
3955
3956 'guioptions' autoselect Visual autoselect modeless ~
3957 "" - -
3958 "a" yes yes
3959 "A" - yes
3960 "aA" yes yes
3961
Bram Moolenaar02467872007-05-06 13:22:01 +00003962 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003963 'c' Use console dialogs instead of popup dialogs for simple
3964 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003965 *'go-d'*
3966 'd' Use dark theme variant if available. Currently only works for
3967 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003968 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003969 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003970 'guitablabel' can be used to change the text in the labels.
3971 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003972 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003973 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003974 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 'f' Foreground: Don't use fork() to detach the GUI from the shell
3976 where it was started. Use this for programs that wait for the
3977 editor to finish (e.g., an e-mail program). Alternatively you
3978 can use "gvim -f" or ":gui -f" to start the GUI in the
3979 foreground. |gui-fork|
3980 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003981 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003982 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3984 corner of the window. It's black&white on non-GTK, because of
3985 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003986 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003988 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003989 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003991 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003993 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003994 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 'g' Grey menu items: Make menu items that are not active grey. If
3996 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00003997 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 't' Include tearoff menu items. Currently only works for Win32,
3999 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004000 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004001 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4002 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004003 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004005 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 'R' Right-hand scrollbar is present when there is a vertically
4007 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004008 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004010 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 'L' Left-hand scrollbar is present when there is a vertically
4012 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004013 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4015 the longest visible line, or on the cursor line if the 'h'
4016 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004017 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018 'h' Limit horizontal scrollbar size to the length of the cursor
4019 line. Reduces computations. |gui-horiz-scroll|
4020
4021 And yes, you may even have scrollbars on the left AND the right if
4022 you really want to :-). See |gui-scrollbars| for more information.
4023
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004024 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 'v' Use a vertical button layout for dialogs. When not included,
4026 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004027 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004028 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 'p' Use Pointer callbacks for X11 GUI. This is required for some
4030 window managers. If the cursor is not blinking or hollow at
4031 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004032 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004034 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004035 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004036 *'go-k'*
4037 'k' Keep the GUI window size when adding/removing a scrollbar, or
4038 toolbar, tabline, etc. Instead, the behavior is similar to
4039 when the window is maximized and will adjust 'lines' and
4040 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004041 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004042 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004043
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 *'guipty'* *'noguipty'*
4045'guipty' boolean (default on)
4046 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 {only available when compiled with GUI enabled}
4048 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4049 I/O to/from shell commands. See |gui-pty|.
4050
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004051 *'guitablabel'* *'gtl'*
4052'guitablabel' 'gtl' string (default empty)
4053 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004054 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004055 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004056 pages line. When empty and when the result is empty Vim will use a
4057 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004058
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004059 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004060 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004061 The expression will be evaluated in the |sandbox| when set from a
4062 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004063 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004064
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004065 Only used when the GUI tab pages line is displayed. 'e' must be
4066 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4067 used.
4068
Bram Moolenaar57657d82006-04-21 22:12:41 +00004069 *'guitabtooltip'* *'gtt'*
4070'guitabtooltip' 'gtt' string (default empty)
4071 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004072 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004073 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004074 pages line. When empty Vim will use a default tooltip.
4075 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004076 You can include a line break. Simplest method is to use |:let|: >
4077 :let &guitabtooltip = "line one\nline two"
4078<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004079
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004081'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004082 (others) "$VIMRUNTIME/doc/help.txt")
4083 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 Name of the main help file. All distributed help files should be
4085 placed together in one directory. Additionally, all "doc" directories
4086 in 'runtimepath' will be used.
4087 Environment variables are expanded |:set_env|. For example:
4088 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004089 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 spaces and backslashes.
4091 This option cannot be set from a |modeline| or in the |sandbox|, for
4092 security reasons.
4093
4094 *'helpheight'* *'hh'*
4095'helpheight' 'hh' number (default 20)
4096 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 Minimal initial height of the help window when it is opened with the
4098 ":help" command. The initial height of the help window is half of the
4099 current window, or (when the 'ea' option is on) the same as other
4100 windows. When the height is less than 'helpheight', the height is
4101 set to 'helpheight'. Set to zero to disable.
4102
4103 *'helplang'* *'hlg'*
4104'helplang' 'hlg' string (default: messages language or empty)
4105 global
4106 {only available when compiled with the |+multi_lang|
4107 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004108 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 for which the desired help can be found. The English help will always
4110 be used as a last resort. You can add "en" to prefer English over
4111 another language, but that will only find tags that exist in that
4112 language and not in the English help.
4113 Example: >
4114 :set helplang=de,it
4115< This will first search German, then Italian and finally English help
4116 files.
4117 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4118 try to find the tag in the current language before using this option.
4119 See |help-translated|.
4120
4121 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4122'hidden' 'hid' boolean (default off)
4123 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 When off a buffer is unloaded when it is |abandon|ed. When on a
4125 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4126 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004127
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004129 hidden even if the 'hidden' option is off when these three are true:
4130 - the buffer is modified
4131 - 'autowrite' is off or writing is not possible
4132 - the '!' flag was used
4133 Also see |windows.txt|.
4134
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004135 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 This option is set for one command with ":hide {command}" |:hide|.
4137 WARNING: It's easy to forget that you have changes in hidden buffers.
4138 Think twice when using ":q!" or ":qa!".
4139
4140 *'highlight'* *'hl'*
4141'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004142 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4143 d:Directory,e:ErrorMsg,i:IncSearch,
4144 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004145 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004146 N:CursorLineNr,r:Question,s:StatusLine,
4147 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004148 v:Visual,V:VisualNOS,w:WarningMsg,
4149 W:WildMenu,f:Folded,F:FoldColumn,
4150 A:DiffAdd,C:DiffChange,D:DiffDelete,
4151 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004152 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004153 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004154 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4155 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004156 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004157 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004160 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004162 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004164 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4165 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004166 characters from 'showbreak'
4167 |hl-Directory| d directories in CTRL-D listing and other special
4168 things in listings
4169 |hl-ErrorMsg| e error messages
4170 h (obsolete, ignored)
4171 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004172 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4174 |hl-MoreMsg| m |more-prompt|
4175 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004176 |hl-LineNr| n line number for ":number" and ":#" commands, and
4177 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004178 |hl-LineNrAbove| a line number above the cursor for when the
4179 'relativenumber' option is set.
4180 |hl-LineNrBelow| b line number below the cursor for when the
4181 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004182 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4183 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184 |hl-Question| r |hit-enter| prompt and yes/no questions
4185 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004186 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4188 |hl-VertSplit| c column used to separate vertically split windows
4189 |hl-Visual| v Visual mode
4190 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4191 Selection" Only X11 Gui's |gui-x11| and
4192 |xterm-clipboard|.
4193 |hl-WarningMsg| w warning messages
4194 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4195 |hl-Folded| f line used for closed folds
4196 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004197 |hl-DiffAdd| A added line in diff mode
4198 |hl-DiffChange| C changed line in diff mode
4199 |hl-DiffDelete| D deleted line in diff mode
4200 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004202 |hl-Conceal| - the placeholders used for concealed characters
4203 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004204 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004205 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004206 |hl-SpellRare| R rare word |spell|
4207 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004208 |hl-Pmenu| + popup menu normal line
4209 |hl-PmenuSel| = popup menu selected line
4210 |hl-PmenuSbar| x popup menu scrollbar
4211 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212
4213 The display modes are:
4214 r reverse (termcap entry "mr" and "me")
4215 i italic (termcap entry "ZH" and "ZR")
4216 b bold (termcap entry "md" and "me")
4217 s standout (termcap entry "so" and "se")
4218 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004219 c undercurl (termcap entry "Us" and "Ce")
4220 2 double underline (termcap entry "Ds" and "Ce")
4221 d dotted underline (termcap entry "ds" and "Ce")
4222 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004223 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 n no highlighting
4225 - no highlighting
4226 : use a highlight group
4227 The default is used for occasions that are not included.
4228 If you want to change what the display modes do, see |dos-colors|
4229 for an example.
4230 When using the ':' display mode, this must be followed by the name of
4231 a highlight group. A highlight group can be used to define any type
4232 of highlighting, including using color. See |:highlight| on how to
4233 define one. The default uses a different group for each occasion.
4234 See |highlight-default| for the default highlight groups.
4235
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004237'history' 'hi' number (Vim default: 50, Vi default: 0,
4238 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004241 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004242 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004243 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 NOTE: This option is set to the Vi default value when 'compatible' is
4245 set and to the Vim default value when 'compatible' is reset.
4246
4247 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4248'hkmap' 'hk' boolean (default off)
4249 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 {only available when compiled with the |+rightleft|
4251 feature}
4252 When on, the keyboard is mapped for the Hebrew character set.
4253 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4254 toggle this option. See |rileft.txt|.
4255 NOTE: This option is reset when 'compatible' is set.
4256
4257 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4258'hkmapp' 'hkp' boolean (default off)
4259 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004260 {only available when compiled with the |+rightleft|
4261 feature}
4262 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4263 This is useful if you have a non-Hebrew keyboard.
4264 See |rileft.txt|.
4265 NOTE: This option is reset when 'compatible' is set.
4266
Bram Moolenaar036986f2017-03-16 17:41:02 +01004267 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4268'hlsearch' 'hls' boolean (default off)
4269 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004270 {not available when compiled without the
4271 |+extra_search| feature}
4272 When there is a previous search pattern, highlight all its matches.
4273 The type of highlighting used can be set with the 'l' occasion in the
4274 'highlight' option. This uses the "Search" highlight group by
4275 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004276 are not applied. If the "CurSearch" highlight group is set then the
4277 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004278 See also: 'incsearch' and |:match|.
4279 When you get bored looking at the highlighted matches, you can turn it
4280 off with |:nohlsearch|. This does not change the option value, as
4281 soon as you use a search command, the highlighting comes back.
4282 'redrawtime' specifies the maximum time spent on finding matches.
4283 When the search pattern can match an end-of-line, Vim will try to
4284 highlight all of the matched text. However, this depends on where the
4285 search starts. This will be the first line in the window or the first
4286 line below a closed fold. A match in a previous line which is not
4287 drawn may not continue in a newly drawn line.
4288 You can specify whether the highlight status is restored on startup
4289 with the 'h' flag in 'viminfo' |viminfo-h|.
4290 NOTE: This option is reset when 'compatible' is set.
4291
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 *'icon'* *'noicon'*
4293'icon' boolean (default off, on when title can be restored)
4294 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 When on, the icon text of the window will be set to the value of
4296 'iconstring' (if it is not empty), or to the name of the file
4297 currently being edited. Only the last part of the name is used.
4298 Overridden by the 'iconstring' option.
4299 Only works if the terminal supports setting window icons (currently
4300 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4301 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4302 builtin termcap).
4303 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004304 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004306 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307
4308 *'iconstring'*
4309'iconstring' string (default "")
4310 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 When this option is not empty, it will be used for the icon text of
4312 the window. This happens only when the 'icon' option is on.
4313 Only works if the terminal supports setting window icon text
4314 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004315 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 When Vim was compiled with HAVE_X11 defined, the original icon will be
4317 restored if possible |X11|.
4318 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004319 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004321 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 {not available when compiled without the |+statusline| feature}
4323
4324 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4325'ignorecase' 'ic' boolean (default off)
4326 global
4327 Ignore case in search patterns. Also used when searching in the tags
4328 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004329 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330 Can be overruled by using "\c" or "\C" in the pattern, see
4331 |/ignorecase|.
4332
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004333 *'imactivatefunc'* *'imaf'*
4334'imactivatefunc' 'imaf' string (default "")
4335 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004336 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004337 activate or deactivate the Input Method. The value can be the name of
4338 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4339 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004340 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004341 The expression will be evaluated in the |sandbox| when set from a
4342 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004343
4344 Example: >
4345 function ImActivateFunc(active)
4346 if a:active
4347 ... do something
4348 else
4349 ... do something
4350 endif
4351 " return value is not used
4352 endfunction
4353 set imactivatefunc=ImActivateFunc
4354<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 *'imactivatekey'* *'imak'*
4356'imactivatekey' 'imak' string (default "")
4357 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004359 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 Specifies the key that your Input Method in X-Windows uses for
4361 activation. When this is specified correctly, vim can fully control
4362 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4363 You can't use this option to change the activation key, the option
4364 tells Vim what the key is.
4365 Format:
4366 [MODIFIER_FLAG-]KEY_STRING
4367
4368 These characters can be used for MODIFIER_FLAG (case is ignored):
4369 S Shift key
4370 L Lock key
4371 C Control key
4372 1 Mod1 key
4373 2 Mod2 key
4374 3 Mod3 key
4375 4 Mod4 key
4376 5 Mod5 key
4377 Combinations are allowed, for example "S-C-space" or "SC-space" are
4378 both shift+ctrl+space.
4379 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4380
4381 Example: >
4382 :set imactivatekey=S-space
4383< "S-space" means shift+space. This is the activation key for kinput2 +
4384 canna (Japanese), and ami (Korean).
4385
4386 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4387'imcmdline' 'imc' boolean (default off)
4388 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 When set the Input Method is always on when starting to edit a command
4390 line, unless entering a search pattern (see 'imsearch' for that).
4391 Setting this option is useful when your input method allows entering
4392 English characters directly, e.g., when it's used to type accented
4393 characters with dead keys.
4394
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004395 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4397 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398 When set the Input Method is never used. This is useful to disable
4399 the IM when it doesn't work properly.
4400 Currently this option is on by default for SGI/IRIX machines. This
4401 may change in later releases.
4402
4403 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004404'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 Specifies whether :lmap or an Input Method (IM) is to be used in
4407 Insert mode. Valid values:
4408 0 :lmap is off and IM is off
4409 1 :lmap is ON and IM is off
4410 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 To always reset the option to zero when leaving Insert mode with <Esc>
4412 this can be used: >
4413 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4414< This makes :lmap and IM turn off automatically when leaving Insert
4415 mode.
4416 Note that this option changes when using CTRL-^ in Insert mode
4417 |i_CTRL-^|.
4418 The value is set to 1 when setting 'keymap' to a valid keymap name.
4419 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004420 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 methods. Use 'imdisable' to disable XIM then.
4422
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004423 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004424 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004425 |+multi_byte_ime| or |global-ime|.
4426
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004428'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004429 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430 Specifies whether :lmap or an Input Method (IM) is to be used when
4431 entering a search pattern. Valid values:
4432 -1 the value of 'iminsert' is used, makes it look like
4433 'iminsert' is also used when typing a search pattern
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
4437 Note that this option changes when using CTRL-^ in Command-line mode
4438 |c_CTRL-^|.
4439 The value is set to 1 when it is not -1 and setting the 'keymap'
4440 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004441 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442 methods. Use 'imdisable' to disable XIM then.
4443
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004444 *'imstatusfunc'* *'imsf'*
4445'imstatusfunc' 'imsf' string (default "")
4446 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004447 This option specifies a function that is called to obtain the status
4448 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004449 The value can be the name of a function, a |lambda| or a |Funcref|.
4450 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004451 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004452
4453 Example: >
4454 function ImStatusFunc()
4455 let is_active = ...do something
4456 return is_active ? 1 : 0
4457 endfunction
4458 set imstatusfunc=ImStatusFunc
4459<
4460 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004461 The expression will be evaluated in the |sandbox| when set from a
4462 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004463
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004464 *'imstyle'* *'imst'*
4465'imstyle' 'imst' number (default 1)
4466 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004467 {only available when compiled with |+xim| and
4468 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004469 This option specifies the input style of Input Method:
4470 0 use on-the-spot style
4471 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004472 See: |xim-input-style|
4473
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004474 For a long time on-the-spot style had been used in the GTK version of
4475 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004476 |single-repeat|, etc. Therefore over-the-spot style becomes the
4477 default now. This should work fine for most people, however if you
4478 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004479 The expression will be evaluated in the |sandbox| when set from a
4480 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004481
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482 *'include'* *'inc'*
4483'include' 'inc' string (default "^\s*#\s*include")
4484 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 {not available when compiled without the
4486 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004487 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 pattern, just like for the "/" command (See |pattern|). The default
4489 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004490 "]I", "[d", etc.
4491 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004492 comes after the matched pattern. But if "\zs" appears in the pattern
4493 then the text matched from "\zs" to the end, or until "\ze" if it
4494 appears, is used as the file name. Use this to include characters
4495 that are not in 'isfname', such as a space. You can then use
4496 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004497 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498
4499 *'includeexpr'* *'inex'*
4500'includeexpr' 'inex' string (default "")
4501 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004502 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004503 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004505 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 :set includeexpr=substitute(v:fname,'\\.','/','g')
4507< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004508
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004510 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511 Also used for |<cfile>|.
4512
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004513 If the expression starts with s: or |<SID>|, then it is replaced with
4514 the script ID (|local-function|). Example: >
4515 set includeexpr=s:MyIncludeExpr(v:fname)
4516 set includeexpr=<SID>SomeIncludeExpr(v:fname)
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004517< Otherwise, the expression is evaluated in the context of the script
4518 where the option was set, thus script-local items are available.
4519
Bram Moolenaar30b65812012-07-12 22:01:11 +02004520 The expression will be evaluated in the |sandbox| when set from a
4521 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004522 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004523
4524 It is not allowed to change text or jump to another window while
4525 evaluating 'includeexpr' |textlock|.
4526
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004528'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004529 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004532 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004533 While typing a search command, show where the pattern, as it was typed
4534 so far, matches. The matched string is highlighted. If the pattern
4535 is invalid or not found, nothing is shown. The screen will be updated
4536 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004537 Also applies to the pattern in commands: >
4538 :global
4539 :lvimgrep
4540 :lvimgrepadd
4541 :smagic
4542 :snomagic
4543 :sort
4544 :substitute
4545 :vglobal
4546 :vimgrep
4547 :vimgrepadd
4548< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004549 original position when no match is found and when pressing <Esc>. You
4550 still need to finish the search command with <Enter> to move the
4551 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004552 You can use the CTRL-G and CTRL-T keys to move to the next and
4553 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004554 When compiled with the |+reltime| feature Vim only searches for about
4555 half a second. With a complicated pattern and/or a lot of text the
4556 match may not be found. This is to avoid that Vim hangs while you
4557 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004558 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004559 When 'hlsearch' is on, all matched strings are highlighted too while
4560 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004561 If you don't want to turn 'hlsearch' on, but want to highlight all
4562 matches while searching, you can turn on and off 'hlsearch' with
4563 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004564 augroup vimrc-incsearch-highlight
4565 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004566 autocmd CmdlineEnter /,\? :set hlsearch
4567 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004568 augroup END
4569<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004570 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004571 to the command line. If 'ignorecase' and 'smartcase' are set and the
4572 command line has no uppercase characters, the added character is
4573 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004574 CTRL-R CTRL-W can be used to add the word at the end of the current
4575 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 NOTE: This option is reset when 'compatible' is set.
4577
4578 *'indentexpr'* *'inde'*
4579'indentexpr' 'inde' string (default "")
4580 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004581 {not available when compiled without the |+eval|
4582 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 Expression which is evaluated to obtain the proper indent for a line.
4584 It is used when a new line is created, for the |=| operator and
4585 in Insert mode as specified with the 'indentkeys' option.
4586 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004587 'smartindent' indenting. When 'lisp' is set, this option is
4588 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 When 'paste' is set this option is not used for indenting.
4590 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004591 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004593
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004594 If the expression starts with s: or |<SID>|, then it is replaced with
4595 the script ID (|local-function|). Example: >
4596 set indentexpr=s:MyIndentExpr()
4597 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004598< Otherwise, the expression is evaluated in the context of the script
4599 where the option was set, thus script-local items are available.
4600
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 The expression must return the number of spaces worth of indent. It
4602 can return "-1" to keep the current indent (this means 'autoindent' is
4603 used for the indent).
4604 Functions useful for computing the indent are |indent()|, |cindent()|
4605 and |lispindent()|.
4606 The evaluation of the expression must not have side effects! It must
4607 not change the text, jump to another window, etc. Afterwards the
4608 cursor position is always restored, thus the cursor may be moved.
4609 Normally this option would be set to call a function: >
4610 :set indentexpr=GetMyIndent()
4611< Error messages will be suppressed, unless the 'debug' option contains
4612 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004613 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004614 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615
Bram Moolenaar30b65812012-07-12 22:01:11 +02004616 The expression will be evaluated in the |sandbox| when set from a
4617 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004618 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004619
4620 It is not allowed to change text or jump to another window while
4621 evaluating 'indentexpr' |textlock|.
4622
4623
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004625'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 A list of keys that, when typed in Insert mode, cause reindenting of
4628 the current line. Only happens if 'indentexpr' isn't empty.
4629 The format is identical to 'cinkeys', see |indentkeys-format|.
4630 See |C-indenting| and |indent-expression|.
4631
4632 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4633'infercase' 'inf' boolean (default off)
4634 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004636 'ignorecase' is also on, the case of the match is adjusted depending
4637 on the typed text. If the typed text contains a lowercase letter
4638 where the match has an upper case letter, the completed part is made
4639 lowercase. If the typed text has no lowercase letters and the match
4640 has a lowercase letter where the typed text has an uppercase letter,
4641 and there is a letter before it, the completed part is made uppercase.
4642 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643
4644 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4645'insertmode' 'im' boolean (default off)
4646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 Makes Vim work in a way that Insert mode is the default mode. Useful
4648 if you want to use Vim as a modeless editor. Used for |evim|.
4649 These Insert mode commands will be useful:
4650 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004651 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 this is a mapping, it is executed as if 'insertmode' was off.
4653 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004655 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4656 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657
4658 These items change when 'insertmode' is set:
4659 - when starting to edit of a file, Vim goes to Insert mode.
4660 - <Esc> in Insert mode is a no-op and beeps.
4661 - <Esc> in Normal mode makes Vim go to Insert mode.
4662 - CTRL-L in Insert mode is a command, it is not inserted.
4663 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4664 However, when <Esc> is used inside a mapping, it behaves like
4665 'insertmode' was not set. This was done to be able to use the same
4666 mappings with 'insertmode' set or not set.
4667 When executing commands with |:normal| 'insertmode' is not used.
4668
4669 NOTE: This option is reset when 'compatible' is set.
4670
4671 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004672'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4674 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4675 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4676 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4677 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679 The characters specified by this option are included in file names and
4680 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004681 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 Multi-byte characters 256 and above are always included, only the
4683 characters up to 255 are specified with this option.
4684 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004685 Think twice before adding white space to this option. Although a
4686 space may appear inside a file name, the effect will be that Vim
4687 doesn't know where a file name starts or ends when doing completion.
4688 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689
4690 Note that on systems using a backslash as path separator, Vim tries to
4691 do its best to make it work as you would expect. That is a bit
4692 tricky, since Vi originally used the backslash to escape special
4693 characters. Vim will not remove a backslash in front of a normal file
4694 name character on these systems, but it will on Unix and alikes. The
4695 '&' and '^' are not included by default, because these are special for
4696 cmd.exe.
4697
4698 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004699 Each part can be a single character number or a range. A range is two
4700 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 decimal number between 0 and 255 or the ASCII character itself (does
4702 not work for digits). Example:
4703 "_,-,128-140,#-43" (include '_' and '-' and the range
4704 128 to 140 and '#' to 43)
4705 If a part starts with '^', the following character number or range
4706 will be excluded from the option. The option is interpreted from left
4707 to right. Put the excluded character after the range where it is
4708 included. To include '^' itself use it as the last character of the
4709 option or the end of a range. Example:
4710 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4711 If the character is '@', all characters where isalpha() returns TRUE
4712 are included. Normally these are the characters a to z and A to Z,
4713 plus accented characters. To include '@' itself use "@-@". Examples:
4714 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004715 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004716 "a-z,A-Z,@-@" All letters plus the '@' character.
4717 A comma can be included by using it where a character number is
4718 expected. Example:
4719 "48-57,,,_" Digits, comma and underscore.
4720 A comma can be excluded by prepending a '^'. Example:
4721 " -~,^,,9" All characters from space to '~', excluding
4722 comma, plus <Tab>.
4723 See |option-backslash| about including spaces and backslashes.
4724
4725 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004726'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727 "@,48-57,_,128-167,224-235"
4728 otherwise: "@,48-57,_,192-255")
4729 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 The characters given by this option are included in identifiers.
4731 Identifiers are used in recognizing environment variables and after a
4732 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004733 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004734 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004736 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4738
4739 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004740'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741 "@,48-57,_,128-167,224-235"
4742 otherwise: "@,48-57,_,192-255"
4743 Vi default: "@,48-57,_")
4744 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004746 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004747 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004748 characters above 255 check the "word" character class (any character
4749 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004750 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751 For a help file it is set to all non-blank printable characters except
4752 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4753 command).
4754 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004755 This option also influences syntax highlighting, unless the syntax
4756 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757 NOTE: This option is set to the Vi default value when 'compatible' is
4758 set and to the Vim default value when 'compatible' is reset.
4759
4760 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004761'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762 "@,~-255"; otherwise: "@,161-255")
4763 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 The characters given by this option are displayed directly on the
4765 screen. It is also used for "\p" in a |pattern|. The characters from
4766 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4767 even when they are not included in 'isprint' or excluded. See
4768 'isfname' for a description of the format of this option.
4769
4770 Non-printable characters are displayed with two characters:
4771 0 - 31 "^@" - "^_"
4772 32 - 126 always single characters
4773 127 "^?"
4774 128 - 159 "~@" - "~_"
4775 160 - 254 "| " - "|~"
4776 255 "~?"
4777 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4778 displayed as <xx>, with the hexadecimal value of the byte.
4779 When 'display' contains "uhex" all unprintable characters are
4780 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004781 The SpecialKey highlighting will be used for unprintable characters.
4782 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783
4784 Multi-byte characters 256 and above are always included, only the
4785 characters up to 255 are specified with this option. When a character
4786 is printable but it is not available in the current font, a
4787 replacement character will be shown.
4788 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4789 There is no option to specify these characters.
4790
4791 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4792'joinspaces' 'js' boolean (default on)
4793 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794 Insert two spaces after a '.', '?' and '!' with a join command.
4795 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4796 Otherwise only one space is inserted.
4797 NOTE: This option is set when 'compatible' is set.
4798
4799 *'key'*
4800'key' string (default "")
4801 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004802 {only available when compiled with the |+cryptv|
4803 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004805 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 Careful: Do not set the key value by hand, someone might see the typed
4807 key. Use the |:X| command. But you can make 'key' empty: >
4808 :set key=
4809< It is not possible to get the value of this option with ":set key" or
4810 "echo &key". This is to avoid showing it to someone who shouldn't
4811 know. It also means you cannot see it yourself once you have set it,
4812 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004813 You can use "&key" in an expression to detect whether encryption is
4814 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004815
4816 *'keymap'* *'kmp'* *E544*
4817'keymap' 'kmp' string (default "")
4818 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 {only available when compiled with the |+keymap|
4820 feature}
4821 Name of a keyboard mapping. See |mbyte-keymap|.
4822 Setting this option to a valid keymap name has the side effect of
4823 setting 'iminsert' to one, so that the keymap becomes effective.
4824 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004825 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826
4827 *'keymodel'* *'km'*
4828'keymodel' 'km' string (default "")
4829 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004830 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831 can do. These values can be used:
4832 startsel Using a shifted special key starts selection (either
4833 Select mode or Visual mode, depending on "key" being
4834 present in 'selectmode').
4835 stopsel Using a not-shifted special key stops selection.
4836 Special keys in this context are the cursor keys, <End>, <Home>,
4837 <PageUp> and <PageDown>.
4838 The 'keymodel' option is set by the |:behave| command.
4839
4840 *'keywordprg'* *'kp'*
4841'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004842 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844 Program to use for the |K| command. Environment variables are
4845 expanded |:set_env|. ":help" may be used to access the Vim internal
4846 help. (Note that previously setting the global option to the empty
4847 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004848 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01004849 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004850 When "man", "man -s" or an Ex command is used, Vim will automatically
4851 translate a count for the "K" command and pass it as the first
4852 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 See |option-backslash| about including spaces and backslashes.
4854 Example: >
4855 :set keywordprg=man\ -s
4856< This option cannot be set from a |modeline| or in the |sandbox|, for
4857 security reasons.
4858
4859 *'langmap'* *'lmap'* *E357* *E358*
4860'langmap' 'lmap' string (default "")
4861 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862 {only available when compiled with the |+langmap|
4863 feature}
4864 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004865 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004866 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 care of translating these special characters to the original meaning
4868 of the key. This means you don't have to change the keyboard mode to
4869 be able to execute Normal mode commands.
4870 This is the opposite of the 'keymap' option, where characters are
4871 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004872 Also consider setting 'langremap' to off, to prevent 'langmap' from
4873 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004874 This option cannot be set from a |modeline| or in the |sandbox|, for
4875 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004877 Example (for Greek, in UTF-8): *greek* >
4878 :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 +00004879< Example (exchanges meaning of z and y for commands): >
4880 :set langmap=zy,yz,ZY,YZ
4881<
4882 The 'langmap' option is a list of parts, separated with commas. Each
4883 part can be in one of two forms:
4884 1. A list of pairs. Each pair is a "from" character immediately
4885 followed by the "to" character. Examples: "aA", "aAbBcC".
4886 2. A list of "from" characters, a semi-colon and a list of "to"
4887 characters. Example: "abc;ABC"
4888 Example: "aA,fgh;FGH,cCdDeE"
4889 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004890 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891
4892 This will allow you to activate vim actions without having to switch
4893 back and forth between the languages. Your language characters will
4894 be understood as normal vim English characters (according to the
4895 langmap mappings) in the following cases:
4896 o Normal/Visual mode (commands, buffer/register names, user mappings)
4897 o Insert/Replace Mode: Register names after CTRL-R
4898 o Insert/Replace Mode: Mappings
4899 Characters entered in Command-line mode will NOT be affected by
4900 this option. Note that this option can be changed at any time
4901 allowing to switch between mappings for different languages/encodings.
4902 Use a mapping to avoid having to type it each time!
4903
4904 *'langmenu'* *'lm'*
4905'langmenu' 'lm' string (default "")
4906 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907 {only available when compiled with the |+menu| and
4908 |+multi_lang| features}
4909 Language to use for menu translation. Tells which file is loaded
4910 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004911 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912< (without the spaces). For example, to always use the Dutch menus, no
4913 matter what $LANG is set to: >
4914 :set langmenu=nl_NL.ISO_8859-1
4915< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004916 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917 If your $LANG is set to a non-English language but you do want to use
4918 the English menus: >
4919 :set langmenu=none
4920< This option must be set before loading menus, switching on filetype
4921 detection or syntax highlighting. Once the menus are defined setting
4922 this option has no effect. But you could do this: >
4923 :source $VIMRUNTIME/delmenu.vim
4924 :set langmenu=de_DE.ISO_8859-1
4925 :source $VIMRUNTIME/menu.vim
4926< Warning: This deletes all menus that you defined yourself!
4927
Bram Moolenaard94464e2015-11-02 15:28:18 +01004928 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004929'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004930 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004931 {only available when compiled with the |+langmap|
4932 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004933 This is just like 'langremap' but with the value inverted. It only
4934 exists for backwards compatibility. When setting 'langremap' then
4935 'langnoremap' is set to the inverted value, and the other way around.
4936
4937 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004938'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004939 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004940 {only available when compiled with the |+langmap|
4941 feature}
4942 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004943 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004944 'langmap' disables some of your mappings, try resetting this option.
4945 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004946 that works for you to avoid mappings to break.
4947
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948 *'laststatus'* *'ls'*
4949'laststatus' 'ls' number (default 1)
4950 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004951 The value of this option influences when the last window will have a
4952 status line:
4953 0: never
4954 1: only if there are at least two windows
4955 2: always
4956 The screen looks nicer with a status line if you have several
4957 windows, but it takes another screen line. |status-line|
4958
4959 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4960'lazyredraw' 'lz' boolean (default off)
4961 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962 When this option is set, the screen will not be redrawn while
4963 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004964 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01004966 This may occasionally cause display errors. It is only meant to be set
4967 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01004968 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969
4970 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4971'linebreak' 'lbr' boolean (default off)
4972 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004973 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004974 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004975 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 than at the last character that fits on the screen. Unlike
4977 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004978 it only affects the way the file is displayed, not its contents.
4979 If 'breakindent' is set, line is visually indented. Then, the value
4980 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004981 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 Note that <Tab> characters after an <EOL> are mostly not displayed
4983 with the right amount of white space.
4984
4985 *'lines'* *E593*
4986'lines' number (default 24 or terminal height)
4987 global
4988 Number of lines of the Vim window.
4989 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004990 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 When Vim is running in the GUI or in a resizable window, setting this
4992 option will cause the window size to be changed. When you only want
4993 to use the size for the GUI, put the command in your |gvimrc| file.
4994 Vim limits the number of lines to what fits on the screen. You can
4995 use this command to get the tallest window possible: >
4996 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004997< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004998 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999 When you set this option and Vim is unable to change the physical
5000 number of lines of the display, the display may be messed up.
5001
5002 *'linespace'* *'lsp'*
5003'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005 {only in the GUI}
5006 Number of pixel lines inserted between characters. Useful if the font
5007 uses the full character cell height, making lines touch each other.
5008 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005009 With some fonts there can be too much room between lines (to have
5010 space for ascents and descents). Then it makes sense to set
5011 'linespace' to a negative value. This may cause display problems
5012 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013
5014 *'lisp'* *'nolisp'*
5015'lisp' boolean (default off)
5016 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005017 Lisp mode: When <Enter> is typed in insert mode set the indent for
5018 the next line to Lisp standards (well, sort of). Also happens with
5019 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5020 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5021 better. Also see 'lispwords'.
5022 The '-' character is included in keyword characters. Redefines the
5023 "=" operator to use this same indentation algorithm rather than
5024 calling an external program if 'equalprg' is empty.
5025 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005026
5027 *'lispwords'* *'lw'*
5028'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005029 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005030 Comma-separated list of words that influence the Lisp indenting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031 |'lisp'|
5032
5033 *'list'* *'nolist'*
5034'list' boolean (default off)
5035 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005036 List mode: By default show tabs as CTRL-I is displayed, display $
5037 after end of line. Useful to see the difference between tabs and
5038 spaces and for trailing blanks. Further changed by the 'listchars'
5039 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005040
5041 The cursor is displayed at the start of the space a Tab character
5042 occupies, not at the end as usual in Normal mode. To get this cursor
5043 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005044 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005045<
5046 Note that list mode will also affect formatting (set with 'textwidth'
5047 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048 changing the way tabs are displayed.
5049
5050 *'listchars'* *'lcs'*
5051'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005052 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005053 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005054 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005055 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 eol:c Character to show at the end of each line. When
5057 omitted, there is no extra character at the end of the
5058 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005059 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005060 tab:xy[z] Two or three characters to be used to show a tab.
5061 The third character is optional.
5062
5063 tab:xy The 'x' is always used, then 'y' as many times as will
5064 fit. Thus "tab:>-" displays:
5065 >
5066 >-
5067 >--
5068 etc.
5069
5070 tab:xyz The 'z' is always used, then 'x' is prepended, and
5071 then 'y' is used as many times as will fit. Thus
5072 "tab:<->" displays:
5073 >
5074 <>
5075 <->
5076 <-->
5077 etc.
5078
5079 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005080 *lcs-space*
5081 space:c Character to show for a space. When omitted, spaces
5082 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005083 *lcs-multispace*
5084 multispace:c...
5085 One or more characters to use cyclically to show for
5086 multiple consecutive spaces. Overrides the "space"
5087 setting, except for single spaces. When omitted, the
5088 "space" setting is used. For example,
5089 `:set listchars=multispace:---+` shows ten consecutive
5090 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005091 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005092 *lcs-lead*
5093 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005094 leading spaces are blank. Overrides the "space" and
5095 "multispace" settings for leading spaces. You can
5096 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005097 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005098< *lcs-leadmultispace*
5099 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005100 Like the |lcs-multispace| value, but for leading
5101 spaces only. Also overrides |lcs-lead| for leading
5102 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005103 `:set listchars=leadmultispace:---+` shows ten
5104 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005105 ---+---+--XXX ~
5106 Where "XXX" denotes the first non-blank characters in
5107 the line.
5108 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005109 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005110 trailing spaces are blank. Overrides the "space" and
5111 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005112 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113 extends:c Character to show in the last column, when 'wrap' is
5114 off and the line continues beyond the right of the
5115 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005116 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005117 precedes:c Character to show in the first visible column of the
5118 physical line, when there is text preceding the
5119 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005120 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005121 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005122 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005123 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005124 nbsp:c Character to show for a non-breakable space character
5125 (0xA0 (160 decimal) and U+202F). Left blank when
5126 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005127
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005128 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005130 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005131
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005132 Each character can be specified as hex: >
5133 set listchars=eol:\\x24
5134 set listchars=eol:\\u21b5
5135 set listchars=eol:\\U000021b5
5136< Note that a double backslash is used. The number of hex characters
5137 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5138
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139 Examples: >
5140 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005141 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142 :set lcs=extends:>,precedes:<
5143< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005144 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5145 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005146 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147
5148 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5149'loadplugins' 'lpl' boolean (default on)
5150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 When on the plugin scripts are loaded when starting up |load-plugins|.
5152 This option can be reset in your |vimrc| file to disable the loading
5153 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005154 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5155 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156
Bram Moolenaard94464e2015-11-02 15:28:18 +01005157 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005158'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005159 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005160 {only available when compiled with the |+lua/dyn|
5161 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005162 Specifies the name of the Lua shared library. The default is
5163 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005164 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005165 This option cannot be set from a |modeline| or in the |sandbox|, for
5166 security reasons.
5167
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005168 *'macatsui'* *'nomacatsui'*
5169'macatsui' boolean (default on)
5170 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005171 {not supported}
5172 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005173
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174 *'magic'* *'nomagic'*
5175'magic' boolean (default on)
5176 global
5177 Changes the special characters that can be used in search patterns.
5178 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005179 WARNING: Switching this option off most likely breaks plugins! That
5180 is because many patterns assume it's on and will fail when it's off.
5181 Only switch it off when working with old Vi scripts. In any other
5182 situation write patterns that work when 'magic' is on. Include "\M"
5183 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005184 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5185 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186
5187 *'makeef'* *'mef'*
5188'makeef' 'mef' string (default: "")
5189 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190 {not available when compiled without the |+quickfix|
5191 feature}
5192 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5193 and the |:grep| command.
5194 When it is empty, an internally generated temp file will be used.
5195 When "##" is included, it is replaced by a number to make the name
5196 unique. This makes sure that the ":make" command doesn't overwrite an
5197 existing file.
5198 NOT used for the ":cf" command. See 'errorfile' for that.
5199 Environment variables are expanded |:set_env|.
5200 See |option-backslash| about including spaces and backslashes.
5201 This option cannot be set from a |modeline| or in the |sandbox|, for
5202 security reasons.
5203
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005204 *'makeencoding'* *'menc'*
5205'makeencoding' 'menc' string (default "")
5206 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005207 Encoding used for reading the output of external commands. When empty,
5208 encoding is not converted.
5209 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5210 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5211 and `:laddfile`.
5212
5213 This would be mostly useful when you use MS-Windows and set 'encoding'
5214 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5215 'makeencoding' to "char" has the same effect as setting to the system
5216 locale encoding. Example: >
5217 :set encoding=utf-8
5218 :set makeencoding=char " system locale is used
5219<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220 *'makeprg'* *'mp'*
5221'makeprg' 'mp' string (default "make", VMS: "MMS")
5222 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005223 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005224 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5225 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005226 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005227 Environment variables are expanded |:set_env|. See |option-backslash|
5228 about including spaces and backslashes.
5229 Note that a '|' must be escaped twice: once for ":set" and once for
5230 the interpretation of a command. When you use a filter called
5231 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232 :set makeprg=gmake\ \\\|\ myfilter
5233< The placeholder "$*" can be given (even multiple times) to specify
5234 where the arguments will be included, for example: >
5235 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5236< This option cannot be set from a |modeline| or in the |sandbox|, for
5237 security reasons.
5238
5239 *'matchpairs'* *'mps'*
5240'matchpairs' 'mps' string (default "(:),{:},[:]")
5241 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005243 other.
5244 Only character pairs are allowed that are different, thus you cannot
5245 jump between two double quotes.
5246 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005247 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005248 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005249 :set mps+=<:>
5250
5251< A more exotic example, to jump between the '=' and ';' in an
5252 assignment, useful for languages like C and Java: >
5253 :au FileType c,cpp,java set mps+==:;
5254
5255< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005256 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257
5258 *'matchtime'* *'mat'*
5259'matchtime' 'mat' number (default 5)
5260 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005261 Tenths of a second to show the matching paren, when 'showmatch' is
5262 set. Note that this is not in milliseconds, like other options that
5263 set a time. This is to be compatible with Nvi.
5264
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005265 *'maxcombine'* *'mco'*
5266'maxcombine' 'mco' number (default 2)
5267 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005268 The maximum number of combining characters supported for displaying.
5269 Only used when 'encoding' is "utf-8".
5270 The default is OK for most languages. Hebrew may require 4.
5271 Maximum value is 6.
5272 Even when this option is set to 2 you can still edit text with more
5273 combining characters, you just can't see them. Use |g8| or |ga|.
5274 See |mbyte-combining|.
5275
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 *'maxfuncdepth'* *'mfd'*
5277'maxfuncdepth' 'mfd' number (default 100)
5278 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005279 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005280 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281 Maximum depth of function calls for user functions. This normally
5282 catches endless recursion. When using a recursive function with
5283 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5284 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005285 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005286 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287 See also |:function|.
5288
5289 *'maxmapdepth'* *'mmd'* *E223*
5290'maxmapdepth' 'mmd' number (default 1000)
5291 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292 Maximum number of times a mapping is done without resulting in a
5293 character to be used. This normally catches endless mappings, like
5294 ":map x y" with ":map y x". It still does not catch ":map g wg",
5295 because the 'w' is used before the next mapping is done. See also
5296 |key-mapping|.
5297
5298 *'maxmem'* *'mm'*
5299'maxmem' 'mm' number (default between 256 to 5120 (system
5300 dependent) or half the amount of memory
5301 available)
5302 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5304 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005305 other memory to be freed.
5306 The maximum usable value is about 2000000. Use this to work without a
5307 limit.
5308 The value is ignored when 'swapfile' is off.
5309 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005311 *'maxmempattern'* *'mmp'*
5312'maxmempattern' 'mmp' number (default 1000)
5313 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005314 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005315 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005316 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005317 When Vim runs into the limit it gives an error message and mostly
5318 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005319 Running into the limit often means that the pattern is very
5320 inefficient or too complex. This may already happen with the pattern
5321 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005322 Might also happen on redraw, when syntax rules try to match a complex
5323 text structure.
5324 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5325 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005326
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327 *'maxmemtot'* *'mmt'*
5328'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5329 dependent) or half the amount of memory
5330 available)
5331 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005332 Maximum amount of memory in Kbyte to use for all buffers together.
5333 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005334 without a limit.
5335 On 64 bit machines higher values might work. But hey, do you really
5336 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005337 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005338 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005339 Buffers with 'swapfile' off still count to the total amount of memory
5340 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005341 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342
5343 *'menuitems'* *'mis'*
5344'menuitems' 'mis' number (default 25)
5345 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346 {not available when compiled without the |+menu|
5347 feature}
5348 Maximum number of items to use in a menu. Used for menus that are
5349 generated from a list of items, e.g., the Buffers menu. Changing this
5350 option has no direct effect, the menu must be refreshed first.
5351
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005352 *'mkspellmem'* *'msm'*
5353'mkspellmem' 'msm' string (default "460000,2000,500")
5354 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005355 {not available when compiled without the |+syntax|
5356 feature}
5357 Parameters for |:mkspell|. This tunes when to start compressing the
5358 word tree. Compression can be slow when there are many words, but
5359 it's needed to avoid running out of memory. The amount of memory used
5360 per word depends very much on how similar the words are, that's why
5361 this tuning is complicated.
5362
5363 There are three numbers, separated by commas:
5364 {start},{inc},{added}
5365
5366 For most languages the uncompressed word tree fits in memory. {start}
5367 gives the amount of memory in Kbyte that can be used before any
5368 compression is done. It should be a bit smaller than the amount of
5369 memory that is available to Vim.
5370
5371 When going over the {start} limit the {inc} number specifies the
5372 amount of memory in Kbyte that can be allocated before another
5373 compression is done. A low number means compression is done after
5374 less words are added, which is slow. A high number means more memory
5375 will be allocated.
5376
5377 After doing compression, {added} times 1024 words can be added before
5378 the {inc} limit is ignored and compression is done when any extra
5379 amount of memory is needed. A low number means there is a smaller
5380 chance of hitting the {inc} limit, less memory is used but it's
5381 slower.
5382
5383 The languages for which these numbers are important are Italian and
5384 Hungarian. The default works for when you have about 512 Mbyte. If
5385 you have 1 Gbyte you could use: >
5386 :set mkspellmem=900000,3000,800
5387< If you have less than 512 Mbyte |:mkspell| may fail for some
5388 languages, no matter what you set 'mkspellmem' to.
5389
Bram Moolenaar07607392019-05-26 19:20:43 +02005390 This option cannot be set from a |modeline| or in the |sandbox|.
5391
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005393'modeline' 'ml' boolean (Vim default: on (off for root),
5394 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005396 If 'modeline' is on 'modelines' gives the number of lines that is
5397 checked for set commands. If 'modeline' is off or 'modelines' is zero
5398 no lines are checked. See |modeline|.
5399
5400 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5401'modelineexpr' 'mle' boolean (default: off)
5402 global
5403 When on allow some options that are an expression to be set in the
5404 modeline. Check the option for whether it is affected by
5405 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005406 This option cannot be set from a |modeline| or in the |sandbox|, for
5407 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005408
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409 *'modelines'* *'mls'*
5410'modelines' 'mls' number (default 5)
5411 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412 If 'modeline' is on 'modelines' gives the number of lines that is
5413 checked for set commands. If 'modeline' is off or 'modelines' is zero
5414 no lines are checked. See |modeline|.
5415 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5416 set and to the Vim default value when 'compatible' is reset.
5417
5418 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005419 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420'modifiable' 'ma' boolean (default on)
5421 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422 When off the buffer contents cannot be changed. The 'fileformat' and
5423 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005424 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425
5426 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5427'modified' 'mod' boolean (default off)
5428 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429 When on, the buffer is considered to be modified. This option is set
5430 when:
5431 1. A change was made to the text since it was last written. Using the
5432 |undo| command to go back to the original text will reset the
5433 option. But undoing changes that were made before writing the
5434 buffer will set the option again, since the text is different from
5435 when it was written.
5436 2. 'fileformat' or 'fileencoding' is different from its original
5437 value. The original value is set when the buffer is read or
5438 written. A ":set nomodified" command also resets the original
5439 values to the current values and the 'modified' option will be
5440 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005441 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005442 This option is not set when a change is made to the buffer as the
5443 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5444 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5445 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5447 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005448 Note that the text may actually be the same, e.g. 'modified' is set
5449 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005450
5451 *'more'* *'nomore'*
5452'more' boolean (Vim default: on, Vi default: off)
5453 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 When on, listings pause when the whole screen is filled. You will get
5455 the |more-prompt|. When this option is off there are no pauses, the
5456 listing continues until finished.
5457 NOTE: This option is set to the Vi default value when 'compatible' is
5458 set and to the Vim default value when 'compatible' is reset.
5459
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005460 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005461'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005462 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005463 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005464 Enable the use of the mouse. Works for most terminals (xterm, Win32
5465 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5466 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5467 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005468 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 v Visual mode
5470 i Insert mode
5471 c Command-line mode
5472 h all previous modes when editing a help file
5473 a all previous modes
5474 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005475 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005477< If your terminal can't overrule the mouse events going to the
5478 application, use: >
5479 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005480< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005481 back to Vim using the mouse events.
5482 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5483 "xterm".
5484
5485 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486 modeless selection. This doesn't move the text cursor.
5487
5488 See |mouse-using|. Also see |'clipboard'|.
5489
5490 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005491 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492 the mouse buttons can still be used by keeping the shift key pressed.
5493 Also see the 'clipboard' option.
5494
5495 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5496'mousefocus' 'mousef' boolean (default off)
5497 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005498 {only works in the GUI}
5499 The window that the mouse pointer is on is automatically activated.
5500 When changing the window layout or window focus in another way, the
5501 mouse pointer is moved to the window with keyboard focus. Off is the
5502 default because it makes using the pull down menus a little goofy, as
5503 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005504 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005505 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506
5507 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5508'mousehide' 'mh' boolean (default on)
5509 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 {only works in the GUI}
5511 When on, the mouse pointer is hidden when characters are typed.
5512 The mouse pointer is restored when the mouse is moved.
5513
5514 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005515'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005517 Sets the model to use for the mouse. The name mostly specifies what
5518 the right mouse button is used for:
5519 extend Right mouse button extends a selection. This works
5520 like in an xterm.
5521 popup Right mouse button pops up a menu. The shifted left
5522 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005523 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 popup_setpos Like "popup", but the cursor will be moved to the
5525 position where the mouse was clicked, and thus the
5526 selected operation will act upon the clicked object.
5527 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005528 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005529 course, that right clicking outside a selection will
5530 end Visual mode.
5531 Overview of what button does what for each model:
5532 mouse extend popup(_setpos) ~
5533 left click place cursor place cursor
5534 left drag start selection start selection
5535 shift-left search word extend selection
5536 right click extend selection popup menu (place cursor)
5537 right drag extend selection -
5538 middle click paste paste
5539
5540 In the "popup" model the right mouse button produces a pop-up menu.
5541 You need to define this first, see |popup-menu|.
5542
5543 Note that you can further refine the meaning of buttons with mappings.
5544 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5545 selection (because that's handled in the GUI code directly).
5546
5547 The 'mousemodel' option is set by the |:behave| command.
5548
Ernie Raelc4cb5442022-04-03 15:47:28 +01005549 *'mousemoveevent'* *'mousemev'*
5550'mousemoveevent' 'mousemev' boolean (default off)
5551 global
5552 {only works in the GUI}
5553 When on, mouse move events are delivered to the input queue and are
5554 available for mapping. The default, off, avoids the mouse movement
5555 overhead except when needed. See |gui-mouse-mapping|.
5556 Warning: Setting this option can make pending mappings to be aborted
5557 when the mouse is moved.
5558 Currently only works in the GUI, may be made to work in a terminal
5559 later.
5560
Bram Moolenaar071d4272004-06-13 20:20:40 +00005561 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005562'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5563 vs:leftright,vd:lrsizing,m:no,
5564 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005566 {only available when compiled with the |+mouseshape|
5567 feature}
5568 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005569 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005570 like used for 'guicursor'. Each part consist of a mode/location-list
5571 and an argument-list:
5572 mode-list:shape,mode-list:shape,..
5573 The mode-list is a dash separated list of these modes/locations:
5574 In a normal window: ~
5575 n Normal mode
5576 v Visual mode
5577 ve Visual mode with 'selection' "exclusive" (same as 'v',
5578 if not specified)
5579 o Operator-pending mode
5580 i Insert mode
5581 r Replace mode
5582
5583 Others: ~
5584 c appending to the command-line
5585 ci inserting in the command-line
5586 cr replacing in the command-line
5587 m at the 'Hit ENTER' or 'More' prompts
5588 ml idem, but cursor in the last line
5589 e any mode, pointer below last window
5590 s any mode, pointer on a status line
5591 sd any mode, while dragging a status line
5592 vs any mode, pointer on a vertical separator line
5593 vd any mode, while dragging a vertical separator line
5594 a everywhere
5595
5596 The shape is one of the following:
5597 avail name looks like ~
5598 w x arrow Normal mouse pointer
5599 w x blank no pointer at all (use with care!)
5600 w x beam I-beam
5601 w x updown up-down sizing arrows
5602 w x leftright left-right sizing arrows
5603 w x busy The system's usual busy pointer
5604 w x no The system's usual 'no input' pointer
5605 x udsizing indicates up-down resizing
5606 x lrsizing indicates left-right resizing
5607 x crosshair like a big thin +
5608 x hand1 black hand
5609 x hand2 white hand
5610 x pencil what you write with
5611 x question big ?
5612 x rightup-arrow arrow pointing right-up
5613 w x up-arrow arrow pointing up
5614 x <number> any X11 pointer number (see X11/cursorfont.h)
5615
5616 The "avail" column contains a 'w' if the shape is available for Win32,
5617 x for X11.
5618 Any modes not specified or shapes not available use the normal mouse
5619 pointer.
5620
5621 Example: >
5622 :set mouseshape=s:udsizing,m:no
5623< will make the mouse turn to a sizing arrow over the status lines and
5624 indicate no input when the hit-enter prompt is displayed (since
5625 clicking the mouse has no effect in this state.)
5626
5627 *'mousetime'* *'mouset'*
5628'mousetime' 'mouset' number (default 500)
5629 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005630 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631 time in msec between two mouse clicks for the second click to be
5632 recognized as a multi click.
5633
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005634 *'mzschemedll'*
5635'mzschemedll' string (default depends on the build)
5636 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005637 {only available when compiled with the |+mzscheme/dyn|
5638 feature}
5639 Specifies the name of the MzScheme shared library. The default is
5640 DYNAMIC_MZSCH_DLL which was specified at compile time.
5641 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005642 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005643 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005644 This option cannot be set from a |modeline| or in the |sandbox|, for
5645 security reasons.
5646
5647 *'mzschemegcdll'*
5648'mzschemegcdll' string (default depends on the build)
5649 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005650 {only available when compiled with the |+mzscheme/dyn|
5651 feature}
5652 Specifies the name of the MzScheme GC shared library. The default is
5653 DYNAMIC_MZGC_DLL which was specified at compile time.
5654 The value can be equal to 'mzschemedll' if it includes the GC code.
5655 Environment variables are expanded |:set_env|.
5656 This option cannot be set from a |modeline| or in the |sandbox|, for
5657 security reasons.
5658
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005659 *'mzquantum'* *'mzq'*
5660'mzquantum' 'mzq' number (default 100)
5661 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005662 {not available when compiled without the |+mzscheme|
5663 feature}
5664 The number of milliseconds between polls for MzScheme threads.
5665 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005666 NOTE: This option is set to the Vim default value when 'compatible'
5667 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005668
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005670'nrformats' 'nf' string (default "bin,octal,hex",
5671 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673 This defines what bases Vim will consider for numbers when using the
5674 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5675 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005676 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005677 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005678 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005679 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005681 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005682 considered to be hexadecimal. Example: Using CTRL-X on
5683 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005684 bin If included, numbers starting with "0b" or "0B" will be
5685 considered to be binary. Example: Using CTRL-X on
5686 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005687 unsigned If included, numbers are recognized as unsigned. Thus a
5688 leading dash or negative sign won't be considered as part of
5689 the number. Examples:
5690 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5691 (without "unsigned" it would become "9-2021").
5692 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5693 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005694 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5695 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696 Numbers which simply begin with a digit in the range 1-9 are always
5697 considered decimal. This also happens for numbers that are not
5698 recognized as octal or hex.
5699
5700 *'number'* *'nu'* *'nonumber'* *'nonu'*
5701'number' 'nu' boolean (default off)
5702 local to window
5703 Print the line number in front of each line. When the 'n' option is
5704 excluded from 'cpoptions' a wrapped line will not use the column of
5705 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005706 The 'numberwidth' option can be used to set the room used for the line
5707 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708 When a long, wrapped line doesn't start with the first character, '-'
5709 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005710 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5711 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005712 *number_relativenumber*
5713 The 'relativenumber' option changes the displayed number to be
5714 relative to the cursor. Together with 'number' there are these
5715 four combinations (cursor in line 3):
5716
Bram Moolenaar3848e002016-03-19 18:42:29 +01005717 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005718 'nornu' 'nornu' 'rnu' 'rnu'
5719
5720 |apple | 1 apple | 2 apple | 2 apple
5721 |pear | 2 pear | 1 pear | 1 pear
5722 |nobody | 3 nobody | 0 nobody |3 nobody
5723 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005724
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005725 *'numberwidth'* *'nuw'*
5726'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5727 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005728 {only available when compiled with the |+linebreak|
5729 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005730 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005731 when the 'number' or 'relativenumber' option is set or printing lines
5732 with a line number. Since one space is always between the number and
5733 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005734 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005735 fit the highest line number in the buffer respectively the number of
5736 rows in the window, depending on whether 'number' or 'relativenumber'
5737 is set. Thus with the Vim default of 4 there is room for a line number
5738 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005739 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005740 NOTE: This option is set to the Vi default value when 'compatible' is
5741 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005742
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005743 *'omnifunc'* *'ofu'*
5744'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005745 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005746 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005747 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005748 This option specifies a function to be used for Insert mode omni
5749 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005750 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005751 invoked and what it should return. The value can be the name of a
5752 function, a |lambda| or a |Funcref|. See |option-value-function| for
5753 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005754 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005755 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005756 This option cannot be set from a |modeline| or in the |sandbox|, for
5757 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005758
5759
Bram Moolenaar02467872007-05-06 13:22:01 +00005760 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005761'opendevice' 'odev' boolean (default off)
5762 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005763 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005764 Enable reading and writing from devices. This may get Vim stuck on a
5765 device that can be opened but doesn't actually do the I/O. Therefore
5766 it is off by default.
5767 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5768 result in editing a device.
5769
5770
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005771 *'operatorfunc'* *'opfunc'*
5772'operatorfunc' 'opfunc' string (default: empty)
5773 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005774 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005775 See |:map-operator| for more info and an example. The value can be
5776 the name of a function, a |lambda| or a |Funcref|. See
5777 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005778
5779 This option cannot be set from a |modeline| or in the |sandbox|, for
5780 security reasons.
5781
5782
Bram Moolenaar251e1912011-06-19 05:09:16 +02005783 *'osfiletype'* *'oft'*
5784'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005786 This option was supported on RISC OS, which has been removed.
5787
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005789 *'packpath'* *'pp'*
5790'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005791 Directories used to find packages. See |packages|.
5792
5793
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005795'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005796 global
5797 Specifies the nroff macros that separate paragraphs. These are pairs
5798 of two letters (see |object-motions|).
5799
5800 *'paste'* *'nopaste'*
5801'paste' boolean (default off)
5802 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005803 Put Vim in Paste mode. This is useful if you want to cut or copy
5804 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805 unexpected effects.
5806 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005807 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005808 knows about pasting and will mostly do the right thing without 'paste'
5809 being set. The same is true for a terminal where Vim handles the
5810 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005811 This option is reset when starting the GUI. Thus if you set it in
5812 your .vimrc it will work in a terminal, but not in the GUI. Setting
5813 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5814 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815 When the 'paste' option is switched on (also when it was already on):
5816 - mapping in Insert mode and Command-line mode is disabled
5817 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005818 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005819 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005820 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005821 - 'revins' is reset
5822 - 'ruler' is reset
5823 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005824 - 'smarttab' is reset
5825 - 'softtabstop' is set to 0
5826 - 'textwidth' is set to 0
5827 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005828 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005829 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005830 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005831 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005832 - 'indentexpr'
5833 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005834 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005835 NOTE: When you start editing another file while the 'paste' option is
5836 on, settings from the modelines or autocommands may change the
5837 settings again, causing trouble when pasting text. You might want to
5838 set the 'paste' option again.
5839 When the 'paste' option is reset the mentioned options are restored to
5840 the value before the moment 'paste' was switched from off to on.
5841 Resetting 'paste' before ever setting it does not have any effect.
5842 Since mapping doesn't work while 'paste' is active, you need to use
5843 the 'pastetoggle' option to toggle the 'paste' option with some key.
5844
5845 *'pastetoggle'* *'pt'*
5846'pastetoggle' 'pt' string (default "")
5847 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005848 When non-empty, specifies the key sequence that toggles the 'paste'
5849 option. This is like specifying a mapping: >
5850 :map {keys} :set invpaste<CR>
5851< Where {keys} is the value of 'pastetoggle'.
5852 The difference is that it will work even when 'paste' is set.
5853 'pastetoggle' works in Insert mode and Normal mode, but not in
5854 Command-line mode.
5855 Mappings are checked first, thus overrule 'pastetoggle'. However,
5856 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5857 this: >
5858 :map <F10> :set paste<CR>
5859 :map <F11> :set nopaste<CR>
5860 :imap <F10> <C-O>:set paste<CR>
5861 :imap <F11> <nop>
5862 :set pastetoggle=<F11>
5863< This will make <F10> start paste mode and <F11> stop paste mode.
5864 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5865 mode everything is inserted literally, except the 'pastetoggle' key
5866 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005867 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868
5869 *'pex'* *'patchexpr'*
5870'patchexpr' 'pex' string (default "")
5871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005872 {not available when compiled without the |+diff|
5873 feature}
5874 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005875 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005876
Bram Moolenaardbc28022014-07-26 13:40:44 +02005877 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005878'patchmode' 'pm' string (default "")
5879 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880 When non-empty the oldest version of a file is kept. This can be used
5881 to keep the original version of a file if you are changing files in a
5882 source distribution. Only the first time that a file is written a
5883 copy of the original file will be kept. The name of the copy is the
5884 name of the original file with the string in the 'patchmode' option
5885 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005886 ".orig" or ".org". 'backupdir' must not be empty for this to work
5887 (Detail: The backup file is renamed to the patchmode file after the
5888 new file has been successfully written, that's why it must be possible
5889 to write a backup file). If there was no file to be backed up, an
5890 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891 When the 'backupskip' pattern matches, a patchmode file is not made.
5892 Using 'patchmode' for compressed files appends the extension at the
5893 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5894 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005895 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005897 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005898'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 other systems: ".,,")
5900 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005901 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005902 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5903 provided that the file being searched for has a relative path (not
5904 starting with "/", "./" or "../"). The directories in the 'path'
5905 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005906 - Use commas to separate directory names: >
5907 :set path=.,/usr/local/include,/usr/include
5908< - Spaces can also be used to separate directory names (for backwards
5909 compatibility with version 3.0). To have a space in a directory
5910 name, precede it with an extra backslash, and escape the space: >
5911 :set path=.,/dir/with\\\ space
5912< - To include a comma in a directory name precede it with an extra
5913 backslash: >
5914 :set path=.,/dir/with\\,comma
5915< - To search relative to the directory of the current file, use: >
5916 :set path=.
5917< - To search in the current directory use an empty string between two
5918 commas: >
5919 :set path=,,
5920< - A directory name may end in a ':' or '/'.
5921 - Environment variables are expanded |:set_env|.
5922 - When using |netrw.vim| URLs can be used. For example, adding
5923 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005924 - Search upwards and downwards in a directory tree using "*", "**" and
5925 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005926 {not available when compiled without the |+path_extra| feature}
5927 - Careful with '\' characters, type two to get one in the option: >
5928 :set path=.,c:\\include
5929< Or just use '/' instead: >
5930 :set path=.,c:/include
5931< Don't forget "." or files won't even be found in the same directory as
5932 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005933 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 it is something like 256 or 1024 characters.
5935 You can check if all the include files are found, using the value of
5936 'path', see |:checkpath|.
5937 The use of |:set+=| and |:set-=| is preferred when adding or removing
5938 directories from the list. This avoids problems when a future version
5939 uses another default. To remove the current directory use: >
5940 :set path-=
5941< To add the current directory use: >
5942 :set path+=
5943< To use an environment variable, you probably need to replace the
5944 separator. Here is an example to append $INCL, in which directory
5945 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005946 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947< Replace the ';' with a ':' or whatever separator is used. Note that
5948 this doesn't work when $INCL contains a comma or white space.
5949
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005950 *'perldll'*
5951'perldll' string (default depends on the build)
5952 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005953 {only available when compiled with the |+perl/dyn|
5954 feature}
5955 Specifies the name of the Perl shared library. The default is
5956 DYNAMIC_PERL_DLL, which was specified at compile time.
5957 Environment variables are expanded |:set_env|.
5958 This option cannot be set from a |modeline| or in the |sandbox|, for
5959 security reasons.
5960
Bram Moolenaar071d4272004-06-13 20:20:40 +00005961 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5962'preserveindent' 'pi' boolean (default off)
5963 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005964 When changing the indent of the current line, preserve as much of the
5965 indent structure as possible. Normally the indent is replaced by a
5966 series of tabs followed by spaces as required (unless |'expandtab'| is
5967 enabled, in which case only spaces are used). Enabling this option
5968 means the indent will preserve as many existing characters as possible
5969 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005970 'expandtab' does not apply to the preserved white space, a Tab remains
5971 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005972 NOTE: When using ">>" multiple times the resulting indent is a mix of
5973 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005974 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005975 Also see 'copyindent'.
5976 Use |:retab| to clean up white space.
5977
5978 *'previewheight'* *'pvh'*
5979'previewheight' 'pvh' number (default 12)
5980 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005981 {not available when compiled without the |+quickfix|
5982 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005983 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005984 commands. Used for |CTRL-W_}| when no count is given. Not used when
5985 'previewpopup' is set.
5986
5987 *'previewpopup'* *'pvp'*
5988'previewpopup' 'pvp' string (default empty)
5989 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005990 {not available when compiled without the |+textprop|
5991 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005992 When not empty a popup window is used for commands that would open a
5993 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005994 Not used for the insert completion info, add "popup" to
5995 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005996
5997 *'previewwindow'* *'nopreviewwindow'*
5998 *'pvw'* *'nopvw'* *E590*
5999'previewwindow' 'pvw' boolean (default off)
6000 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006001 {not available when compiled without the |+quickfix|
6002 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006003 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004 set. It's normally not set directly, but by using one of the commands
6005 |:ptag|, |:pedit|, etc.
6006
6007 *'printdevice'* *'pdev'*
6008'printdevice' 'pdev' string (default empty)
6009 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010 {only available when compiled with the |+printer|
6011 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006012 The name of the printer to be used for |:hardcopy|.
6013 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006014 This option cannot be set from a |modeline| or in the |sandbox|, for
6015 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006016
Bram Moolenaar8299df92004-07-10 09:47:34 +00006017 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006018'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006019 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020 {only available when compiled with the |+printer|
6021 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006022 Sets the character encoding used when printing.
6023 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006024
6025 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006026'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006027 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028 {only available when compiled with the |+printer|
6029 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006030 Expression used to print the PostScript produced with |:hardcopy|.
6031 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006032 This option cannot be set from a |modeline| or in the |sandbox|, for
6033 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006034
Bram Moolenaar8299df92004-07-10 09:47:34 +00006035 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036'printfont' 'pfn' string (default "courier")
6037 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 {only available when compiled with the |+printer|
6039 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006040 The name of the font that will be used for |:hardcopy|.
6041 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042
6043 *'printheader'* *'pheader'*
6044'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6045 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046 {only available when compiled with the |+printer|
6047 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006048 The format of the header produced in |:hardcopy| output.
6049 See |pheader-option|.
6050
6051 *'printmbcharset'* *'pmbcs'*
6052'printmbcharset' 'pmbcs' string (default "")
6053 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006054 {only available when compiled with the |+printer|
6055 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006056 The CJK character set to be used for CJK output from |:hardcopy|.
6057 See |pmbcs-option|.
6058
6059 *'printmbfont'* *'pmbfn'*
6060'printmbfont' 'pmbfn' string (default "")
6061 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006062 {only available when compiled with the |+printer|
6063 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006064 List of font names to be used for CJK output from |:hardcopy|.
6065 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066
6067 *'printoptions'* *'popt'*
6068'printoptions' 'popt' string (default "")
6069 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006071 List of items that control the format of the output of |:hardcopy|.
6072 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006073
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006074 *'prompt'* *'noprompt'*
6075'prompt' boolean (default on)
6076 global
6077 When on a ":" prompt is used in Ex mode.
6078
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006079 *'pumheight'* *'ph'*
6080'pumheight' 'ph' number (default 0)
6081 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006082 Determines the maximum number of items to show in the popup menu for
6083 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006084 |ins-completion-menu|.
6085
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006086 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006087'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006088 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006089 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006090 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006091
Bram Moolenaard94464e2015-11-02 15:28:18 +01006092 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006093'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006094 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006095 {only available when compiled with the |+python/dyn|
6096 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006097 Specifies the name of the Python 2.x shared library. The default is
6098 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006099 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006100 This option cannot be set from a |modeline| or in the |sandbox|, for
6101 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006102
Bram Moolenaar94073162018-01-31 21:49:05 +01006103 *'pythonhome'*
6104'pythonhome' string (default "")
6105 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006106 {only available when compiled with the |+python/dyn|
6107 feature}
6108 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6109 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6110 which was specified at compile time, will be used for the Python 2.x
6111 home directory.
6112 Environment variables are expanded |:set_env|.
6113 This option cannot be set from a |modeline| or in the |sandbox|, for
6114 security reasons.
6115
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006116 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006117'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006118 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006119 {only available when compiled with the |+python3/dyn|
6120 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006121 Specifies the name of the Python 3 shared library. The default is
6122 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006123 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006124 This option cannot be set from a |modeline| or in the |sandbox|, for
6125 security reasons.
6126
Bram Moolenaar94073162018-01-31 21:49:05 +01006127 *'pythonthreehome'*
6128'pythonthreehome' string (default "")
6129 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006130 {only available when compiled with the |+python3/dyn|
6131 feature}
6132 Specifies the name of the Python 3 home directory. When
6133 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6134 PYTHON3_HOME, which was specified at compile time, will be used for
6135 the Python 3 home directory.
6136 Environment variables are expanded |:set_env|.
6137 This option cannot be set from a |modeline| or in the |sandbox|, for
6138 security reasons.
6139
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006140 *'pyxversion'* *'pyx'*
6141'pyxversion' 'pyx' number (default depends on the build)
6142 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006143 {only available when compiled with the |+python| or
6144 the |+python3| feature}
6145 Specifies the python version used for pyx* functions and commands
6146 |python_x|. The default value is as follows:
6147
6148 Compiled with Default ~
6149 |+python| and |+python3| 0
6150 only |+python| 2
6151 only |+python3| 3
6152
6153 Available values are 0, 2 and 3.
6154 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6155 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6156 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6157 to 2 if Python 2 is available.
6158 See also: |has-pythonx|
6159
6160 If Vim is compiled with only |+python| or |+python3| setting
6161 'pyxversion' has no effect. The pyx* functions and commands are
6162 always the same as the compiled version.
6163
6164 This option cannot be set from a |modeline| or in the |sandbox|, for
6165 security reasons.
6166
Bram Moolenaar858ba062020-05-31 23:11:59 +02006167 *'quickfixtextfunc'* *'qftf'*
6168'quickfixtextfunc' 'qftf' string (default "")
6169 global
6170 {only available when compiled with the |+quickfix|
6171 feature}
6172 This option specifies a function to be used to get the text to display
6173 in the quickfix and location list windows. This can be used to
6174 customize the information displayed in the quickfix or location window
6175 for each entry in the corresponding quickfix or location list. See
6176 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006177 function and an example. The value can be the name of a function, a
6178 |lambda| or a |Funcref|. See |option-value-function| for more
6179 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006180
6181 This option cannot be set from a |modeline| or in the |sandbox|, for
6182 security reasons.
6183
Bram Moolenaar677ee682005-01-27 14:41:15 +00006184 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006185'quoteescape' 'qe' string (default "\")
6186 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006187 The characters that are used to escape quotes in a string. Used for
6188 objects like a', a" and a` |a'|.
6189 When one of the characters in this option is found inside a string,
6190 the following character will be skipped. The default value makes the
6191 text "foo\"bar\\" considered to be one string.
6192
Bram Moolenaar071d4272004-06-13 20:20:40 +00006193 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6194'readonly' 'ro' boolean (default off)
6195 local to buffer
6196 If on, writes fail unless you use a '!'. Protects you from
6197 accidentally overwriting a file. Default on when Vim is started
6198 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006199 When using ":w!" the 'readonly' option is reset for the current
6200 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006201 When using the ":view" command the 'readonly' option is set for the
6202 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006203 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006205 *'redrawtime'* *'rdt'*
6206'redrawtime' 'rdt' number (default 2000)
6207 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006208 {only available when compiled with the |+reltime|
6209 feature}
6210 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006211 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006212 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006213 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006214 matches will be highlighted.
6215 For syntax highlighting the time applies per window. When over the
6216 limit syntax highlighting is disabled until |CTRL-L| is used.
6217 This is used to avoid that Vim hangs when using a very complicated
6218 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006219
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006220 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006221'regexpengine' 're' number (default 0)
6222 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006223 This selects the default regexp engine. |two-engines|
6224 The possible values are:
6225 0 automatic selection
6226 1 old engine
6227 2 NFA engine
6228 Note that when using the NFA engine and the pattern contains something
6229 that is not supported the pattern will not match. This is only useful
6230 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006231 Using automatic selection enables Vim to switch the engine, if the
6232 default engine becomes too costly. E.g., when the NFA engine uses too
6233 many states. This should prevent Vim from hanging on a combination of
6234 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006235
Bram Moolenaar64486672010-05-16 15:46:46 +02006236 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6237'relativenumber' 'rnu' boolean (default off)
6238 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006239 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006240 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006241 precede some vertical motion commands (e.g. j k + -) with, without
6242 having to calculate it yourself. Especially useful in combination with
6243 other commands (e.g. y d c < > gq gw =).
6244 When the 'n' option is excluded from 'cpoptions' a wrapped
6245 line will not use the column of line numbers (this is the default when
6246 'compatible' isn't set).
6247 The 'numberwidth' option can be used to set the room used for the line
6248 number.
6249 When a long, wrapped line doesn't start with the first character, '-'
6250 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006251 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6252 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006253
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006254 The number in front of the cursor line also depends on the value of
6255 'number', see |number_relativenumber| for all combinations of the two
6256 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006257
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 *'remap'* *'noremap'*
6259'remap' boolean (default on)
6260 global
6261 Allows for mappings to work recursively. If you do not want this for
6262 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006263 NOTE: To avoid portability problems with Vim scripts, always keep
6264 this option at the default "on". Only switch it off when working with
6265 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006267 *'renderoptions'* *'rop'*
6268'renderoptions' 'rop' string (default: empty)
6269 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006270 {only available when compiled with GUI and DIRECTX on
6271 MS-Windows}
6272 Select a text renderer and set its options. The options depend on the
6273 renderer.
6274
6275 Syntax: >
6276 set rop=type:{renderer}(,{name}:{value})*
6277<
6278 Currently, only one optional renderer is available.
6279
6280 render behavior ~
6281 directx Vim will draw text using DirectX (DirectWrite). It makes
6282 drawn glyphs more beautiful than default GDI.
6283 It requires 'encoding' is "utf-8", and only works on
6284 MS-Windows Vista or newer version.
6285
6286 Options:
6287 name meaning type value ~
6288 gamma gamma float 1.0 - 2.2 (maybe)
6289 contrast enhancedContrast float (unknown)
6290 level clearTypeLevel float (unknown)
6291 geom pixelGeometry int 0 - 2 (see below)
6292 renmode renderingMode int 0 - 6 (see below)
6293 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006294 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006295
Bram Moolenaar92467d32017-12-05 13:22:16 +01006296 See this URL for detail (except for scrlines):
6297 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006298
6299 For geom: structure of a device pixel.
6300 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6301 1 - DWRITE_PIXEL_GEOMETRY_RGB
6302 2 - DWRITE_PIXEL_GEOMETRY_BGR
6303
6304 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006305 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006306
6307 For renmode: method of rendering glyphs.
6308 0 - DWRITE_RENDERING_MODE_DEFAULT
6309 1 - DWRITE_RENDERING_MODE_ALIASED
6310 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6311 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6312 4 - DWRITE_RENDERING_MODE_NATURAL
6313 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6314 6 - DWRITE_RENDERING_MODE_OUTLINE
6315
6316 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006317 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006318
6319 For taamode: antialiasing mode used for drawing text.
6320 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6321 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6322 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6323 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6324
6325 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006326 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6327
Bram Moolenaara338adc2018-01-31 20:51:47 +01006328 For scrlines:
6329 This was used for optimizing scrolling behavior, however this
6330 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006331
6332 Example: >
6333 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006334 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006335 set rop=type:directx
6336<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006337 If select a raster font (Courier, Terminal or FixedSys which
6338 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006339 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006340
6341 NOTE: It is known that some fonts and options combination
6342 causes trouble on drawing glyphs.
6343
Bram Moolenaar92467d32017-12-05 13:22:16 +01006344 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006345 special made fonts (True-Type fonts which includes only
6346 bitmap glyphs).
6347 - 'taamode:3' will not work with some vector fonts.
6348
6349 NOTE: With this option, you can display colored emoji
6350 (emoticon) in Windows 8.1 or later. To display colored emoji,
6351 there are some conditions which you should notice.
6352
6353 - If your font includes non-colored emoji already, it will
6354 be used.
6355 - If your font doesn't have emoji, the system chooses an
6356 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6357 will be used.
6358 - When this alternative font didn't have fixed width glyph,
6359 emoji might be rendered beyond the bounding box of drawing
6360 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006361
6362 Other render types are currently not supported.
6363
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364 *'report'*
6365'report' number (default 2)
6366 global
6367 Threshold for reporting number of lines changed. When the number of
6368 changed lines is more than 'report' a message will be given for most
6369 ":" commands. If you want it always, set 'report' to 0.
6370 For the ":substitute" command the number of substitutions is used
6371 instead of the number of lines.
6372
6373 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6374'restorescreen' 'rs' boolean (default on)
6375 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006376 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006377 When set, the screen contents is restored when exiting Vim. This also
6378 happens when executing external commands.
6379
6380 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6381 options in your .vimrc. To disable restoring:
6382 set t_ti= t_te=
6383 To enable restoring (for an xterm):
6384 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6385 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6386
6387 *'revins'* *'ri'* *'norevins'* *'nori'*
6388'revins' 'ri' boolean (default off)
6389 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006390 {only available when compiled with the |+rightleft|
6391 feature}
6392 Inserting characters in Insert mode will work backwards. See "typing
6393 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6394 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006395 NOTE: This option is reset when 'compatible' is set.
6396 This option is reset when 'paste' is set and restored when 'paste' is
6397 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006398
6399 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6400'rightleft' 'rl' boolean (default off)
6401 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 {only available when compiled with the |+rightleft|
6403 feature}
6404 When on, display orientation becomes right-to-left, i.e., characters
6405 that are stored in the file appear from the right to the left.
6406 Using this option, it is possible to edit files for languages that
6407 are written from the right to the left such as Hebrew and Arabic.
6408 This option is per window, so it is possible to edit mixed files
6409 simultaneously, or to view the same file in both ways (this is
6410 useful whenever you have a mixed text file with both right-to-left
6411 and left-to-right strings so that both sets are displayed properly
6412 in different windows). Also see |rileft.txt|.
6413
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006414 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415'rightleftcmd' 'rlc' string (default "search")
6416 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006417 {only available when compiled with the |+rightleft|
6418 feature}
6419 Each word in this option enables the command line editing to work in
6420 right-to-left mode for a group of commands:
6421
6422 search "/" and "?" commands
6423
6424 This is useful for languages such as Hebrew, Arabic and Farsi.
6425 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6426
Bram Moolenaard94464e2015-11-02 15:28:18 +01006427 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006428'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006429 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006430 {only available when compiled with the |+ruby/dyn|
6431 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006432 Specifies the name of the Ruby shared library. The default is
6433 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006434 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006435 This option cannot be set from a |modeline| or in the |sandbox|, for
6436 security reasons.
6437
Bram Moolenaar071d4272004-06-13 20:20:40 +00006438 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006439'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441 {not available when compiled without the
6442 |+cmdline_info| feature}
6443 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006444 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445 text in the file is shown on the far right:
6446 Top first line is visible
6447 Bot last line is visible
6448 All first and last line are visible
6449 45% relative position in the file
6450 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006451 Each window has its own ruler. If a window has a status line, the
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01006452 ruler is shown there. If a window doesn't have a status line and
6453 'cmdheight' is zero, the ruler is not shown. Otherwise it is shown in
6454 the last line of the screen. If the statusline is given by
6455 'statusline' (i.e. not empty), this option takes precedence over
zeertzjq75020942022-07-31 11:37:20 +01006456 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006458 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 the text column (byte number) and the screen column are shown,
6460 separated with a dash.
6461 For an empty line "0-1" is shown.
6462 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006463 This option is reset when 'paste' is set and restored when 'paste' is
6464 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 If you don't want to see the ruler all the time but want to know where
6466 you are, use "g CTRL-G" |g_CTRL-G|.
6467 NOTE: This option is reset when 'compatible' is set.
6468
6469 *'rulerformat'* *'ruf'*
6470'rulerformat' 'ruf' string (default empty)
6471 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006472 {not available when compiled without the |+statusline|
6473 feature}
6474 When this option is not empty, it determines the content of the ruler
6475 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006476 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006477 This option cannot be set in a modeline when 'modelineexpr' is off.
6478
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 The default ruler width is 17 characters. To make the ruler 15
6480 characters wide, put "%15(" at the start and "%)" at the end.
6481 Example: >
6482 :set rulerformat=%15(%c%V\ %p%%%)
6483<
6484 *'runtimepath'* *'rtp'* *vimfiles*
6485'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006486 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 $VIM/vimfiles,
6488 $VIMRUNTIME,
6489 $VIM/vimfiles/after,
6490 $HOME/.vim/after"
6491 Amiga: "home:vimfiles,
6492 $VIM/vimfiles,
6493 $VIMRUNTIME,
6494 $VIM/vimfiles/after,
6495 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006496 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006497 $VIM/vimfiles,
6498 $VIMRUNTIME,
6499 $VIM/vimfiles/after,
6500 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006501 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502 $VIMRUNTIME,
6503 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006504 Haiku: "$BE_USER_SETTINGS/vim,
6505 $VIM/vimfiles,
6506 $VIMRUNTIME,
6507 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006508 $BE_USER_SETTINGS/vim/after"
6509 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006510 $VIM/vimfiles,
6511 $VIMRUNTIME,
6512 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006513 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515 This is a list of directories which will be searched for runtime
6516 files:
6517 filetype.vim filetypes by file name |new-filetype|
6518 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006519 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 colors/ color scheme files |:colorscheme|
6521 compiler/ compiler files |:compiler|
6522 doc/ documentation |write-local-help|
6523 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006524 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 indent/ indent scripts |indent-expression|
6526 keymap/ key mapping files |mbyte-keymap|
6527 lang/ menu translations |:menutrans|
6528 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006529 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 plugin/ plugin scripts |write-plugin|
6531 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006532 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533 syntax/ syntax files |mysyntaxfile|
6534 tutor/ files for vimtutor |tutor|
6535
6536 And any other file searched for with the |:runtime| command.
6537
6538 The defaults for most systems are setup to search five locations:
6539 1. In your home directory, for your personal preferences.
6540 2. In a system-wide Vim directory, for preferences from the system
6541 administrator.
6542 3. In $VIMRUNTIME, for files distributed with Vim.
6543 *after-directory*
6544 4. In the "after" directory in the system-wide Vim directory. This is
6545 for the system administrator to overrule or add to the distributed
6546 defaults (rarely needed)
6547 5. In the "after" directory in your home directory. This is for
6548 personal preferences to overrule or add to the distributed defaults
6549 or system-wide settings (rarely needed).
6550
Bram Moolenaard0796902016-09-16 20:02:31 +02006551 More entries are added when using |packages|. If it gets very long
6552 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6553 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006554
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6556 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006557 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006558 wildcards.
6559 See |:runtime|.
6560 Example: >
6561 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6562< This will use the directory "~/vimruntime" first (containing your
6563 personal Vim runtime files), then "/mygroup/vim" (shared between a
6564 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6565 files).
6566 You probably should always include $VIMRUNTIME somewhere, to use the
6567 distributed runtime files. You can put a directory before $VIMRUNTIME
6568 to find files which replace a distributed runtime files. You can put
6569 a directory after $VIMRUNTIME to find files which add to distributed
6570 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006571 When Vim is started with |--clean| the home directory entries are not
6572 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 This option cannot be set from a |modeline| or in the |sandbox|, for
6574 security reasons.
6575
6576 *'scroll'* *'scr'*
6577'scroll' 'scr' number (default: half the window height)
6578 local to window
6579 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6580 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006581 changes. This may happen when enabling the |status-line| or
6582 'tabline' option after setting the 'scroll' option.
6583 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006584 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006585 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586
6587 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6588'scrollbind' 'scb' boolean (default off)
6589 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590 See also |scroll-binding|. When this option is set, the current
6591 window scrolls as other scrollbind windows (windows that also have
6592 this option set) scroll. This option is useful for viewing the
6593 differences between two versions of a file, see 'diff'.
6594 See |'scrollopt'| for options that determine how this option should be
6595 interpreted.
6596 This option is mostly reset when splitting a window to edit another
6597 file. This means that ":split | edit file" results in two windows
6598 with scroll-binding, but ":split file" does not.
6599
Bram Moolenaarae20f342019-11-05 21:09:23 +01006600 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6601'scrollfocus' 'scf' boolean (default off)
6602 global
6603 {only for MS-Windows GUI}
6604 When using the scroll wheel and this option is set, the window under
6605 the mouse pointer is scrolled. With this option off the current
6606 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006607 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006608
Bram Moolenaar071d4272004-06-13 20:20:40 +00006609 *'scrolljump'* *'sj'*
6610'scrolljump' 'sj' number (default 1)
6611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006612 Minimal number of lines to scroll when the cursor gets off the
6613 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6614 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006615 When set to a negative number from -1 to -100 this is used as the
6616 percentage of the window height. Thus -50 scrolls half the window
6617 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006618 NOTE: This option is set to 1 when 'compatible' is set.
6619
6620 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006621'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006622 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 Minimal number of screen lines to keep above and below the cursor.
6624 This will make some context visible around where you are working. If
6625 you set it to a very large value (999) the cursor line will always be
6626 in the middle of the window (except at the start or end of the file or
6627 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006628 After using the local value, go back the global value with one of
6629 these two: >
6630 setlocal scrolloff<
6631 setlocal scrolloff=-1
6632< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006633 NOTE: This option is set to 0 when 'compatible' is set.
6634
6635 *'scrollopt'* *'sbo'*
6636'scrollopt' 'sbo' string (default "ver,jump")
6637 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006639 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6640 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006641 The following words are available:
6642 ver Bind vertical scrolling for 'scrollbind' windows
6643 hor Bind horizontal scrolling for 'scrollbind' windows
6644 jump Applies to the offset between two windows for vertical
6645 scrolling. This offset is the difference in the first
6646 displayed line of the bound windows. When moving
6647 around in a window, another 'scrollbind' window may
6648 reach a position before the start or after the end of
6649 the buffer. The offset is not changed though, when
6650 moving back the 'scrollbind' window will try to scroll
6651 to the desired position when possible.
6652 When now making that window the current one, two
6653 things can be done with the relative offset:
6654 1. When "jump" is not included, the relative offset is
6655 adjusted for the scroll position in the new current
6656 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006657 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 2. When "jump" is included, the other windows are
6659 scrolled to keep the same relative offset. When
6660 going back to the other window, it still uses the
6661 same relative offset.
6662 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006663 When 'diff' mode is active there always is vertical scroll binding,
6664 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665
6666 *'sections'* *'sect'*
6667'sections' 'sect' string (default "SHNHH HUnhsh")
6668 global
6669 Specifies the nroff macros that separate sections. These are pairs of
6670 two letters (See |object-motions|). The default makes a section start
6671 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6672
6673 *'secure'* *'nosecure'* *E523*
6674'secure' boolean (default off)
6675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 When on, ":autocmd", shell and write commands are not allowed in
6677 ".vimrc" and ".exrc" in the current directory and map commands are
6678 displayed. Switch it off only if you know that you will not run into
6679 problems, or when the 'exrc' option is off. On Unix this option is
6680 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006681 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006682 'secure' at the end of your ~/.vimrc then.
6683 This option cannot be set from a |modeline| or in the |sandbox|, for
6684 security reasons.
6685
6686 *'selection'* *'sel'*
6687'selection' 'sel' string (default "inclusive")
6688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 This option defines the behavior of the selection. It is only used
6690 in Visual and Select mode.
6691 Possible values:
6692 value past line inclusive ~
6693 old no yes
6694 inclusive yes yes
6695 exclusive yes no
6696 "past line" means that the cursor is allowed to be positioned one
6697 character past the line.
6698 "inclusive" means that the last character of the selection is included
6699 in an operation. For example, when "x" is used to delete the
6700 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006701 When "old" is used and 'virtualedit' allows the cursor to move past
6702 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006703 Note that when "exclusive" is used and selecting from the end
6704 backwards, you cannot include the last character of a line, when
6705 starting in Normal mode and 'virtualedit' empty.
6706
6707 The 'selection' option is set by the |:behave| command.
6708
6709 *'selectmode'* *'slm'*
6710'selectmode' 'slm' string (default "")
6711 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006712 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 Select mode instead of Visual mode, when a selection is started.
6714 Possible values:
6715 mouse when using the mouse
6716 key when using shifted special keys
6717 cmd when using "v", "V" or CTRL-V
6718 See |Select-mode|.
6719 The 'selectmode' option is set by the |:behave| command.
6720
6721 *'sessionoptions'* *'ssop'*
6722'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006723 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006725 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726 feature}
6727 Changes the effect of the |:mksession| command. It is a comma
6728 separated list of words. Each word enables saving and restoring
6729 something:
6730 word save and restore ~
6731 blank empty windows
6732 buffers hidden and unloaded buffers, not just those in windows
6733 curdir the current directory
6734 folds manually created folds, opened/closed folds and local
6735 fold options
6736 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006737 and contain at least one lowercase letter. Only
6738 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006739 help the help window
6740 localoptions options and mappings local to a window or buffer (not
6741 global values for local options)
6742 options all options and mappings (also global values for local
6743 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006744 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006745 resize size of the Vim window: 'lines' and 'columns'
6746 sesdir the directory in which the session file is located
6747 will become the current directory (useful with
6748 projects accessed over a network from different
6749 systems)
6750 slash backslashes in file names replaced with forward
6751 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006752 tabpages all tab pages; without this only the current tab page
6753 is restored, so that you can make a session for each
6754 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006755 terminal include terminal windows where the command can be
6756 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006757 unix with Unix end-of-line format (single <NL>), even when
6758 on Windows or DOS
6759 winpos position of the whole Vim window
6760 winsize window sizes
6761
6762 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006763 When neither "curdir" nor "sesdir" is included, file names are stored
6764 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006765 If you leave out "options" many things won't work well after restoring
6766 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006767 "slash" and "unix" are useful on Windows when sharing session files
6768 with Unix. The Unix version of Vim cannot source dos format scripts,
6769 but the Windows version of Vim can source unix format scripts.
6770
6771 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006772'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 global
6774 Name of the shell to use for ! and :! commands. When changing the
6775 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6776 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006777 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006778 See |option-backslash| about including spaces and backslashes.
6779 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006780
Bram Moolenaara2baa732022-02-04 16:09:54 +00006781 In |restricted-mode| shell commands will not be possible. This mode
6782 is used if the value of $SHELL ends in "false" or "nologin".
6783
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006784 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006785 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6787< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006788 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006790 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006792 Example with escaped space (Vim will do this when initializing the
6793 option from $SHELL): >
6794 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006795< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006796 backslashes are consumed by `:set`.
6797
Bram Moolenaar071d4272004-06-13 20:20:40 +00006798 Under MS-Windows, when the executable ends in ".com" it must be
6799 included. Thus setting the shell to "command.com" or "4dos.com"
6800 works, but "command" and "4dos" do not work for all commands (e.g.,
6801 filtering).
6802 For unknown reasons, when using "4dos.com" the current directory is
6803 changed to "C:\". To avoid this set 'shell' like this: >
6804 :set shell=command.com\ /c\ 4dos
6805< This option cannot be set from a |modeline| or in the |sandbox|, for
6806 security reasons.
6807
6808 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006809'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006810 Win32, when 'shell' contains "powershell":
6811 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006812 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006815 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6816 For MS-Windows, the default is set according to the value of 'shell',
6817 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006818 On Unix it can have more than one flag. Each white space separated
6819 part is passed as an argument to the shell command.
6820 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006821 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822 This option cannot be set from a |modeline| or in the |sandbox|, for
6823 security reasons.
6824
6825 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006826'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6827 "2>&1| tee", or
6828 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 {not available when compiled without the |+quickfix|
6831 feature}
6832 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006833 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834 including spaces and backslashes.
6835 The name of the temporary file can be represented by "%s" if necessary
6836 (the file name is appended automatically if no %s appears in the value
6837 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006838 For the Amiga the default is ">". For MS-Windows using powershell the
6839 default is "2>&1 | Out-File -Encoding default", otherwise the default
6840 is ">%s 2>&1". The output is directly saved in a file and not echoed
6841 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006842 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843 in a file and echoed to the screen. If the 'shell' option is "csh" or
6844 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006845 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006846 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6847 means that stderr is also included. Before using the 'shell' option a
6848 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006849 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6850 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 The initialization of this option is done after reading the ".vimrc"
6852 and the other initializations, so that when the 'shell' option is set
6853 there, the 'shellpipe' option changes automatically, unless it was
6854 explicitly set before.
6855 When 'shellpipe' is set to an empty string, no redirection of the
6856 ":make" output will be done. This is useful if you use a 'makeprg'
6857 that writes to 'makeef' by itself. If you want no piping, but do
6858 want to include the 'makeef', set 'shellpipe' to a single space.
6859 Don't forget to precede the space with a backslash: ":set sp=\ ".
6860 In the future pipes may be used for filtering and this option will
6861 become obsolete (at least for Unix).
6862 This option cannot be set from a |modeline| or in the |sandbox|, for
6863 security reasons.
6864
6865 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006866'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 Quoting character(s), put around the command passed to the shell, for
6869 the "!" and ":!" commands. The redirection is kept outside of the
6870 quoting. See 'shellxquote' to include the redirection. It's
6871 probably not useful to set both options.
6872 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006873 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006874 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875 This option cannot be set from a |modeline| or in the |sandbox|, for
6876 security reasons.
6877
6878 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006879'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6880 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882 String to be used to put the output of a filter command in a temporary
6883 file. See also |:!|. See |option-backslash| about including spaces
6884 and backslashes.
6885 The name of the temporary file can be represented by "%s" if necessary
6886 (the file name is appended automatically if no %s appears in the value
6887 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006888 The default is ">". For Unix, if the 'shell' option is "csh" or
6889 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006890 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006891 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6892 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006893 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6894 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006895 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6896 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006897 The initialization of this option is done after reading the ".vimrc"
6898 and the other initializations, so that when the 'shell' option is set
6899 there, the 'shellredir' option changes automatically unless it was
6900 explicitly set before.
6901 In the future pipes may be used for filtering and this option will
6902 become obsolete (at least for Unix).
6903 This option cannot be set from a |modeline| or in the |sandbox|, for
6904 security reasons.
6905
6906 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6907'shellslash' 'ssl' boolean (default off)
6908 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006909 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006911 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006912 powershell.exe. Backward slashes can still be typed, but they are
6913 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006914 Note that setting or resetting this option has no effect for some
6915 existing file names, thus this option needs to be set before opening
6916 any file for best results. This might change in the future.
6917 'shellslash' only works when a backslash can be used as a path
6918 separator. To test if this is so use: >
6919 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006920< Also see 'completeslash'.
6921
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006922 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6923'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6924 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006925 When on, use temp files for shell commands. When off use a pipe.
6926 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006927 Currently a pipe is only supported on Unix and MS-Windows 2K and
6928 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006929 :if has("filterpipe")
6930< The advantage of using a pipe is that nobody can read the temp file
6931 and the 'shell' command does not need to support redirection.
6932 The advantage of using a temp file is that the file type and encoding
6933 can be detected.
6934 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6935 |FilterWritePost| autocommands event are not triggered when
6936 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006937 The `system()` function does not respect this option and always uses
6938 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006939 NOTE: This option is set to the Vim default value when 'compatible'
6940 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006941
Bram Moolenaar071d4272004-06-13 20:20:40 +00006942 *'shelltype'* *'st'*
6943'shelltype' 'st' number (default 0)
6944 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006945 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946 On the Amiga this option influences the way how the commands work
6947 which use a shell.
6948 0 and 1: always use the shell
6949 2 and 3: use the shell only to filter lines
6950 4 and 5: use shell only for ':sh' command
6951 When not using the shell, the command is executed directly.
6952
6953 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6954 1 and 3: use "shell cmd" to start external commands
6955
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006956 *'shellxescape'* *'sxe'*
6957'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006958 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006959 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006960 When 'shellxquote' is set to "(" then the characters listed in this
6961 option will be escaped with a '^' character. This makes it possible
6962 to execute most external commands with cmd.exe.
6963
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964 *'shellxquote'* *'sxq'*
6965'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006966 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006967 for Win32, when 'shell' is
6968 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006969 for Win32, when 'shell' contains "sh"
6970 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006971 for Unix, when using system(): "\"")
6972 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 Quoting character(s), put around the command passed to the shell, for
6974 the "!" and ":!" commands. Includes the redirection. See
6975 'shellquote' to exclude the redirection. It's probably not useful
6976 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006977 When the value is '(' then ')' is appended. When the value is '"('
6978 then ')"' is appended.
6979 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006980 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006981 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6982 pwsh.exe which automatically strips off the first and last quote on a
6983 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6984 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006985 'shell', to reduce the need to set this option by the user. See
6986 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006987 This option cannot be set from a |modeline| or in the |sandbox|, for
6988 security reasons.
6989
6990 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6991'shiftround' 'sr' boolean (default off)
6992 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 Round indent to multiple of 'shiftwidth'. Applies to > and <
6994 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6995 a multiple of 'shiftwidth' (this is Vi compatible).
6996 NOTE: This option is reset when 'compatible' is set.
6997
6998 *'shiftwidth'* *'sw'*
6999'shiftwidth' 'sw' number (default 8)
7000 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007001 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007002 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007003 When zero the 'ts' value will be used. Use the |shiftwidth()|
7004 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005
7006 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007007'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7008 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007010 This option helps to avoid all the |hit-enter| prompts caused by file
7011 messages, for example with CTRL-G, and to avoid some other messages.
7012 It is a list of flags:
7013 flag meaning when present ~
7014 f use "(3 of 5)" instead of "(file 3 of 5)"
7015 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02007016 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007017 m use "[+]" instead of "[Modified]"
7018 n use "[New]" instead of "[New File]"
7019 r use "[RO]" instead of "[readonly]"
7020 w use "[w]" instead of "written" for file write message
7021 and "[a]" instead of "appended" for ':w >> file' command
7022 x use "[dos]" instead of "[dos format]", "[unix]" instead of
7023 "[unix format]" and "[mac]" instead of "[mac format]".
7024 a all of the above abbreviations
7025
7026 o overwrite message for writing a file with subsequent message
7027 for reading a file (useful for ":wn" or when 'autowrite' on)
7028 O message for reading a file overwrites any previous message.
7029 Also for quickfix message (e.g., ":cn").
7030 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02007031 hit TOP, continuing at BOTTOM" messages; when using the search
7032 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007033 t truncate file message at the start if it is too long to fit
7034 on the command-line, "<" will appear in the left most column.
7035 Ignored in Ex mode.
7036 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00007037 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007038 Ignored in Ex mode.
7039 W don't give "written" or "[w]" when writing a file
7040 A don't give the "ATTENTION" message when an existing swap file
7041 is found.
7042 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02007043 c don't give |ins-completion-menu| messages. For example,
7044 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
7045 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01007046 q use "recording" instead of "recording @a"
7047 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02007048 was used for the command; note that this also affects messages
7049 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007050 S do not show search count message when searching, e.g.
7051 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052
7053 This gives you the opportunity to avoid that a change between buffers
7054 requires you to hit <Enter>, but still gives as useful a message as
7055 possible for the space available. To get the whole message that you
7056 would have got with 'shm' empty, use ":file!"
7057 Useful values:
7058 shm= No abbreviation of message.
7059 shm=a Abbreviation, but no loss of information.
7060 shm=at Abbreviation, and truncate message when necessary.
7061
7062 NOTE: This option is set to the Vi default value when 'compatible' is
7063 set and to the Vim default value when 'compatible' is reset.
7064
7065 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7066'shortname' 'sn' boolean (default off)
7067 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068 Filenames are assumed to be 8 characters plus one extension of 3
7069 characters. Multiple dots in file names are not allowed. When this
7070 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007071 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007072 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007073 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007074
7075 *'showbreak'* *'sbr'* *E595*
7076'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007077 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007078 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 feature}
7080 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007081 values are "> " or "+++ ": >
7082 :set showbreak=>\
7083< Note the backslash to escape the trailing space. It's easier like
7084 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007085 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007086< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007087 comma (in a future version the comma might be used to separate the
7088 part that is shown at the end and at the start of a line).
7089 The characters are highlighted according to the '@' flag in
7090 'highlight'.
7091 Note that tabs after the showbreak will be displayed differently.
7092 If you want the 'showbreak' to appear in between line numbers, add the
7093 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007094 A window-local value overrules a global value. If the global value is
7095 set and you want no value in the current window use NONE: >
7096 :setlocal showbreak=NONE
7097<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007098 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007099'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7100 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102 {not available when compiled without the
7103 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007104 Show (partial) command in the last line of the screen. Set this
7105 option off if your terminal is slow.
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01007106 The option has no effect when 'cmdheight' is zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 In Visual mode the size of the selected area is shown:
7108 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007109 If the number of bytes is different it is also displayed: "2-6"
7110 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007112 - When selecting a block, the size in screen characters:
7113 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 NOTE: This option is set to the Vi default value when 'compatible' is
7115 set and to the Vim default value when 'compatible' is reset.
7116
7117 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7118'showfulltag' 'sft' boolean (default off)
7119 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 When completing a word in insert mode (see |ins-completion|) from the
7121 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007122 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123 matched a C function, you can see a template for what arguments are
7124 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007125 Note that this doesn't work well together with having "longest" in
7126 'completeopt', because the completion from the search pattern may not
7127 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128
7129 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7130'showmatch' 'sm' boolean (default off)
7131 global
7132 When a bracket is inserted, briefly jump to the matching one. The
7133 jump is only done if the match can be seen on the screen. The time to
7134 show the match can be set with 'matchtime'.
7135 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007136 seen or not).
7137 This option is reset when 'paste' is set and restored when 'paste' is
7138 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 When the 'm' flag is not included in 'cpoptions', typing a character
7140 will immediately move the cursor back to where it belongs.
7141 See the "sm" field in 'guicursor' for setting the cursor shape and
7142 blinking when showing the match.
7143 The 'matchpairs' option can be used to specify the characters to show
7144 matches for. 'rightleft' and 'revins' are used to look for opposite
7145 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007146 Also see the matchparen plugin for highlighting the match when moving
7147 around |pi_paren.txt|.
7148 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149
7150 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7151'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7152 global
7153 If in Insert, Replace or Visual mode put a message on the last line.
7154 Use the 'M' flag in 'highlight' to set the type of highlighting for
7155 this message.
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01007156 The option has no effect when 'cmdheight' is zero.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007157 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007158 doesn't mean XIM is really active, especially when 'imactivatekey' is
7159 not set.
7160 NOTE: This option is set to the Vi default value when 'compatible' is
7161 set and to the Vim default value when 'compatible' is reset.
7162
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007163 *'showtabline'* *'stal'*
7164'showtabline' 'stal' number (default 1)
7165 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007166 The value of this option specifies when the line with tab page labels
7167 will be displayed:
7168 0: never
7169 1: only if there are at least two tab pages
7170 2: always
7171 This is both for the GUI and non-GUI implementation of the tab pages
7172 line.
7173 See |tab-page| for more information about tab pages.
7174
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175 *'sidescroll'* *'ss'*
7176'sidescroll' 'ss' number (default 0)
7177 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178 The minimal number of columns to scroll horizontally. Used only when
7179 the 'wrap' option is off and the cursor is moved off of the screen.
7180 When it is zero the cursor will be put in the middle of the screen.
7181 When using a slow terminal set it to a large number or 0. When using
7182 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7183 commands.
7184
7185 *'sidescrolloff'* *'siso'*
7186'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007187 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007189 right of the cursor if 'nowrap' is set. Setting this option to a
7190 value greater than 0 while having |'sidescroll'| also at a non-zero
7191 value makes some context visible in the line you are scrolling in
7192 horizontally (except at beginning of the line). Setting this option
7193 to a large value (like 999) has the effect of keeping the cursor
7194 horizontally centered in the window, as long as one does not come too
7195 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007196 After using the local value, go back the global value with one of
7197 these two: >
7198 setlocal sidescrolloff<
7199 setlocal sidescrolloff=-1
7200< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007201
7202 Example: Try this together with 'sidescroll' and 'listchars' as
7203 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007204 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007205
7206 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7207 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007208<
7209 *'signcolumn'* *'scl'*
7210'signcolumn' 'scl' string (default "auto")
7211 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007212 {not available when compiled without the |+signs|
7213 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007214 Whether or not to draw the signcolumn. Valid values are:
7215 "auto" only when there is a sign to display
7216 "no" never
7217 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007218 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007219 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220
7221
7222 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7223'smartcase' 'scs' boolean (default off)
7224 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 Override the 'ignorecase' option if the search pattern contains upper
7226 case characters. Only used when the search pattern is typed and
7227 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007228 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007229 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7230 recalling the search pattern from history and hitting <Enter>.
7231 NOTE: This option is reset when 'compatible' is set.
7232
7233 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7234'smartindent' 'si' boolean (default off)
7235 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236 Do smart autoindenting when starting a new line. Works for C-like
7237 programs, but can also be used for other languages. 'cindent' does
7238 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007239 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007240 setting 'si' has no effect. 'indentexpr' is a more advanced
7241 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242 Normally 'autoindent' should also be on when using 'smartindent'.
7243 An indent is automatically inserted:
7244 - After a line ending in '{'.
7245 - After a line starting with a keyword from 'cinwords'.
7246 - Before a line starting with '}' (only with the "O" command).
7247 When typing '}' as the first character in a new line, that line is
7248 given the same indent as the matching '{'.
7249 When typing '#' as the first character in a new line, the indent for
7250 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007251 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7253 When using the ">>" command, lines starting with '#' are not shifted
7254 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007255 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007256 This option is reset when 'paste' is set and restored when 'paste' is
7257 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007258
7259 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7260'smarttab' 'sta' boolean (default off)
7261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007262 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007263 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7264 <BS> will delete a 'shiftwidth' worth of space at the start of the
7265 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007266 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007267 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7268 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007269 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007270 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007271 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007272 This option is reset when 'paste' is set and restored when 'paste' is
7273 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274 NOTE: This option is reset when 'compatible' is set.
7275
7276 *'softtabstop'* *'sts'*
7277'softtabstop' 'sts' number (default 0)
7278 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 Number of spaces that a <Tab> counts for while performing editing
7280 operations, like inserting a <Tab> or using <BS>. It "feels" like
7281 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7282 used. This is useful to keep the 'ts' setting at its standard value
7283 of 8, while being able to edit like it is set to 'sts'. However,
7284 commands like "x" still work on the actual characters.
7285 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007286 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007287 'softtabstop' is set to 0 when the 'paste' option is set and restored
7288 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007289 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7290 spaces is minimized by using <Tab>s.
7291 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7292 set.
7293 NOTE: This option is set to 0 when 'compatible' is set.
7294
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007295 If Vim is compiled with the |+vartabs| feature then the value of
7296 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7297 anything other than an empty string.
7298
Bram Moolenaar217ad922005-03-20 22:37:15 +00007299 *'spell'* *'nospell'*
7300'spell' boolean (default off)
7301 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007302 {not available when compiled without the |+syntax|
7303 feature}
7304 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007305 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007306
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007307 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007308'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007309 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007310 {not available when compiled without the |+syntax|
7311 feature}
7312 Pattern to locate the end of a sentence. The following word will be
7313 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007314 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007315 When this check is not wanted make this option empty.
7316 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007317 Be careful with special characters, see |option-backslash| about
7318 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007319 To set this option automatically depending on the language, see
7320 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007321
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007322 *'spellfile'* *'spf'*
7323'spellfile' 'spf' string (default empty)
7324 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007325 {not available when compiled without the |+syntax|
7326 feature}
7327 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007328 commands. It must end in ".{encoding}.add". You need to include the
7329 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007330 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007331 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007332 |zg| and |zw| commands can be used to access each. This allows using
7333 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007334 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007335 you: Using the first directory in 'runtimepath' that is writable. If
7336 there is no "spell" directory yet it will be created. For the file
7337 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007338 ignoring the region.
7339 The resulting ".spl" file will be used for spell checking, it does not
7340 have to appear in 'spelllang'.
7341 Normally one file is used for all regions, but you can add the region
7342 name if you want to. However, it will then only be used when
7343 'spellfile' is set to it, for entries in 'spelllang' only files
7344 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007345 This option cannot be set from a |modeline| or in the |sandbox|, for
7346 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007347
Bram Moolenaar217ad922005-03-20 22:37:15 +00007348 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007349'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007350 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007351 {not available when compiled without the |+syntax|
7352 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007353 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007354 on spellchecking will be done for these languages. Example: >
7355 set spelllang=en_us,nl,medical
7356< This means US English, Dutch and medical words are recognized. Words
7357 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007358 The word list name must consist of alphanumeric characters, a dash or
7359 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007360 recommended to separate the two letter language name from a
7361 specification. Thus "en-rare" is used for rare English words.
7362 A region name must come last and have the form "_xx", where "xx" is
7363 the two-letter, lower case region name. You can use more than one
7364 region by listing them: "en_us,en_ca" supports both US and Canadian
7365 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007366 Britain. (Note: currently en_au and en_nz dictionaries are older than
7367 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007368 If the name "cjk" is included East Asian characters are excluded from
7369 spell checking. This is useful when editing text that also has Asian
7370 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007371 Note that the "medical" dictionary does not exist, it is just an
7372 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007373 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007374 As a special case the name of a .spl file can be given as-is. The
7375 first "_xx" in the name is removed and used as the region name
7376 (_xx is an underscore, two letters and followed by a non-letter).
7377 This is mainly for testing purposes. You must make sure the correct
7378 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007379 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007380 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7381 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007382 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007383
Bram Moolenaar98692072006-02-04 00:57:42 +00007384 If the |spellfile.vim| plugin is active and you use a language name
7385 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7386 will ask you if you want to download the file.
7387
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007388 After this option has been set successfully, Vim will source the files
7389 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007390 up to the first character that is not an ASCII letter or number and
7391 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007392
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007393 *'spelloptions'* *'spo'*
7394'spelloptions' 'spo' string (default "")
7395 local to buffer
7396 {not available when compiled without the |+syntax|
7397 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007398 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007399 camel When a word is CamelCased, assume "Cased" is a
7400 separate word: every upper-case character in a word
7401 that comes after a lower case character indicates the
7402 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007403
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007404 *'spellsuggest'* *'sps'*
7405'spellsuggest' 'sps' string (default "best")
7406 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007407 {not available when compiled without the |+syntax|
7408 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007409 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007410 the |spellsuggest()| function. This is a comma-separated list of
7411 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007412
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007413 best Internal method that works best for English. Finds
7414 changes like "fast" and uses a bit of sound-a-like
7415 scoring to improve the ordering.
7416
7417 double Internal method that uses two methods and mixes the
7418 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007419 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007420 word. That only works when the language specifies
7421 sound folding. Can be slow and doesn't always give
7422 better results.
7423
7424 fast Internal method that only checks for simple changes:
7425 character inserts/deletes/swaps. Works well for
7426 simple typing mistakes.
7427
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007428 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007429 Not used for |spellsuggest()|. The number of
7430 suggestions is never more than the value of 'lines'
7431 minus two.
7432
Bram Moolenaar585ee072022-01-29 11:22:17 +00007433 timeout:{millisec} Limit the time searching for suggestions to
7434 {millisec} milli seconds. Applies to the following
7435 methods. When omitted the limit is 5000. When
7436 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007437 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007438
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007439 file:{filename} Read file {filename}, which must have two columns,
7440 separated by a slash. The first column contains the
7441 bad word, the second column the suggested good word.
7442 Example:
7443 theribal/terrible ~
7444 Use this for common mistakes that do not appear at the
7445 top of the suggestion list with the internal methods.
7446 Lines without a slash are ignored, use this for
7447 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007448 The word in the second column must be correct,
7449 otherwise it will not be used. Add the word to an
7450 ".add" file if it is currently flagged as a spelling
7451 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007452 The file is used for all languages.
7453
7454 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7455 trouble with spaces. |v:val| holds the badly spelled
7456 word. The expression must evaluate to a List of
7457 Lists, each with a suggestion and a score.
7458 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007459 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007460 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007461 internal methods use. A lower score is better.
7462 This may invoke |spellsuggest()| if you temporarily
7463 set 'spellsuggest' to exclude the "expr:" part.
7464 Errors are silently ignored, unless you set the
7465 'verbose' option to a non-zero value.
7466
7467 Only one of "best", "double" or "fast" may be used. The others may
7468 appear several times in any order. Example: >
7469 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7470<
7471 This option cannot be set from a |modeline| or in the |sandbox|, for
7472 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007473
7474
Bram Moolenaar071d4272004-06-13 20:20:40 +00007475 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7476'splitbelow' 'sb' boolean (default off)
7477 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 When on, splitting a window will put the new window below the current
7479 one. |:split|
7480
7481 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7482'splitright' 'spr' boolean (default off)
7483 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484 When on, splitting a window will put the new window right of the
7485 current one. |:vsplit|
7486
7487 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7488'startofline' 'sol' boolean (default on)
7489 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007491 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007492 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007493 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007494 with a linewise operator, with "%" with a count and to buffer changing
7495 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7496 only has a line number, e.g., ":25" or ":+".
7497 In case of buffer changing commands the cursor is placed at the column
7498 where it was the last time the buffer was edited.
7499 NOTE: This option is set when 'compatible' is set.
7500
Bram Moolenaar00654022011-02-25 14:42:19 +01007501 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007502'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007503 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007504 {not available when compiled without the |+statusline|
7505 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007506 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 Also see |status-line|.
7508
7509 The option consists of printf style '%' items interspersed with
7510 normal text. Each status line item is of the form:
7511 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007512 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007513 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514
Bram Moolenaar238a5642006-02-21 22:12:05 +00007515 When the option starts with "%!" then it is used as an expression,
7516 evaluated and the result is used as the option value. Example: >
7517 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007518< The *g:statusline_winid* variable will be set to the |window-ID| of the
7519 window that the status line belongs to.
7520 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007521 Note that the "%!" expression is evaluated in the context of the
7522 current window and buffer, while %{} items are evaluated in the
7523 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007524
7525 When there is error while evaluating the option then it will be made
7526 empty to avoid further errors. Otherwise screen updating would loop.
7527
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 Note that the only effect of 'ruler' when this option is set (and
7529 'laststatus' is 2) is controlling the output of |CTRL-G|.
7530
7531 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007532 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007533 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007534 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535 minwid Minimum width of the item, padding as set by '-' & '0'.
7536 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007537 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538 on the left for text items. Numeric items will be
7539 shifted down to maxwid-2 digits followed by '>'number
7540 where number is the amount of missing digits, much like
7541 an exponential notation.
7542 item A one letter code as described below.
7543
7544 Following is a description of the possible statusline items. The
7545 second character in "item" is the type:
7546 N for number
7547 S for string
7548 F for flags as described below
7549 - not applicable
7550
7551 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007552 f S Path to the file in the buffer, as typed or relative to current
7553 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 F S Full path to the file in the buffer.
7555 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007556 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007558 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007559 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007560 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007561 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007562 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007563 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007564 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007565 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007566 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7568 being used: "<keymap>"
7569 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007570 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007571 B N As above, in hexadecimal.
7572 o N Byte number in file of byte under cursor, first byte is 1.
7573 Mnemonic: Offset from start of file (with one added)
7574 {not available when compiled without |+byte_offset| feature}
7575 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007576 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 l N Line number.
7578 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007579 c N Column number (byte index).
7580 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007581 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 p N Percentage through file in lines as in |CTRL-G|.
7583 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007584 percentage described for 'ruler'. Always 3 in length, unless
7585 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007586 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007588 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007589 Note that there is no '%' before the closing '}'. The
7590 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007591 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007592 {% - This is almost same as { except the result of the expression is
7593 re-evaluated as a statusline format string. Thus if the
7594 return value of expr contains % items they will get expanded.
7595 The expression can contain the } character, the end of
7596 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007597 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007598 func! Stl_filename() abort
7599 return "%t"
7600 endfunc
7601< `stl=%{Stl_filename()}` results in `"%t"`
7602 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007603 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007604 ( - Start of item group. Can be used for setting the width and
7605 alignment of a section. Must be followed by %) somewhere.
7606 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007607 T N For 'tabline': start of tab page N label. Use %T after the last
7608 label. This information is used for mouse clicks.
7609 X N For 'tabline': start of close tab N label. Use %X after the
7610 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7611 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612 < - Where to truncate line if too long. Default is at the start.
7613 No width fields allowed.
7614 = - Separation point between left and right aligned items.
7615 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007616 # - Set highlight group. The name must follow and then a # again.
7617 Thus use %#HLname# for highlight group HLname. The same
7618 highlighting is used, also for the statusline of non-current
7619 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007621 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007622 The difference between User{N} and StatusLine will be applied
7623 to StatusLineNC for the statusline of non-current windows.
7624 The number N must be between 1 and 9. See |hl-User1..9|
7625
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007626 When displaying a flag, Vim removes the leading comma, if any, when
7627 that flag comes right after plaintext. This will make a nice display
7628 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007629
Bram Moolenaar582fd852005-03-28 20:58:01 +00007630 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007631 not set) and a minwid is not set for the group, the whole group will
7632 become empty. This will make a group like the following disappear
7633 completely from the statusline when none of the flags are set. >
7634 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007635< Beware that an expression is evaluated each and every time the status
7636 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007637 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007638 While evaluating %{} the current buffer and current window will be set
7639 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007640 currently being drawn. The expression will evaluate in this context.
7641 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7642 real current buffer and "g:actual_curwin" to the |window-ID| of the
7643 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007644
Bram Moolenaar30b65812012-07-12 22:01:11 +02007645 The 'statusline' option will be evaluated in the |sandbox| if set from
7646 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007647 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007648
7649 It is not allowed to change text or jump to another window while
7650 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007651
7652 If the statusline is not updated when you want it (e.g., after setting
7653 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007654 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007656 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007657 Otherwise the result is taken as flag text and applied to the rules
7658 described above.
7659
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007660 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007661 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007662 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007663
7664 Examples:
7665 Emulate standard status line with 'ruler' set >
7666 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7667< Similar, but add ASCII value of char under the cursor (like "ga") >
7668 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7669< Display byte count and byte value, modified flag in red. >
7670 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7671 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7672< Display a ,GZ flag if a compressed file is loaded >
7673 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7674< In the |:autocmd|'s: >
7675 :let b:gzflag = 1
7676< And: >
7677 :unlet b:gzflag
7678< And define this function: >
7679 :function VarExists(var, val)
7680 : if exists(a:var) | return a:val | else | return '' | endif
7681 :endfunction
7682<
7683 *'suffixes'* *'su'*
7684'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7685 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007686 Files with these suffixes get a lower priority when multiple files
7687 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007688 suffixes. Spaces after the comma are ignored. A dot is also seen as
7689 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 separator, precede it with a backslash (see |option-backslash| about
7691 including spaces and backslashes).
7692 See 'wildignore' for completely ignoring files.
7693 The use of |:set+=| and |:set-=| is preferred when adding or removing
7694 suffixes from the list. This avoids problems when a future version
7695 uses another default.
7696
7697 *'suffixesadd'* *'sua'*
7698'suffixesadd' 'sua' string (default "")
7699 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007700 {not available when compiled without the
7701 |+file_in_path| feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007702 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007703 file for the "gf", "[I", etc. commands. Example: >
7704 :set suffixesadd=.java
7705<
7706 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7707'swapfile' 'swf' boolean (default on)
7708 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007709 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710 swapfile is not wanted for a specific buffer. For example, with
7711 confidential information that even root must not be able to access.
7712 Careful: All text will be in memory:
7713 - Don't use this for big files.
7714 - Recovery will be impossible!
7715 A swapfile will only be present when |'updatecount'| is non-zero and
7716 'swapfile' is set.
7717 When 'swapfile' is reset, the swap file for the current buffer is
7718 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7719 non-zero, a swap file is immediately created.
7720 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007721 If you want to open a new buffer without creating a swap file for it,
7722 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007723 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007724
7725 This option is used together with 'bufhidden' and 'buftype' to
7726 specify special kinds of buffers. See |special-buffers|.
7727
7728 *'swapsync'* *'sws'*
7729'swapsync' 'sws' string (default "fsync")
7730 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007731 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007732 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733 When this option is empty parts of the swap file may be in memory and
7734 not written to disk. When the system crashes you may lose more work.
7735 On Unix the system does a sync now and then without Vim asking for it,
7736 so the disadvantage of setting this option off is small. On some
7737 systems the swap file will not be written at all. For a unix system
7738 setting it to "sync" will use the sync() call instead of the default
7739 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007740 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007741
7742 *'switchbuf'* *'swb'*
7743'switchbuf' 'swb' string (default "")
7744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007746 Mostly for |quickfix| commands some values are also used for other
7747 commands, as mentioned below.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007748 Possible values (comma-separated list):
Bram Moolenaar071d4272004-06-13 20:20:40 +00007749 useopen If included, jump to the first open window that
7750 contains the specified buffer (if there is one).
7751 Otherwise: Do not examine other windows.
7752 This setting is checked with |quickfix| commands, when
7753 jumping to errors (":cc", ":cn", "cp", etc.). It is
7754 also used in all buffer related split commands, for
7755 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007756 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007757 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007759 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007760 Otherwise: do not split, use current window (when used
7761 in the quickfix window: the previously used window or
7762 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007763 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007764 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007765 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007766 uselast If included, jump to the previously used window when
7767 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007769 *'synmaxcol'* *'smc'*
7770'synmaxcol' 'smc' number (default 3000)
7771 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007772 {not available when compiled without the |+syntax|
7773 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007774 Maximum column in which to search for syntax items. In long lines the
7775 text after this column is not highlighted and following lines may not
7776 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007777 This helps to avoid very slow redrawing for an XML file that is one
7778 long line.
7779 Set to zero to remove the limit.
7780
Bram Moolenaar071d4272004-06-13 20:20:40 +00007781 *'syntax'* *'syn'*
7782'syntax' 'syn' string (default empty)
7783 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007784 {not available when compiled without the |+syntax|
7785 feature}
7786 When this option is set, the syntax with this name is loaded, unless
7787 syntax highlighting has been switched off with ":syntax off".
7788 Otherwise this option does not always reflect the current syntax (the
7789 b:current_syntax variable does).
7790 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007791 not automatically recognized. Example, in an IDL file:
7792 /* vim: set syntax=idl : */ ~
7793 When a dot appears in the value then this separates two filetype
7794 names. Example:
7795 /* vim: set syntax=c.doxygen : */ ~
7796 This will use the "c" syntax first, then the "doxygen" syntax.
7797 Note that the second one must be prepared to be loaded as an addition,
7798 otherwise it will be skipped. More than one dot may appear.
7799 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007800 :set syntax=OFF
7801< To switch syntax highlighting on according to the current value of the
7802 'filetype' option: >
7803 :set syntax=ON
7804< What actually happens when setting the 'syntax' option is that the
7805 Syntax autocommand event is triggered with the value as argument.
7806 This option is not copied to another buffer, independent of the 's' or
7807 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007808 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007810 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007811'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007812 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00007813 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007814 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007815 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007816
7817 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007818 option and only when there is no GUI tab line. When 'e' is in
7819 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007820 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007821
7822 The value is evaluated like with 'statusline'. You can use
7823 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007824 the text to be displayed. Use "%1T" for the first label, "%2T" for
7825 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007826
Bram Moolenaare12bab32019-01-08 22:02:56 +01007827 When changing something that is used in 'tabline' that does not
7828 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007829 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007830
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007831 Keep in mind that only one of the tab pages is the current one, others
7832 are invisible and you can't jump to their windows.
7833
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007834
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007835 *'tabpagemax'* *'tpm'*
7836'tabpagemax' 'tpm' number (default 10)
7837 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007838 Maximum number of tab pages to be opened by the |-p| command line
7839 argument or the ":tab all" command. |tabpage|
7840
7841
7842 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007843'tabstop' 'ts' number (default 8)
7844 local to buffer
7845 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007846 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847
7848 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007849 appear wrong in many places, e.g., when printing it.
7850 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851
7852 There are four main ways to use tabs in Vim:
7853 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7854 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007855 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007856 behave like a tab appears every 4 (or 3) characters.
7857 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7858 'expandtab'. This way you will always insert spaces. The
7859 formatting will never be messed up when 'tabstop' is changed.
7860 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007861 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 works when using Vim to edit the file.
7863 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7864 'noexpandtab'. This should then work (for initial indents only)
7865 for any tabstop setting that people use. It might be nice to have
7866 tabs after the first non-blank inserted as spaces if you do this
7867 though. Otherwise aligned comments will be wrong when 'tabstop' is
7868 changed.
7869
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007870 If Vim is compiled with the |+vartabs| feature then the value of
7871 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7872 than an empty string.
7873
Bram Moolenaar071d4272004-06-13 20:20:40 +00007874 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7875'tagbsearch' 'tbs' boolean (default on)
7876 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007877 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007878 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 searching makes searching for a tag a LOT faster, but a linear search
7880 will find more tags if the tags file wasn't properly sorted.
7881 Vim normally assumes that your tags files are sorted, or indicate that
7882 they are not sorted. Only when this is not the case does the
7883 'tagbsearch' option need to be switched off.
7884
7885 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007886 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 certain files, or retry all files with a linear search. When
7888 'tagbsearch' is off, only a linear search is done.
7889
7890 Linear searching is done anyway, for one file, when Vim finds a line
7891 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007892 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007893< [The whitespace before and after the '0' must be a single <Tab>]
7894
7895 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007896 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007897 instead of a normal tag name, a retry is done with a linear search.
7898 Tags in unsorted tags files, and matches with different case will only
7899 be found in the retry.
7900
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007901 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007902 linear search can be avoided when case is ignored. Use a value of '2'
7903 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7904 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00007905 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
7906 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
7907 used for this as well. Note that case must be folded to uppercase for
7908 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007909
7910 By default, tag searches are case-sensitive. Case is ignored when
7911 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7912 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007913 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7914 'tagcase' is "smart", and the pattern contains only lowercase
7915 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007916
7917 When 'tagbsearch' is off, tags searching is slower when a full match
7918 exists, but faster when no full match exists. Tags in unsorted tags
7919 files may only be found with 'tagbsearch' off.
7920 When the tags file is not sorted, or sorted in a wrong way (not on
7921 ASCII byte value), 'tagbsearch' should be off, or the line given above
7922 must be included in the tags file.
7923 This option doesn't affect commands that find all matching tags (e.g.,
7924 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007926 *'tagcase'* *'tc'*
7927'tagcase' 'tc' string (default "followic")
7928 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007929 This option specifies how case is handled when searching the tags
7930 file:
7931 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007932 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007933 ignore Ignore case
7934 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007935 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007936 NOTE: This option is set to the Vi default value when 'compatible' is
7937 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007938
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007939 *'tagfunc'* *'tfu'*
7940'tagfunc' 'tfu' string (default: empty)
7941 local to buffer
7942 {not available when compiled without the |+eval|
7943 feature}
7944 This option specifies a function to be used to perform tag searches.
7945 The function gets the tag pattern and should return a List of matching
7946 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007947 function and an example. The value can be the name of a function, a
7948 |lambda| or a |Funcref|. See |option-value-function| for more
7949 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007950
Bram Moolenaar071d4272004-06-13 20:20:40 +00007951 *'taglength'* *'tl'*
7952'taglength' 'tl' number (default 0)
7953 global
7954 If non-zero, tags are significant up to this number of characters.
7955
7956 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7957'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7958 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007959 If on and using a tags file in another directory, file names in that
7960 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 NOTE: This option is set to the Vi default value when 'compatible' is
7962 set and to the Vim default value when 'compatible' is reset.
7963
7964 *'tags'* *'tag'* *E433*
7965'tags' 'tag' string (default "./tags,tags", when compiled with
7966 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7967 global or local to buffer |global-local|
7968 Filenames for the tag command, separated by spaces or commas. To
7969 include a space or comma in a file name, precede it with a backslash
7970 (see |option-backslash| about including spaces and backslashes).
7971 When a file name starts with "./", the '.' is replaced with the path
7972 of the current file. But only when the 'd' flag is not included in
7973 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7974 |tags-option|.
7975 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007976 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7977 find all files named "tags" below "/lib". The filename itself cannot
7978 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7979 files called "tags?". {not available when compiled without the
7980 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007981 The |tagfiles()| function can be used to get a list of the file names
7982 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007983 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7984 files are also supported. They are automatically recognized. The
7985 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7986 differences are ignored (MS-Windows). |emacs-tags|
7987 The use of |:set+=| and |:set-=| is preferred when adding or removing
7988 file names from the list. This avoids problems when a future version
7989 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990
7991 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7992'tagstack' 'tgst' boolean (default on)
7993 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007994 When on, the |tagstack| is used normally. When off, a ":tag" or
7995 ":tselect" command with an argument will not push the tag onto the
7996 tagstack. A following ":tag" without an argument, a ":pop" command or
7997 any other command that uses the tagstack will use the unmodified
7998 tagstack, but does change the pointer to the active entry.
7999 Resetting this option is useful when using a ":tag" command in a
8000 mapping which should not change the tagstack.
8001
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008002 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008003'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008004 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008005 {only available when compiled with the |+tcl/dyn|
8006 feature}
8007 Specifies the name of the Tcl shared library. The default is
8008 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008009 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008010 This option cannot be set from a |modeline| or in the |sandbox|, for
8011 security reasons.
8012
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 *'term'* *E529* *E530* *E531*
8014'term' string (default is $TERM, if that fails:
8015 in the GUI: "builtin_gui"
8016 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008017 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008018 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008019 on Unix: "ansi"
8020 on VMS: "ansi"
8021 on Win 32: "win32")
8022 global
8023 Name of the terminal. Used for choosing the terminal control
8024 characters. Environment variables are expanded |:set_env|.
8025 For example: >
8026 :set term=$TERM
8027< See |termcap|.
8028
8029 *'termbidi'* *'tbidi'*
8030 *'notermbidi'* *'notbidi'*
8031'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8032 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008033 {only available when compiled with the |+arabic|
8034 feature}
8035 The terminal is in charge of Bi-directionality of text (as specified
8036 by Unicode). The terminal is also expected to do the required shaping
8037 that some languages (such as Arabic) require.
8038 Setting this option implies that 'rightleft' will not be set when
8039 'arabic' is set and the value of 'arabicshape' will be ignored.
8040 Note that setting 'termbidi' has the immediate effect that
8041 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8042 This option is reset when the GUI is started.
8043 For further details see |arabic.txt|.
8044
8045 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008046'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 Encoding used for the terminal. This specifies what character
8049 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008050 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008051 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008052 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008053 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008054 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8055 Any attempts to set a different value will be rejected, and an error
8056 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008057 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058 because the Win32 system always passes Unicode characters.
8059 When empty, the same encoding is used as for the 'encoding' option.
8060 This is the normal value.
8061 Not all combinations for 'termencoding' and 'encoding' are valid. See
8062 |encoding-table|.
8063 The value for this option must be supported by internal conversions or
8064 iconv(). When this is not possible no conversion will be done and you
8065 will probably experience problems with non-ASCII characters.
8066 Example: You are working with the locale set to euc-jp (Japanese) and
8067 want to edit a UTF-8 file: >
8068 :let &termencoding = &encoding
8069 :set encoding=utf-8
8070< You need to do this when your system has no locale support for UTF-8.
8071
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008072 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008073'termguicolors' 'tgc' boolean (default off)
8074 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008075 {not available when compiled without the
8076 |+termguicolors| feature}
8077 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008078 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008079
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008080 Requires a ISO-8613-3 compatible terminal. If setting this option
8081 does not work (produces a colorless UI) reading |xterm-true-color|
8082 might help.
8083
8084 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8085 is required. Use this check to find out: >
8086 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008087< This requires Vim to be built with the |+vtp| feature.
8088
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008089 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008090
8091 When using Vim with Windows Terminal, the background of Windows
8092 Terminal is normally filled with the Vim background color. Setting
8093 'termguicolors' and the guibg of the Normal highlight group to NONE
8094 will make the background transparent: >
8095 :hi Normal guibg=NONE
8096<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008097 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008098
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008099 *'termwinkey'* *'twk'*
8100'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008101 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008102 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008103 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008104 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008105 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008106< The string must be one key stroke but can be multiple bytes.
8107 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008108 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008109 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008110
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008111 *'termwinscroll'* *'twsl'*
8112'termwinscroll' 'twsl' number (default 10000)
8113 local to buffer
8114 {not available when compiled without the
8115 |+terminal| feature}
8116 Number of scrollback lines to keep. When going over this limit the
8117 first 10% of the scrollback lines are deleted. This is just to reduce
8118 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008119 Also used as a limit for text sent to the terminal in one write,
8120 multiplied by the number of columns times 3 (average number of bytes
8121 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008122
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008123 *'termwinsize'* *'tws'*
8124'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008125 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008126 Size used when opening the |terminal| window. Format:
8127 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008128 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008129 - When set with a "x" (e.g., "24x80") the terminal size is not
8130 adjusted to the window size. If the window is smaller only the
8131 top-left part is displayed.
8132 - When set with a "*" (e.g., "10*50") the terminal size follows the
8133 window size, but will not be smaller than the specified rows and/or
8134 columns.
8135 - When rows is zero then use the height of the window.
8136 - When columns is zero then use the width of the window.
8137 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008138 - Can be overruled in the |term_start()| options with "term_rows" and
8139 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008140
8141 Examples:
8142 "30x0" uses 30 rows and the current window width.
8143 "20*0" uses at least 20 rows and the current window width.
8144 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008145 Note that the command running in the terminal window may still change
8146 the size of the terminal. In that case the Vim window will be
8147 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008148
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008149 *'termwintype'* *'twt'*
8150'termwintype' 'twt' string (default "")
8151 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008152 {only available when compiled with the |terminal|
8153 feature on MS-Windows}
8154 Specify the virtual console (pty) used when opening the terminal
8155 window.
8156
8157 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008158 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008159 "winpty" use winpty, fail if not supported
8160 "conpty" use |ConPTY|, fail if not supported
8161
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008162 |ConPTY| support depends on the platform. Windows 10 October 2018
8163 Update is the first version that supports ConPTY, however it is still
8164 considered unstable. ConPTY might become stable in the next release
8165 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008166 supported then you cannot open a terminal window.
8167
Bram Moolenaar071d4272004-06-13 20:20:40 +00008168 *'terse'* *'noterse'*
8169'terse' boolean (default off)
8170 global
8171 When set: Add 's' flag to 'shortmess' option (this makes the message
8172 for a search that hits the start or end of the file not being
8173 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8174 shortens a lot of messages}
8175
8176 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8177'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8178 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179 This option is obsolete. Use 'fileformats'.
8180 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8181 set to the default value for the current system. When 'textauto' is
8182 reset, 'fileformats' is made empty.
8183 NOTE: This option is set to the Vi default value when 'compatible' is
8184 set and to the Vim default value when 'compatible' is reset.
8185
8186 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008187'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008188 others: default off)
8189 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008190 This option is obsolete. Use 'fileformat'.
8191 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8192 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8193 "unix".
8194
8195 *'textwidth'* *'tw'*
8196'textwidth' 'tw' number (default 0)
8197 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008198 Maximum width of text that is being inserted. A longer line will be
8199 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008200 this.
8201 'textwidth' is set to 0 when the 'paste' option is set and restored
8202 when 'paste' is reset.
8203 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008204 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008205 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008206 NOTE: This option is set to 0 when 'compatible' is set.
8207
8208 *'thesaurus'* *'tsr'*
8209'thesaurus' 'tsr' string (default "")
8210 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008212 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8213 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008214
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008215 This option is not used if 'thesaurusfunc' is set, either for the
8216 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008217
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008218 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008219 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008220 name. See |option-backslash| about using backslashes. The use of
8221 |:set+=| and |:set-=| is preferred when adding or removing directories
8222 from the list. This avoids problems when a future version uses
8223 another default. Backticks cannot be used in this option for security
8224 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008225
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008226 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008227'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008228 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008229 {not available when compiled without the |+eval|
8230 feature}
8231 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008232 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008233 The value can be the name of a function, a |lambda| or a |Funcref|.
8234 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008235
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008236 This option cannot be set from a |modeline| or in the |sandbox|, for
8237 security reasons.
8238
Bram Moolenaar071d4272004-06-13 20:20:40 +00008239 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8240'tildeop' 'top' boolean (default off)
8241 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008242 When on: The tilde command "~" behaves like an operator.
8243 NOTE: This option is reset when 'compatible' is set.
8244
8245 *'timeout'* *'to'* *'notimeout'* *'noto'*
8246'timeout' 'to' boolean (default on)
8247 global
8248 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008249'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008251 These two options together determine the behavior when part of a
8252 mapped key sequence or keyboard code has been received:
8253
8254 'timeout' 'ttimeout' action ~
8255 off off do not time out
8256 on on or off time out on :mappings and key codes
8257 off on time out on key codes
8258
8259 If both options are off, Vim will wait until either the complete
8260 mapping or key sequence has been received, or it is clear that there
8261 is no mapping or key sequence for the received characters. For
8262 example: if you have mapped "vl" and Vim has received 'v', the next
8263 character is needed to see if the 'v' is followed by an 'l'.
8264 When one of the options is on, Vim will wait for about 1 second for
8265 the next character to arrive. After that the already received
8266 characters are interpreted as single characters. The waiting time can
8267 be changed with the 'timeoutlen' option.
8268 On slow terminals or very busy systems timing out may cause
8269 malfunctioning cursor keys. If both options are off, Vim waits
8270 forever after an entered <Esc> if there are key codes that start
8271 with <Esc>. You will have to type <Esc> twice. If you do not have
8272 problems with key codes, but would like to have :mapped key
8273 sequences not timing out in 1 second, set the 'ttimeout' option and
8274 reset the 'timeout' option.
8275
8276 NOTE: 'ttimeout' is reset when 'compatible' is set.
8277
8278 *'timeoutlen'* *'tm'*
8279'timeoutlen' 'tm' number (default 1000)
8280 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008281
Bram Moolenaar071d4272004-06-13 20:20:40 +00008282 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008283'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008285 The time in milliseconds that is waited for a key code or mapped key
8286 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8287 when part of a command has been typed.
8288 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8289 different timeout value for key codes is desired set 'ttimeoutlen' to
8290 a non-negative number.
8291
8292 ttimeoutlen mapping delay key code delay ~
8293 < 0 'timeoutlen' 'timeoutlen'
8294 >= 0 'timeoutlen' 'ttimeoutlen'
8295
8296 The timeout only happens when the 'timeout' and 'ttimeout' options
8297 tell so. A useful setting would be >
8298 :set timeout timeoutlen=3000 ttimeoutlen=100
8299< (time out on mapping after three seconds, time out on key codes after
8300 a tenth of a second).
8301
8302 *'title'* *'notitle'*
8303'title' boolean (default off, on when title can be restored)
8304 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008305 When on, the title of the window will be set to the value of
8306 'titlestring' (if it is not empty), or to:
8307 filename [+=-] (path) - VIM
8308 Where:
8309 filename the name of the file being edited
8310 - indicates the file cannot be modified, 'ma' off
8311 + indicates the file was modified
8312 = indicates the file is read-only
8313 =+ indicates the file is read-only and modified
8314 (path) is the path of the file being edited
8315 - VIM the server name |v:servername| or "VIM"
8316 Only works if the terminal supports setting window titles
8317 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008318 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8320 *X11*
8321 When Vim was compiled with HAVE_X11 defined, the original title will
8322 be restored if possible. The output of ":version" will include "+X11"
8323 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8324 works for the icon name |'icon'|.
8325 But: When Vim was started with the |-X| argument, restoring the title
8326 will not work (except in the GUI).
8327 If the title cannot be restored, it is set to the value of 'titleold'.
8328 You might want to restore the title outside of Vim then.
8329 When using an xterm from a remote machine you can use this command:
8330 rsh machine_name xterm -display $DISPLAY &
8331 then the WINDOWID environment variable should be inherited and the
8332 title of the window should change back to what it should be after
8333 exiting Vim.
8334
8335 *'titlelen'*
8336'titlelen' number (default 85)
8337 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008338 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008339 title. When the title is longer, only the end of the path name is
8340 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008341 Using a percentage makes this adapt to the width of the window. But
8342 it won't work perfectly, because the actual number of characters
8343 available also depends on the font used and other things in the title
8344 bar. When 'titlelen' is zero the full path is used. Otherwise,
8345 values from 1 to 30000 percent can be used.
8346 'titlelen' is also used for the 'titlestring' option.
8347
8348 *'titleold'*
8349'titleold' string (default "Thanks for flying Vim")
8350 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008351 This option will be used for the window title when exiting Vim if the
8352 original title cannot be restored. Only happens if 'title' is on or
8353 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008354 This option cannot be set from a |modeline| or in the |sandbox|, for
8355 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008356 *'titlestring'*
8357'titlestring' string (default "")
8358 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008359 When this option is not empty, it will be used for the title of the
8360 window. This happens only when the 'title' option is on.
8361 Only works if the terminal supports setting window titles (currently
8362 Amiga console, Win32 console, all GUI versions and terminals with a
8363 non-empty 't_ts' option).
8364 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008365 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008366
Bram Moolenaar071d4272004-06-13 20:20:40 +00008367 When this option contains printf-style '%' items, they will be
8368 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008369 This option cannot be set in a modeline when 'modelineexpr' is off.
8370
Bram Moolenaar071d4272004-06-13 20:20:40 +00008371 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008372 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008373 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8374< The value of 'titlelen' is used to align items in the middle or right
8375 of the available space.
8376 Some people prefer to have the file name first: >
8377 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8378< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008379 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008380 separating space only when needed.
8381 NOTE: Use of special characters in 'titlestring' may cause the display
8382 to be garbled (e.g., when it contains a CR or NL character).
8383 {not available when compiled without the |+statusline| feature}
8384
8385 *'toolbar'* *'tb'*
8386'toolbar' 'tb' string (default "icons,tooltips")
8387 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008388 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008389 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008390 possible values are:
8391 icons Toolbar buttons are shown with icons.
8392 text Toolbar buttons shown with text.
8393 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008394 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008395 tooltips Tooltips are active for toolbar buttons.
8396 Tooltips refer to the popup help text which appears after the mouse
8397 cursor is placed over a toolbar button for a brief moment.
8398
8399 If you want the toolbar to be shown with icons as well as text, do the
8400 following: >
8401 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008402< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008403 will show icons if both are requested.
8404
8405 If none of the strings specified in 'toolbar' are valid or if
8406 'toolbar' is empty, this option is ignored. If you want to disable
8407 the toolbar, you need to set the 'guioptions' option. For example: >
8408 :set guioptions-=T
8409< Also see |gui-toolbar|.
8410
8411 *'toolbariconsize'* *'tbis'*
8412'toolbariconsize' 'tbis' string (default "small")
8413 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008414 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008415 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008416 tiny Use tiny icons.
8417 small Use small icons (default).
8418 medium Use medium-sized icons.
8419 large Use large icons.
8420 huge Use even larger icons.
8421 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008423 the current theme. Common dimensions are giant=48x48, huge=32x32,
8424 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008425
8426 If 'toolbariconsize' is empty, the global default size as determined
8427 by user preferences or the current theme is used.
8428
8429 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8430'ttybuiltin' 'tbi' boolean (default on)
8431 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008432 When on, the builtin termcaps are searched before the external ones.
8433 When off the builtin termcaps are searched after the external ones.
8434 When this option is changed, you should set the 'term' option next for
8435 the change to take effect, for example: >
8436 :set notbi term=$TERM
8437< See also |termcap|.
8438 Rationale: The default for this option is "on", because the builtin
8439 termcap entries are generally better (many systems contain faulty
8440 xterm entries...).
8441
8442 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8443'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8444 sun-cmd, screen, rxvt, dtterm or
8445 iris-ansi; also on when running Vim in
8446 a DOS console)
8447 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008448 Indicates a fast terminal connection. More characters will be sent to
8449 the screen for redrawing, instead of using insert/delete line
8450 commands. Improves smoothness of redrawing when there are multiple
8451 windows and the terminal does not support a scrolling region.
8452 Also enables the extra writing of characters at the end of each screen
8453 line for lines that wrap. This helps when using copy/paste with the
8454 mouse in an xterm and other terminals.
8455
8456 *'ttymouse'* *'ttym'*
8457'ttymouse' 'ttym' string (default depends on 'term')
8458 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008459 {only in Unix and VMS, doesn't work in the GUI; not
8460 available when compiled without |+mouse|}
8461 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008462 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008463 *xterm-mouse*
8464 xterm xterm-like mouse handling. The mouse generates
8465 "<Esc>[Mscr", where "scr" is three bytes:
8466 "s" = button state
8467 "c" = column plus 33
8468 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008469 This only works up to 223 columns! See "dec",
8470 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471 xterm2 Works like "xterm", but with the xterm reporting the
8472 mouse position while the mouse is dragged. This works
8473 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008474 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008475 work. See below for how Vim detects this
8476 automatically.
8477 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008478 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008479 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008480 for the row and column. No other mouse events are
8481 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008482 *dec-mouse*
8483 dec DEC terminal mouse handling. The mouse generates a
8484 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008485 This is also available for an Xterm, if it was
8486 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 *jsbterm-mouse*
8488 jsbterm JSB term mouse handling.
8489 *pterm-mouse*
8490 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008491 *urxvt-mouse*
8492 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008493 The mouse works only if the terminal supports this
8494 encoding style, but it does not have 223 columns limit
8495 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008496 *sgr-mouse*
8497 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008498 mouse reporting. The mouse works even in columns
8499 beyond 223. This option is backward compatible with
8500 "xterm2" because it can also decode "xterm2" style
8501 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502
8503 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008504 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8505 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008506 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8507 recognized, if enabled at compile time. DEC terminal mouse codes
8508 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008509 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8510 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008511 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008512 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8513 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8514 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008515 Additionally, if vim is compiled with the |+termresponse| feature and
8516 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008517 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008518 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008519 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8520 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8521 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008522 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8523 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008524 :set t_RV=
8525<
8526 *'ttyscroll'* *'tsl'*
8527'ttyscroll' 'tsl' number (default 999)
8528 global
8529 Maximum number of lines to scroll the screen. If there are more lines
8530 to scroll the window is redrawn. For terminals where scrolling is
8531 very slow and redrawing is not slow this can be set to a small number,
8532 e.g., 3, to speed up displaying.
8533
8534 *'ttytype'* *'tty'*
8535'ttytype' 'tty' string (default from $TERM)
8536 global
8537 Alias for 'term', see above.
8538
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008539 *'undodir'* *'udir'*
8540'undodir' 'udir' string (default ".")
8541 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008542 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008543 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008544 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008545 "." means using the directory of the file. The undo file name for
8546 "file.txt" is ".file.txt.un~".
8547 For other directories the file name is the full path of the edited
8548 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008549 When writing: The first directory that exists is used. "." always
8550 works, no directories after "." will be used for writing.
8551 When reading all entries are tried to find an undo file. The first
8552 undo file that exists is used. When it cannot be read an error is
8553 given, no further entry is used.
8554 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008555 This option cannot be set from a |modeline| or in the |sandbox|, for
8556 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008557
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008558 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008559'undofile' 'udf' boolean (default off)
8560 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008561 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008562 When on, Vim automatically saves undo history to an undo file when
8563 writing a buffer to a file, and restores undo history from the same
8564 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008565 The directory where the undo file is stored is specified by 'undodir'.
8566 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008567 The undo file is not read when 'undoreload' causes the buffer from
8568 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008569 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008570 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008571
Bram Moolenaar071d4272004-06-13 20:20:40 +00008572 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008573'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008574 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008575 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008576 is kept in memory, higher numbers will cause more memory to be used.
8577 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008578 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8579 itself: >
8580 set ul=0
8581< But you can also get Vi compatibility by including the 'u' flag in
8582 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008583 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008584 Set to -1 for no undo at all. You might want to do this only for the
8585 current buffer: >
8586 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008587< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008588
8589 The local value is set to -123456 when the global value is to be used.
8590
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008591 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008592
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008593 *'undoreload'* *'ur'*
8594'undoreload' 'ur' number (default 10000)
8595 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008596 Save the whole buffer for undo when reloading it. This applies to the
8597 ":e!" command and reloading for when the buffer changed outside of
8598 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008599 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008600 of lines is smaller than the value of this option.
8601 Set this option to zero to disable undo for a reload.
8602
8603 When saving undo for a reload, any undo file is not read.
8604
8605 Note that this causes the whole buffer to be stored in memory. Set
8606 this option to a lower value if you run out of memory.
8607
Bram Moolenaar071d4272004-06-13 20:20:40 +00008608 *'updatecount'* *'uc'*
8609'updatecount' 'uc' number (default: 200)
8610 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008611 After typing this many characters the swap file will be written to
8612 disk. When zero, no swap file will be created at all (see chapter on
8613 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8614 Vim with the "-n" option, see |startup|. When editing in readonly
8615 mode this option will be initialized to 10000.
8616 The swapfile can be disabled per buffer with |'swapfile'|.
8617 When 'updatecount' is set from zero to non-zero, swap files are
8618 created for all buffers that have 'swapfile' set. When 'updatecount'
8619 is set to zero, existing swap files are not deleted.
8620 Also see |'swapsync'|.
8621 This option has no meaning in buffers where |'buftype'| is "nofile"
8622 or "nowrite".
8623
8624 *'updatetime'* *'ut'*
8625'updatetime' 'ut' number (default 4000)
8626 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008627 If this many milliseconds nothing is typed the swap file will be
8628 written to disk (see |crash-recovery|). Also used for the
8629 |CursorHold| autocommand event.
8630
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008631 *'varsofttabstop'* *'vsts'*
8632'varsofttabstop' 'vsts' string (default "")
8633 local to buffer
8634 {only available when compiled with the |+vartabs|
8635 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008636 A list of the number of spaces that a <Tab> counts for while editing,
8637 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8638 width <Tab>s are being inserted, while in fact a mixture of spaces
8639 and <Tab>s is used. Tab widths are separated with commas, with the
8640 final value applying to all subsequent tabs.
8641
8642 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008643 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008644 to use the following: >
8645 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008646< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8647 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008648
8649 Note that the value of |'softtabstop'| will be ignored while
8650 'varsofttabstop' is set.
8651
8652 *'vartabstop'* *'vts'*
8653'vartabstop' 'vts' string (default "")
8654 local to buffer
8655 {only available when compiled with the |+vartabs|
8656 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008657 A list of the number of spaces that a <Tab> in the file counts for,
8658 separated by commas. Each value corresponds to one tab, with the
8659 final value applying to all subsequent tabs. For example: >
8660 :set vartabstop=4,20,10,8
8661< This will make the first tab 4 spaces wide, the second 20 spaces,
8662 the third 10 spaces, and all following tabs 8 spaces.
8663
8664 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8665 is set.
8666
Bram Moolenaar071d4272004-06-13 20:20:40 +00008667 *'verbose'* *'vbs'*
8668'verbose' 'vbs' number (default 0)
8669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008670 When bigger than zero, Vim will give messages about what it is doing.
8671 Currently, these messages are given:
8672 >= 1 When the viminfo file is read or written.
8673 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008674 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008675 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008676 >= 8 Files for which a group of autocommands is executed.
8677 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008678 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008679 >= 12 Every executed function.
8680 >= 13 When an exception is thrown, caught, finished, or discarded.
8681 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008682 >= 15 Every executed Ex command from a script (truncated at 200
8683 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008684 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008685
8686 This option can also be set with the "-V" argument. See |-V|.
8687 This option is also set by the |:verbose| command.
8688
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008689 When the 'verbosefile' option is set then the verbose messages are not
8690 displayed.
8691
8692 *'verbosefile'* *'vfile'*
8693'verbosefile' 'vfile' string (default empty)
8694 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008695 When not empty all messages are written in a file with this name.
8696 When the file exists messages are appended.
8697 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008698 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008699 Setting 'verbosefile' to a new value is like making it empty first.
8700 The difference with |:redir| is that verbose messages are not
8701 displayed when 'verbosefile' is set.
8702
Bram Moolenaar071d4272004-06-13 20:20:40 +00008703 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008704'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705 "$VIM/vimfiles/view",
8706 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008707 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008708 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008710 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008711 feature}
8712 Name of the directory where to store files for |:mkview|.
8713 This option cannot be set from a |modeline| or in the |sandbox|, for
8714 security reasons.
8715
8716 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008717'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008718 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008719 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008720 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008721 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008722 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008723 word save and restore ~
8724 cursor cursor position in file and in window
8725 folds manually created folds, opened/closed folds and local
8726 fold options
8727 options options and mappings local to a window or buffer (not
8728 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008729 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008730 slash backslashes in file names replaced with forward
8731 slashes
8732 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008733 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008734 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008735
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008736 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008737 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008738 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008739
8740 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008741'viminfo' 'vi' string (Vi default: "", Vim default for
8742 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008743 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8744 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008746 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008747 feature}
8748 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008749 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8750 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008751 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008752 consisting of a single character identifying the particular parameter,
8753 followed by a number or string which specifies the value of that
8754 parameter. If a particular character is left out, then the default
8755 value is used for that parameter. The following is a list of the
8756 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008757 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008758 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008759 ! When included, save and restore global variables that start
8760 with an uppercase letter, and don't contain a lowercase
8761 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008762 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008763 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008764 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008765 " Maximum number of lines saved for each register. Old name of
8766 the '<' item, with the disadvantage that you need to put a
8767 backslash before the ", otherwise it will be recognized as the
8768 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008769 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008770 % When included, save and restore the buffer list. If Vim is
8771 started with a file name argument, the buffer list is not
8772 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008773 buffer list is restored from the viminfo file. Quickfix
8774 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8775 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008776 When followed by a number, the number specifies the maximum
8777 number of buffers that are stored. Without a number all
8778 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008779 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008780 ' Maximum number of previously edited files for which the marks
8781 are remembered. This parameter must always be included when
8782 'viminfo' is non-empty.
8783 Including this item also means that the |jumplist| and the
8784 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008785 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008786 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008787 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008788 patterns are also saved. When not included, the value of
8789 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008790 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008791 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008792 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008793 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008794 < Maximum number of lines saved for each register. If zero then
8795 registers are not saved. When not included, all lines are
8796 saved. '"' is the old name for this item.
8797 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008798 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008799 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008800 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008801 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008802 c When included, convert the text in the viminfo file from the
8803 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008804 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008805 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008806 f Whether file marks need to be stored. If zero, file marks ('0
8807 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008808 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008809 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008810 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008811 h Disable the effect of 'hlsearch' when loading the viminfo
8812 file. When not included, it depends on whether ":nohlsearch"
8813 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008814 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008815 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008816 the 'n'. Must be at the end of the option! If the
8817 'viminfofile' option is set, that file name overrides the one
8818 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008819 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008820 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008821 r Removable media. The argument is a string (up to the next
8822 ','). This parameter can be given several times. Each
8823 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008824 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008825 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8826 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8827 ignored. Maximum length of each 'r' argument is 50
8828 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008829 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008830 s Maximum size of an item in Kbyte. If zero then registers are
8831 not saved. Currently only applies to registers. The default
8832 "s10" will exclude registers with more than 10 Kbyte of text.
8833 Also see the '<' item above: line count limit.
8834
8835 Example: >
8836 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8837<
8838 '50 Marks will be remembered for the last 50 files you
8839 edited.
8840 <1000 Contents of registers (up to 1000 lines each) will be
8841 remembered.
8842 s100 Registers with more than 100 Kbyte text are skipped.
8843 :0 Command-line history will not be saved.
8844 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8845 no / Since '/' is not specified, the default will be used,
8846 that is, save all of the search history, and also the
8847 previous search and substitute patterns.
8848 no % The buffer list will not be saved nor read back.
8849 no h 'hlsearch' highlighting will be restored.
8850
8851 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8852 load the contents of the file, this is not done automatically.
8853
8854 This option cannot be set from a |modeline| or in the |sandbox|, for
8855 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008856 NOTE: This option is set to the Vim default value when 'compatible'
8857 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008858
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008859 *'viminfofile'* *'vif'*
8860'viminfofile' 'vif' string (default: "")
8861 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008862 {not available when compiled without the |+viminfo|
8863 feature}
8864 When non-empty, overrides the file name used for viminfo.
8865 When equal to "NONE" no viminfo file will be read or written.
8866 This option can be set with the |-i| command line flag. The |--clean|
8867 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008868 This option cannot be set from a |modeline| or in the |sandbox|, for
8869 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008870
Bram Moolenaar071d4272004-06-13 20:20:40 +00008871 *'virtualedit'* *'ve'*
8872'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008873 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008874 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008875 block Allow virtual editing in Visual block mode.
8876 insert Allow virtual editing in Insert mode.
8877 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008878 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008879 none When used as the local value, do not allow virtual
8880 editing even when the global value is set. When used
8881 as the global value, "none" is the same as "".
8882 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008883
Bram Moolenaar071d4272004-06-13 20:20:40 +00008884 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008885 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886 of the line. Useful for selecting a rectangle in Visual mode and
8887 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008888 "onemore" is not the same, it will only allow moving the cursor just
8889 after the last character of the line. This makes some commands more
8890 consistent. Previously the cursor was always past the end of the line
8891 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008892 break some plugins or Vim scripts. For example because |l| can move
8893 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008894 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008895 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008896 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008897 It doesn't make sense to combine "all" with "onemore", but you will
8898 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008899 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008900 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008901
8902 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8903'visualbell' 'vb' boolean (default off)
8904 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008905 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008906 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008907 use: >
8908 :set vb t_vb=
8909< If you want a short flash, you can use this on many terminals: >
8910 :set vb t_vb=[?5h$<100>[?5l
8911< Here $<100> specifies the time, you can use a smaller or bigger value
8912 to get a shorter or longer flash.
8913
8914 Note: Vim will limit the bell to once per half a second. This avoids
8915 having to wait for the flashing to finish when there are lots of
8916 bells, e.g. on key repeat. This also happens without 'visualbell'
8917 set.
8918
Bram Moolenaar071d4272004-06-13 20:20:40 +00008919 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8920 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8921 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008922
8923 Note: When the GUI starts, 't_vb' is reset to its default value. You
8924 might want to set it again in your |gvimrc|.
8925
Bram Moolenaar071d4272004-06-13 20:20:40 +00008926 Does not work on the Amiga, you always get a screen flash.
8927 Also see 'errorbells'.
8928
8929 *'warn'* *'nowarn'*
8930'warn' boolean (default on)
8931 global
8932 Give a warning message when a shell command is used while the buffer
8933 has been changed.
8934
8935 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8936'weirdinvert' 'wiv' boolean (default off)
8937 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008938 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008939 It is provided for backwards compatibility with version 4.x.
8940 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8941 vice versa. Has no effect when the GUI is running.
8942
8943 *'whichwrap'* *'ww'*
8944'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8945 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946 Allow specified keys that move the cursor left/right to move to the
8947 previous/next line when the cursor is on the first/last character in
8948 the line. Concatenate characters to allow this for these keys:
8949 char key mode ~
8950 b <BS> Normal and Visual
8951 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008952 h "h" Normal and Visual (not recommended)
8953 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008954 < <Left> Normal and Visual
8955 > <Right> Normal and Visual
8956 ~ "~" Normal
8957 [ <Left> Insert and Replace
8958 ] <Right> Insert and Replace
8959 For example: >
8960 :set ww=<,>,[,]
8961< allows wrap only when cursor keys are used.
8962 When the movement keys are used in combination with a delete or change
8963 operator, the <EOL> also counts for a character. This makes "3h"
8964 different from "3dh" when the cursor crosses the end of a line. This
8965 is also true for "x" and "X", because they do the same as "dl" and
8966 "dh". If you use this, you may also want to use the mapping
8967 ":map <BS> X" to make backspace delete the character in front of the
8968 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008969 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008970 line (not an empty line) then it will not move to the next line. This
8971 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008972 NOTE: This option is set to the Vi default value when 'compatible' is
8973 set and to the Vim default value when 'compatible' is reset.
8974
8975 *'wildchar'* *'wc'*
8976'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8977 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008978 Character you have to type to start wildcard expansion in the
8979 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008980 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008981 The character is not recognized when used inside a macro. See
8982 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008983 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008984 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008985 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008986< NOTE: This option is set to the Vi default value when 'compatible' is
8987 set and to the Vim default value when 'compatible' is reset.
8988
8989 *'wildcharm'* *'wcm'*
8990'wildcharm' 'wcm' number (default: none (0))
8991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008992 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008993 recognized when used inside a macro. You can find "spare" command-line
8994 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008995 you'll never actually type 'wildcharm', just use it in mappings that
8996 automatically invoke completion mode, e.g.: >
8997 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008998 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008999< Then after typing :ss you can use CTRL-P & CTRL-N.
9000
9001 *'wildignore'* *'wig'*
9002'wildignore' 'wig' string (default "")
9003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009004 {not available when compiled without the |+wildignore|
9005 feature}
9006 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009007 patterns is ignored when expanding |wildcards|, completing file or
9008 directory names, and influences the result of |expand()|, |glob()| and
9009 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009010 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9011 Also see 'suffixes'.
9012 Example: >
9013 :set wildignore=*.o,*.obj
9014< The use of |:set+=| and |:set-=| is preferred when adding or removing
9015 a pattern from the list. This avoids problems when a future version
9016 uses another default.
9017
Bram Moolenaar94950a92010-12-02 16:01:29 +01009018
Bram Moolenaar81af9252010-12-10 20:35:50 +01009019 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009020'wildignorecase' 'wic' boolean (default off)
9021 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009022 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009023 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009024 Does not apply when the shell is used to expand wildcards, which
9025 happens when there are special characters.
9026
9027
Bram Moolenaar071d4272004-06-13 20:20:40 +00009028 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009029'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009031 {not available if compiled without the |+wildmenu|
9032 feature}
9033 When 'wildmenu' is on, command-line completion operates in an enhanced
9034 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
9035 the possible matches are shown just above the command line, with the
9036 first match highlighted (overwriting the status line, if there is
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009037 one). This is the behavior without "pum" in 'wildoptions'.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009038 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009039 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9040 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9041 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009042 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009043 If there are more matches than can fit in the line, a ">" is shown on
9044 the right and/or a "<" is shown on the left. The status line scrolls
9045 as needed.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009046 When 'wildoptions' contains "pum", then the completion matches are
9047 shown in a popup menu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009048 The "wildmenu" mode is abandoned when a key is hit that is not used
9049 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009050 While the "wildmenu" is active, not using the popup menu, the
9051 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009052
9053 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9054 <Down> - in filename/menu name completion: move into a
9055 subdirectory or submenu.
9056 <CR> - in menu completion, when the cursor is just after a
9057 dot: move into a submenu.
9058 <Up> - in filename/menu name completion: move up into
9059 parent directory or parent menu.
9060
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009061 When using the popup menu for command line completion, the following
9062 keys have special meanings:
9063 <Down> - select next match (like CTRL-N)
9064 <Left> - in filename/menu name completion: move up into
9065 parent directory or parent menu.
9066 <Right> - in filename/menu name completion: move into a
9067 subdirectory or submenu.
9068 <Up> - select previous match (like CTRL-P)
9069 CTRL-E - end completion, go back to what was there before
9070 selecting a match.
9071 CTRL-N - go to the next entry
9072 CTRL-P - go to the previous entry
9073 CTRL-Y - accept the currently selected match and stop
9074 completion.
9075
Bram Moolenaar071d4272004-06-13 20:20:40 +00009076 This makes the menus accessible from the console |console-menus|.
9077
9078 If you prefer the <Left> and <Right> keys to move the cursor instead
9079 of selecting a different match, use this: >
9080 :cnoremap <Left> <Space><BS><Left>
9081 :cnoremap <Right> <Space><BS><Right>
9082<
9083 The "WildMenu" highlighting is used for displaying the current match
9084 |hl-WildMenu|.
9085
9086 *'wildmode'* *'wim'*
9087'wildmode' 'wim' string (Vim default: "full")
9088 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009089 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009090 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009091 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009092 first part specifies the behavior for the first use of 'wildchar',
9093 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009094
9095 Each part consists of a colon separated list consisting of the
9096 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009097 "" Complete only the first match.
9098 "full" Complete the next full match. After the last match,
9099 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009100 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009101 "longest" Complete till longest common string. If this doesn't
9102 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009103 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009104 "lastused" When completing buffer names and more than one buffer
9105 matches, sort buffers by time last used (other than
9106 the current buffer).
9107 When there is only a single match, it is fully completed in all cases.
9108
9109 Examples of useful colon-separated values:
9110 "longest:full" Like "longest", but also start 'wildmenu' if it is
9111 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009112 "list:full" When more than one match, list all matches and
9113 complete first match.
9114 "list:longest" When more than one match, list all matches and
9115 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009116 "list:lastused" When more than one buffer matches, list all matches
9117 and sort buffers by time last used (other than the
9118 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009119
9120 Examples: >
9121 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009122< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009123 :set wildmode=longest,full
9124< Complete longest common string, then each full match >
9125 :set wildmode=list:full
9126< List all matches and complete each full match >
9127 :set wildmode=list,full
9128< List all matches without completing, then each full match >
9129 :set wildmode=longest,list
9130< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009131 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009132
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009133 *'wildoptions'* *'wop'*
9134'wildoptions' 'wop' string (default "")
9135 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009136 {not available when compiled without the |+wildignore|
9137 feature}
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009138 A list of words that change how |cmdline-completion| is done.
9139 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009140 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009141 this value is specified, wildcard expansion will not
9142 be used for completion. The matches will be sorted by
9143 the "best match" rather than alphabetically sorted.
9144 This will find more matches than the wildcard
9145 expansion. Currently fuzzy matching based completion
9146 is not supported for file and directory names and
9147 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009148 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009149 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009150 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009151 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009152 is displayed per line. Often used tag kinds are:
9153 d #define
9154 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009155
Bram Moolenaar071d4272004-06-13 20:20:40 +00009156 *'winaltkeys'* *'wak'*
9157'winaltkeys' 'wak' string (default "menu")
9158 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009159 {only used in Win32, Motif, GTK and Photon GUI}
9160 Some GUI versions allow the access to menu entries by using the ALT
9161 key in combination with a character that appears underlined in the
9162 menu. This conflicts with the use of the ALT key for mappings and
9163 entering special characters. This option tells what to do:
9164 no Don't use ALT keys for menus. ALT key combinations can be
9165 mapped, but there is no automatic handling. This can then be
9166 done with the |:simalt| command.
9167 yes ALT key handling is done by the windowing system. ALT key
9168 combinations cannot be mapped.
9169 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009170 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009171 keys can be mapped.
9172 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9173 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009174 This option is not used for <F10>; on Win32 and with GTK <F10> will
9175 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009176
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009177 *'wincolor'* *'wcr'*
9178'wincolor' 'wcr' string (default empty)
9179 local to window
9180 Highlight group name to use for this window instead of the Normal
9181 color |hl-Normal|.
9182
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009183 *'window'* *'wi'*
9184'window' 'wi' number (default screen height - 1)
9185 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009186 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9187 window and the value is smaller than 'lines' minus one. The screen
9188 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009189 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9190 in a much smarter way, taking care of wrapping lines.
9191 When resizing the Vim window, the value is smaller than 1 or more than
9192 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009193 Note: Do not confuse this with the height of the Vim window, use
9194 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009195
Bram Moolenaar071d4272004-06-13 20:20:40 +00009196 *'winheight'* *'wh'* *E591*
9197'winheight' 'wh' number (default 1)
9198 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009199 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009200 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009201 focus goes to a window that is smaller, its size is increased, at the
9202 cost of the height of other windows.
9203 Set 'winheight' to a small number for normal editing.
9204 Set it to 999 to make the current window fill most of the screen.
9205 Other windows will be only 'winminheight' high. This has the drawback
9206 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9207 to create only two windows, set the option after startup is done,
9208 using the |VimEnter| event: >
9209 au VimEnter * set winheight=999
9210< Minimum value is 1.
9211 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009212 height of the current window.
9213 'winheight' applies to the current window. Use 'winminheight' to set
9214 the minimal height for other windows.
9215
9216 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9217'winfixheight' 'wfh' boolean (default off)
9218 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009219 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009220 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9221 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009222 The height may be changed anyway when running out of room.
9223
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009224 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9225'winfixwidth' 'wfw' boolean (default off)
9226 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009227 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009228 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009229 The width may be changed anyway when running out of room.
9230
Bram Moolenaar071d4272004-06-13 20:20:40 +00009231 *'winminheight'* *'wmh'*
9232'winminheight' 'wmh' number (default 1)
9233 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009234 The minimal height of a window, when it's not the current window.
9235 This is a hard minimum, windows will never become smaller.
9236 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9237 status bar) if necessary. They will return to at least one line when
9238 they become active (since the cursor has to have somewhere to go.)
9239 Use 'winheight' to set the minimal height of the current window.
9240 This option is only checked when making a window smaller. Don't use a
9241 large number, it will cause errors when opening more than a few
9242 windows. A value of 0 to 3 is reasonable.
9243
9244 *'winminwidth'* *'wmw'*
9245'winminwidth' 'wmw' number (default 1)
9246 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009247 The minimal width of a window, when it's not the current window.
9248 This is a hard minimum, windows will never become smaller.
9249 When set to zero, windows may be "squashed" to zero columns (i.e. just
9250 a vertical separator) if necessary. They will return to at least one
9251 line when they become active (since the cursor has to have somewhere
9252 to go.)
9253 Use 'winwidth' to set the minimal width of the current window.
9254 This option is only checked when making a window smaller. Don't use a
9255 large number, it will cause errors when opening more than a few
9256 windows. A value of 0 to 12 is reasonable.
9257
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009258 *'winptydll'*
9259'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9260 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009261 {only available when compiled with the |terminal|
9262 feature on MS-Windows}
9263 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009264 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009265 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009266 a fallback.
9267 Environment variables are expanded |:set_env|.
9268 This option cannot be set from a |modeline| or in the |sandbox|, for
9269 security reasons.
9270
Bram Moolenaar071d4272004-06-13 20:20:40 +00009271 *'winwidth'* *'wiw'* *E592*
9272'winwidth' 'wiw' number (default 20)
9273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009274 Minimal number of columns for the current window. This is not a hard
9275 minimum, Vim will use fewer columns if there is not enough room. If
9276 the current window is smaller, its size is increased, at the cost of
9277 the width of other windows. Set it to 999 to make the current window
9278 always fill the screen. Set it to a small number for normal editing.
9279 The width is not adjusted after one of the commands to change the
9280 width of the current window.
9281 'winwidth' applies to the current window. Use 'winminwidth' to set
9282 the minimal width for other windows.
9283
9284 *'wrap'* *'nowrap'*
9285'wrap' boolean (default on)
9286 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009287 This option changes how text is displayed. It doesn't change the text
9288 in the buffer, see 'textwidth' for that.
9289 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009290 displaying continues on the next line. When off lines will not wrap
9291 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009292 moved to a part that is not shown, the screen will scroll
9293 horizontally.
9294 The line will be broken in the middle of a word if necessary. See
9295 'linebreak' to get the break at a word boundary.
9296 To make scrolling horizontally a bit more useful, try this: >
9297 :set sidescroll=5
9298 :set listchars+=precedes:<,extends:>
9299< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009300 This option can't be set from a |modeline| when the 'diff' option is
9301 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009302
9303 *'wrapmargin'* *'wm'*
9304'wrapmargin' 'wm' number (default 0)
9305 local to buffer
9306 Number of characters from the right window border where wrapping
9307 starts. When typing text beyond this limit, an <EOL> will be inserted
9308 and inserting continues on the next line.
9309 Options that add a margin, such as 'number' and 'foldcolumn', cause
9310 the text width to be further reduced. This is Vi compatible.
9311 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009312 This option is set to 0 when 'paste' is set and restored when 'paste'
9313 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009314 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009315
9316 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9317'wrapscan' 'ws' boolean (default on) *E384* *E385*
9318 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009319 Searches wrap around the end of the file. Also applies to |]s| and
9320 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009321
9322 *'write'* *'nowrite'*
9323'write' boolean (default on)
9324 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009325 Allows writing files. When not set, writing a file is not allowed.
9326 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009327 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009328 argument. Filtering text is still possible, even though this requires
9329 writing a temporary file.
9330
9331 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9332'writeany' 'wa' boolean (default off)
9333 global
9334 Allows writing to any file with no need for "!" override.
9335
9336 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9337'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9338 otherwise)
9339 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009340 Make a backup before overwriting a file. The backup is removed after
9341 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009342 also on.
9343 WARNING: Switching this option off means that when Vim fails to write
9344 your buffer correctly and then, for whatever reason, Vim exits, you
9345 lose both the original file and what you were writing. Only reset
9346 this option if your file system is almost full and it makes the write
9347 fail (and make sure not to exit Vim until the write was successful).
9348 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009349 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009350 Depending on 'backupcopy' the backup is a new file or the original
9351 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009352 NOTE: This option is set to the default value when 'compatible' is
9353 set.
9354
9355 *'writedelay'* *'wd'*
9356'writedelay' 'wd' number (default 0)
9357 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009358 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009359 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009360 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009361
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009362 *'xtermcodes'* *'noxtermcodes'*
9363'xtermcodes' boolean (default on)
9364 global
9365 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009366 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009367 key codes and number of colors from the terminal. This takes care of
9368 various configuration options of the terminal that cannot be obtained
9369 from the termlib/terminfo entry, see |xterm-codes|.
9370 A side effect may be that t_Co changes and Vim will redraw the
9371 display.
9372
9373
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009374 vim:tw=78:ts=8:noet:ft=help:norl: