blob: 1d14c44333746b4a11b30027a05383fb98cc6334 [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
1680 after that. Therefore do append an item with += but use ^= to
1681 prepend, e.g.: >
1682 set clipboard^=unnamed
1683< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001684
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001685 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 unnamed When included, Vim will use the clipboard register '*'
1687 for all yank, delete, change and put operations which
1688 would normally go to the unnamed register. When a
1689 register is explicitly specified, it will always be
1690 used regardless of whether "unnamed" is in 'clipboard'
1691 or not. The clipboard register can always be
1692 explicitly accessed using the "* notation. Also see
1693 |gui-clipboard|.
1694
Bram Moolenaar30b65812012-07-12 22:01:11 +02001695 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001696 unnamedplus A variant of the "unnamed" flag which uses the
1697 clipboard register '+' (|quoteplus|) instead of
1698 register '*' for all yank, delete, change and put
1699 operations which would normally go to the unnamed
1700 register. When "unnamed" is also included to the
1701 option, yank operations (but not delete, change or
1702 put) will additionally copy the text into register
1703 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001704 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001705 Availability can be checked with: >
1706 if has('unnamedplus')
1707<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001708 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 autoselect Works like the 'a' flag in 'guioptions': If present,
1710 then whenever Visual mode is started, or the Visual
1711 area extended, Vim tries to become the owner of the
1712 windowing system's global selection or put the
1713 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001714 register "*. See |'go-a'| and |quotestar| for details.
1715 When the GUI is active, the 'a' flag in 'guioptions'
1716 is used, when the GUI is not active, this "autoselect"
1717 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718 Also applies to the modeless selection.
1719
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001720 *clipboard-autoselectplus*
1721 autoselectplus Like "autoselect" but using the + register instead of
1722 the * register. Compare to the 'P' flag in
1723 'guioptions'.
1724
1725 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726 autoselectml Like "autoselect", but for the modeless selection
1727 only. Compare to the 'A' flag in 'guioptions'.
1728
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001729 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001730 html When the clipboard contains HTML, use this when
1731 pasting. When putting text on the clipboard, mark it
1732 as HTML. This works to copy rendered HTML from
1733 Firefox, paste it as raw HTML in Vim, select the HTML
1734 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001735 You probably want to add this only temporarily,
1736 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001737 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001738
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001739 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740 exclude:{pattern}
1741 Defines a pattern that is matched against the name of
1742 the terminal 'term'. If there is a match, no
1743 connection will be made to the X server. This is
1744 useful in this situation:
1745 - Running Vim in a console.
1746 - $DISPLAY is set to start applications on another
1747 display.
1748 - You do not want to connect to the X server in the
1749 console, but do want this in a terminal emulator.
1750 To never connect to the X server use: >
1751 exclude:.*
1752< This has the same effect as using the |-X| argument.
1753 Note that when there is no connection to the X server
1754 the window title won't be restored and the clipboard
1755 cannot be accessed.
1756 The value of 'magic' is ignored, {pattern} is
1757 interpreted as if 'magic' was on.
1758 The rest of the option value will be used for
1759 {pattern}, this must be the last entry.
1760
1761 *'cmdheight'* *'ch'*
1762'cmdheight' 'ch' number (default 1)
1763 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764 Number of screen lines to use for the command-line. Helps avoiding
1765 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001766 The value of this option is stored with the tab page, so that each tab
1767 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768
1769 *'cmdwinheight'* *'cwh'*
1770'cmdwinheight' 'cwh' number (default 7)
1771 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 Number of screen lines to use for the command-line window. |cmdwin|
1773
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001774 *'colorcolumn'* *'cc'*
1775'colorcolumn' 'cc' string (default "")
1776 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001777 {not available when compiled without the |+syntax|
1778 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001779 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001780 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1781 text. Will make screen redrawing slower.
1782 The screen column can be an absolute number, or a number preceded with
1783 '+' or '-', which is added to or subtracted from 'textwidth'. >
1784
1785 :set cc=+1 " highlight column after 'textwidth'
1786 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1787 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1788<
1789 When 'textwidth' is zero then the items with '-' and '+' are not used.
1790 A maximum of 256 columns are highlighted.
1791
Bram Moolenaar071d4272004-06-13 20:20:40 +00001792 *'columns'* *'co'* *E594*
1793'columns' 'co' number (default 80 or terminal width)
1794 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001795 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001796 initialization and does not have to be set by hand. Also see
1797 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 When Vim is running in the GUI or in a resizable window, setting this
1799 option will cause the window size to be changed. When you only want
1800 to use the size for the GUI, put the command in your |gvimrc| file.
1801 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001802 number of columns of the display, the display may be messed up. For
1803 the GUI it is always possible and Vim limits the number of columns to
1804 what fits on the screen. You can use this command to get the widest
1805 window possible: >
1806 :set columns=9999
1807< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808
1809 *'comments'* *'com'* *E524* *E525*
1810'comments' 'com' string (default
1811 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1812 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001813 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814 |format-comments|. See |option-backslash| about using backslashes to
1815 insert a space.
1816
1817 *'commentstring'* *'cms'* *E537*
1818'commentstring' 'cms' string (default "/*%s*/")
1819 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820 {not available when compiled without the |+folding|
1821 feature}
1822 A template for a comment. The "%s" in the value is replaced with the
1823 comment text. Currently only used to add markers for folding, see
1824 |fold-marker|.
1825
1826 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001827'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001828 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 This option has the effect of making Vim either more Vi-compatible, or
1831 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001832
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001834 other options are also changed as a side effect.
1835 NOTE: Setting or resetting this option can have a lot of unexpected
1836 effects: Mappings are interpreted in another way, undo behaves
1837 differently, etc. If you set this option in your vimrc file, you
1838 should probably put it at the very start.
1839
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 By default this option is on and the Vi defaults are used for the
1841 options. This default was chosen for those people who want to use Vim
1842 just like Vi, and don't even (want to) know about the 'compatible'
1843 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001844 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001845 this option is switched off, and all options that have not been
1846 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001847 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001848 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001849 happen for the system-wide vimrc or gvimrc file, nor for a file given
1850 with the |-u| argument). Also see |compatible-default| and
1851 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852 You can also set this option with the "-C" argument, and reset it with
1853 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001854 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855
Bram Moolenaar214641f2017-03-05 17:04:09 +01001856 When this option is set, numerous other options are set to make Vim as
1857 Vi-compatible as possible. When this option is unset, various options
1858 are set to make Vim more useful. The table below lists all the
1859 options affected.
1860 The {?} column indicates when the options are affected:
1861 + Means that the option is set to the value given in {set value} when
1862 'compatible' is set.
1863 & Means that the option is set to the value given in {set value} when
1864 'compatible' is set AND is set to its Vim default value when
1865 'compatible' is unset.
1866 - Means the option is NOT changed when setting 'compatible' but IS
1867 set to its Vim default when 'compatible' is unset.
1868 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869
Bram Moolenaar036986f2017-03-16 17:41:02 +01001870 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001871
1872 'allowrevins' + off no CTRL-_ command
1873 'antialias' + off don't use antialiased fonts
1874 'arabic' + off reset arabic-related options
1875 'arabicshape' + on correct character shapes
1876 'backspace' + "" normal backspace
1877 'backup' + off no backup file
1878 'backupcopy' & Unix: "yes" backup file is a copy
1879 else: "auto" copy or rename backup file
1880 'balloonexpr' + "" text to show in evaluation balloon
1881 'breakindent' + off don't indent when wrapping lines
1882 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001883 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001884 'cindent' + off no C code indentation
1885 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1886 'copyindent' + off don't copy indent structure
1887 'cpoptions' & (all flags) Vi-compatible flags
1888 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001889 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001890 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001891 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001892 'cscopeverbose' + off see |cscopeverbose|
1893 'delcombine' + off unicode: delete whole char combination
1894 'digraph' + off no digraphs
1895 'esckeys' & off no <Esc>-keys in Insert mode
1896 'expandtab' + off tabs not expanded to spaces
1897 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001898 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001899 'formatexpr' + "" use 'formatprg' for auto-formatting
1900 'formatoptions' & "vt" Vi compatible formatting
1901 'gdefault' + off no default 'g' flag for ":s"
1902 'history' & 0 no commandline history
1903 'hkmap' + off no Hebrew keyboard mapping
1904 'hkmapp' + off no phonetic Hebrew keyboard mapping
1905 'hlsearch' + off no highlighting of search matches
1906 'incsearch' + off no incremental searching
1907 'indentexpr' + "" no indenting by expression
1908 'insertmode' + off do not start in Insert mode
1909 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001910 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001911 'joinspaces' + on insert 2 spaces after period
1912 'modeline' & off no modelines
1913 'more' & off no pauses in listings
1914 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1915 'numberwidth' & 8 min number of columns for line number
1916 'preserveindent'+ off don't preserve current indent structure
1917 when changing it
1918 'revins' + off no reverse insert
1919 'ruler' + off no ruler
1920 'scrolljump' + 1 no jump scroll
1921 'scrolloff' + 0 no scroll offset
1922 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1923 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001924 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001925 'showcmd' & off command characters not shown
1926 'showmode' & off current mode not shown
1927 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1928 'smartcase' + off no automatic ignore case switch
1929 'smartindent' + off no smart indentation
1930 'smarttab' + off no smart tab size
1931 'softtabstop' + 0 tabs are always 'tabstop' positions
1932 'startofline' + on goto startofline with some commands
1933 'tagcase' & "followic" 'ignorecase' when searching tags file
1934 'tagrelative' & off tag file names are not relative
1935 'termguicolors' + off don't use highlight-(guifg|guibg)
1936 'textauto' & off no automatic textmode detection
1937 'textwidth' + 0 no automatic line wrap
1938 'tildeop' + off tilde is not an operator
1939 'ttimeout' + off no terminal timeout
1940 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001941 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001942 'virtualedit' + "" cursor can only be placed on characters
1943 'whichwrap' & "" left-right movements don't wrap
1944 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001945 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001946 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001947
1948 *'complete'* *'cpt'* *E535*
1949'complete' 'cpt' string (default: ".,w,b,u,t,i")
1950 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951 This option specifies how keyword completion |ins-completion| works
1952 when CTRL-P or CTRL-N are used. It is also used for whole-line
1953 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001954 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001955 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956 w scan buffers from other windows
1957 b scan other loaded buffers that are in the buffer list
1958 u scan the unloaded buffers that are in the buffer list
1959 U scan the buffers that are not in the buffer list
1960 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001961 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962 k{dict} scan the file {dict}. Several "k" flags can be given,
1963 patterns are valid too. For example: >
1964 :set cpt=k/usr/dict/*,k~/spanish
1965< s scan the files given with the 'thesaurus' option
1966 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1967 are valid too.
1968 i scan current and included files
1969 d scan current and included files for defined name or macro
1970 |i_CTRL-X_CTRL-D|
1971 ] tag completion
1972 t same as "]"
1973
1974 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1975 not executed, this may lead to unexpected completions from some files
1976 (gzipped files for example). Unloaded buffers are not scanned for
1977 whole-line completion.
1978
1979 The default is ".,w,b,u,t,i", which means to scan:
1980 1. the current buffer
1981 2. buffers in other windows
1982 3. other loaded buffers
1983 4. unloaded buffers
1984 5. tags
1985 6. included files
1986
1987 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001988 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1989 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001991 *'completefunc'* *'cfu'*
1992'completefunc' 'cfu' string (default: empty)
1993 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001994 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001995 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001996 This option specifies a function to be used for Insert mode completion
1997 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001998 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00001999 invoked and what it should return. The value can be the name of a
2000 function, a |lambda| or a |Funcref|. See |option-value-function| for
2001 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002002 This option cannot be set from a |modeline| or in the |sandbox|, for
2003 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002004
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002005 *'completeslash'* *'csl'*
2006'completeslash' 'csl' string (default: "")
2007 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002008 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002009 When this option is set it overrules 'shellslash' for completion:
2010 - When this option is set to "slash", a forward slash is used for path
2011 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002012 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002013 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002014 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002015 - When this option is empty, same character is used as for
2016 'shellslash'.
2017 For Insert mode completion the buffer-local value is used. For
2018 command line completion the global value is used.
2019
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002020 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002021'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002022 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002023 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002024 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002025
2026 menu Use a popup menu to show the possible completions. The
2027 menu is only shown when there is more than one match and
2028 sufficient colors are available. |ins-completion-menu|
2029
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002030 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002031 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002032 match, e.g., what file it comes from.
2033
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002034 longest Only insert the longest common text of the matches. If
2035 the menu is displayed you can use CTRL-L to add more
2036 characters. Whether case is ignored depends on the kind
2037 of completion. For buffer text the 'ignorecase' option is
2038 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002039
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002040 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002041 completion in the preview window. Only works in
2042 combination with "menu" or "menuone".
2043
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002044 popup Show extra information about the currently selected
2045 completion in a popup window. Only works in combination
2046 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002047 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002048 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002049
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002050 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002051 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002052 |CompleteChanged| autocommand to fetch the info and call
2053 |popup_show()| once the popup has been filled.
2054 See the example at |complete-popuphidden|.
2055 {only works when compiled with the |+textprop| feature}
2056
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002057 noinsert Do not insert any text for a match until the user selects
2058 a match from the menu. Only works in combination with
2059 "menu" or "menuone". No effect if "longest" is present.
2060
2061 noselect Do not select a match in the menu, force the user to
2062 select one from the menu. Only works in combination with
2063 "menu" or "menuone".
2064
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002065
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002066 *'completepopup'* *'cpp'*
2067'completepopup' 'cpp' string (default empty)
2068 global
2069 {not available when compiled without the |+textprop|
2070 or |+quickfix| feature}
2071 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002072 properties of the info popup when it is created. If an info popup
2073 window already exists it is closed, so that the option value is
2074 applied when it is created again.
2075 You can also use |popup_findinfo()| and then set properties for an
2076 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002077
2078
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002079 *'concealcursor'* *'cocu'*
2080'concealcursor' 'cocu' string (default: "")
2081 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002082 {not available when compiled without the |+conceal|
2083 feature}
2084 Sets the modes in which text in the cursor line can also be concealed.
2085 When the current mode is listed then concealing happens just like in
2086 other lines.
2087 n Normal mode
2088 v Visual mode
2089 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002090 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002091
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002092 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002093 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002094 are moving around text is concealed, but when starting to insert text
2095 or selecting a Visual area the concealed text is displayed, so that
2096 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002097 Keep in mind that the cursor position is not always where it's
2098 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002099
2100
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002101 *'conceallevel'* *'cole'*
2102'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002103 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002104 {not available when compiled without the |+conceal|
2105 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002106 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2107 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002108
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002109 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002110 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002111 1 Each block of concealed text is replaced with one
2112 character. If the syntax item does not have a custom
2113 replacement character defined (see |:syn-cchar|) the
2114 character defined in 'listchars' is used (default is a
2115 space).
2116 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002117 2 Concealed text is completely hidden unless it has a
2118 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002119 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002120 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002121
Bram Moolenaara7781e02010-07-19 20:13:22 +02002122 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002123 edit and copy the text. This can be changed with the 'concealcursor'
2124 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002125
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2127'confirm' 'cf' boolean (default off)
2128 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129 When 'confirm' is on, certain operations that would normally
2130 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2131 instead raise a |dialog| asking if you wish to save the current
2132 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2133 If 'confirm' is off you can still activate confirmation for one
2134 command only (this is most useful in mappings) with the |:confirm|
2135 command.
2136 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2137
2138 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2139'conskey' 'consk' boolean (default off)
2140 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002141 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142
2143 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2144'copyindent' 'ci' boolean (default off)
2145 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146 Copy the structure of the existing lines indent when autoindenting a
2147 new line. Normally the new indent is reconstructed by a series of
2148 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2149 in which case only spaces are used). Enabling this option makes the
2150 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002151 existing line. 'expandtab' has no effect on these characters, a Tab
2152 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002154 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 Also see 'preserveindent'.
2156
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002157 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158'cpoptions' 'cpo' string (Vim default: "aABceFs",
2159 Vi default: all flags)
2160 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002162 this indicates Vi-compatible behavior. This is used for things where
2163 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 'cpoptions' stands for "compatible-options".
2165 Commas can be added for readability.
2166 To avoid problems with flags that are added in the future, use the
2167 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002168
Bram Moolenaar071d4272004-06-13 20:20:40 +00002169 NOTE: This option is set to the Vi default value when 'compatible' is
2170 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002171
2172 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2173 is saved, 'cpoptions' is set to the Vim default, and the saved value
2174 is restored at the end of the script. Changes to the value of
2175 'cpoptions' will be applied to the saved value, but keep in mind that
2176 removing a flag that is not present when 'cpoptions' is changed has no
2177 effect. In the |.vimrc| file the value is not restored, thus using
2178 `vim9script` in the |.vimrc| file results in using the Vim default.
2179
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002180 NOTE: This option is set to the POSIX default value at startup when
2181 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002182 variable exists |posix|. This means Vim tries to behave like the
2183 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184
2185 contains behavior ~
2186 *cpo-a*
2187 a When included, a ":read" command with a file name
2188 argument will set the alternate file name for the
2189 current window.
2190 *cpo-A*
2191 A When included, a ":write" command with a file name
2192 argument will set the alternate file name for the
2193 current window.
2194 *cpo-b*
2195 b "\|" in a ":map" command is recognized as the end of
2196 the map command. The '\' is included in the mapping,
2197 the text after the '|' is interpreted as the next
2198 command. Use a CTRL-V instead of a backslash to
2199 include the '|' in the mapping. Applies to all
2200 mapping, abbreviation, menu and autocmd commands.
2201 See also |map_bar|.
2202 *cpo-B*
2203 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002204 abbreviations, user commands and the "to" part of the
2205 menu commands. Remove this flag to be able to use a
2206 backslash like a CTRL-V. For example, the command
2207 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208 'B' included: "\^[" (^[ is a real <Esc>)
2209 'B' excluded: "<Esc>" (5 characters)
2210 ('<' excluded in both cases)
2211 *cpo-c*
2212 c Searching continues at the end of any match at the
2213 cursor position, but not further than the start of the
2214 next line. When not present searching continues
2215 one character from the cursor position. With 'c'
2216 "abababababab" only gets three matches when repeating
2217 "/abab", without 'c' there are five matches.
2218 *cpo-C*
2219 C Do not concatenate sourced lines that start with a
2220 backslash. See |line-continuation|.
2221 *cpo-d*
2222 d Using "./" in the 'tags' option doesn't mean to use
2223 the tags file relative to the current file, but the
2224 tags file in the current directory.
2225 *cpo-D*
2226 D Can't use CTRL-K to enter a digraph after Normal mode
2227 commands with a character argument, like |r|, |f| and
2228 |t|.
2229 *cpo-e*
2230 e When executing a register with ":@r", always add a
2231 <CR> to the last line, also when the register is not
2232 linewise. If this flag is not present, the register
2233 is not linewise and the last line does not end in a
2234 <CR>, then the last line is put on the command-line
2235 and can be edited before hitting <CR>.
2236 *cpo-E*
2237 E It is an error when using "y", "d", "c", "g~", "gu" or
2238 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002239 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 This makes "y0" fail in the first column.
2241 *cpo-f*
2242 f When included, a ":read" command with a file name
2243 argument will set the file name for the current buffer,
2244 if the current buffer doesn't have a file name yet.
2245 *cpo-F*
2246 F When included, a ":write" command with a file name
2247 argument will set the file name for the current
2248 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002249 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250 *cpo-g*
2251 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002252 *cpo-H*
2253 H When using "I" on a line with only blanks, insert
2254 before the last blank. Without this flag insert after
2255 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256 *cpo-i*
2257 i When included, interrupting the reading of a file will
2258 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002259 *cpo-I*
2260 I When moving the cursor up or down just after inserting
2261 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262 *cpo-j*
2263 j When joining lines, only add two spaces after a '.',
2264 not after '!' or '?'. Also see 'joinspaces'.
2265 *cpo-J*
2266 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002267 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 white space.
2269 *cpo-k*
2270 k Disable the recognition of raw key codes in
2271 mappings, abbreviations, and the "to" part of menu
2272 commands. For example, if <Key> sends ^[OA (where ^[
2273 is <Esc>), the command ":map X ^[OA" results in X
2274 being mapped to:
2275 'k' included: "^[OA" (3 characters)
2276 'k' excluded: "<Key>" (one key code)
2277 Also see the '<' flag below.
2278 *cpo-K*
2279 K Don't wait for a key code to complete when it is
2280 halfway a mapping. This breaks mapping <F1><F1> when
2281 only part of the second <F1> has been read. It
2282 enables cancelling the mapping by typing <F1><Esc>.
2283 *cpo-l*
2284 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002285 literally, only "\]", "\^", "\-" and "\\" are special.
2286 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2288 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002289 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290 *cpo-L*
2291 L When the 'list' option is set, 'wrapmargin',
2292 'textwidth', 'softtabstop' and Virtual Replace mode
2293 (see |gR|) count a <Tab> as two characters, instead of
2294 the normal behavior of a <Tab>.
2295 *cpo-m*
2296 m When included, a showmatch will always wait half a
2297 second. When not included, a showmatch will wait half
2298 a second or until a character is typed. |'showmatch'|
2299 *cpo-M*
2300 M When excluded, "%" matching will take backslashes into
2301 account. Thus in "( \( )" and "\( ( \)" the outer
2302 parenthesis match. When included "%" ignores
2303 backslashes, which is Vi compatible.
2304 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002305 n When included, the column used for 'number' and
2306 'relativenumber' will also be used for text of wrapped
2307 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002308 *cpo-o*
2309 o Line offset to search command is not remembered for
2310 next search.
2311 *cpo-O*
2312 O Don't complain if a file is being overwritten, even
2313 when it didn't exist when editing it. This is a
2314 protection against a file unexpectedly created by
2315 someone else. Vi didn't complain about this.
2316 *cpo-p*
2317 p Vi compatible Lisp indenting. When not present, a
2318 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002319 *cpo-P*
2320 P When included, a ":write" command that appends to a
2321 file will set the file name for the current buffer, if
2322 the current buffer doesn't have a file name yet and
2323 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002324 *cpo-q*
2325 q When joining multiple lines leave the cursor at the
2326 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002327 *cpo-r*
2328 r Redo ("." command) uses "/" to repeat a search
2329 command, instead of the actually used search string.
2330 *cpo-R*
2331 R Remove marks from filtered lines. Without this flag
2332 marks are kept like |:keepmarks| was used.
2333 *cpo-s*
2334 s Set buffer options when entering the buffer for the
2335 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002336 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337 set when the buffer is created.
2338 *cpo-S*
2339 S Set buffer options always when entering a buffer
2340 (except 'readonly', 'fileformat', 'filetype' and
2341 'syntax'). This is the (most) Vi compatible setting.
2342 The options are set to the values in the current
2343 buffer. When you change an option and go to another
2344 buffer, the value is copied. Effectively makes the
2345 buffer options global to all buffers.
2346
2347 's' 'S' copy buffer options
2348 no no when buffer created
2349 yes no when buffer first entered (default)
2350 X yes each time when buffer entered (vi comp.)
2351 *cpo-t*
2352 t Search pattern for the tag command is remembered for
2353 "n" command. Otherwise Vim only puts the pattern in
2354 the history for search pattern, but doesn't change the
2355 last used search pattern.
2356 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002357 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358 *cpo-v*
2359 v Backspaced characters remain visible on the screen in
2360 Insert mode. Without this flag the characters are
2361 erased from the screen right away. With this flag the
2362 screen newly typed text overwrites backspaced
2363 characters.
2364 *cpo-w*
2365 w When using "cw" on a blank character, only change one
2366 character and not all blanks until the start of the
2367 next word.
2368 *cpo-W*
2369 W Don't overwrite a readonly file. When omitted, ":w!"
2370 overwrites a readonly file, if possible.
2371 *cpo-x*
2372 x <Esc> on the command-line executes the command-line.
2373 The default in Vim is to abandon the command-line,
2374 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002375 *cpo-X*
2376 X When using a count with "R" the replaced text is
2377 deleted only once. Also when repeating "R" with "."
2378 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002380 y A yank command can be redone with ".". Think twice if
2381 you really want to use this, it may break some
2382 plugins, since most people expect "." to only repeat a
2383 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002384 *cpo-Z*
2385 Z When using "w!" while the 'readonly' option is set,
2386 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 *cpo-!*
2388 ! When redoing a filter command, use the last used
2389 external command, whatever it was. Otherwise the last
2390 used -filter- command is used.
2391 *cpo-$*
2392 $ When making a change to one line, don't redisplay the
2393 line, but put a '$' at the end of the changed text.
2394 The changed text will be overwritten when you type the
2395 new text. The line is redisplayed if you type any
2396 command that moves the cursor from the insertion
2397 point.
2398 *cpo-%*
2399 % Vi-compatible matching is done for the "%" command.
2400 Does not recognize "#if", "#endif", etc.
2401 Does not recognize "/*" and "*/".
2402 Parens inside single and double quotes are also
2403 counted, causing a string that contains a paren to
2404 disturb the matching. For example, in a line like
2405 "if (strcmp("foo(", s))" the first paren does not
2406 match the last one. When this flag is not included,
2407 parens inside single and double quotes are treated
2408 specially. When matching a paren outside of quotes,
2409 everything inside quotes is ignored. When matching a
2410 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002411 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002412 This flag is also used for other features, such as
2413 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002414 *cpo--*
2415 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002416 it would go above the first line or below the last
2417 line. Without it the cursor moves to the first or
2418 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002419 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002420 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002421 *cpo-+*
2422 + When included, a ":write file" command will reset the
2423 'modified' flag of the buffer, even though the buffer
2424 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002425 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002426 * Use ":*" in the same way as ":@". When not included,
2427 ":*" is an alias for ":'<,'>", select the Visual area.
2428 *cpo-<*
2429 < Disable the recognition of special key codes in |<>|
2430 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002431 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002432 ":map X <Tab>" results in X being mapped to:
2433 '<' included: "<Tab>" (5 characters)
2434 '<' excluded: "^I" (^I is a real <Tab>)
2435 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002436 *cpo->*
2437 > When appending to a register, put a line break before
2438 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002439 *cpo-;*
2440 ; When using |,| or |;| to repeat the last |t| search
2441 and the cursor is right in front of the searched
2442 character, the cursor won't move. When not included,
2443 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002444 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002445
2446 POSIX flags. These are not included in the Vi default value, except
2447 when $VIM_POSIX was set on startup. |posix|
2448
2449 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002450 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002451 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002452 *cpo-&*
2453 & When ":preserve" was used keep the swap file when
2454 exiting normally while this buffer is still loaded.
2455 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002456 *cpo-\*
2457 \ Backslash in a [] range in a search pattern is taken
2458 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002459 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2460 '\' excluded: "/[ \-]" finds <Space> and '-'
2461 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002462 *cpo-/*
2463 / When "%" is used as the replacement string in a |:s|
2464 command, use the previous replacement string. |:s%|
2465 *cpo-{*
2466 { The |{| and |}| commands also stop at a "{" character
2467 at the start of a line.
2468 *cpo-.*
2469 . The ":chdir" and ":cd" commands fail if the current
2470 buffer is modified, unless ! is used. Vim doesn't
2471 need this, since it remembers the full path of an
2472 opened file.
2473 *cpo-bar*
2474 | The value of the $LINES and $COLUMNS environment
2475 variables overrule the terminal size values obtained
2476 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002477
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002479 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002480'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002481 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002482 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002483 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002484 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002485 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002486 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002487 blowfish Blowfish method. Medium strong encryption but it has
2488 an implementation flaw. Requires Vim 7.3 or later,
2489 files can NOT be read by Vim 7.2 and older. This adds
2490 a "seed" to the file, every time you write the file
2491 the encrypted bytes will be different.
2492 *blowfish2*
2493 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002494 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002495 and older. This adds a "seed" to the file, every time
2496 you write the file the encrypted bytes will be
2497 different. The whole undo file is encrypted, not just
2498 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002499 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002500 *E1197* *E1198* *E1199* *E1200* *E1201*
2501 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2502 Code. Medium strong till strong encryption.
2503 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002504 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002505 It adds a seed and a message authentication code (MAC)
2506 to the file. This needs at least a Vim 8.2.3022 to
2507 read the encrypted file.
2508 Encryption of swap files is not supported, therefore
2509 no swap file will be used when xchacha20 encryption is
2510 enabled.
2511 Encryption of undo files is not yet supported,
2512 therefore no undo file will currently be written.
2513 CURRENTLY EXPERIMENTAL: Files written with this method
2514 might have to be read back with the same version of
2515 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002516
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002517 You should use "blowfish2", also to re-encrypt older files.
2518
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002519 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002520 to the detected method of the file being read. Thus if you write it
2521 without changing 'cryptmethod' the same method will be used.
2522 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002523 explicitly write it, you don't get a warning unless there are other
2524 modifications. Also see |:X|.
2525
2526 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002527 the value "blowfish2". When setting the local value to an empty
2528 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002529
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002530 When a new encryption method is added in a later version of Vim, and
2531 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002532 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002533
2534
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535 *'cscopepathcomp'* *'cspc'*
2536'cscopepathcomp' 'cspc' number (default 0)
2537 global
2538 {not available when compiled without the |+cscope|
2539 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 Determines how many components of the path to show in a list of tags.
2541 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002542 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543
2544 *'cscopeprg'* *'csprg'*
2545'cscopeprg' 'csprg' string (default "cscope")
2546 global
2547 {not available when compiled without the |+cscope|
2548 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 Specifies the command to execute cscope. See |cscopeprg|.
2550 This option cannot be set from a |modeline| or in the |sandbox|, for
2551 security reasons.
2552
2553 *'cscopequickfix'* *'csqf'*
2554'cscopequickfix' 'csqf' string (default "")
2555 global
2556 {not available when compiled without the |+cscope|
2557 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558 Specifies whether to use quickfix window to show cscope results.
2559 See |cscopequickfix|.
2560
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002561 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002562'cscoperelative' 'csre' boolean (default off)
2563 global
2564 {not available when compiled without the |+cscope|
2565 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002566 In the absence of a prefix (-P) for cscope. setting this option enables
2567 to use the basename of cscope.out path as the prefix.
2568 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002569 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002570
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2572'cscopetag' 'cst' boolean (default off)
2573 global
2574 {not available when compiled without the |+cscope|
2575 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 Use cscope for tag commands. See |cscope-options|.
2577 NOTE: This option is reset when 'compatible' is set.
2578
2579 *'cscopetagorder'* *'csto'*
2580'cscopetagorder' 'csto' number (default 0)
2581 global
2582 {not available when compiled without the |+cscope|
2583 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584 Determines the order in which ":cstag" performs a search. See
2585 |cscopetagorder|.
2586 NOTE: This option is set to 0 when 'compatible' is set.
2587
2588 *'cscopeverbose'* *'csverb'*
2589 *'nocscopeverbose'* *'nocsverb'*
2590'cscopeverbose' 'csverb' boolean (default off)
2591 global
2592 {not available when compiled without the |+cscope|
2593 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 Give messages when adding a cscope database. See |cscopeverbose|.
2595 NOTE: This option is reset when 'compatible' is set.
2596
Bram Moolenaar860cae12010-06-05 23:22:07 +02002597 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2598'cursorbind' 'crb' boolean (default off)
2599 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002600 When this option is set, as the cursor in the current
2601 window moves other cursorbound windows (windows that also have
2602 this option set) move their cursors to the corresponding line and
2603 column. This option is useful for viewing the
2604 differences between two versions of a file (see 'diff'); in diff mode,
2605 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002606 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002607
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002608
2609 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2610'cursorcolumn' 'cuc' boolean (default off)
2611 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002612 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002613 feature}
2614 Highlight the screen column of the cursor with CursorColumn
2615 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2616 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002617 If you only want the highlighting in the current window you can use
2618 these autocommands: >
2619 au WinLeave * set nocursorline nocursorcolumn
2620 au WinEnter * set cursorline cursorcolumn
2621<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002622
2623 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2624'cursorline' 'cul' boolean (default off)
2625 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002626 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002627 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002628 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2629 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002630 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002631 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002632
2633
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002634 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002635'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002636 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002637 {not available when compiled without the |+syntax|
2638 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002639 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002640 Valid values:
2641 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002642 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002643 "screenline" Highlight only the screen line of the cursor with
2644 CursorLine |hl-CursorLine|.
2645 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002646 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002647
2648 Special value:
2649 "both" Alias for the values "line,number".
2650
2651 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002652
2653
Bram Moolenaar071d4272004-06-13 20:20:40 +00002654 *'debug'*
2655'debug' string (default "")
2656 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002657 These values can be used:
2658 msg Error messages that would otherwise be omitted will be given
2659 anyway.
2660 throw Error messages that would otherwise be omitted will be given
2661 anyway and also throw an exception and set |v:errmsg|.
2662 beep A message will be given when otherwise only a beep would be
2663 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002664 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002665 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2666 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667
2668 *'define'* *'def'*
2669'define' 'def' string (default "^\s*#\s*define")
2670 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002671 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672 pattern, just like for the "/" command. This option is used for the
2673 commands like "[i" and "[d" |include-search|. The 'isident' option is
2674 used to recognize the defined name after the match:
2675 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2676 See |option-backslash| about inserting backslashes to include a space
2677 or backslash.
2678 The default value is for C programs. For C++ this value would be
2679 useful, to include const type declarations: >
2680 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002681< You can also use "\ze" just before the name and continue the pattern
2682 to check what is following. E.g. for Javascript, if a function is
2683 defined with "func_name = function(args)": >
2684 ^\s*\ze\i\+\s*=\s*function(
2685< If the function is defined with "func_name : function() {...": >
2686 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002688 To avoid that use `:let` with a single quote string: >
2689 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002690<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691
2692 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2693'delcombine' 'deco' boolean (default off)
2694 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 If editing Unicode and this option is set, backspace and Normal mode
2696 "x" delete each combining character on its own. When it is off (the
2697 default) the character along with its combining characters are
2698 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002699 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700
2701 This is useful for Arabic, Hebrew and many other languages where one
2702 may have combining characters overtop of base characters, and want
2703 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002704 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705
2706 *'dictionary'* *'dict'*
2707'dictionary' 'dict' string (default "")
2708 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 List of file names, separated by commas, that are used to lookup words
2710 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2711 contain a list of words. This can be one word per line, or several
2712 words per line, separated by non-keyword characters (white space is
2713 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002714
2715 When this option is empty or an entry "spell" is present, and spell
2716 checking is enabled, words in the word lists for the currently active
2717 'spelllang' are used. See |spell|.
2718
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002719 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720 after a comma are ignored, otherwise spaces are included in the file
2721 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002722 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 Where to find a list of words?
2724 - On FreeBSD, there is the file "/usr/share/dict/words".
2725 - In the Simtel archive, look in the "msdos/linguist" directory.
2726 - In "miscfiles" of the GNU collection.
2727 The use of |:set+=| and |:set-=| is preferred when adding or removing
2728 directories from the list. This avoids problems when a future version
2729 uses another default.
2730 Backticks cannot be used in this option for security reasons.
2731
2732 *'diff'* *'nodiff'*
2733'diff' boolean (default off)
2734 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735 {not available when compiled without the |+diff|
2736 feature}
2737 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002738 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739
2740 *'dex'* *'diffexpr'*
2741'diffexpr' 'dex' string (default "")
2742 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743 {not available when compiled without the |+diff|
2744 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002745 Expression which is evaluated to obtain a diff file (either ed-style
2746 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002747 This option cannot be set from a |modeline| or in the |sandbox|, for
2748 security reasons.
2749
2750 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002751'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 {not available when compiled without the |+diff|
2754 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002755 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756 All are optional. Items must be separated by a comma.
2757
2758 filler Show filler lines, to keep the text
2759 synchronized with a window that has inserted
2760 lines at the same position. Mostly useful
2761 when windows are side-by-side and 'scrollbind'
2762 is set.
2763
2764 context:{n} Use a context of {n} lines between a change
2765 and a fold that contains unchanged lines.
2766 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002767 When using zero the context is actually one,
2768 since folds require a line in between, also
2769 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 See |fold-diff|.
2771
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002772 iblank Ignore changes where lines are all blank. Adds
2773 the "-B" flag to the "diff" command if
2774 'diffexpr' is empty. Check the documentation
2775 of the "diff" command for what this does
2776 exactly.
2777 NOTE: the diff windows will get out of sync,
2778 because no differences between blank lines are
2779 taken into account.
2780
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781 icase Ignore changes in case of text. "a" and "A"
2782 are considered the same. Adds the "-i" flag
2783 to the "diff" command if 'diffexpr' is empty.
2784
2785 iwhite Ignore changes in amount of white space. Adds
2786 the "-b" flag to the "diff" command if
2787 'diffexpr' is empty. Check the documentation
2788 of the "diff" command for what this does
2789 exactly. It should ignore adding trailing
2790 white space, but not leading white space.
2791
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002792 iwhiteall Ignore all white space changes. Adds
2793 the "-w" flag to the "diff" command if
2794 'diffexpr' is empty. Check the documentation
2795 of the "diff" command for what this does
2796 exactly.
2797
2798 iwhiteeol Ignore white space changes at end of line.
2799 Adds the "-Z" flag to the "diff" command if
2800 'diffexpr' is empty. Check the documentation
2801 of the "diff" command for what this does
2802 exactly.
2803
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002804 horizontal Start diff mode with horizontal splits (unless
2805 explicitly specified otherwise).
2806
2807 vertical Start diff mode with vertical splits (unless
2808 explicitly specified otherwise).
2809
Bram Moolenaarc8234772019-11-10 21:00:27 +01002810 closeoff When a window is closed where 'diff' is set
2811 and there is only one window remaining in the
2812 same tab page with 'diff' set, execute
2813 `:diffoff` in that window. This undoes a
2814 `:diffsplit` command.
2815
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002816 hiddenoff Do not use diff mode for a buffer when it
2817 becomes hidden.
2818
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002819 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2820 starting diff mode. Without this 2 is used.
2821
Bram Moolenaar4223d432021-02-10 13:18:17 +01002822 followwrap Follow the 'wrap' option and leave as it is.
2823
Bram Moolenaare828b762018-09-10 17:51:58 +02002824 internal Use the internal diff library. This is
2825 ignored when 'diffexpr' is set. *E960*
2826 When running out of memory when writing a
2827 buffer this item will be ignored for diffs
2828 involving that buffer. Set the 'verbose'
2829 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830
Bram Moolenaare828b762018-09-10 17:51:58 +02002831 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002832 Use the indent heuristic for the internal
2833 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002834
2835 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002836 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002837 algorithms are:
2838 myers the default algorithm
2839 minimal spend extra time to generate the
2840 smallest possible diff
2841 patience patience diff algorithm
2842 histogram histogram diff algorithm
2843
2844 Examples: >
2845 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002847 :set diffopt=internal,filler,foldcolumn:3
2848 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849<
2850 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2851'digraph' 'dg' boolean (default off)
2852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853 {not available when compiled without the |+digraphs|
2854 feature}
2855 Enable the entering of digraphs in Insert mode with {char1} <BS>
2856 {char2}. See |digraphs|.
2857 NOTE: This option is reset when 'compatible' is set.
2858
2859 *'directory'* *'dir'*
2860'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002861 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862 for Unix: ".,~/tmp,/var/tmp,/tmp")
2863 global
2864 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002865 Recommended value: ".,~/vimswap//" - this will put the swap file next
2866 to the edited file if possible, and in your personal swap directory
2867 otherwise. Make sure "~/vimswap//" is only readable for you.
2868
2869 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 - The swap file will be created in the first directory where this is
2871 possible.
2872 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002873 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874 - A directory "." means to put the swap file in the same directory as
2875 the edited file. On Unix, a dot is prepended to the file name, so
2876 it doesn't show in a directory listing. On MS-Windows the "hidden"
2877 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002878 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2879 the swap file relative to where the edited file is. The leading "."
2880 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002881 - For Unix and Win32, if a directory ends in two path separators "//",
2882 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002883 with all path separators replaced by percent '%' signs (including
2884 the colon following the drive letter on Win32). This will ensure
2885 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002886 On Win32, it is also possible to end with "\\". However, When a
2887 separating comma is following, you must use "//", since "\\" will
2888 include the comma in the file name. Therefore it is recommended to
2889 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890 - Spaces after the comma are ignored, other spaces are considered part
2891 of the directory name. To have a space at the start of a directory
2892 name, precede it with a backslash.
2893 - To include a comma in a directory name precede it with a backslash.
2894 - A directory name may end in an ':' or '/'.
2895 - Environment variables are expanded |:set_env|.
2896 - Careful with '\' characters, type one before a space, type two to
2897 get one in the option (see |option-backslash|), for example: >
2898 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2899< - For backwards compatibility with Vim version 3.0 a '>' at the start
2900 of the option is removed.
2901 Using "." first in the list is recommended. This means that editing
2902 the same file twice will result in a warning. Using "/tmp" on Unix is
2903 discouraged: When the system crashes you lose the swap file.
2904 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002905 choice than "/tmp". But others on the computer may be able to see the
2906 files, and it can contain a lot of files, your swap files get lost in
2907 the crowd. That is why a "tmp" directory in your home directory is
2908 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 The use of |:set+=| and |:set-=| is preferred when adding or removing
2910 directories from the list. This avoids problems when a future version
2911 uses another default.
2912 This option cannot be set from a |modeline| or in the |sandbox|, for
2913 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914
2915 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002916'display' 'dy' string (default "", set to "truncate" in
2917 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002919 Change the way text is displayed. This is comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 flags:
2921 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002922 in a window will be displayed. "@@@" is put in the
2923 last columns of the last screen line to indicate the
2924 rest of the line is not displayed.
2925 truncate Like "lastline", but "@@@" is displayed in the first
2926 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927 uhex Show unprintable characters hexadecimal as <xx>
2928 instead of using ^C and ~C.
2929
Bram Moolenaard0796902016-09-16 20:02:31 +02002930 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002931 doesn't fit is replaced with "@" lines.
2932
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 *'eadirection'* *'ead'*
2934'eadirection' 'ead' string (default "both")
2935 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 Tells when the 'equalalways' option applies:
2937 ver vertically, width of windows is not affected
2938 hor horizontally, height of windows is not affected
2939 both width and height of windows is affected
2940
2941 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2942'edcompatible' 'ed' boolean (default off)
2943 global
2944 Makes the 'g' and 'c' flags of the ":substitute" command to be
2945 toggled each time the flag is given. See |complex-change|. See
2946 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002947 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002948 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949
Bram Moolenaar03413f42016-04-12 21:07:15 +02002950 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002951'emoji' 'emo' boolean (default: on)
2952 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002953 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002954 This excludes "text emoji" characters, which are normally displayed as
2955 single width. Unfortunately there is no good specification for this
2956 and it has been determined on trial-and-error basis. Use the
2957 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002958
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002960'encoding' 'enc' string (default for MS-Windows: "utf-8",
2961 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 Sets the character encoding used inside Vim. It applies to text in
2964 the buffers, registers, Strings in expressions, text stored in the
2965 viminfo file, etc. It sets the kind of characters which Vim can work
2966 with. See |encoding-names| for the possible values.
2967
2968 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002969 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002971 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972
Bram Moolenaar865242e2010-07-14 21:12:05 +02002973 This option cannot be set from a |modeline|. It would most likely
2974 corrupt the text.
2975
Bram Moolenaar3df01732017-02-17 22:47:16 +01002976 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2977 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 'encoding', "utf-8" is the natural choice for the environment and
2979 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002980 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 versions, and to avoid changing the encoding of newly created files
2982 without your knowledge (in case 'fileencodings' is empty).
2983
2984 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002985 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 iconv() or as specified with 'charconvert'.
2987
Bram Moolenaar207f0092020-08-30 17:20:20 +02002988 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002989 can use: >
2990 if has("multi_byte_encoding")
2991<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 Normally 'encoding' will be equal to your current locale. This will
2993 be the default if Vim recognizes your environment settings. If
2994 'encoding' is not set to the current locale, 'termencoding' must be
2995 set to convert typed and displayed text. See |encoding-table|.
2996
2997 When you set this option, it fires the |EncodingChanged| autocommand
2998 event so that you can set up fonts if necessary.
2999
3000 When the option is set, the value is converted to lowercase. Thus
3001 you can set it with uppercase values too. Underscores are translated
3002 to '-' signs.
3003 When the encoding is recognized, it is changed to the standard name.
3004 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3005 "iso-8859-2" and "utf8" becomes "utf-8".
3006
3007 Note: "latin1" is also used when the encoding could not be detected.
3008 This only works when editing files in the same encoding! When the
3009 actual character set is not latin1, make sure 'fileencoding' and
3010 'fileencodings' are empty. When conversion is needed, switch to using
3011 utf-8.
3012
3013 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3014 You don't notice this while editing, but it does matter for the
3015 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3016 setting 'encoding' to one of these values instead of utf-8 only has
3017 effect for encoding used for files when 'fileencoding' is empty.
3018
Bram Moolenaar661b1822005-07-28 22:36:45 +00003019 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3020 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021
3022 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3023'endofline' 'eol' boolean (default on)
3024 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003026 is on, or 'fixeol' option is off, no <EOL> will be written for the
3027 last line in the file. This option is automatically set or reset when
3028 starting to edit a new file, depending on whether file has an <EOL>
3029 for the last line in the file. Normally you don't have to set or
3030 reset this option.
3031 When 'binary' is off and 'fixeol' is on the value is not used when
3032 writing the file. When 'binary' is on or 'fixeol' is off it is used
3033 to remember the presence of a <EOL> for the last line in the file, so
3034 that when you write the file the situation from the original file can
3035 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036
3037 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3038'equalalways' 'ea' boolean (default on)
3039 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003041 splitting or closing a window. This also happens the moment the
3042 option is switched on. When off, splitting a window will reduce the
3043 size of the current window and leave the other windows the same. When
3044 closing a window the extra lines are given to the window next to it
3045 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 When mixing vertically and horizontally split windows, a minimal size
3047 is computed and some windows may be larger if there is room. The
3048 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003049 Changing the height and width of a window can be avoided by setting
3050 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003051 If a window size is specified when creating a new window sizes are
3052 currently not equalized (it's complicated, but may be implemented in
3053 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054
3055 *'equalprg'* *'ep'*
3056'equalprg' 'ep' string (default "")
3057 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003059 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003060 or 'indentexpr'. When Vim was compiled without internal formatting,
3061 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003062 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063 about including spaces and backslashes.
3064 This option cannot be set from a |modeline| or in the |sandbox|, for
3065 security reasons.
3066
3067 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3068'errorbells' 'eb' boolean (default off)
3069 global
3070 Ring the bell (beep or screen flash) for error messages. This only
3071 makes a difference for error messages, the bell will be used always
3072 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003073 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003074 screen flash or do nothing. See 'belloff' to finetune when to ring the
3075 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076
3077 *'errorfile'* *'ef'*
3078'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3079 others: "errors.err")
3080 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 {not available when compiled without the |+quickfix|
3082 feature}
3083 Name of the errorfile for the QuickFix mode (see |:cf|).
3084 When the "-q" command-line argument is used, 'errorfile' is set to the
3085 following argument. See |-q|.
3086 NOT used for the ":make" command. See 'makeef' for that.
3087 Environment variables are expanded |:set_env|.
3088 See |option-backslash| about including spaces and backslashes.
3089 This option cannot be set from a |modeline| or in the |sandbox|, for
3090 security reasons.
3091
3092 *'errorformat'* *'efm'*
3093'errorformat' 'efm' string (default is very long)
3094 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 {not available when compiled without the |+quickfix|
3096 feature}
3097 Scanf-like description of the format for the lines in the error file
3098 (see |errorformat|).
3099
3100 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3101'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3102 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 Function keys that start with an <Esc> are recognized in Insert
3104 mode. When this option is off, the cursor and function keys cannot be
3105 used in Insert mode if they start with an <Esc>. The advantage of
3106 this is that the single <Esc> is recognized immediately, instead of
3107 after one second. Instead of resetting this option, you might want to
3108 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3109 when 'esckeys' is off, you can still map anything, but the cursor keys
3110 won't work by default.
3111 NOTE: This option is set to the Vi default value when 'compatible' is
3112 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003113 NOTE: when this option is off then the |modifyOtherKeys| functionality
3114 is disabled while in Insert mode to avoid ending Insert mode with any
3115 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116
3117 *'eventignore'* *'ei'*
3118'eventignore' 'ei' string (default "")
3119 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003121 When set to "all" or when "all" is one of the items, all autocommand
3122 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003123 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124 :set ei=WinEnter,WinLeave
3125<
3126 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3127'expandtab' 'et' boolean (default off)
3128 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003130 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3132 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003133 This option is reset when the 'paste' option is set and restored when
3134 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 NOTE: This option is reset when 'compatible' is set.
3136
3137 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3138'exrc' 'ex' boolean (default off)
3139 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003141 directory.
3142
3143 Setting this option is a potential security leak. E.g., consider
3144 unpacking a package or fetching files from github, a .vimrc in there
3145 might be a trojan horse. BETTER NOT SET THIS OPTION!
3146 Instead, define an autocommand in your .vimrc to set options for a
3147 matching directory.
3148
3149 If you do switch this option on you should also consider setting the
3150 'secure' option (see |initialization|).
3151 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 This option cannot be set from a |modeline| or in the |sandbox|, for
3153 security reasons.
3154
3155 *'fileencoding'* *'fenc'* *E213*
3156'fileencoding' 'fenc' string (default: "")
3157 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003159
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003161 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 When 'fileencoding' is empty, the same value as 'encoding' will be
3163 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003164 No error will be given when the value is set, only when it is used,
3165 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003166 Conversion will also be done when 'encoding' and 'fileencoding' are
3167 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3168 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003170 'encoding' is "utf-8" or another Unicode encoding, conversion
3171 is most likely done in a way that the reverse conversion
3172 results in the same text. When 'encoding' is not "utf-8" some
3173 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003174
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175 See 'encoding' for the possible values. Additionally, values may be
3176 specified that can be handled by the converter, see
3177 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003178
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 When reading a file 'fileencoding' will be set from 'fileencodings'.
3180 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003181 'fileencoding', use the |++enc| argument. One exception: when
3182 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003183 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003184
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3186 When the option is set, the value is converted to lowercase. Thus
3187 you can set it with uppercase values too. '_' characters are
3188 replaced with '-'. If a name is recognized from the list for
3189 'encoding', it is replaced by the standard name. For example
3190 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003191
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 When this option is set, after starting to edit a file, the 'modified'
3193 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003194
3195 Keep in mind that changing 'fenc' from a modeline happens
3196 AFTER the text has been read, thus it applies to when the file will be
3197 written. If you do set 'fenc' in a modeline, you might want to set
3198 'nomodified' to avoid not being able to ":q".
3199
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 This option can not be changed when 'modifiable' is off.
3201
3202 *'fe'*
3203 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003204 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205 old short name was 'fe', which is no longer used.
3206
3207 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003208'fileencodings' 'fencs' string (default: "ucs-bom",
3209 "ucs-bom,utf-8,default,latin1" when
3210 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 This is a list of character encodings considered when starting to edit
3213 an existing file. When a file is read, Vim tries to use the first
3214 mentioned character encoding. If an error is detected, the next one
3215 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003216 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 an empty string, which means the value of 'encoding' is used.
3218 WARNING: Conversion can cause loss of information! When
3219 'encoding' is "utf-8" (or one of the other Unicode variants)
3220 conversion is most likely done in a way that the reverse
3221 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003222 "utf-8" some non-ASCII characters may be lost! You can use
3223 the |++bad| argument to specify what is done with characters
3224 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 For an empty file or a file with only ASCII characters most encodings
3226 will work and the first entry of 'fileencodings' will be used (except
3227 "ucs-bom", which requires the BOM to be present). If you prefer
3228 another encoding use an BufReadPost autocommand event to test if your
3229 preferred encoding is to be used. Example: >
3230 au BufReadPost * if search('\S', 'w') == 0 |
3231 \ set fenc=iso-2022-jp | endif
3232< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3233 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003234 When the |++enc| argument is used then the value of 'fileencodings' is
3235 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003236 Note that 'fileencodings' is not used for a new file, the global value
3237 of 'fileencoding' is used instead. You can set it with: >
3238 :setglobal fenc=iso-8859-2
3239< This means that a non-existing file may get a different encoding than
3240 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 The special value "ucs-bom" can be used to check for a Unicode BOM
3242 (Byte Order Mark) at the start of the file. It must not be preceded
3243 by "utf-8" or another Unicode encoding for this to work properly.
3244 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3245 because Vim cannot detect an error, thus the encoding is always
3246 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003247 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003248 environment. On MS-Windows this is the system encoding. Otherwise
3249 this is the default value for 'encoding'. It is useful when
3250 'encoding' is set to "utf-8" and your environment uses a non-latin1
3251 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003252 When 'encoding' is "utf-8" and a file contains an illegal byte
3253 sequence it won't be recognized as UTF-8. You can use the |8g8|
3254 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 WRONG VALUES: WHAT'S WRONG:
3256 latin1,utf-8 "latin1" will always be used
3257 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3258 file
3259 cp1250,latin1 "cp1250" will always be used
3260 If 'fileencodings' is empty, 'fileencoding' is not modified.
3261 See 'fileencoding' for the possible values.
3262 Setting this option does not have an effect until the next time a file
3263 is read.
3264
3265 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003266'fileformat' 'ff' string (MS-Windows default: "dos",
3267 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 This gives the <EOL> of the current buffer, which is used for
3270 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003271 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 unix <NL>
3273 mac <CR>
3274 When "dos" is used, CTRL-Z at the end of a file is ignored.
3275 See |file-formats| and |file-read|.
3276 For the character encoding of the file see 'fileencoding'.
3277 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003278 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 This option is set automatically when starting to edit a file and
3280 'fileformats' is not empty and 'binary' is off.
3281 When this option is set, after starting to edit a file, the 'modified'
3282 option is set, because the file would be different when written.
3283 This option can not be changed when 'modifiable' is off.
3284 For backwards compatibility: When this option is set to "dos",
3285 'textmode' is set, otherwise 'textmode' is reset.
3286
3287 *'fileformats'* *'ffs'*
3288'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003289 Vim+Vi MS-Windows: "dos,unix",
3290 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 Vi Cygwin: "unix,dos",
3292 Vi others: "")
3293 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 This gives the end-of-line (<EOL>) formats that will be tried when
3295 starting to edit a new buffer and when reading a file into an existing
3296 buffer:
3297 - When empty, the format defined with 'fileformat' will be used
3298 always. It is not set automatically.
3299 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003300 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 'fileformats' name will be used when a file is read into an existing
3302 buffer, no matter what 'fileformat' for that buffer is set to.
3303 - When more than one name is present, separated by commas, automatic
3304 <EOL> detection will be done when reading a file. When starting to
3305 edit a file, a check is done for the <EOL>:
3306 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3307 'fileformat' is set to "dos".
3308 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003309 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003311 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3312 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003313 This means that "mac" is only chosen when:
3314 "unix" is not present or no <NL> is found in the file, and
3315 "dos" is not present or no <CR><NL> is found in the file.
3316 Except: if "unix" was chosen, but there is a <CR> before
3317 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003318 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 4. If 'fileformat' is still not set, the first name from
3320 'fileformats' is used.
3321 When reading a file into an existing buffer, the same is done, but
3322 this happens like 'fileformat' has been set appropriately for that
3323 file only, the option is not changed.
3324 When 'binary' is set, the value of 'fileformats' is not used.
3325
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003326 When Vim starts up with an empty buffer the first item is used. You
3327 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003328
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3330 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3331 done:
3332 - When 'fileformats' is empty, there is no automatic detection. Dos
3333 format will be used.
3334 - When 'fileformats' is set to one or more names, automatic detection
3335 is done. This is based on the first <NL> in the file: If there is a
3336 <CR> in front of it, Dos format is used, otherwise Unix format is
3337 used.
3338 Also see |file-formats|.
3339 For backwards compatibility: When this option is set to an empty
3340 string or one format (no comma is included), 'textauto' is reset,
3341 otherwise 'textauto' is set.
3342 NOTE: This option is set to the Vi default value when 'compatible' is
3343 set and to the Vim default value when 'compatible' is reset.
3344
Bram Moolenaarbf884932013-04-05 22:26:15 +02003345 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3346'fileignorecase' 'fic' boolean (default on for systems where case in file
3347 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003348 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003349 When set case is ignored when using file names and directories.
3350 See 'wildignorecase' for only ignoring case when doing completion.
3351
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 *'filetype'* *'ft'*
3353'filetype' 'ft' string (default: "")
3354 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 When this option is set, the FileType autocommand event is triggered.
3356 All autocommands that match with the value of this option will be
3357 executed. Thus the value of 'filetype' is used in place of the file
3358 name.
3359 Otherwise this option does not always reflect the current file type.
3360 This option is normally set when the file type is detected. To enable
3361 this use the ":filetype on" command. |:filetype|
3362 Setting this option to a different value is most useful in a modeline,
3363 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003364 Example, for in an IDL file:
3365 /* vim: set filetype=idl : */ ~
3366 |FileType| |filetypes|
3367 When a dot appears in the value then this separates two filetype
3368 names. Example:
3369 /* vim: set filetype=c.doxygen : */ ~
3370 This will use the "c" filetype first, then the "doxygen" filetype.
3371 This works both for filetype plugins and for syntax files. More than
3372 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373 This option is not copied to another buffer, independent of the 's' or
3374 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003375 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376
3377 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003378'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003380 {not available when compiled without the |+folding|
3381 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 Characters to fill the statuslines and vertical separators.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003383 It is a comma-separated list of items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384
3385 item default Used for ~
3386 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003387 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 vert:c '|' vertical separators |:vsplit|
3389 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003390 foldopen:c '-' mark the beginning of a fold
3391 foldclose:c '+' show a closed fold
3392 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003394 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003396 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003397 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 otherwise.
3399
3400 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003401 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402< This is similar to the default, except that these characters will also
3403 be used when there is highlighting.
3404
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003405 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3406 single-byte and multibyte characters are supported. But double-width
3407 characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003408
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 The highlighting used for these items:
3410 item highlight group ~
3411 stl:c StatusLine |hl-StatusLine|
3412 stlnc:c StatusLineNC |hl-StatusLineNC|
3413 vert:c VertSplit |hl-VertSplit|
3414 fold:c Folded |hl-Folded|
3415 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003416 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003418 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3419'fixendofline' 'fixeol' boolean (default on)
3420 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003421 When writing a file and this option is on, <EOL> at the end of file
3422 will be restored if missing. Turn this option off if you want to
3423 preserve the situation from the original file.
3424 When the 'binary' option is set the value of this option doesn't
3425 matter.
3426 See the 'endofline' option.
3427
Bram Moolenaar071d4272004-06-13 20:20:40 +00003428 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003429'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 {only available when compiled with the |+rightleft|
3432 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003433 This option was for using Farsi, which has been removed. See
3434 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435
3436 *'foldclose'* *'fcl'*
3437'foldclose' 'fcl' string (default "")
3438 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 {not available when compiled without the |+folding|
3440 feature}
3441 When set to "all", a fold is closed when the cursor isn't in it and
3442 its level is higher than 'foldlevel'. Useful if you want folds to
3443 automatically close when moving out of them.
3444
3445 *'foldcolumn'* *'fdc'*
3446'foldcolumn' 'fdc' number (default 0)
3447 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448 {not available when compiled without the |+folding|
3449 feature}
3450 When non-zero, a column with the specified width is shown at the side
3451 of the window which indicates open and closed folds. The maximum
3452 value is 12.
3453 See |folding|.
3454
3455 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3456'foldenable' 'fen' boolean (default on)
3457 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458 {not available when compiled without the |+folding|
3459 feature}
3460 When off, all folds are open. This option can be used to quickly
3461 switch between showing all text unfolded and viewing the text with
3462 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003463 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 'foldenable' is off.
3465 This option is set by commands that create a new fold or close a fold.
3466 See |folding|.
3467
3468 *'foldexpr'* *'fde'*
3469'foldexpr' 'fde' string (default: "0")
3470 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003472 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003474 for each line to obtain its fold level. The context is set to the
3475 script where 'foldexpr' was set, script-local items can be accessed.
3476 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003477
Bram Moolenaar30b65812012-07-12 22:01:11 +02003478 The expression will be evaluated in the |sandbox| if set from a
3479 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003480 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003481 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003482
3483 It is not allowed to change text or jump to another window while
3484 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485
3486 *'foldignore'* *'fdi'*
3487'foldignore' 'fdi' string (default: "#")
3488 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 {not available when compiled without the |+folding|
3490 feature}
3491 Used only when 'foldmethod' is "indent". Lines starting with
3492 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003493 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494 The default "#" works well for C programs. See |fold-indent|.
3495
3496 *'foldlevel'* *'fdl'*
3497'foldlevel' 'fdl' number (default: 0)
3498 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 {not available when compiled without the |+folding|
3500 feature}
3501 Sets the fold level: Folds with a higher level will be closed.
3502 Setting this option to zero will close all folds. Higher numbers will
3503 close fewer folds.
3504 This option is set by commands like |zm|, |zM| and |zR|.
3505 See |fold-foldlevel|.
3506
3507 *'foldlevelstart'* *'fdls'*
3508'foldlevelstart' 'fdls' number (default: -1)
3509 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 {not available when compiled without the |+folding|
3511 feature}
3512 Sets 'foldlevel' when starting to edit another buffer in a window.
3513 Useful to always start editing with all folds closed (value zero),
3514 some folds closed (one) or no folds closed (99).
3515 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003516 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517 ignores this option and closes all folds.
3518 It is also done before BufReadPre autocommands, to allow an autocmd to
3519 overrule the 'foldlevel' value for specific files.
3520 When the value is negative, it is not used.
3521
3522 *'foldmarker'* *'fmr'* *E536*
3523'foldmarker' 'fmr' string (default: "{{{,}}}")
3524 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 {not available when compiled without the |+folding|
3526 feature}
3527 The start and end marker used when 'foldmethod' is "marker". There
3528 must be one comma, which separates the start and end marker. The
3529 marker is a literal string (a regular expression would be too slow).
3530 See |fold-marker|.
3531
3532 *'foldmethod'* *'fdm'*
3533'foldmethod' 'fdm' string (default: "manual")
3534 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 {not available when compiled without the |+folding|
3536 feature}
3537 The kind of folding used for the current window. Possible values:
3538 |fold-manual| manual Folds are created manually.
3539 |fold-indent| indent Lines with equal indent form a fold.
3540 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3541 |fold-marker| marker Markers are used to specify folds.
3542 |fold-syntax| syntax Syntax highlighting items specify folds.
3543 |fold-diff| diff Fold text that is not changed.
3544
3545 *'foldminlines'* *'fml'*
3546'foldminlines' 'fml' number (default: 1)
3547 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 {not available when compiled without the |+folding|
3549 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003550 Sets the number of screen lines above which a fold can be displayed
3551 closed. Also for manually closed folds. With the default value of
3552 one a fold can only be closed if it takes up two or more screen lines.
3553 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003554 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 "zc" to close a fold, which is displayed open because it's smaller
3556 than 'foldminlines', a following "zc" may close a containing fold.
3557
3558 *'foldnestmax'* *'fdn'*
3559'foldnestmax' 'fdn' number (default: 20)
3560 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 {not available when compiled without the |+folding|
3562 feature}
3563 Sets the maximum nesting of folds for the "indent" and "syntax"
3564 methods. This avoids that too many folds will be created. Using more
3565 than 20 doesn't work, because the internal limit is 20.
3566
3567 *'foldopen'* *'fdo'*
3568'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3569 search,tag,undo")
3570 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 {not available when compiled without the |+folding|
3572 feature}
3573 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003574 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003576 NOTE: When the command is part of a mapping this option is not used.
3577 Add the |zv| command to the mapping to get the same effect.
3578 (rationale: the mapping may want to control opening folds itself)
3579
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 item commands ~
3581 all any
3582 block "(", "{", "[[", "[{", etc.
3583 hor horizontal movements: "l", "w", "fx", etc.
3584 insert any command in Insert mode
3585 jump far jumps: "G", "gg", etc.
3586 mark jumping to a mark: "'m", CTRL-O, etc.
3587 percent "%"
3588 quickfix ":cn", ":crew", ":make", etc.
3589 search search for a pattern: "/", "n", "*", "gd", etc.
3590 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003591 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 tag jumping to a tag: ":ta", CTRL-T, etc.
3593 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 When a movement command is used for an operator (e.g., "dl" or "y%")
3595 this option is not used. This means the operator will include the
3596 whole closed fold.
3597 Note that vertical movements are not here, because it would make it
3598 very difficult to move onto a closed fold.
3599 In insert mode the folds containing the cursor will always be open
3600 when text is inserted.
3601 To close folds you can re-apply 'foldlevel' with the |zx| command or
3602 set the 'foldclose' option to "all".
3603
3604 *'foldtext'* *'fdt'*
3605'foldtext' 'fdt' string (default: "foldtext()")
3606 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607 {not available when compiled without the |+folding|
3608 feature}
3609 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003610 fold. The context is set to the script where 'foldexpr' was set,
3611 script-local items can be accessed. See |fold-foldtext| for the
3612 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613
Bram Moolenaar30b65812012-07-12 22:01:11 +02003614 The expression will be evaluated in the |sandbox| if set from a
3615 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003616 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003617
3618 It is not allowed to change text or jump to another window while
3619 evaluating 'foldtext' |textlock|.
3620
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003621 *'formatexpr'* *'fex'*
3622'formatexpr' 'fex' string (default "")
3623 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003624 {not available when compiled without the |+eval|
3625 feature}
3626 Expression which is evaluated to format a range of lines for the |gq|
3627 operator or automatic formatting (see 'formatoptions'). When this
3628 option is empty 'formatprg' is used.
3629
3630 The |v:lnum| variable holds the first line to be formatted.
3631 The |v:count| variable holds the number of lines to be formatted.
3632 The |v:char| variable holds the character that is going to be
3633 inserted if the expression is being evaluated due to
3634 automatic formatting. This can be empty. Don't insert
3635 it yet!
3636
3637 Example: >
3638 :set formatexpr=mylang#Format()
3639< This will invoke the mylang#Format() function in the
3640 autoload/mylang.vim file in 'runtimepath'. |autoload|
3641
3642 The expression is also evaluated when 'textwidth' is set and adding
3643 text beyond that limit. This happens under the same conditions as
3644 when internal formatting is used. Make sure the cursor is kept in the
3645 same spot relative to the text then! The |mode()| function will
3646 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003647
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003648 When the expression evaluates to non-zero Vim will fall back to using
3649 the internal format mechanism.
3650
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003651 If the expression starts with s: or |<SID>|, then it is replaced with
3652 the script ID (|local-function|). Example: >
3653 set formatexpr=s:MyFormatExpr()
3654 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003655< Otherwise, the expression is evaluated in the context of the script
3656 where the option was set, thus script-local items are available.
3657
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003658 The expression will be evaluated in the |sandbox| when set from a
3659 modeline, see |sandbox-option|. That stops the option from working,
3660 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003661 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003662 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003663
Bram Moolenaar86b68352004-12-27 21:59:20 +00003664 *'formatlistpat'* *'flp'*
3665'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3666 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003667 A pattern that is used to recognize a list header. This is used for
3668 the "n" flag in 'formatoptions'.
3669 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003670 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003671 while still checking more characters. There must be a character
3672 following the pattern, when it matches the whole line it is handled
3673 like there is no match.
3674 The default recognizes a number, followed by an optional punctuation
3675 character and white space.
3676
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003677 *'formatoptions'* *'fo'*
3678'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3679 local to buffer
3680 This is a sequence of letters which describes how automatic
3681 formatting is to be done. See |fo-table|. When the 'paste' option is
3682 on, no formatting is done (like 'formatoptions' is empty). Commas can
3683 be inserted for readability.
3684 To avoid problems with flags that are added in the future, use the
3685 "+=" and "-=" feature of ":set" |add-option-flags|.
3686 NOTE: This option is set to the Vi default value when 'compatible' is
3687 set and to the Vim default value when 'compatible' is reset.
3688
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 *'formatprg'* *'fp'*
3690'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003691 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003692 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003693 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003695 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003696 If the 'formatexpr' option is not empty it will be used instead.
3697 Otherwise, if 'formatprg' option is an empty string, the internal
3698 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003699 Environment variables are expanded |:set_env|. See |option-backslash|
3700 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003701 This option cannot be set from a |modeline| or in the |sandbox|, for
3702 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703
Bram Moolenaard94464e2015-11-02 15:28:18 +01003704 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003705'fsync' 'fs' boolean (default on)
3706 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003707 When on, the library function fsync() will be called after writing a
3708 file. This will flush a file to disk, ensuring that it is safely
3709 written even on filesystems which do metadata-only journaling. This
3710 will force the harddrive to spin up on Linux systems running in laptop
3711 mode, so it may be undesirable in some situations. Be warned that
3712 turning this off increases the chances of data loss after a crash. On
3713 systems without an fsync() implementation, this variable is always
3714 off.
3715 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003716 'fsync' also applies to |writefile()| (unless a flag is used to
3717 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003718 This option cannot be set from a |modeline| or in the |sandbox|, for
3719 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003720
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3722'gdefault' 'gd' boolean (default off)
3723 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724 When on, the ":substitute" flag 'g' is default on. This means that
3725 all matches in a line are substituted instead of one. When a 'g' flag
3726 is given to a ":substitute" command, this will toggle the substitution
3727 of all or one match. See |complex-change|.
3728
3729 command 'gdefault' on 'gdefault' off ~
3730 :s/// subst. all subst. one
3731 :s///g subst. one subst. all
3732 :s///gg subst. all subst. one
3733
3734 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003735 DEPRECATED: Setting this option may break plugins that are not aware
3736 of this option. Also, many users get confused that adding the /g flag
3737 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003738 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739
3740 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003741'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 Format to recognize for the ":grep" command output.
3744 This is a scanf-like string that uses the same format as the
3745 'errorformat' option: see |errorformat|.
3746
3747 *'grepprg'* *'gp'*
3748'grepprg' 'gp' string (default "grep -n ",
3749 Unix: "grep -n $* /dev/null",
3750 Win32: "findstr /n" or "grep -n",
3751 VMS: "SEARCH/NUMBERS ")
3752 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003753 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754 and '#' characters, which are expanded like when used in a command-
3755 line. The placeholder "$*" is allowed to specify where the arguments
3756 will be included. Environment variables are expanded |:set_env|. See
3757 |option-backslash| about including spaces and backslashes.
3758 When your "grep" accepts the "-H" argument, use this to make ":grep"
3759 also work well with a single file: >
3760 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003761< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003762 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3763 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003764 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 apply equally to 'grepprg'.
3766 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3767 otherwise it's "grep -n".
3768 This option cannot be set from a |modeline| or in the |sandbox|, for
3769 security reasons.
3770
3771 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3772'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3773 ve:ver35-Cursor,
3774 o:hor50-Cursor,
3775 i-ci:ver25-Cursor/lCursor,
3776 r-cr:hor20-Cursor/lCursor,
3777 sm:block-Cursor
3778 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003779 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 "n-v-c:block,o:hor50,i-ci:hor15,
3781 r-cr:hor30,sm:block")
3782 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003784 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003786 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003787 height of the cursor can be changed. This can be done by specifying a
3788 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003789 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3790 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003792 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003793 mode-list and an argument-list:
3794 mode-list:argument-list,mode-list:argument-list,..
3795 The mode-list is a dash separated list of these modes:
3796 n Normal mode
3797 v Visual mode
3798 ve Visual mode with 'selection' "exclusive" (same as 'v',
3799 if not specified)
3800 o Operator-pending mode
3801 i Insert mode
3802 r Replace mode
3803 c Command-line Normal (append) mode
3804 ci Command-line Insert mode
3805 cr Command-line Replace mode
3806 sm showmatch in Insert mode
3807 a all modes
3808 The argument-list is a dash separated list of these arguments:
3809 hor{N} horizontal bar, {N} percent of the character height
3810 ver{N} vertical bar, {N} percent of the character width
3811 block block cursor, fills the whole character
3812 [only one of the above three should be present]
3813 blinkwait{N} *cursor-blinking*
3814 blinkon{N}
3815 blinkoff{N}
3816 blink times for cursor: blinkwait is the delay before
3817 the cursor starts blinking, blinkon is the time that
3818 the cursor is shown and blinkoff is the time that the
3819 cursor is not shown. The times are in msec. When one
3820 of the numbers is zero, there is no blinking. The
3821 default is: "blinkwait700-blinkon400-blinkoff250".
3822 These numbers are used for a missing entry. This
3823 means that blinking is enabled by default. To switch
3824 blinking off you can use "blinkon0". The cursor only
3825 blinks when Vim is waiting for input, not while
3826 executing a command.
3827 To make the cursor blink in an xterm, see
3828 |xterm-blink|.
3829 {group-name}
3830 a highlight group name, that sets the color and font
3831 for the cursor
3832 {group-name}/{group-name}
3833 Two highlight group names, the first is used when
3834 no language mappings are used, the other when they
3835 are. |language-mapping|
3836
3837 Examples of parts:
3838 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3839 block cursor with colors from the "nCursor"
3840 highlight group
3841 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3842 In Insert and Command-line Insert mode, use a
3843 30% vertical bar cursor with colors from the
3844 "iCursor" highlight group. Blink a bit
3845 faster.
3846
3847 The 'a' mode is different. It will set the given argument-list for
3848 all modes. It does not reset anything to defaults. This can be used
3849 to do a common setting for all modes. For example, to switch off
3850 blinking: "a:blinkon0"
3851
3852 Examples of cursor highlighting: >
3853 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3854 :highlight Cursor gui=NONE guifg=bg guibg=fg
3855<
3856 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003857 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858'guifont' 'gfn' string (default "")
3859 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 {only available when compiled with GUI enabled}
3861 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003862 In its simplest form the value is just one font name.
3863 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864
3865 *'guifontset'* *'gfs'*
3866 *E250* *E252* *E234* *E597* *E598*
3867'guifontset' 'gfs' string (default "")
3868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 {only available when compiled with GUI enabled and
3870 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003871 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872 When not empty, specifies two (or more) fonts to be used. The first
3873 one for normal English, the second one for your special language. See
3874 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003875
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3877'guifontwide' 'gfw' string (default "")
3878 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 {only available when compiled with GUI enabled}
3880 When not empty, specifies a comma-separated list of fonts to be used
3881 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003882 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003883
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 *'guiheadroom'* *'ghr'*
3885'guiheadroom' 'ghr' number (default 50)
3886 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003887 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 The number of pixels subtracted from the screen height when fitting
3889 the GUI window on the screen. Set this before the GUI is started,
3890 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003891 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003892 lines will be left for window decorations and other items on the
3893 screen. Set it to a negative value to allow windows taller than the
3894 screen.
3895
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003896 *'guiligatures'* *'gli'* *E1243*
3897'guiligatures' 'gli' string (default "")
3898 global
3899 {only for GTK GUI}
3900 List of ASCII characters that, when combined together, can create more
3901 complex shapes. Each character must be a printable ASCII character
3902 with a value in the 32-127 range.
3903 Example: >
3904 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3905< Changing this option updates screen output immediately. Set it to an
3906 empty string to disable ligatures.
3907
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003909'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3910 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003911 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003912 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003915 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 sequence of letters which describes what components and options of the
3917 GUI should be used.
3918 To avoid problems with flags that are added in the future, use the
3919 "+=" and "-=" feature of ":set" |add-option-flags|.
3920
Bram Moolenaar13568252018-03-16 20:46:58 +01003921 Valid characters are as follows:
3922 *'go-!'*
3923 '!' External commands are executed in a terminal window. Without
3924 this flag the MS-Windows GUI will open a console window to
3925 execute the command. The Unix GUI will simulate a dumb
3926 terminal to list the command output.
3927 The terminal window will be positioned at the bottom, and grow
3928 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003929 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930 'a' Autoselect: If present, then whenever VISUAL mode is started,
3931 or the Visual area extended, Vim tries to become the owner of
3932 the windowing system's global selection. This means that the
3933 Visually highlighted text is available for pasting into other
3934 applications as well as into Vim itself. When the Visual mode
3935 ends, possibly due to an operation on the text, or when an
3936 application wants to paste the selection, the highlighted text
3937 is automatically yanked into the "* selection register.
3938 Thus the selection is still available for pasting into other
3939 applications after the VISUAL mode has ended.
3940 If not present, then Vim won't become the owner of the
3941 windowing system's global selection unless explicitly told to
3942 by a yank or delete operation for the "* register.
3943 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003944 *'go-P'*
3945 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003946 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003947 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003948 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 applies to the modeless selection.
3950
3951 'guioptions' autoselect Visual autoselect modeless ~
3952 "" - -
3953 "a" yes yes
3954 "A" - yes
3955 "aA" yes yes
3956
Bram Moolenaar02467872007-05-06 13:22:01 +00003957 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 'c' Use console dialogs instead of popup dialogs for simple
3959 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003960 *'go-d'*
3961 'd' Use dark theme variant if available. Currently only works for
3962 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003963 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003964 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003965 'guitablabel' can be used to change the text in the labels.
3966 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003967 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003968 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003969 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 'f' Foreground: Don't use fork() to detach the GUI from the shell
3971 where it was started. Use this for programs that wait for the
3972 editor to finish (e.g., an e-mail program). Alternatively you
3973 can use "gvim -f" or ":gui -f" to start the GUI in the
3974 foreground. |gui-fork|
3975 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003976 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003977 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3979 corner of the window. It's black&white on non-GTK, because of
3980 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003981 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003983 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003984 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003986 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003988 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003989 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 'g' Grey menu items: Make menu items that are not active grey. If
3991 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00003992 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993 't' Include tearoff menu items. Currently only works for Win32,
3994 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003995 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003996 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
3997 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003998 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004000 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 'R' Right-hand scrollbar is present when there is a vertically
4002 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004003 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004005 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 'L' Left-hand scrollbar is present when there is a vertically
4007 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004008 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4010 the longest visible line, or on the cursor line if the 'h'
4011 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004012 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013 'h' Limit horizontal scrollbar size to the length of the cursor
4014 line. Reduces computations. |gui-horiz-scroll|
4015
4016 And yes, you may even have scrollbars on the left AND the right if
4017 you really want to :-). See |gui-scrollbars| for more information.
4018
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004019 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 'v' Use a vertical button layout for dialogs. When not included,
4021 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004022 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004023 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024 'p' Use Pointer callbacks for X11 GUI. This is required for some
4025 window managers. If the cursor is not blinking or hollow at
4026 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004027 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004029 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004030 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004031 *'go-k'*
4032 'k' Keep the GUI window size when adding/removing a scrollbar, or
4033 toolbar, tabline, etc. Instead, the behavior is similar to
4034 when the window is maximized and will adjust 'lines' and
4035 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004036 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004037 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004038
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 *'guipty'* *'noguipty'*
4040'guipty' boolean (default on)
4041 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 {only available when compiled with GUI enabled}
4043 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4044 I/O to/from shell commands. See |gui-pty|.
4045
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004046 *'guitablabel'* *'gtl'*
4047'guitablabel' 'gtl' string (default empty)
4048 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004049 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004050 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004051 pages line. When empty and when the result is empty Vim will use a
4052 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004053
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004054 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004055 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004056 The expression will be evaluated in the |sandbox| when set from a
4057 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004058 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004059
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004060 Only used when the GUI tab pages line is displayed. 'e' must be
4061 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4062 used.
4063
Bram Moolenaar57657d82006-04-21 22:12:41 +00004064 *'guitabtooltip'* *'gtt'*
4065'guitabtooltip' 'gtt' string (default empty)
4066 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004067 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004068 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004069 pages line. When empty Vim will use a default tooltip.
4070 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004071 You can include a line break. Simplest method is to use |:let|: >
4072 :let &guitabtooltip = "line one\nline two"
4073<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004074
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004076'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 (others) "$VIMRUNTIME/doc/help.txt")
4078 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004079 Name of the main help file. All distributed help files should be
4080 placed together in one directory. Additionally, all "doc" directories
4081 in 'runtimepath' will be used.
4082 Environment variables are expanded |:set_env|. For example:
4083 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004084 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085 spaces and backslashes.
4086 This option cannot be set from a |modeline| or in the |sandbox|, for
4087 security reasons.
4088
4089 *'helpheight'* *'hh'*
4090'helpheight' 'hh' number (default 20)
4091 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 Minimal initial height of the help window when it is opened with the
4093 ":help" command. The initial height of the help window is half of the
4094 current window, or (when the 'ea' option is on) the same as other
4095 windows. When the height is less than 'helpheight', the height is
4096 set to 'helpheight'. Set to zero to disable.
4097
4098 *'helplang'* *'hlg'*
4099'helplang' 'hlg' string (default: messages language or empty)
4100 global
4101 {only available when compiled with the |+multi_lang|
4102 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004103 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 for which the desired help can be found. The English help will always
4105 be used as a last resort. You can add "en" to prefer English over
4106 another language, but that will only find tags that exist in that
4107 language and not in the English help.
4108 Example: >
4109 :set helplang=de,it
4110< This will first search German, then Italian and finally English help
4111 files.
4112 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4113 try to find the tag in the current language before using this option.
4114 See |help-translated|.
4115
4116 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4117'hidden' 'hid' boolean (default off)
4118 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 When off a buffer is unloaded when it is |abandon|ed. When on a
4120 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4121 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004122
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004124 hidden even if the 'hidden' option is off when these three are true:
4125 - the buffer is modified
4126 - 'autowrite' is off or writing is not possible
4127 - the '!' flag was used
4128 Also see |windows.txt|.
4129
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004130 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 This option is set for one command with ":hide {command}" |:hide|.
4132 WARNING: It's easy to forget that you have changes in hidden buffers.
4133 Think twice when using ":q!" or ":qa!".
4134
4135 *'highlight'* *'hl'*
4136'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004137 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4138 d:Directory,e:ErrorMsg,i:IncSearch,
4139 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004140 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004141 N:CursorLineNr,r:Question,s:StatusLine,
4142 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004143 v:Visual,V:VisualNOS,w:WarningMsg,
4144 W:WildMenu,f:Folded,F:FoldColumn,
4145 A:DiffAdd,C:DiffChange,D:DiffDelete,
4146 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004147 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004148 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004149 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4150 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004151 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004152 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004155 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004156 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004157 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004159 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4160 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161 characters from 'showbreak'
4162 |hl-Directory| d directories in CTRL-D listing and other special
4163 things in listings
4164 |hl-ErrorMsg| e error messages
4165 h (obsolete, ignored)
4166 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004167 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4169 |hl-MoreMsg| m |more-prompt|
4170 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004171 |hl-LineNr| n line number for ":number" and ":#" commands, and
4172 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004173 |hl-LineNrAbove| a line number above the cursor for when the
4174 'relativenumber' option is set.
4175 |hl-LineNrBelow| b line number below the cursor for when the
4176 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004177 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4178 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179 |hl-Question| r |hit-enter| prompt and yes/no questions
4180 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004181 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4183 |hl-VertSplit| c column used to separate vertically split windows
4184 |hl-Visual| v Visual mode
4185 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4186 Selection" Only X11 Gui's |gui-x11| and
4187 |xterm-clipboard|.
4188 |hl-WarningMsg| w warning messages
4189 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4190 |hl-Folded| f line used for closed folds
4191 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004192 |hl-DiffAdd| A added line in diff mode
4193 |hl-DiffChange| C changed line in diff mode
4194 |hl-DiffDelete| D deleted line in diff mode
4195 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004197 |hl-Conceal| - the placeholders used for concealed characters
4198 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004199 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004200 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004201 |hl-SpellRare| R rare word |spell|
4202 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004203 |hl-Pmenu| + popup menu normal line
4204 |hl-PmenuSel| = popup menu selected line
4205 |hl-PmenuSbar| x popup menu scrollbar
4206 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207
4208 The display modes are:
4209 r reverse (termcap entry "mr" and "me")
4210 i italic (termcap entry "ZH" and "ZR")
4211 b bold (termcap entry "md" and "me")
4212 s standout (termcap entry "so" and "se")
4213 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004214 c undercurl (termcap entry "Us" and "Ce")
4215 2 double underline (termcap entry "Ds" and "Ce")
4216 d dotted underline (termcap entry "ds" and "Ce")
4217 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004218 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 n no highlighting
4220 - no highlighting
4221 : use a highlight group
4222 The default is used for occasions that are not included.
4223 If you want to change what the display modes do, see |dos-colors|
4224 for an example.
4225 When using the ':' display mode, this must be followed by the name of
4226 a highlight group. A highlight group can be used to define any type
4227 of highlighting, including using color. See |:highlight| on how to
4228 define one. The default uses a different group for each occasion.
4229 See |highlight-default| for the default highlight groups.
4230
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004232'history' 'hi' number (Vim default: 50, Vi default: 0,
4233 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004236 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004238 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239 NOTE: This option is set to the Vi default value when 'compatible' is
4240 set and to the Vim default value when 'compatible' is reset.
4241
4242 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4243'hkmap' 'hk' boolean (default off)
4244 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245 {only available when compiled with the |+rightleft|
4246 feature}
4247 When on, the keyboard is mapped for the Hebrew character set.
4248 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4249 toggle this option. See |rileft.txt|.
4250 NOTE: This option is reset when 'compatible' is set.
4251
4252 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4253'hkmapp' 'hkp' boolean (default off)
4254 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004255 {only available when compiled with the |+rightleft|
4256 feature}
4257 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4258 This is useful if you have a non-Hebrew keyboard.
4259 See |rileft.txt|.
4260 NOTE: This option is reset when 'compatible' is set.
4261
Bram Moolenaar036986f2017-03-16 17:41:02 +01004262 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4263'hlsearch' 'hls' boolean (default off)
4264 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004265 {not available when compiled without the
4266 |+extra_search| feature}
4267 When there is a previous search pattern, highlight all its matches.
4268 The type of highlighting used can be set with the 'l' occasion in the
4269 'highlight' option. This uses the "Search" highlight group by
4270 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004271 are not applied. If the "CurSearch" highlight group is set then the
4272 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004273 See also: 'incsearch' and |:match|.
4274 When you get bored looking at the highlighted matches, you can turn it
4275 off with |:nohlsearch|. This does not change the option value, as
4276 soon as you use a search command, the highlighting comes back.
4277 'redrawtime' specifies the maximum time spent on finding matches.
4278 When the search pattern can match an end-of-line, Vim will try to
4279 highlight all of the matched text. However, this depends on where the
4280 search starts. This will be the first line in the window or the first
4281 line below a closed fold. A match in a previous line which is not
4282 drawn may not continue in a newly drawn line.
4283 You can specify whether the highlight status is restored on startup
4284 with the 'h' flag in 'viminfo' |viminfo-h|.
4285 NOTE: This option is reset when 'compatible' is set.
4286
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 *'icon'* *'noicon'*
4288'icon' boolean (default off, on when title can be restored)
4289 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 When on, the icon text of the window will be set to the value of
4291 'iconstring' (if it is not empty), or to the name of the file
4292 currently being edited. Only the last part of the name is used.
4293 Overridden by the 'iconstring' option.
4294 Only works if the terminal supports setting window icons (currently
4295 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4296 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4297 builtin termcap).
4298 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004299 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004301 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302
4303 *'iconstring'*
4304'iconstring' string (default "")
4305 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306 When this option is not empty, it will be used for the icon text of
4307 the window. This happens only when the 'icon' option is on.
4308 Only works if the terminal supports setting window icon text
4309 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004310 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 When Vim was compiled with HAVE_X11 defined, the original icon will be
4312 restored if possible |X11|.
4313 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004314 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004316 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 {not available when compiled without the |+statusline| feature}
4318
4319 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4320'ignorecase' 'ic' boolean (default off)
4321 global
4322 Ignore case in search patterns. Also used when searching in the tags
4323 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004324 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325 Can be overruled by using "\c" or "\C" in the pattern, see
4326 |/ignorecase|.
4327
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004328 *'imactivatefunc'* *'imaf'*
4329'imactivatefunc' 'imaf' string (default "")
4330 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004331 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004332 activate or deactivate the Input Method. The value can be the name of
4333 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4334 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004335 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004336 The expression will be evaluated in the |sandbox| when set from a
4337 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004338
4339 Example: >
4340 function ImActivateFunc(active)
4341 if a:active
4342 ... do something
4343 else
4344 ... do something
4345 endif
4346 " return value is not used
4347 endfunction
4348 set imactivatefunc=ImActivateFunc
4349<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 *'imactivatekey'* *'imak'*
4351'imactivatekey' 'imak' string (default "")
4352 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004354 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 Specifies the key that your Input Method in X-Windows uses for
4356 activation. When this is specified correctly, vim can fully control
4357 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4358 You can't use this option to change the activation key, the option
4359 tells Vim what the key is.
4360 Format:
4361 [MODIFIER_FLAG-]KEY_STRING
4362
4363 These characters can be used for MODIFIER_FLAG (case is ignored):
4364 S Shift key
4365 L Lock key
4366 C Control key
4367 1 Mod1 key
4368 2 Mod2 key
4369 3 Mod3 key
4370 4 Mod4 key
4371 5 Mod5 key
4372 Combinations are allowed, for example "S-C-space" or "SC-space" are
4373 both shift+ctrl+space.
4374 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4375
4376 Example: >
4377 :set imactivatekey=S-space
4378< "S-space" means shift+space. This is the activation key for kinput2 +
4379 canna (Japanese), and ami (Korean).
4380
4381 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4382'imcmdline' 'imc' boolean (default off)
4383 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 When set the Input Method is always on when starting to edit a command
4385 line, unless entering a search pattern (see 'imsearch' for that).
4386 Setting this option is useful when your input method allows entering
4387 English characters directly, e.g., when it's used to type accented
4388 characters with dead keys.
4389
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004390 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4392 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 When set the Input Method is never used. This is useful to disable
4394 the IM when it doesn't work properly.
4395 Currently this option is on by default for SGI/IRIX machines. This
4396 may change in later releases.
4397
4398 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004399'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401 Specifies whether :lmap or an Input Method (IM) is to be used in
4402 Insert mode. Valid values:
4403 0 :lmap is off and IM is off
4404 1 :lmap is ON and IM is off
4405 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 To always reset the option to zero when leaving Insert mode with <Esc>
4407 this can be used: >
4408 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4409< This makes :lmap and IM turn off automatically when leaving Insert
4410 mode.
4411 Note that this option changes when using CTRL-^ in Insert mode
4412 |i_CTRL-^|.
4413 The value is set to 1 when setting 'keymap' to a valid keymap name.
4414 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004415 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 methods. Use 'imdisable' to disable XIM then.
4417
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004418 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004419 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004420 |+multi_byte_ime| or |global-ime|.
4421
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004423'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 Specifies whether :lmap or an Input Method (IM) is to be used when
4426 entering a search pattern. Valid values:
4427 -1 the value of 'iminsert' is used, makes it look like
4428 'iminsert' is also used when typing a search pattern
4429 0 :lmap is off and IM is off
4430 1 :lmap is ON and IM is off
4431 2 :lmap is off and IM is ON
4432 Note that this option changes when using CTRL-^ in Command-line mode
4433 |c_CTRL-^|.
4434 The value is set to 1 when it is not -1 and setting the 'keymap'
4435 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004436 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004437 methods. Use 'imdisable' to disable XIM then.
4438
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004439 *'imstatusfunc'* *'imsf'*
4440'imstatusfunc' 'imsf' string (default "")
4441 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004442 This option specifies a function that is called to obtain the status
4443 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004444 The value can be the name of a function, a |lambda| or a |Funcref|.
4445 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004446 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004447
4448 Example: >
4449 function ImStatusFunc()
4450 let is_active = ...do something
4451 return is_active ? 1 : 0
4452 endfunction
4453 set imstatusfunc=ImStatusFunc
4454<
4455 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004456 The expression will be evaluated in the |sandbox| when set from a
4457 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004458
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004459 *'imstyle'* *'imst'*
4460'imstyle' 'imst' number (default 1)
4461 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004462 {only available when compiled with |+xim| and
4463 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004464 This option specifies the input style of Input Method:
4465 0 use on-the-spot style
4466 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004467 See: |xim-input-style|
4468
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004469 For a long time on-the-spot style had been used in the GTK version of
4470 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004471 |single-repeat|, etc. Therefore over-the-spot style becomes the
4472 default now. This should work fine for most people, however if you
4473 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004474 The expression will be evaluated in the |sandbox| when set from a
4475 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004476
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 *'include'* *'inc'*
4478'include' 'inc' string (default "^\s*#\s*include")
4479 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 {not available when compiled without the
4481 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004482 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483 pattern, just like for the "/" command (See |pattern|). The default
4484 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004485 "]I", "[d", etc.
4486 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004487 comes after the matched pattern. But if "\zs" appears in the pattern
4488 then the text matched from "\zs" to the end, or until "\ze" if it
4489 appears, is used as the file name. Use this to include characters
4490 that are not in 'isfname', such as a space. You can then use
4491 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004492 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004493
4494 *'includeexpr'* *'inex'*
4495'includeexpr' 'inex' string (default "")
4496 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004498 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004500 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 :set includeexpr=substitute(v:fname,'\\.','/','g')
4502< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004503
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004505 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 Also used for |<cfile>|.
4507
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004508 If the expression starts with s: or |<SID>|, then it is replaced with
4509 the script ID (|local-function|). Example: >
4510 set includeexpr=s:MyIncludeExpr(v:fname)
4511 set includeexpr=<SID>SomeIncludeExpr(v:fname)
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004512< Otherwise, the expression is evaluated in the context of the script
4513 where the option was set, thus script-local items are available.
4514
Bram Moolenaar30b65812012-07-12 22:01:11 +02004515 The expression will be evaluated in the |sandbox| when set from a
4516 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004517 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004518
4519 It is not allowed to change text or jump to another window while
4520 evaluating 'includeexpr' |textlock|.
4521
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004523'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004524 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004527 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004528 While typing a search command, show where the pattern, as it was typed
4529 so far, matches. The matched string is highlighted. If the pattern
4530 is invalid or not found, nothing is shown. The screen will be updated
4531 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004532 Also applies to the pattern in commands: >
4533 :global
4534 :lvimgrep
4535 :lvimgrepadd
4536 :smagic
4537 :snomagic
4538 :sort
4539 :substitute
4540 :vglobal
4541 :vimgrep
4542 :vimgrepadd
4543< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004544 original position when no match is found and when pressing <Esc>. You
4545 still need to finish the search command with <Enter> to move the
4546 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004547 You can use the CTRL-G and CTRL-T keys to move to the next and
4548 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004549 When compiled with the |+reltime| feature Vim only searches for about
4550 half a second. With a complicated pattern and/or a lot of text the
4551 match may not be found. This is to avoid that Vim hangs while you
4552 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004553 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004554 When 'hlsearch' is on, all matched strings are highlighted too while
4555 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004556 If you don't want to turn 'hlsearch' on, but want to highlight all
4557 matches while searching, you can turn on and off 'hlsearch' with
4558 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004559 augroup vimrc-incsearch-highlight
4560 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004561 autocmd CmdlineEnter /,\? :set hlsearch
4562 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004563 augroup END
4564<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004565 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004566 to the command line. If 'ignorecase' and 'smartcase' are set and the
4567 command line has no uppercase characters, the added character is
4568 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004569 CTRL-R CTRL-W can be used to add the word at the end of the current
4570 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004571 NOTE: This option is reset when 'compatible' is set.
4572
4573 *'indentexpr'* *'inde'*
4574'indentexpr' 'inde' string (default "")
4575 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004576 {not available when compiled without the |+eval|
4577 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 Expression which is evaluated to obtain the proper indent for a line.
4579 It is used when a new line is created, for the |=| operator and
4580 in Insert mode as specified with the 'indentkeys' option.
4581 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004582 'smartindent' indenting. When 'lisp' is set, this option is
4583 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 When 'paste' is set this option is not used for indenting.
4585 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004586 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004588
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004589 If the expression starts with s: or |<SID>|, then it is replaced with
4590 the script ID (|local-function|). Example: >
4591 set indentexpr=s:MyIndentExpr()
4592 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004593< Otherwise, the expression is evaluated in the context of the script
4594 where the option was set, thus script-local items are available.
4595
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596 The expression must return the number of spaces worth of indent. It
4597 can return "-1" to keep the current indent (this means 'autoindent' is
4598 used for the indent).
4599 Functions useful for computing the indent are |indent()|, |cindent()|
4600 and |lispindent()|.
4601 The evaluation of the expression must not have side effects! It must
4602 not change the text, jump to another window, etc. Afterwards the
4603 cursor position is always restored, thus the cursor may be moved.
4604 Normally this option would be set to call a function: >
4605 :set indentexpr=GetMyIndent()
4606< Error messages will be suppressed, unless the 'debug' option contains
4607 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004608 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004609 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004610
Bram Moolenaar30b65812012-07-12 22:01:11 +02004611 The expression will be evaluated in the |sandbox| when set from a
4612 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004613 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004614
4615 It is not allowed to change text or jump to another window while
4616 evaluating 'indentexpr' |textlock|.
4617
4618
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004620'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 A list of keys that, when typed in Insert mode, cause reindenting of
4623 the current line. Only happens if 'indentexpr' isn't empty.
4624 The format is identical to 'cinkeys', see |indentkeys-format|.
4625 See |C-indenting| and |indent-expression|.
4626
4627 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4628'infercase' 'inf' boolean (default off)
4629 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004631 'ignorecase' is also on, the case of the match is adjusted depending
4632 on the typed text. If the typed text contains a lowercase letter
4633 where the match has an upper case letter, the completed part is made
4634 lowercase. If the typed text has no lowercase letters and the match
4635 has a lowercase letter where the typed text has an uppercase letter,
4636 and there is a letter before it, the completed part is made uppercase.
4637 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638
4639 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4640'insertmode' 'im' boolean (default off)
4641 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 Makes Vim work in a way that Insert mode is the default mode. Useful
4643 if you want to use Vim as a modeless editor. Used for |evim|.
4644 These Insert mode commands will be useful:
4645 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004646 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 this is a mapping, it is executed as if 'insertmode' was off.
4648 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004650 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4651 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652
4653 These items change when 'insertmode' is set:
4654 - when starting to edit of a file, Vim goes to Insert mode.
4655 - <Esc> in Insert mode is a no-op and beeps.
4656 - <Esc> in Normal mode makes Vim go to Insert mode.
4657 - CTRL-L in Insert mode is a command, it is not inserted.
4658 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4659 However, when <Esc> is used inside a mapping, it behaves like
4660 'insertmode' was not set. This was done to be able to use the same
4661 mappings with 'insertmode' set or not set.
4662 When executing commands with |:normal| 'insertmode' is not used.
4663
4664 NOTE: This option is reset when 'compatible' is set.
4665
4666 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004667'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4669 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4670 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4671 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4672 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4673 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004674 The characters specified by this option are included in file names and
4675 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004676 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677 Multi-byte characters 256 and above are always included, only the
4678 characters up to 255 are specified with this option.
4679 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004680 Think twice before adding white space to this option. Although a
4681 space may appear inside a file name, the effect will be that Vim
4682 doesn't know where a file name starts or ends when doing completion.
4683 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684
4685 Note that on systems using a backslash as path separator, Vim tries to
4686 do its best to make it work as you would expect. That is a bit
4687 tricky, since Vi originally used the backslash to escape special
4688 characters. Vim will not remove a backslash in front of a normal file
4689 name character on these systems, but it will on Unix and alikes. The
4690 '&' and '^' are not included by default, because these are special for
4691 cmd.exe.
4692
4693 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004694 Each part can be a single character number or a range. A range is two
4695 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 decimal number between 0 and 255 or the ASCII character itself (does
4697 not work for digits). Example:
4698 "_,-,128-140,#-43" (include '_' and '-' and the range
4699 128 to 140 and '#' to 43)
4700 If a part starts with '^', the following character number or range
4701 will be excluded from the option. The option is interpreted from left
4702 to right. Put the excluded character after the range where it is
4703 included. To include '^' itself use it as the last character of the
4704 option or the end of a range. Example:
4705 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4706 If the character is '@', all characters where isalpha() returns TRUE
4707 are included. Normally these are the characters a to z and A to Z,
4708 plus accented characters. To include '@' itself use "@-@". Examples:
4709 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004710 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711 "a-z,A-Z,@-@" All letters plus the '@' character.
4712 A comma can be included by using it where a character number is
4713 expected. Example:
4714 "48-57,,,_" Digits, comma and underscore.
4715 A comma can be excluded by prepending a '^'. Example:
4716 " -~,^,,9" All characters from space to '~', excluding
4717 comma, plus <Tab>.
4718 See |option-backslash| about including spaces and backslashes.
4719
4720 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004721'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722 "@,48-57,_,128-167,224-235"
4723 otherwise: "@,48-57,_,192-255")
4724 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 The characters given by this option are included in identifiers.
4726 Identifiers are used in recognizing environment variables and after a
4727 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004728 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004729 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004731 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4733
4734 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004735'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736 "@,48-57,_,128-167,224-235"
4737 otherwise: "@,48-57,_,192-255"
4738 Vi default: "@,48-57,_")
4739 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004740 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004741 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004742 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004743 characters above 255 check the "word" character class (any character
4744 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004745 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004746 For a help file it is set to all non-blank printable characters except
4747 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4748 command).
4749 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004750 This option also influences syntax highlighting, unless the syntax
4751 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752 NOTE: This option is set to the Vi default value when 'compatible' is
4753 set and to the Vim default value when 'compatible' is reset.
4754
4755 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004756'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757 "@,~-255"; otherwise: "@,161-255")
4758 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 The characters given by this option are displayed directly on the
4760 screen. It is also used for "\p" in a |pattern|. The characters from
4761 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4762 even when they are not included in 'isprint' or excluded. See
4763 'isfname' for a description of the format of this option.
4764
4765 Non-printable characters are displayed with two characters:
4766 0 - 31 "^@" - "^_"
4767 32 - 126 always single characters
4768 127 "^?"
4769 128 - 159 "~@" - "~_"
4770 160 - 254 "| " - "|~"
4771 255 "~?"
4772 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4773 displayed as <xx>, with the hexadecimal value of the byte.
4774 When 'display' contains "uhex" all unprintable characters are
4775 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004776 The SpecialKey highlighting will be used for unprintable characters.
4777 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778
4779 Multi-byte characters 256 and above are always included, only the
4780 characters up to 255 are specified with this option. When a character
4781 is printable but it is not available in the current font, a
4782 replacement character will be shown.
4783 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4784 There is no option to specify these characters.
4785
4786 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4787'joinspaces' 'js' boolean (default on)
4788 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 Insert two spaces after a '.', '?' and '!' with a join command.
4790 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4791 Otherwise only one space is inserted.
4792 NOTE: This option is set when 'compatible' is set.
4793
4794 *'key'*
4795'key' string (default "")
4796 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004797 {only available when compiled with the |+cryptv|
4798 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004800 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801 Careful: Do not set the key value by hand, someone might see the typed
4802 key. Use the |:X| command. But you can make 'key' empty: >
4803 :set key=
4804< It is not possible to get the value of this option with ":set key" or
4805 "echo &key". This is to avoid showing it to someone who shouldn't
4806 know. It also means you cannot see it yourself once you have set it,
4807 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004808 You can use "&key" in an expression to detect whether encryption is
4809 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810
4811 *'keymap'* *'kmp'* *E544*
4812'keymap' 'kmp' string (default "")
4813 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814 {only available when compiled with the |+keymap|
4815 feature}
4816 Name of a keyboard mapping. See |mbyte-keymap|.
4817 Setting this option to a valid keymap name has the side effect of
4818 setting 'iminsert' to one, so that the keymap becomes effective.
4819 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004820 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004821
4822 *'keymodel'* *'km'*
4823'keymodel' 'km' string (default "")
4824 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004825 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826 can do. These values can be used:
4827 startsel Using a shifted special key starts selection (either
4828 Select mode or Visual mode, depending on "key" being
4829 present in 'selectmode').
4830 stopsel Using a not-shifted special key stops selection.
4831 Special keys in this context are the cursor keys, <End>, <Home>,
4832 <PageUp> and <PageDown>.
4833 The 'keymodel' option is set by the |:behave| command.
4834
4835 *'keywordprg'* *'kp'*
4836'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004837 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839 Program to use for the |K| command. Environment variables are
4840 expanded |:set_env|. ":help" may be used to access the Vim internal
4841 help. (Note that previously setting the global option to the empty
4842 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004843 When the first character is ":", the command is invoked as a Vim
4844 Ex command prefixed with [count].
4845 When "man", "man -s" or an Ex command is used, Vim will automatically
4846 translate a count for the "K" command and pass it as the first
4847 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848 See |option-backslash| about including spaces and backslashes.
4849 Example: >
4850 :set keywordprg=man\ -s
4851< This option cannot be set from a |modeline| or in the |sandbox|, for
4852 security reasons.
4853
4854 *'langmap'* *'lmap'* *E357* *E358*
4855'langmap' 'lmap' string (default "")
4856 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857 {only available when compiled with the |+langmap|
4858 feature}
4859 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004860 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004861 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862 care of translating these special characters to the original meaning
4863 of the key. This means you don't have to change the keyboard mode to
4864 be able to execute Normal mode commands.
4865 This is the opposite of the 'keymap' option, where characters are
4866 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004867 Also consider setting 'langremap' to off, to prevent 'langmap' from
4868 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004869 This option cannot be set from a |modeline| or in the |sandbox|, for
4870 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004872 Example (for Greek, in UTF-8): *greek* >
4873 :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 +00004874< Example (exchanges meaning of z and y for commands): >
4875 :set langmap=zy,yz,ZY,YZ
4876<
4877 The 'langmap' option is a list of parts, separated with commas. Each
4878 part can be in one of two forms:
4879 1. A list of pairs. Each pair is a "from" character immediately
4880 followed by the "to" character. Examples: "aA", "aAbBcC".
4881 2. A list of "from" characters, a semi-colon and a list of "to"
4882 characters. Example: "abc;ABC"
4883 Example: "aA,fgh;FGH,cCdDeE"
4884 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004885 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886
4887 This will allow you to activate vim actions without having to switch
4888 back and forth between the languages. Your language characters will
4889 be understood as normal vim English characters (according to the
4890 langmap mappings) in the following cases:
4891 o Normal/Visual mode (commands, buffer/register names, user mappings)
4892 o Insert/Replace Mode: Register names after CTRL-R
4893 o Insert/Replace Mode: Mappings
4894 Characters entered in Command-line mode will NOT be affected by
4895 this option. Note that this option can be changed at any time
4896 allowing to switch between mappings for different languages/encodings.
4897 Use a mapping to avoid having to type it each time!
4898
4899 *'langmenu'* *'lm'*
4900'langmenu' 'lm' string (default "")
4901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004902 {only available when compiled with the |+menu| and
4903 |+multi_lang| features}
4904 Language to use for menu translation. Tells which file is loaded
4905 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004906 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907< (without the spaces). For example, to always use the Dutch menus, no
4908 matter what $LANG is set to: >
4909 :set langmenu=nl_NL.ISO_8859-1
4910< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004911 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912 If your $LANG is set to a non-English language but you do want to use
4913 the English menus: >
4914 :set langmenu=none
4915< This option must be set before loading menus, switching on filetype
4916 detection or syntax highlighting. Once the menus are defined setting
4917 this option has no effect. But you could do this: >
4918 :source $VIMRUNTIME/delmenu.vim
4919 :set langmenu=de_DE.ISO_8859-1
4920 :source $VIMRUNTIME/menu.vim
4921< Warning: This deletes all menus that you defined yourself!
4922
Bram Moolenaard94464e2015-11-02 15:28:18 +01004923 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004924'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004925 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004926 {only available when compiled with the |+langmap|
4927 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004928 This is just like 'langremap' but with the value inverted. It only
4929 exists for backwards compatibility. When setting 'langremap' then
4930 'langnoremap' is set to the inverted value, and the other way around.
4931
4932 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004933'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004934 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004935 {only available when compiled with the |+langmap|
4936 feature}
4937 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004938 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004939 'langmap' disables some of your mappings, try resetting this option.
4940 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004941 that works for you to avoid mappings to break.
4942
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943 *'laststatus'* *'ls'*
4944'laststatus' 'ls' number (default 1)
4945 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 The value of this option influences when the last window will have a
4947 status line:
4948 0: never
4949 1: only if there are at least two windows
4950 2: always
4951 The screen looks nicer with a status line if you have several
4952 windows, but it takes another screen line. |status-line|
4953
4954 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4955'lazyredraw' 'lz' boolean (default off)
4956 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 When this option is set, the screen will not be redrawn while
4958 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004959 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01004961 This may occasionally cause display errors. It is only meant to be set
4962 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01004963 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964
4965 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4966'linebreak' 'lbr' boolean (default off)
4967 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004968 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004970 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004971 than at the last character that fits on the screen. Unlike
4972 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004973 it only affects the way the file is displayed, not its contents.
4974 If 'breakindent' is set, line is visually indented. Then, the value
4975 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004976 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977 Note that <Tab> characters after an <EOL> are mostly not displayed
4978 with the right amount of white space.
4979
4980 *'lines'* *E593*
4981'lines' number (default 24 or terminal height)
4982 global
4983 Number of lines of the Vim window.
4984 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004985 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986 When Vim is running in the GUI or in a resizable window, setting this
4987 option will cause the window size to be changed. When you only want
4988 to use the size for the GUI, put the command in your |gvimrc| file.
4989 Vim limits the number of lines to what fits on the screen. You can
4990 use this command to get the tallest window possible: >
4991 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004992< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004993 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004994 When you set this option and Vim is unable to change the physical
4995 number of lines of the display, the display may be messed up.
4996
4997 *'linespace'* *'lsp'*
4998'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000 {only in the GUI}
5001 Number of pixel lines inserted between characters. Useful if the font
5002 uses the full character cell height, making lines touch each other.
5003 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005004 With some fonts there can be too much room between lines (to have
5005 space for ascents and descents). Then it makes sense to set
5006 'linespace' to a negative value. This may cause display problems
5007 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008
5009 *'lisp'* *'nolisp'*
5010'lisp' boolean (default off)
5011 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 Lisp mode: When <Enter> is typed in insert mode set the indent for
5013 the next line to Lisp standards (well, sort of). Also happens with
5014 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5015 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5016 better. Also see 'lispwords'.
5017 The '-' character is included in keyword characters. Redefines the
5018 "=" operator to use this same indentation algorithm rather than
5019 calling an external program if 'equalprg' is empty.
5020 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005021
5022 *'lispwords'* *'lw'*
5023'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005024 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005025 Comma-separated list of words that influence the Lisp indenting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005026 |'lisp'|
5027
5028 *'list'* *'nolist'*
5029'list' boolean (default off)
5030 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005031 List mode: By default show tabs as CTRL-I is displayed, display $
5032 after end of line. Useful to see the difference between tabs and
5033 spaces and for trailing blanks. Further changed by the 'listchars'
5034 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005035
5036 The cursor is displayed at the start of the space a Tab character
5037 occupies, not at the end as usual in Normal mode. To get this cursor
5038 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005039 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005040<
5041 Note that list mode will also affect formatting (set with 'textwidth'
5042 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 changing the way tabs are displayed.
5044
5045 *'listchars'* *'lcs'*
5046'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005047 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005048 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005049 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005050 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 eol:c Character to show at the end of each line. When
5052 omitted, there is no extra character at the end of the
5053 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005054 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005055 tab:xy[z] Two or three characters to be used to show a tab.
5056 The third character is optional.
5057
5058 tab:xy The 'x' is always used, then 'y' as many times as will
5059 fit. Thus "tab:>-" displays:
5060 >
5061 >-
5062 >--
5063 etc.
5064
5065 tab:xyz The 'z' is always used, then 'x' is prepended, and
5066 then 'y' is used as many times as will fit. Thus
5067 "tab:<->" displays:
5068 >
5069 <>
5070 <->
5071 <-->
5072 etc.
5073
5074 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005075 *lcs-space*
5076 space:c Character to show for a space. When omitted, spaces
5077 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005078 *lcs-multispace*
5079 multispace:c...
5080 One or more characters to use cyclically to show for
5081 multiple consecutive spaces. Overrides the "space"
5082 setting, except for single spaces. When omitted, the
5083 "space" setting is used. For example,
5084 `:set listchars=multispace:---+` shows ten consecutive
5085 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005086 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005087 *lcs-lead*
5088 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005089 leading spaces are blank. Overrides the "space" and
5090 "multispace" settings for leading spaces. You can
5091 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005092 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005093< *lcs-leadmultispace*
5094 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005095 Like the |lcs-multispace| value, but for leading
5096 spaces only. Also overrides |lcs-lead| for leading
5097 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005098 `:set listchars=leadmultispace:---+` shows ten
5099 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005100 ---+---+--XXX ~
5101 Where "XXX" denotes the first non-blank characters in
5102 the line.
5103 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005104 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005105 trailing spaces are blank. Overrides the "space" and
5106 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005107 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108 extends:c Character to show in the last column, when 'wrap' is
5109 off and the line continues beyond the right of the
5110 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005111 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005112 precedes:c Character to show in the first visible column of the
5113 physical line, when there is text preceding the
5114 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005115 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005116 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005117 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005118 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005119 nbsp:c Character to show for a non-breakable space character
5120 (0xA0 (160 decimal) and U+202F). Left blank when
5121 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005122
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005123 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005125 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005127 Each character can be specified as hex: >
5128 set listchars=eol:\\x24
5129 set listchars=eol:\\u21b5
5130 set listchars=eol:\\U000021b5
5131< Note that a double backslash is used. The number of hex characters
5132 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5133
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134 Examples: >
5135 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005136 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005137 :set lcs=extends:>,precedes:<
5138< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005139 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5140 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005141 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142
5143 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5144'loadplugins' 'lpl' boolean (default on)
5145 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005146 When on the plugin scripts are loaded when starting up |load-plugins|.
5147 This option can be reset in your |vimrc| file to disable the loading
5148 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005149 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5150 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151
Bram Moolenaard94464e2015-11-02 15:28:18 +01005152 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005153'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005154 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005155 {only available when compiled with the |+lua/dyn|
5156 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005157 Specifies the name of the Lua shared library. The default is
5158 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005159 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005160 This option cannot be set from a |modeline| or in the |sandbox|, for
5161 security reasons.
5162
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005163 *'macatsui'* *'nomacatsui'*
5164'macatsui' boolean (default on)
5165 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005166 {not supported}
5167 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005168
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 *'magic'* *'nomagic'*
5170'magic' boolean (default on)
5171 global
5172 Changes the special characters that can be used in search patterns.
5173 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005174 WARNING: Switching this option off most likely breaks plugins! That
5175 is because many patterns assume it's on and will fail when it's off.
5176 Only switch it off when working with old Vi scripts. In any other
5177 situation write patterns that work when 'magic' is on. Include "\M"
5178 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005179 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5180 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005181
5182 *'makeef'* *'mef'*
5183'makeef' 'mef' string (default: "")
5184 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 {not available when compiled without the |+quickfix|
5186 feature}
5187 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5188 and the |:grep| command.
5189 When it is empty, an internally generated temp file will be used.
5190 When "##" is included, it is replaced by a number to make the name
5191 unique. This makes sure that the ":make" command doesn't overwrite an
5192 existing file.
5193 NOT used for the ":cf" command. See 'errorfile' for that.
5194 Environment variables are expanded |:set_env|.
5195 See |option-backslash| about including spaces and backslashes.
5196 This option cannot be set from a |modeline| or in the |sandbox|, for
5197 security reasons.
5198
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005199 *'makeencoding'* *'menc'*
5200'makeencoding' 'menc' string (default "")
5201 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005202 Encoding used for reading the output of external commands. When empty,
5203 encoding is not converted.
5204 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5205 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5206 and `:laddfile`.
5207
5208 This would be mostly useful when you use MS-Windows and set 'encoding'
5209 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5210 'makeencoding' to "char" has the same effect as setting to the system
5211 locale encoding. Example: >
5212 :set encoding=utf-8
5213 :set makeencoding=char " system locale is used
5214<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005215 *'makeprg'* *'mp'*
5216'makeprg' 'mp' string (default "make", VMS: "MMS")
5217 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005218 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005219 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5220 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005221 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005222 Environment variables are expanded |:set_env|. See |option-backslash|
5223 about including spaces and backslashes.
5224 Note that a '|' must be escaped twice: once for ":set" and once for
5225 the interpretation of a command. When you use a filter called
5226 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227 :set makeprg=gmake\ \\\|\ myfilter
5228< The placeholder "$*" can be given (even multiple times) to specify
5229 where the arguments will be included, for example: >
5230 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5231< This option cannot be set from a |modeline| or in the |sandbox|, for
5232 security reasons.
5233
5234 *'matchpairs'* *'mps'*
5235'matchpairs' 'mps' string (default "(:),{:},[:]")
5236 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005238 other.
5239 Only character pairs are allowed that are different, thus you cannot
5240 jump between two double quotes.
5241 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005242 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005243 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244 :set mps+=<:>
5245
5246< A more exotic example, to jump between the '=' and ';' in an
5247 assignment, useful for languages like C and Java: >
5248 :au FileType c,cpp,java set mps+==:;
5249
5250< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005251 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005252
5253 *'matchtime'* *'mat'*
5254'matchtime' 'mat' number (default 5)
5255 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005256 Tenths of a second to show the matching paren, when 'showmatch' is
5257 set. Note that this is not in milliseconds, like other options that
5258 set a time. This is to be compatible with Nvi.
5259
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005260 *'maxcombine'* *'mco'*
5261'maxcombine' 'mco' number (default 2)
5262 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005263 The maximum number of combining characters supported for displaying.
5264 Only used when 'encoding' is "utf-8".
5265 The default is OK for most languages. Hebrew may require 4.
5266 Maximum value is 6.
5267 Even when this option is set to 2 you can still edit text with more
5268 combining characters, you just can't see them. Use |g8| or |ga|.
5269 See |mbyte-combining|.
5270
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271 *'maxfuncdepth'* *'mfd'*
5272'maxfuncdepth' 'mfd' number (default 100)
5273 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005274 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005275 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 Maximum depth of function calls for user functions. This normally
5277 catches endless recursion. When using a recursive function with
5278 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5279 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005280 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005281 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282 See also |:function|.
5283
5284 *'maxmapdepth'* *'mmd'* *E223*
5285'maxmapdepth' 'mmd' number (default 1000)
5286 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287 Maximum number of times a mapping is done without resulting in a
5288 character to be used. This normally catches endless mappings, like
5289 ":map x y" with ":map y x". It still does not catch ":map g wg",
5290 because the 'w' is used before the next mapping is done. See also
5291 |key-mapping|.
5292
5293 *'maxmem'* *'mm'*
5294'maxmem' 'mm' number (default between 256 to 5120 (system
5295 dependent) or half the amount of memory
5296 available)
5297 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5299 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005300 other memory to be freed.
5301 The maximum usable value is about 2000000. Use this to work without a
5302 limit.
5303 The value is ignored when 'swapfile' is off.
5304 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005306 *'maxmempattern'* *'mmp'*
5307'maxmempattern' 'mmp' number (default 1000)
5308 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005309 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005310 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005311 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005312 When Vim runs into the limit it gives an error message and mostly
5313 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005314 Running into the limit often means that the pattern is very
5315 inefficient or too complex. This may already happen with the pattern
5316 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005317 Might also happen on redraw, when syntax rules try to match a complex
5318 text structure.
5319 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5320 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005321
Bram Moolenaar071d4272004-06-13 20:20:40 +00005322 *'maxmemtot'* *'mmt'*
5323'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5324 dependent) or half the amount of memory
5325 available)
5326 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005327 Maximum amount of memory in Kbyte to use for all buffers together.
5328 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005329 without a limit.
5330 On 64 bit machines higher values might work. But hey, do you really
5331 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005332 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005333 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005334 Buffers with 'swapfile' off still count to the total amount of memory
5335 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005336 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005337
5338 *'menuitems'* *'mis'*
5339'menuitems' 'mis' number (default 25)
5340 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341 {not available when compiled without the |+menu|
5342 feature}
5343 Maximum number of items to use in a menu. Used for menus that are
5344 generated from a list of items, e.g., the Buffers menu. Changing this
5345 option has no direct effect, the menu must be refreshed first.
5346
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005347 *'mkspellmem'* *'msm'*
5348'mkspellmem' 'msm' string (default "460000,2000,500")
5349 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005350 {not available when compiled without the |+syntax|
5351 feature}
5352 Parameters for |:mkspell|. This tunes when to start compressing the
5353 word tree. Compression can be slow when there are many words, but
5354 it's needed to avoid running out of memory. The amount of memory used
5355 per word depends very much on how similar the words are, that's why
5356 this tuning is complicated.
5357
5358 There are three numbers, separated by commas:
5359 {start},{inc},{added}
5360
5361 For most languages the uncompressed word tree fits in memory. {start}
5362 gives the amount of memory in Kbyte that can be used before any
5363 compression is done. It should be a bit smaller than the amount of
5364 memory that is available to Vim.
5365
5366 When going over the {start} limit the {inc} number specifies the
5367 amount of memory in Kbyte that can be allocated before another
5368 compression is done. A low number means compression is done after
5369 less words are added, which is slow. A high number means more memory
5370 will be allocated.
5371
5372 After doing compression, {added} times 1024 words can be added before
5373 the {inc} limit is ignored and compression is done when any extra
5374 amount of memory is needed. A low number means there is a smaller
5375 chance of hitting the {inc} limit, less memory is used but it's
5376 slower.
5377
5378 The languages for which these numbers are important are Italian and
5379 Hungarian. The default works for when you have about 512 Mbyte. If
5380 you have 1 Gbyte you could use: >
5381 :set mkspellmem=900000,3000,800
5382< If you have less than 512 Mbyte |:mkspell| may fail for some
5383 languages, no matter what you set 'mkspellmem' to.
5384
Bram Moolenaar07607392019-05-26 19:20:43 +02005385 This option cannot be set from a |modeline| or in the |sandbox|.
5386
Bram Moolenaar071d4272004-06-13 20:20:40 +00005387 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005388'modeline' 'ml' boolean (Vim default: on (off for root),
5389 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005391 If 'modeline' is on 'modelines' gives the number of lines that is
5392 checked for set commands. If 'modeline' is off or 'modelines' is zero
5393 no lines are checked. See |modeline|.
5394
5395 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5396'modelineexpr' 'mle' boolean (default: off)
5397 global
5398 When on allow some options that are an expression to be set in the
5399 modeline. Check the option for whether it is affected by
5400 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005401 This option cannot be set from a |modeline| or in the |sandbox|, for
5402 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005403
Bram Moolenaar071d4272004-06-13 20:20:40 +00005404 *'modelines'* *'mls'*
5405'modelines' 'mls' number (default 5)
5406 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407 If 'modeline' is on 'modelines' gives the number of lines that is
5408 checked for set commands. If 'modeline' is off or 'modelines' is zero
5409 no lines are checked. See |modeline|.
5410 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5411 set and to the Vim default value when 'compatible' is reset.
5412
5413 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005414 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415'modifiable' 'ma' boolean (default on)
5416 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005417 When off the buffer contents cannot be changed. The 'fileformat' and
5418 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005419 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420
5421 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5422'modified' 'mod' boolean (default off)
5423 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424 When on, the buffer is considered to be modified. This option is set
5425 when:
5426 1. A change was made to the text since it was last written. Using the
5427 |undo| command to go back to the original text will reset the
5428 option. But undoing changes that were made before writing the
5429 buffer will set the option again, since the text is different from
5430 when it was written.
5431 2. 'fileformat' or 'fileencoding' is different from its original
5432 value. The original value is set when the buffer is read or
5433 written. A ":set nomodified" command also resets the original
5434 values to the current values and the 'modified' option will be
5435 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005436 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005437 This option is not set when a change is made to the buffer as the
5438 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5439 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5440 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5442 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005443 Note that the text may actually be the same, e.g. 'modified' is set
5444 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445
5446 *'more'* *'nomore'*
5447'more' boolean (Vim default: on, Vi default: off)
5448 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005449 When on, listings pause when the whole screen is filled. You will get
5450 the |more-prompt|. When this option is off there are no pauses, the
5451 listing continues until finished.
5452 NOTE: This option is set to the Vi default value when 'compatible' is
5453 set and to the Vim default value when 'compatible' is reset.
5454
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005455 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005456'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005457 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005458 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005459 Enable the use of the mouse. Works for most terminals (xterm, Win32
5460 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5461 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5462 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005463 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005464 v Visual mode
5465 i Insert mode
5466 c Command-line mode
5467 h all previous modes when editing a help file
5468 a all previous modes
5469 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005470 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005472< If your terminal can't overrule the mouse events going to the
5473 application, use: >
5474 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005475< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005476 back to Vim using the mouse events.
5477 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5478 "xterm".
5479
5480 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 modeless selection. This doesn't move the text cursor.
5482
5483 See |mouse-using|. Also see |'clipboard'|.
5484
5485 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005486 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487 the mouse buttons can still be used by keeping the shift key pressed.
5488 Also see the 'clipboard' option.
5489
5490 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5491'mousefocus' 'mousef' boolean (default off)
5492 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493 {only works in the GUI}
5494 The window that the mouse pointer is on is automatically activated.
5495 When changing the window layout or window focus in another way, the
5496 mouse pointer is moved to the window with keyboard focus. Off is the
5497 default because it makes using the pull down menus a little goofy, as
5498 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005499 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005500 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005501
5502 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5503'mousehide' 'mh' boolean (default on)
5504 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505 {only works in the GUI}
5506 When on, the mouse pointer is hidden when characters are typed.
5507 The mouse pointer is restored when the mouse is moved.
5508
5509 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005510'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005511 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512 Sets the model to use for the mouse. The name mostly specifies what
5513 the right mouse button is used for:
5514 extend Right mouse button extends a selection. This works
5515 like in an xterm.
5516 popup Right mouse button pops up a menu. The shifted left
5517 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005518 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519 popup_setpos Like "popup", but the cursor will be moved to the
5520 position where the mouse was clicked, and thus the
5521 selected operation will act upon the clicked object.
5522 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005523 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 course, that right clicking outside a selection will
5525 end Visual mode.
5526 Overview of what button does what for each model:
5527 mouse extend popup(_setpos) ~
5528 left click place cursor place cursor
5529 left drag start selection start selection
5530 shift-left search word extend selection
5531 right click extend selection popup menu (place cursor)
5532 right drag extend selection -
5533 middle click paste paste
5534
5535 In the "popup" model the right mouse button produces a pop-up menu.
5536 You need to define this first, see |popup-menu|.
5537
5538 Note that you can further refine the meaning of buttons with mappings.
5539 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5540 selection (because that's handled in the GUI code directly).
5541
5542 The 'mousemodel' option is set by the |:behave| command.
5543
Ernie Raelc4cb5442022-04-03 15:47:28 +01005544 *'mousemoveevent'* *'mousemev'*
5545'mousemoveevent' 'mousemev' boolean (default off)
5546 global
5547 {only works in the GUI}
5548 When on, mouse move events are delivered to the input queue and are
5549 available for mapping. The default, off, avoids the mouse movement
5550 overhead except when needed. See |gui-mouse-mapping|.
5551 Warning: Setting this option can make pending mappings to be aborted
5552 when the mouse is moved.
5553 Currently only works in the GUI, may be made to work in a terminal
5554 later.
5555
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005557'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5558 vs:leftright,vd:lrsizing,m:no,
5559 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005561 {only available when compiled with the |+mouseshape|
5562 feature}
5563 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005564 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 like used for 'guicursor'. Each part consist of a mode/location-list
5566 and an argument-list:
5567 mode-list:shape,mode-list:shape,..
5568 The mode-list is a dash separated list of these modes/locations:
5569 In a normal window: ~
5570 n Normal mode
5571 v Visual mode
5572 ve Visual mode with 'selection' "exclusive" (same as 'v',
5573 if not specified)
5574 o Operator-pending mode
5575 i Insert mode
5576 r Replace mode
5577
5578 Others: ~
5579 c appending to the command-line
5580 ci inserting in the command-line
5581 cr replacing in the command-line
5582 m at the 'Hit ENTER' or 'More' prompts
5583 ml idem, but cursor in the last line
5584 e any mode, pointer below last window
5585 s any mode, pointer on a status line
5586 sd any mode, while dragging a status line
5587 vs any mode, pointer on a vertical separator line
5588 vd any mode, while dragging a vertical separator line
5589 a everywhere
5590
5591 The shape is one of the following:
5592 avail name looks like ~
5593 w x arrow Normal mouse pointer
5594 w x blank no pointer at all (use with care!)
5595 w x beam I-beam
5596 w x updown up-down sizing arrows
5597 w x leftright left-right sizing arrows
5598 w x busy The system's usual busy pointer
5599 w x no The system's usual 'no input' pointer
5600 x udsizing indicates up-down resizing
5601 x lrsizing indicates left-right resizing
5602 x crosshair like a big thin +
5603 x hand1 black hand
5604 x hand2 white hand
5605 x pencil what you write with
5606 x question big ?
5607 x rightup-arrow arrow pointing right-up
5608 w x up-arrow arrow pointing up
5609 x <number> any X11 pointer number (see X11/cursorfont.h)
5610
5611 The "avail" column contains a 'w' if the shape is available for Win32,
5612 x for X11.
5613 Any modes not specified or shapes not available use the normal mouse
5614 pointer.
5615
5616 Example: >
5617 :set mouseshape=s:udsizing,m:no
5618< will make the mouse turn to a sizing arrow over the status lines and
5619 indicate no input when the hit-enter prompt is displayed (since
5620 clicking the mouse has no effect in this state.)
5621
5622 *'mousetime'* *'mouset'*
5623'mousetime' 'mouset' number (default 500)
5624 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005625 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626 time in msec between two mouse clicks for the second click to be
5627 recognized as a multi click.
5628
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005629 *'mzschemedll'*
5630'mzschemedll' string (default depends on the build)
5631 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005632 {only available when compiled with the |+mzscheme/dyn|
5633 feature}
5634 Specifies the name of the MzScheme shared library. The default is
5635 DYNAMIC_MZSCH_DLL which was specified at compile time.
5636 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005637 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005638 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005639 This option cannot be set from a |modeline| or in the |sandbox|, for
5640 security reasons.
5641
5642 *'mzschemegcdll'*
5643'mzschemegcdll' string (default depends on the build)
5644 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005645 {only available when compiled with the |+mzscheme/dyn|
5646 feature}
5647 Specifies the name of the MzScheme GC shared library. The default is
5648 DYNAMIC_MZGC_DLL which was specified at compile time.
5649 The value can be equal to 'mzschemedll' if it includes the GC code.
5650 Environment variables are expanded |:set_env|.
5651 This option cannot be set from a |modeline| or in the |sandbox|, for
5652 security reasons.
5653
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005654 *'mzquantum'* *'mzq'*
5655'mzquantum' 'mzq' number (default 100)
5656 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005657 {not available when compiled without the |+mzscheme|
5658 feature}
5659 The number of milliseconds between polls for MzScheme threads.
5660 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005661 NOTE: This option is set to the Vim default value when 'compatible'
5662 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005663
Bram Moolenaar071d4272004-06-13 20:20:40 +00005664 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005665'nrformats' 'nf' string (default "bin,octal,hex",
5666 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668 This defines what bases Vim will consider for numbers when using the
5669 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5670 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005671 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005673 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005674 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005676 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005677 considered to be hexadecimal. Example: Using CTRL-X on
5678 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005679 bin If included, numbers starting with "0b" or "0B" will be
5680 considered to be binary. Example: Using CTRL-X on
5681 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005682 unsigned If included, numbers are recognized as unsigned. Thus a
5683 leading dash or negative sign won't be considered as part of
5684 the number. Examples:
5685 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5686 (without "unsigned" it would become "9-2021").
5687 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5688 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005689 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5690 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 Numbers which simply begin with a digit in the range 1-9 are always
5692 considered decimal. This also happens for numbers that are not
5693 recognized as octal or hex.
5694
5695 *'number'* *'nu'* *'nonumber'* *'nonu'*
5696'number' 'nu' boolean (default off)
5697 local to window
5698 Print the line number in front of each line. When the 'n' option is
5699 excluded from 'cpoptions' a wrapped line will not use the column of
5700 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005701 The 'numberwidth' option can be used to set the room used for the line
5702 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 When a long, wrapped line doesn't start with the first character, '-'
5704 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005705 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5706 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005707 *number_relativenumber*
5708 The 'relativenumber' option changes the displayed number to be
5709 relative to the cursor. Together with 'number' there are these
5710 four combinations (cursor in line 3):
5711
Bram Moolenaar3848e002016-03-19 18:42:29 +01005712 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005713 'nornu' 'nornu' 'rnu' 'rnu'
5714
5715 |apple | 1 apple | 2 apple | 2 apple
5716 |pear | 2 pear | 1 pear | 1 pear
5717 |nobody | 3 nobody | 0 nobody |3 nobody
5718 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005719
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005720 *'numberwidth'* *'nuw'*
5721'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5722 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005723 {only available when compiled with the |+linebreak|
5724 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005725 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005726 when the 'number' or 'relativenumber' option is set or printing lines
5727 with a line number. Since one space is always between the number and
5728 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005729 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005730 fit the highest line number in the buffer respectively the number of
5731 rows in the window, depending on whether 'number' or 'relativenumber'
5732 is set. Thus with the Vim default of 4 there is room for a line number
5733 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005734 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005735 NOTE: This option is set to the Vi default value when 'compatible' is
5736 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005737
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005738 *'omnifunc'* *'ofu'*
5739'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005740 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005741 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005742 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005743 This option specifies a function to be used for Insert mode omni
5744 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005745 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005746 invoked and what it should return. The value can be the name of a
5747 function, a |lambda| or a |Funcref|. See |option-value-function| for
5748 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005749 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005750 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005751 This option cannot be set from a |modeline| or in the |sandbox|, for
5752 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005753
5754
Bram Moolenaar02467872007-05-06 13:22:01 +00005755 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005756'opendevice' 'odev' boolean (default off)
5757 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005758 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005759 Enable reading and writing from devices. This may get Vim stuck on a
5760 device that can be opened but doesn't actually do the I/O. Therefore
5761 it is off by default.
5762 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5763 result in editing a device.
5764
5765
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005766 *'operatorfunc'* *'opfunc'*
5767'operatorfunc' 'opfunc' string (default: empty)
5768 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005769 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005770 See |:map-operator| for more info and an example. The value can be
5771 the name of a function, a |lambda| or a |Funcref|. See
5772 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005773
5774 This option cannot be set from a |modeline| or in the |sandbox|, for
5775 security reasons.
5776
5777
Bram Moolenaar251e1912011-06-19 05:09:16 +02005778 *'osfiletype'* *'oft'*
5779'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005781 This option was supported on RISC OS, which has been removed.
5782
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005784 *'packpath'* *'pp'*
5785'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005786 Directories used to find packages. See |packages|.
5787
5788
Bram Moolenaar071d4272004-06-13 20:20:40 +00005789 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005790'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005791 global
5792 Specifies the nroff macros that separate paragraphs. These are pairs
5793 of two letters (see |object-motions|).
5794
5795 *'paste'* *'nopaste'*
5796'paste' boolean (default off)
5797 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005798 Put Vim in Paste mode. This is useful if you want to cut or copy
5799 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005800 unexpected effects.
5801 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005802 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005803 knows about pasting and will mostly do the right thing without 'paste'
5804 being set. The same is true for a terminal where Vim handles the
5805 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005806 This option is reset when starting the GUI. Thus if you set it in
5807 your .vimrc it will work in a terminal, but not in the GUI. Setting
5808 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5809 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005810 When the 'paste' option is switched on (also when it was already on):
5811 - mapping in Insert mode and Command-line mode is disabled
5812 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005814 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005815 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005816 - 'revins' is reset
5817 - 'ruler' is reset
5818 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005819 - 'smarttab' is reset
5820 - 'softtabstop' is set to 0
5821 - 'textwidth' is set to 0
5822 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005823 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005825 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005826 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005827 - 'indentexpr'
5828 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005829 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005830 NOTE: When you start editing another file while the 'paste' option is
5831 on, settings from the modelines or autocommands may change the
5832 settings again, causing trouble when pasting text. You might want to
5833 set the 'paste' option again.
5834 When the 'paste' option is reset the mentioned options are restored to
5835 the value before the moment 'paste' was switched from off to on.
5836 Resetting 'paste' before ever setting it does not have any effect.
5837 Since mapping doesn't work while 'paste' is active, you need to use
5838 the 'pastetoggle' option to toggle the 'paste' option with some key.
5839
5840 *'pastetoggle'* *'pt'*
5841'pastetoggle' 'pt' string (default "")
5842 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843 When non-empty, specifies the key sequence that toggles the 'paste'
5844 option. This is like specifying a mapping: >
5845 :map {keys} :set invpaste<CR>
5846< Where {keys} is the value of 'pastetoggle'.
5847 The difference is that it will work even when 'paste' is set.
5848 'pastetoggle' works in Insert mode and Normal mode, but not in
5849 Command-line mode.
5850 Mappings are checked first, thus overrule 'pastetoggle'. However,
5851 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5852 this: >
5853 :map <F10> :set paste<CR>
5854 :map <F11> :set nopaste<CR>
5855 :imap <F10> <C-O>:set paste<CR>
5856 :imap <F11> <nop>
5857 :set pastetoggle=<F11>
5858< This will make <F10> start paste mode and <F11> stop paste mode.
5859 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5860 mode everything is inserted literally, except the 'pastetoggle' key
5861 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005862 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863
5864 *'pex'* *'patchexpr'*
5865'patchexpr' 'pex' string (default "")
5866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005867 {not available when compiled without the |+diff|
5868 feature}
5869 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005870 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871
Bram Moolenaardbc28022014-07-26 13:40:44 +02005872 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873'patchmode' 'pm' string (default "")
5874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005875 When non-empty the oldest version of a file is kept. This can be used
5876 to keep the original version of a file if you are changing files in a
5877 source distribution. Only the first time that a file is written a
5878 copy of the original file will be kept. The name of the copy is the
5879 name of the original file with the string in the 'patchmode' option
5880 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005881 ".orig" or ".org". 'backupdir' must not be empty for this to work
5882 (Detail: The backup file is renamed to the patchmode file after the
5883 new file has been successfully written, that's why it must be possible
5884 to write a backup file). If there was no file to be backed up, an
5885 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 When the 'backupskip' pattern matches, a patchmode file is not made.
5887 Using 'patchmode' for compressed files appends the extension at the
5888 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5889 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005890 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005892 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005893'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894 other systems: ".,,")
5895 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005897 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5898 provided that the file being searched for has a relative path (not
5899 starting with "/", "./" or "../"). The directories in the 'path'
5900 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005901 - Use commas to separate directory names: >
5902 :set path=.,/usr/local/include,/usr/include
5903< - Spaces can also be used to separate directory names (for backwards
5904 compatibility with version 3.0). To have a space in a directory
5905 name, precede it with an extra backslash, and escape the space: >
5906 :set path=.,/dir/with\\\ space
5907< - To include a comma in a directory name precede it with an extra
5908 backslash: >
5909 :set path=.,/dir/with\\,comma
5910< - To search relative to the directory of the current file, use: >
5911 :set path=.
5912< - To search in the current directory use an empty string between two
5913 commas: >
5914 :set path=,,
5915< - A directory name may end in a ':' or '/'.
5916 - Environment variables are expanded |:set_env|.
5917 - When using |netrw.vim| URLs can be used. For example, adding
5918 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005919 - Search upwards and downwards in a directory tree using "*", "**" and
5920 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921 {not available when compiled without the |+path_extra| feature}
5922 - Careful with '\' characters, type two to get one in the option: >
5923 :set path=.,c:\\include
5924< Or just use '/' instead: >
5925 :set path=.,c:/include
5926< Don't forget "." or files won't even be found in the same directory as
5927 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005928 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005929 it is something like 256 or 1024 characters.
5930 You can check if all the include files are found, using the value of
5931 'path', see |:checkpath|.
5932 The use of |:set+=| and |:set-=| is preferred when adding or removing
5933 directories from the list. This avoids problems when a future version
5934 uses another default. To remove the current directory use: >
5935 :set path-=
5936< To add the current directory use: >
5937 :set path+=
5938< To use an environment variable, you probably need to replace the
5939 separator. Here is an example to append $INCL, in which directory
5940 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005941 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005942< Replace the ';' with a ':' or whatever separator is used. Note that
5943 this doesn't work when $INCL contains a comma or white space.
5944
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005945 *'perldll'*
5946'perldll' string (default depends on the build)
5947 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005948 {only available when compiled with the |+perl/dyn|
5949 feature}
5950 Specifies the name of the Perl shared library. The default is
5951 DYNAMIC_PERL_DLL, which was specified at compile time.
5952 Environment variables are expanded |:set_env|.
5953 This option cannot be set from a |modeline| or in the |sandbox|, for
5954 security reasons.
5955
Bram Moolenaar071d4272004-06-13 20:20:40 +00005956 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5957'preserveindent' 'pi' boolean (default off)
5958 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005959 When changing the indent of the current line, preserve as much of the
5960 indent structure as possible. Normally the indent is replaced by a
5961 series of tabs followed by spaces as required (unless |'expandtab'| is
5962 enabled, in which case only spaces are used). Enabling this option
5963 means the indent will preserve as many existing characters as possible
5964 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005965 'expandtab' does not apply to the preserved white space, a Tab remains
5966 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967 NOTE: When using ">>" multiple times the resulting indent is a mix of
5968 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005969 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005970 Also see 'copyindent'.
5971 Use |:retab| to clean up white space.
5972
5973 *'previewheight'* *'pvh'*
5974'previewheight' 'pvh' number (default 12)
5975 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005976 {not available when compiled without the |+quickfix|
5977 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005978 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005979 commands. Used for |CTRL-W_}| when no count is given. Not used when
5980 'previewpopup' is set.
5981
5982 *'previewpopup'* *'pvp'*
5983'previewpopup' 'pvp' string (default empty)
5984 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005985 {not available when compiled without the |+textprop|
5986 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005987 When not empty a popup window is used for commands that would open a
5988 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005989 Not used for the insert completion info, add "popup" to
5990 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005991
5992 *'previewwindow'* *'nopreviewwindow'*
5993 *'pvw'* *'nopvw'* *E590*
5994'previewwindow' 'pvw' boolean (default off)
5995 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005996 {not available when compiled without the |+quickfix|
5997 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005998 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999 set. It's normally not set directly, but by using one of the commands
6000 |:ptag|, |:pedit|, etc.
6001
6002 *'printdevice'* *'pdev'*
6003'printdevice' 'pdev' string (default empty)
6004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005 {only available when compiled with the |+printer|
6006 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006007 The name of the printer to be used for |:hardcopy|.
6008 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006009 This option cannot be set from a |modeline| or in the |sandbox|, for
6010 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006011
Bram Moolenaar8299df92004-07-10 09:47:34 +00006012 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006013'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006014 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015 {only available when compiled with the |+printer|
6016 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006017 Sets the character encoding used when printing.
6018 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006019
6020 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006021'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006022 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023 {only available when compiled with the |+printer|
6024 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006025 Expression used to print the PostScript produced with |:hardcopy|.
6026 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006027 This option cannot be set from a |modeline| or in the |sandbox|, for
6028 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029
Bram Moolenaar8299df92004-07-10 09:47:34 +00006030 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031'printfont' 'pfn' string (default "courier")
6032 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033 {only available when compiled with the |+printer|
6034 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006035 The name of the font that will be used for |:hardcopy|.
6036 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006037
6038 *'printheader'* *'pheader'*
6039'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6040 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006041 {only available when compiled with the |+printer|
6042 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006043 The format of the header produced in |:hardcopy| output.
6044 See |pheader-option|.
6045
6046 *'printmbcharset'* *'pmbcs'*
6047'printmbcharset' 'pmbcs' string (default "")
6048 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006049 {only available when compiled with the |+printer|
6050 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006051 The CJK character set to be used for CJK output from |:hardcopy|.
6052 See |pmbcs-option|.
6053
6054 *'printmbfont'* *'pmbfn'*
6055'printmbfont' 'pmbfn' string (default "")
6056 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006057 {only available when compiled with the |+printer|
6058 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006059 List of font names to be used for CJK output from |:hardcopy|.
6060 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061
6062 *'printoptions'* *'popt'*
6063'printoptions' 'popt' string (default "")
6064 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006065 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006066 List of items that control the format of the output of |:hardcopy|.
6067 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006068
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006069 *'prompt'* *'noprompt'*
6070'prompt' boolean (default on)
6071 global
6072 When on a ":" prompt is used in Ex mode.
6073
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006074 *'pumheight'* *'ph'*
6075'pumheight' 'ph' number (default 0)
6076 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006077 Determines the maximum number of items to show in the popup menu for
6078 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006079 |ins-completion-menu|.
6080
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006081 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006082'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006083 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006084 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006085 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006086
Bram Moolenaard94464e2015-11-02 15:28:18 +01006087 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006088'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006089 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006090 {only available when compiled with the |+python/dyn|
6091 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006092 Specifies the name of the Python 2.x shared library. The default is
6093 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006094 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006095 This option cannot be set from a |modeline| or in the |sandbox|, for
6096 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006097
Bram Moolenaar94073162018-01-31 21:49:05 +01006098 *'pythonhome'*
6099'pythonhome' string (default "")
6100 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006101 {only available when compiled with the |+python/dyn|
6102 feature}
6103 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6104 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6105 which was specified at compile time, will be used for the Python 2.x
6106 home directory.
6107 Environment variables are expanded |:set_env|.
6108 This option cannot be set from a |modeline| or in the |sandbox|, for
6109 security reasons.
6110
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006111 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006112'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006113 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006114 {only available when compiled with the |+python3/dyn|
6115 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006116 Specifies the name of the Python 3 shared library. The default is
6117 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006118 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006119 This option cannot be set from a |modeline| or in the |sandbox|, for
6120 security reasons.
6121
Bram Moolenaar94073162018-01-31 21:49:05 +01006122 *'pythonthreehome'*
6123'pythonthreehome' string (default "")
6124 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006125 {only available when compiled with the |+python3/dyn|
6126 feature}
6127 Specifies the name of the Python 3 home directory. When
6128 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6129 PYTHON3_HOME, which was specified at compile time, will be used for
6130 the Python 3 home directory.
6131 Environment variables are expanded |:set_env|.
6132 This option cannot be set from a |modeline| or in the |sandbox|, for
6133 security reasons.
6134
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006135 *'pyxversion'* *'pyx'*
6136'pyxversion' 'pyx' number (default depends on the build)
6137 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006138 {only available when compiled with the |+python| or
6139 the |+python3| feature}
6140 Specifies the python version used for pyx* functions and commands
6141 |python_x|. The default value is as follows:
6142
6143 Compiled with Default ~
6144 |+python| and |+python3| 0
6145 only |+python| 2
6146 only |+python3| 3
6147
6148 Available values are 0, 2 and 3.
6149 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6150 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6151 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6152 to 2 if Python 2 is available.
6153 See also: |has-pythonx|
6154
6155 If Vim is compiled with only |+python| or |+python3| setting
6156 'pyxversion' has no effect. The pyx* functions and commands are
6157 always the same as the compiled version.
6158
6159 This option cannot be set from a |modeline| or in the |sandbox|, for
6160 security reasons.
6161
Bram Moolenaar858ba062020-05-31 23:11:59 +02006162 *'quickfixtextfunc'* *'qftf'*
6163'quickfixtextfunc' 'qftf' string (default "")
6164 global
6165 {only available when compiled with the |+quickfix|
6166 feature}
6167 This option specifies a function to be used to get the text to display
6168 in the quickfix and location list windows. This can be used to
6169 customize the information displayed in the quickfix or location window
6170 for each entry in the corresponding quickfix or location list. See
6171 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006172 function and an example. The value can be the name of a function, a
6173 |lambda| or a |Funcref|. See |option-value-function| for more
6174 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006175
6176 This option cannot be set from a |modeline| or in the |sandbox|, for
6177 security reasons.
6178
Bram Moolenaar677ee682005-01-27 14:41:15 +00006179 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006180'quoteescape' 'qe' string (default "\")
6181 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006182 The characters that are used to escape quotes in a string. Used for
6183 objects like a', a" and a` |a'|.
6184 When one of the characters in this option is found inside a string,
6185 the following character will be skipped. The default value makes the
6186 text "foo\"bar\\" considered to be one string.
6187
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6189'readonly' 'ro' boolean (default off)
6190 local to buffer
6191 If on, writes fail unless you use a '!'. Protects you from
6192 accidentally overwriting a file. Default on when Vim is started
6193 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006194 When using ":w!" the 'readonly' option is reset for the current
6195 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006196 When using the ":view" command the 'readonly' option is set for the
6197 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006198 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006200 *'redrawtime'* *'rdt'*
6201'redrawtime' 'rdt' number (default 2000)
6202 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006203 {only available when compiled with the |+reltime|
6204 feature}
6205 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006206 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006207 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006208 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006209 matches will be highlighted.
6210 For syntax highlighting the time applies per window. When over the
6211 limit syntax highlighting is disabled until |CTRL-L| is used.
6212 This is used to avoid that Vim hangs when using a very complicated
6213 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006214
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006215 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006216'regexpengine' 're' number (default 0)
6217 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006218 This selects the default regexp engine. |two-engines|
6219 The possible values are:
6220 0 automatic selection
6221 1 old engine
6222 2 NFA engine
6223 Note that when using the NFA engine and the pattern contains something
6224 that is not supported the pattern will not match. This is only useful
6225 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006226 Using automatic selection enables Vim to switch the engine, if the
6227 default engine becomes too costly. E.g., when the NFA engine uses too
6228 many states. This should prevent Vim from hanging on a combination of
6229 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006230
Bram Moolenaar64486672010-05-16 15:46:46 +02006231 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6232'relativenumber' 'rnu' boolean (default off)
6233 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006234 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006235 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006236 precede some vertical motion commands (e.g. j k + -) with, without
6237 having to calculate it yourself. Especially useful in combination with
6238 other commands (e.g. y d c < > gq gw =).
6239 When the 'n' option is excluded from 'cpoptions' a wrapped
6240 line will not use the column of line numbers (this is the default when
6241 'compatible' isn't set).
6242 The 'numberwidth' option can be used to set the room used for the line
6243 number.
6244 When a long, wrapped line doesn't start with the first character, '-'
6245 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006246 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6247 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006248
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006249 The number in front of the cursor line also depends on the value of
6250 'number', see |number_relativenumber| for all combinations of the two
6251 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006252
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 *'remap'* *'noremap'*
6254'remap' boolean (default on)
6255 global
6256 Allows for mappings to work recursively. If you do not want this for
6257 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006258 NOTE: To avoid portability problems with Vim scripts, always keep
6259 this option at the default "on". Only switch it off when working with
6260 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006262 *'renderoptions'* *'rop'*
6263'renderoptions' 'rop' string (default: empty)
6264 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006265 {only available when compiled with GUI and DIRECTX on
6266 MS-Windows}
6267 Select a text renderer and set its options. The options depend on the
6268 renderer.
6269
6270 Syntax: >
6271 set rop=type:{renderer}(,{name}:{value})*
6272<
6273 Currently, only one optional renderer is available.
6274
6275 render behavior ~
6276 directx Vim will draw text using DirectX (DirectWrite). It makes
6277 drawn glyphs more beautiful than default GDI.
6278 It requires 'encoding' is "utf-8", and only works on
6279 MS-Windows Vista or newer version.
6280
6281 Options:
6282 name meaning type value ~
6283 gamma gamma float 1.0 - 2.2 (maybe)
6284 contrast enhancedContrast float (unknown)
6285 level clearTypeLevel float (unknown)
6286 geom pixelGeometry int 0 - 2 (see below)
6287 renmode renderingMode int 0 - 6 (see below)
6288 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006289 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006290
Bram Moolenaar92467d32017-12-05 13:22:16 +01006291 See this URL for detail (except for scrlines):
6292 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006293
6294 For geom: structure of a device pixel.
6295 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6296 1 - DWRITE_PIXEL_GEOMETRY_RGB
6297 2 - DWRITE_PIXEL_GEOMETRY_BGR
6298
6299 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006300 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006301
6302 For renmode: method of rendering glyphs.
6303 0 - DWRITE_RENDERING_MODE_DEFAULT
6304 1 - DWRITE_RENDERING_MODE_ALIASED
6305 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6306 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6307 4 - DWRITE_RENDERING_MODE_NATURAL
6308 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6309 6 - DWRITE_RENDERING_MODE_OUTLINE
6310
6311 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006312 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006313
6314 For taamode: antialiasing mode used for drawing text.
6315 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6316 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6317 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6318 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6319
6320 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006321 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6322
Bram Moolenaara338adc2018-01-31 20:51:47 +01006323 For scrlines:
6324 This was used for optimizing scrolling behavior, however this
6325 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006326
6327 Example: >
6328 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006329 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006330 set rop=type:directx
6331<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006332 If select a raster font (Courier, Terminal or FixedSys which
6333 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006334 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006335
6336 NOTE: It is known that some fonts and options combination
6337 causes trouble on drawing glyphs.
6338
Bram Moolenaar92467d32017-12-05 13:22:16 +01006339 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006340 special made fonts (True-Type fonts which includes only
6341 bitmap glyphs).
6342 - 'taamode:3' will not work with some vector fonts.
6343
6344 NOTE: With this option, you can display colored emoji
6345 (emoticon) in Windows 8.1 or later. To display colored emoji,
6346 there are some conditions which you should notice.
6347
6348 - If your font includes non-colored emoji already, it will
6349 be used.
6350 - If your font doesn't have emoji, the system chooses an
6351 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6352 will be used.
6353 - When this alternative font didn't have fixed width glyph,
6354 emoji might be rendered beyond the bounding box of drawing
6355 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006356
6357 Other render types are currently not supported.
6358
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 *'report'*
6360'report' number (default 2)
6361 global
6362 Threshold for reporting number of lines changed. When the number of
6363 changed lines is more than 'report' a message will be given for most
6364 ":" commands. If you want it always, set 'report' to 0.
6365 For the ":substitute" command the number of substitutions is used
6366 instead of the number of lines.
6367
6368 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6369'restorescreen' 'rs' boolean (default on)
6370 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006371 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 When set, the screen contents is restored when exiting Vim. This also
6373 happens when executing external commands.
6374
6375 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6376 options in your .vimrc. To disable restoring:
6377 set t_ti= t_te=
6378 To enable restoring (for an xterm):
6379 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6380 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6381
6382 *'revins'* *'ri'* *'norevins'* *'nori'*
6383'revins' 'ri' boolean (default off)
6384 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385 {only available when compiled with the |+rightleft|
6386 feature}
6387 Inserting characters in Insert mode will work backwards. See "typing
6388 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6389 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006390 NOTE: This option is reset when 'compatible' is set.
6391 This option is reset when 'paste' is set and restored when 'paste' is
6392 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393
6394 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6395'rightleft' 'rl' boolean (default off)
6396 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397 {only available when compiled with the |+rightleft|
6398 feature}
6399 When on, display orientation becomes right-to-left, i.e., characters
6400 that are stored in the file appear from the right to the left.
6401 Using this option, it is possible to edit files for languages that
6402 are written from the right to the left such as Hebrew and Arabic.
6403 This option is per window, so it is possible to edit mixed files
6404 simultaneously, or to view the same file in both ways (this is
6405 useful whenever you have a mixed text file with both right-to-left
6406 and left-to-right strings so that both sets are displayed properly
6407 in different windows). Also see |rileft.txt|.
6408
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006409 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410'rightleftcmd' 'rlc' string (default "search")
6411 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 {only available when compiled with the |+rightleft|
6413 feature}
6414 Each word in this option enables the command line editing to work in
6415 right-to-left mode for a group of commands:
6416
6417 search "/" and "?" commands
6418
6419 This is useful for languages such as Hebrew, Arabic and Farsi.
6420 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6421
Bram Moolenaard94464e2015-11-02 15:28:18 +01006422 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006423'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006424 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006425 {only available when compiled with the |+ruby/dyn|
6426 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006427 Specifies the name of the Ruby shared library. The default is
6428 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006429 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006430 This option cannot be set from a |modeline| or in the |sandbox|, for
6431 security reasons.
6432
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006434'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006435 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 {not available when compiled without the
6437 |+cmdline_info| feature}
6438 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006439 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 text in the file is shown on the far right:
6441 Top first line is visible
6442 Bot last line is visible
6443 All first and last line are visible
6444 45% relative position in the file
6445 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006446 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006448 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006449 this option takes precedence over 'ruler' and 'rulerformat'
6450 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006451 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006452 the text column (byte number) and the screen column are shown,
6453 separated with a dash.
6454 For an empty line "0-1" is shown.
6455 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006456 This option is reset when 'paste' is set and restored when 'paste' is
6457 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 If you don't want to see the ruler all the time but want to know where
6459 you are, use "g CTRL-G" |g_CTRL-G|.
6460 NOTE: This option is reset when 'compatible' is set.
6461
6462 *'rulerformat'* *'ruf'*
6463'rulerformat' 'ruf' string (default empty)
6464 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 {not available when compiled without the |+statusline|
6466 feature}
6467 When this option is not empty, it determines the content of the ruler
6468 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006469 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006470 This option cannot be set in a modeline when 'modelineexpr' is off.
6471
Bram Moolenaar071d4272004-06-13 20:20:40 +00006472 The default ruler width is 17 characters. To make the ruler 15
6473 characters wide, put "%15(" at the start and "%)" at the end.
6474 Example: >
6475 :set rulerformat=%15(%c%V\ %p%%%)
6476<
6477 *'runtimepath'* *'rtp'* *vimfiles*
6478'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006479 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480 $VIM/vimfiles,
6481 $VIMRUNTIME,
6482 $VIM/vimfiles/after,
6483 $HOME/.vim/after"
6484 Amiga: "home:vimfiles,
6485 $VIM/vimfiles,
6486 $VIMRUNTIME,
6487 $VIM/vimfiles/after,
6488 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006489 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 $VIM/vimfiles,
6491 $VIMRUNTIME,
6492 $VIM/vimfiles/after,
6493 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006494 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 $VIMRUNTIME,
6496 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006497 Haiku: "$BE_USER_SETTINGS/vim,
6498 $VIM/vimfiles,
6499 $VIMRUNTIME,
6500 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006501 $BE_USER_SETTINGS/vim/after"
6502 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 $VIM/vimfiles,
6504 $VIMRUNTIME,
6505 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006506 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006507 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 This is a list of directories which will be searched for runtime
6509 files:
6510 filetype.vim filetypes by file name |new-filetype|
6511 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006512 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513 colors/ color scheme files |:colorscheme|
6514 compiler/ compiler files |:compiler|
6515 doc/ documentation |write-local-help|
6516 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006517 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 indent/ indent scripts |indent-expression|
6519 keymap/ key mapping files |mbyte-keymap|
6520 lang/ menu translations |:menutrans|
6521 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006522 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006523 plugin/ plugin scripts |write-plugin|
6524 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006525 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 syntax/ syntax files |mysyntaxfile|
6527 tutor/ files for vimtutor |tutor|
6528
6529 And any other file searched for with the |:runtime| command.
6530
6531 The defaults for most systems are setup to search five locations:
6532 1. In your home directory, for your personal preferences.
6533 2. In a system-wide Vim directory, for preferences from the system
6534 administrator.
6535 3. In $VIMRUNTIME, for files distributed with Vim.
6536 *after-directory*
6537 4. In the "after" directory in the system-wide Vim directory. This is
6538 for the system administrator to overrule or add to the distributed
6539 defaults (rarely needed)
6540 5. In the "after" directory in your home directory. This is for
6541 personal preferences to overrule or add to the distributed defaults
6542 or system-wide settings (rarely needed).
6543
Bram Moolenaard0796902016-09-16 20:02:31 +02006544 More entries are added when using |packages|. If it gets very long
6545 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6546 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006547
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6549 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006550 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006551 wildcards.
6552 See |:runtime|.
6553 Example: >
6554 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6555< This will use the directory "~/vimruntime" first (containing your
6556 personal Vim runtime files), then "/mygroup/vim" (shared between a
6557 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6558 files).
6559 You probably should always include $VIMRUNTIME somewhere, to use the
6560 distributed runtime files. You can put a directory before $VIMRUNTIME
6561 to find files which replace a distributed runtime files. You can put
6562 a directory after $VIMRUNTIME to find files which add to distributed
6563 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006564 When Vim is started with |--clean| the home directory entries are not
6565 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 This option cannot be set from a |modeline| or in the |sandbox|, for
6567 security reasons.
6568
6569 *'scroll'* *'scr'*
6570'scroll' 'scr' number (default: half the window height)
6571 local to window
6572 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6573 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006574 changes. This may happen when enabling the |status-line| or
6575 'tabline' option after setting the 'scroll' option.
6576 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006577 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006578 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006579
6580 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6581'scrollbind' 'scb' boolean (default off)
6582 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006583 See also |scroll-binding|. When this option is set, the current
6584 window scrolls as other scrollbind windows (windows that also have
6585 this option set) scroll. This option is useful for viewing the
6586 differences between two versions of a file, see 'diff'.
6587 See |'scrollopt'| for options that determine how this option should be
6588 interpreted.
6589 This option is mostly reset when splitting a window to edit another
6590 file. This means that ":split | edit file" results in two windows
6591 with scroll-binding, but ":split file" does not.
6592
Bram Moolenaarae20f342019-11-05 21:09:23 +01006593 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6594'scrollfocus' 'scf' boolean (default off)
6595 global
6596 {only for MS-Windows GUI}
6597 When using the scroll wheel and this option is set, the window under
6598 the mouse pointer is scrolled. With this option off the current
6599 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006600 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006601
Bram Moolenaar071d4272004-06-13 20:20:40 +00006602 *'scrolljump'* *'sj'*
6603'scrolljump' 'sj' number (default 1)
6604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 Minimal number of lines to scroll when the cursor gets off the
6606 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6607 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006608 When set to a negative number from -1 to -100 this is used as the
6609 percentage of the window height. Thus -50 scrolls half the window
6610 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611 NOTE: This option is set to 1 when 'compatible' is set.
6612
6613 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006614'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006615 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 Minimal number of screen lines to keep above and below the cursor.
6617 This will make some context visible around where you are working. If
6618 you set it to a very large value (999) the cursor line will always be
6619 in the middle of the window (except at the start or end of the file or
6620 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006621 After using the local value, go back the global value with one of
6622 these two: >
6623 setlocal scrolloff<
6624 setlocal scrolloff=-1
6625< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 NOTE: This option is set to 0 when 'compatible' is set.
6627
6628 *'scrollopt'* *'sbo'*
6629'scrollopt' 'sbo' string (default "ver,jump")
6630 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006632 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6633 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 The following words are available:
6635 ver Bind vertical scrolling for 'scrollbind' windows
6636 hor Bind horizontal scrolling for 'scrollbind' windows
6637 jump Applies to the offset between two windows for vertical
6638 scrolling. This offset is the difference in the first
6639 displayed line of the bound windows. When moving
6640 around in a window, another 'scrollbind' window may
6641 reach a position before the start or after the end of
6642 the buffer. The offset is not changed though, when
6643 moving back the 'scrollbind' window will try to scroll
6644 to the desired position when possible.
6645 When now making that window the current one, two
6646 things can be done with the relative offset:
6647 1. When "jump" is not included, the relative offset is
6648 adjusted for the scroll position in the new current
6649 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006650 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651 2. When "jump" is included, the other windows are
6652 scrolled to keep the same relative offset. When
6653 going back to the other window, it still uses the
6654 same relative offset.
6655 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006656 When 'diff' mode is active there always is vertical scroll binding,
6657 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658
6659 *'sections'* *'sect'*
6660'sections' 'sect' string (default "SHNHH HUnhsh")
6661 global
6662 Specifies the nroff macros that separate sections. These are pairs of
6663 two letters (See |object-motions|). The default makes a section start
6664 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6665
6666 *'secure'* *'nosecure'* *E523*
6667'secure' boolean (default off)
6668 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 When on, ":autocmd", shell and write commands are not allowed in
6670 ".vimrc" and ".exrc" in the current directory and map commands are
6671 displayed. Switch it off only if you know that you will not run into
6672 problems, or when the 'exrc' option is off. On Unix this option is
6673 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006674 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 'secure' at the end of your ~/.vimrc then.
6676 This option cannot be set from a |modeline| or in the |sandbox|, for
6677 security reasons.
6678
6679 *'selection'* *'sel'*
6680'selection' 'sel' string (default "inclusive")
6681 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006682 This option defines the behavior of the selection. It is only used
6683 in Visual and Select mode.
6684 Possible values:
6685 value past line inclusive ~
6686 old no yes
6687 inclusive yes yes
6688 exclusive yes no
6689 "past line" means that the cursor is allowed to be positioned one
6690 character past the line.
6691 "inclusive" means that the last character of the selection is included
6692 in an operation. For example, when "x" is used to delete the
6693 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006694 When "old" is used and 'virtualedit' allows the cursor to move past
6695 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 Note that when "exclusive" is used and selecting from the end
6697 backwards, you cannot include the last character of a line, when
6698 starting in Normal mode and 'virtualedit' empty.
6699
6700 The 'selection' option is set by the |:behave| command.
6701
6702 *'selectmode'* *'slm'*
6703'selectmode' 'slm' string (default "")
6704 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006705 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706 Select mode instead of Visual mode, when a selection is started.
6707 Possible values:
6708 mouse when using the mouse
6709 key when using shifted special keys
6710 cmd when using "v", "V" or CTRL-V
6711 See |Select-mode|.
6712 The 'selectmode' option is set by the |:behave| command.
6713
6714 *'sessionoptions'* *'ssop'*
6715'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006716 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006718 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 feature}
6720 Changes the effect of the |:mksession| command. It is a comma
6721 separated list of words. Each word enables saving and restoring
6722 something:
6723 word save and restore ~
6724 blank empty windows
6725 buffers hidden and unloaded buffers, not just those in windows
6726 curdir the current directory
6727 folds manually created folds, opened/closed folds and local
6728 fold options
6729 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006730 and contain at least one lowercase letter. Only
6731 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 help the help window
6733 localoptions options and mappings local to a window or buffer (not
6734 global values for local options)
6735 options all options and mappings (also global values for local
6736 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006737 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738 resize size of the Vim window: 'lines' and 'columns'
6739 sesdir the directory in which the session file is located
6740 will become the current directory (useful with
6741 projects accessed over a network from different
6742 systems)
6743 slash backslashes in file names replaced with forward
6744 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006745 tabpages all tab pages; without this only the current tab page
6746 is restored, so that you can make a session for each
6747 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006748 terminal include terminal windows where the command can be
6749 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 unix with Unix end-of-line format (single <NL>), even when
6751 on Windows or DOS
6752 winpos position of the whole Vim window
6753 winsize window sizes
6754
6755 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006756 When neither "curdir" nor "sesdir" is included, file names are stored
6757 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006758 If you leave out "options" many things won't work well after restoring
6759 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006760 "slash" and "unix" are useful on Windows when sharing session files
6761 with Unix. The Unix version of Vim cannot source dos format scripts,
6762 but the Windows version of Vim can source unix format scripts.
6763
6764 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006765'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766 global
6767 Name of the shell to use for ! and :! commands. When changing the
6768 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6769 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006770 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006771 See |option-backslash| about including spaces and backslashes.
6772 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006773
Bram Moolenaara2baa732022-02-04 16:09:54 +00006774 In |restricted-mode| shell commands will not be possible. This mode
6775 is used if the value of $SHELL ends in "false" or "nologin".
6776
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006777 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006778 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006779 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6780< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006781 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006783 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006785 Example with escaped space (Vim will do this when initializing the
6786 option from $SHELL): >
6787 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006788< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006789 backslashes are consumed by `:set`.
6790
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791 Under MS-Windows, when the executable ends in ".com" it must be
6792 included. Thus setting the shell to "command.com" or "4dos.com"
6793 works, but "command" and "4dos" do not work for all commands (e.g.,
6794 filtering).
6795 For unknown reasons, when using "4dos.com" the current directory is
6796 changed to "C:\". To avoid this set 'shell' like this: >
6797 :set shell=command.com\ /c\ 4dos
6798< This option cannot be set from a |modeline| or in the |sandbox|, for
6799 security reasons.
6800
6801 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006802'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006803 Win32, when 'shell' contains "powershell":
6804 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006805 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006807 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006808 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6809 For MS-Windows, the default is set according to the value of 'shell',
6810 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006811 On Unix it can have more than one flag. Each white space separated
6812 part is passed as an argument to the shell command.
6813 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006814 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006815 This option cannot be set from a |modeline| or in the |sandbox|, for
6816 security reasons.
6817
6818 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006819'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6820 "2>&1| tee", or
6821 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 {not available when compiled without the |+quickfix|
6824 feature}
6825 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006826 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827 including spaces and backslashes.
6828 The name of the temporary file can be represented by "%s" if necessary
6829 (the file name is appended automatically if no %s appears in the value
6830 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006831 For the Amiga the default is ">". For MS-Windows using powershell the
6832 default is "2>&1 | Out-File -Encoding default", otherwise the default
6833 is ">%s 2>&1". The output is directly saved in a file and not echoed
6834 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006835 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 in a file and echoed to the screen. If the 'shell' option is "csh" or
6837 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006838 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006839 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6840 means that stderr is also included. Before using the 'shell' option a
6841 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006842 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6843 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 The initialization of this option is done after reading the ".vimrc"
6845 and the other initializations, so that when the 'shell' option is set
6846 there, the 'shellpipe' option changes automatically, unless it was
6847 explicitly set before.
6848 When 'shellpipe' is set to an empty string, no redirection of the
6849 ":make" output will be done. This is useful if you use a 'makeprg'
6850 that writes to 'makeef' by itself. If you want no piping, but do
6851 want to include the 'makeef', set 'shellpipe' to a single space.
6852 Don't forget to precede the space with a backslash: ":set sp=\ ".
6853 In the future pipes may be used for filtering and this option will
6854 become obsolete (at least for Unix).
6855 This option cannot be set from a |modeline| or in the |sandbox|, for
6856 security reasons.
6857
6858 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006859'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006861 Quoting character(s), put around the command passed to the shell, for
6862 the "!" and ":!" commands. The redirection is kept outside of the
6863 quoting. See 'shellxquote' to include the redirection. It's
6864 probably not useful to set both options.
6865 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006866 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006867 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 This option cannot be set from a |modeline| or in the |sandbox|, for
6869 security reasons.
6870
6871 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006872'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6873 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875 String to be used to put the output of a filter command in a temporary
6876 file. See also |:!|. See |option-backslash| about including spaces
6877 and backslashes.
6878 The name of the temporary file can be represented by "%s" if necessary
6879 (the file name is appended automatically if no %s appears in the value
6880 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006881 The default is ">". For Unix, if the 'shell' option is "csh" or
6882 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006883 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006884 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6885 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006886 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6887 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006888 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6889 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890 The initialization of this option is done after reading the ".vimrc"
6891 and the other initializations, so that when the 'shell' option is set
6892 there, the 'shellredir' option changes automatically unless it was
6893 explicitly set before.
6894 In the future pipes may be used for filtering and this option will
6895 become obsolete (at least for Unix).
6896 This option cannot be set from a |modeline| or in the |sandbox|, for
6897 security reasons.
6898
6899 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6900'shellslash' 'ssl' boolean (default off)
6901 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006902 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006904 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006905 powershell.exe. Backward slashes can still be typed, but they are
6906 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907 Note that setting or resetting this option has no effect for some
6908 existing file names, thus this option needs to be set before opening
6909 any file for best results. This might change in the future.
6910 'shellslash' only works when a backslash can be used as a path
6911 separator. To test if this is so use: >
6912 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006913< Also see 'completeslash'.
6914
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006915 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6916'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6917 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006918 When on, use temp files for shell commands. When off use a pipe.
6919 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006920 Currently a pipe is only supported on Unix and MS-Windows 2K and
6921 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006922 :if has("filterpipe")
6923< The advantage of using a pipe is that nobody can read the temp file
6924 and the 'shell' command does not need to support redirection.
6925 The advantage of using a temp file is that the file type and encoding
6926 can be detected.
6927 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6928 |FilterWritePost| autocommands event are not triggered when
6929 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006930 The `system()` function does not respect this option and always uses
6931 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006932 NOTE: This option is set to the Vim default value when 'compatible'
6933 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006934
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 *'shelltype'* *'st'*
6936'shelltype' 'st' number (default 0)
6937 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006938 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006939 On the Amiga this option influences the way how the commands work
6940 which use a shell.
6941 0 and 1: always use the shell
6942 2 and 3: use the shell only to filter lines
6943 4 and 5: use shell only for ':sh' command
6944 When not using the shell, the command is executed directly.
6945
6946 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6947 1 and 3: use "shell cmd" to start external commands
6948
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006949 *'shellxescape'* *'sxe'*
6950'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006951 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006952 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006953 When 'shellxquote' is set to "(" then the characters listed in this
6954 option will be escaped with a '^' character. This makes it possible
6955 to execute most external commands with cmd.exe.
6956
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 *'shellxquote'* *'sxq'*
6958'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006959 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006960 for Win32, when 'shell' is
6961 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006962 for Win32, when 'shell' contains "sh"
6963 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964 for Unix, when using system(): "\"")
6965 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 Quoting character(s), put around the command passed to the shell, for
6967 the "!" and ":!" commands. Includes the redirection. See
6968 'shellquote' to exclude the redirection. It's probably not useful
6969 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006970 When the value is '(' then ')' is appended. When the value is '"('
6971 then ')"' is appended.
6972 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006973 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006974 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6975 pwsh.exe which automatically strips off the first and last quote on a
6976 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6977 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006978 'shell', to reduce the need to set this option by the user. See
6979 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006980 This option cannot be set from a |modeline| or in the |sandbox|, for
6981 security reasons.
6982
6983 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6984'shiftround' 'sr' boolean (default off)
6985 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 Round indent to multiple of 'shiftwidth'. Applies to > and <
6987 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6988 a multiple of 'shiftwidth' (this is Vi compatible).
6989 NOTE: This option is reset when 'compatible' is set.
6990
6991 *'shiftwidth'* *'sw'*
6992'shiftwidth' 'sw' number (default 8)
6993 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006994 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006995 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006996 When zero the 'ts' value will be used. Use the |shiftwidth()|
6997 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006998
6999 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007000'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7001 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007002 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003 This option helps to avoid all the |hit-enter| prompts caused by file
7004 messages, for example with CTRL-G, and to avoid some other messages.
7005 It is a list of flags:
7006 flag meaning when present ~
7007 f use "(3 of 5)" instead of "(file 3 of 5)"
7008 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02007009 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007010 m use "[+]" instead of "[Modified]"
7011 n use "[New]" instead of "[New File]"
7012 r use "[RO]" instead of "[readonly]"
7013 w use "[w]" instead of "written" for file write message
7014 and "[a]" instead of "appended" for ':w >> file' command
7015 x use "[dos]" instead of "[dos format]", "[unix]" instead of
7016 "[unix format]" and "[mac]" instead of "[mac format]".
7017 a all of the above abbreviations
7018
7019 o overwrite message for writing a file with subsequent message
7020 for reading a file (useful for ":wn" or when 'autowrite' on)
7021 O message for reading a file overwrites any previous message.
7022 Also for quickfix message (e.g., ":cn").
7023 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02007024 hit TOP, continuing at BOTTOM" messages; when using the search
7025 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007026 t truncate file message at the start if it is too long to fit
7027 on the command-line, "<" will appear in the left most column.
7028 Ignored in Ex mode.
7029 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00007030 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031 Ignored in Ex mode.
7032 W don't give "written" or "[w]" when writing a file
7033 A don't give the "ATTENTION" message when an existing swap file
7034 is found.
7035 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02007036 c don't give |ins-completion-menu| messages. For example,
7037 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
7038 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01007039 q use "recording" instead of "recording @a"
7040 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02007041 was used for the command; note that this also affects messages
7042 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007043 S do not show search count message when searching, e.g.
7044 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045
7046 This gives you the opportunity to avoid that a change between buffers
7047 requires you to hit <Enter>, but still gives as useful a message as
7048 possible for the space available. To get the whole message that you
7049 would have got with 'shm' empty, use ":file!"
7050 Useful values:
7051 shm= No abbreviation of message.
7052 shm=a Abbreviation, but no loss of information.
7053 shm=at Abbreviation, and truncate message when necessary.
7054
7055 NOTE: This option is set to the Vi default value when 'compatible' is
7056 set and to the Vim default value when 'compatible' is reset.
7057
7058 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7059'shortname' 'sn' boolean (default off)
7060 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061 Filenames are assumed to be 8 characters plus one extension of 3
7062 characters. Multiple dots in file names are not allowed. When this
7063 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007064 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007065 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007066 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007067
7068 *'showbreak'* *'sbr'* *E595*
7069'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007070 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007071 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007072 feature}
7073 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007074 values are "> " or "+++ ": >
7075 :set showbreak=>\
7076< Note the backslash to escape the trailing space. It's easier like
7077 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007078 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007079< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080 comma (in a future version the comma might be used to separate the
7081 part that is shown at the end and at the start of a line).
7082 The characters are highlighted according to the '@' flag in
7083 'highlight'.
7084 Note that tabs after the showbreak will be displayed differently.
7085 If you want the 'showbreak' to appear in between line numbers, add the
7086 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007087 A window-local value overrules a global value. If the global value is
7088 set and you want no value in the current window use NONE: >
7089 :setlocal showbreak=NONE
7090<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007091 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007092'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7093 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 {not available when compiled without the
7096 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007097 Show (partial) command in the last line of the screen. Set this
7098 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 In Visual mode the size of the selected area is shown:
7100 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007101 If the number of bytes is different it is also displayed: "2-6"
7102 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007104 - When selecting a block, the size in screen characters:
7105 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106 NOTE: This option is set to the Vi default value when 'compatible' is
7107 set and to the Vim default value when 'compatible' is reset.
7108
7109 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7110'showfulltag' 'sft' boolean (default off)
7111 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007112 When completing a word in insert mode (see |ins-completion|) from the
7113 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007114 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 matched a C function, you can see a template for what arguments are
7116 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007117 Note that this doesn't work well together with having "longest" in
7118 'completeopt', because the completion from the search pattern may not
7119 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120
7121 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7122'showmatch' 'sm' boolean (default off)
7123 global
7124 When a bracket is inserted, briefly jump to the matching one. The
7125 jump is only done if the match can be seen on the screen. The time to
7126 show the match can be set with 'matchtime'.
7127 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007128 seen or not).
7129 This option is reset when 'paste' is set and restored when 'paste' is
7130 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007131 When the 'm' flag is not included in 'cpoptions', typing a character
7132 will immediately move the cursor back to where it belongs.
7133 See the "sm" field in 'guicursor' for setting the cursor shape and
7134 blinking when showing the match.
7135 The 'matchpairs' option can be used to specify the characters to show
7136 matches for. 'rightleft' and 'revins' are used to look for opposite
7137 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007138 Also see the matchparen plugin for highlighting the match when moving
7139 around |pi_paren.txt|.
7140 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141
7142 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7143'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7144 global
7145 If in Insert, Replace or Visual mode put a message on the last line.
7146 Use the 'M' flag in 'highlight' to set the type of highlighting for
7147 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007148 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 doesn't mean XIM is really active, especially when 'imactivatekey' is
7150 not set.
7151 NOTE: This option is set to the Vi default value when 'compatible' is
7152 set and to the Vim default value when 'compatible' is reset.
7153
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007154 *'showtabline'* *'stal'*
7155'showtabline' 'stal' number (default 1)
7156 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007157 The value of this option specifies when the line with tab page labels
7158 will be displayed:
7159 0: never
7160 1: only if there are at least two tab pages
7161 2: always
7162 This is both for the GUI and non-GUI implementation of the tab pages
7163 line.
7164 See |tab-page| for more information about tab pages.
7165
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 *'sidescroll'* *'ss'*
7167'sidescroll' 'ss' number (default 0)
7168 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 The minimal number of columns to scroll horizontally. Used only when
7170 the 'wrap' option is off and the cursor is moved off of the screen.
7171 When it is zero the cursor will be put in the middle of the screen.
7172 When using a slow terminal set it to a large number or 0. When using
7173 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7174 commands.
7175
7176 *'sidescrolloff'* *'siso'*
7177'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007178 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007180 right of the cursor if 'nowrap' is set. Setting this option to a
7181 value greater than 0 while having |'sidescroll'| also at a non-zero
7182 value makes some context visible in the line you are scrolling in
7183 horizontally (except at beginning of the line). Setting this option
7184 to a large value (like 999) has the effect of keeping the cursor
7185 horizontally centered in the window, as long as one does not come too
7186 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007187 After using the local value, go back the global value with one of
7188 these two: >
7189 setlocal sidescrolloff<
7190 setlocal sidescrolloff=-1
7191< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007192
7193 Example: Try this together with 'sidescroll' and 'listchars' as
7194 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007195 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007196
7197 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7198 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007199<
7200 *'signcolumn'* *'scl'*
7201'signcolumn' 'scl' string (default "auto")
7202 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007203 {not available when compiled without the |+signs|
7204 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007205 Whether or not to draw the signcolumn. Valid values are:
7206 "auto" only when there is a sign to display
7207 "no" never
7208 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007209 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007210 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211
7212
7213 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7214'smartcase' 'scs' boolean (default off)
7215 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216 Override the 'ignorecase' option if the search pattern contains upper
7217 case characters. Only used when the search pattern is typed and
7218 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007219 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7221 recalling the search pattern from history and hitting <Enter>.
7222 NOTE: This option is reset when 'compatible' is set.
7223
7224 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7225'smartindent' 'si' boolean (default off)
7226 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007227 Do smart autoindenting when starting a new line. Works for C-like
7228 programs, but can also be used for other languages. 'cindent' does
7229 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007230 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007231 setting 'si' has no effect. 'indentexpr' is a more advanced
7232 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233 Normally 'autoindent' should also be on when using 'smartindent'.
7234 An indent is automatically inserted:
7235 - After a line ending in '{'.
7236 - After a line starting with a keyword from 'cinwords'.
7237 - Before a line starting with '}' (only with the "O" command).
7238 When typing '}' as the first character in a new line, that line is
7239 given the same indent as the matching '{'.
7240 When typing '#' as the first character in a new line, the indent for
7241 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007242 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7244 When using the ">>" command, lines starting with '#' are not shifted
7245 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007246 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007247 This option is reset when 'paste' is set and restored when 'paste' is
7248 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249
7250 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7251'smarttab' 'sta' boolean (default off)
7252 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007254 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7255 <BS> will delete a 'shiftwidth' worth of space at the start of the
7256 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007257 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007258 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7259 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007260 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007261 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007262 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007263 This option is reset when 'paste' is set and restored when 'paste' is
7264 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265 NOTE: This option is reset when 'compatible' is set.
7266
7267 *'softtabstop'* *'sts'*
7268'softtabstop' 'sts' number (default 0)
7269 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007270 Number of spaces that a <Tab> counts for while performing editing
7271 operations, like inserting a <Tab> or using <BS>. It "feels" like
7272 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7273 used. This is useful to keep the 'ts' setting at its standard value
7274 of 8, while being able to edit like it is set to 'sts'. However,
7275 commands like "x" still work on the actual characters.
7276 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007277 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007278 'softtabstop' is set to 0 when the 'paste' option is set and restored
7279 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007280 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7281 spaces is minimized by using <Tab>s.
7282 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7283 set.
7284 NOTE: This option is set to 0 when 'compatible' is set.
7285
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007286 If Vim is compiled with the |+vartabs| feature then the value of
7287 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7288 anything other than an empty string.
7289
Bram Moolenaar217ad922005-03-20 22:37:15 +00007290 *'spell'* *'nospell'*
7291'spell' boolean (default off)
7292 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007293 {not available when compiled without the |+syntax|
7294 feature}
7295 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007296 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007297
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007298 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007299'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007300 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007301 {not available when compiled without the |+syntax|
7302 feature}
7303 Pattern to locate the end of a sentence. The following word will be
7304 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007305 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007306 When this check is not wanted make this option empty.
7307 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007308 Be careful with special characters, see |option-backslash| about
7309 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007310 To set this option automatically depending on the language, see
7311 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007312
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007313 *'spellfile'* *'spf'*
7314'spellfile' 'spf' string (default empty)
7315 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007316 {not available when compiled without the |+syntax|
7317 feature}
7318 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007319 commands. It must end in ".{encoding}.add". You need to include the
7320 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007321 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007322 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007323 |zg| and |zw| commands can be used to access each. This allows using
7324 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007325 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007326 you: Using the first directory in 'runtimepath' that is writable. If
7327 there is no "spell" directory yet it will be created. For the file
7328 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007329 ignoring the region.
7330 The resulting ".spl" file will be used for spell checking, it does not
7331 have to appear in 'spelllang'.
7332 Normally one file is used for all regions, but you can add the region
7333 name if you want to. However, it will then only be used when
7334 'spellfile' is set to it, for entries in 'spelllang' only files
7335 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007336 This option cannot be set from a |modeline| or in the |sandbox|, for
7337 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007338
Bram Moolenaar217ad922005-03-20 22:37:15 +00007339 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007340'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007341 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007342 {not available when compiled without the |+syntax|
7343 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007344 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007345 on spellchecking will be done for these languages. Example: >
7346 set spelllang=en_us,nl,medical
7347< This means US English, Dutch and medical words are recognized. Words
7348 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007349 The word list name must consist of alphanumeric characters, a dash or
7350 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007351 recommended to separate the two letter language name from a
7352 specification. Thus "en-rare" is used for rare English words.
7353 A region name must come last and have the form "_xx", where "xx" is
7354 the two-letter, lower case region name. You can use more than one
7355 region by listing them: "en_us,en_ca" supports both US and Canadian
7356 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007357 Britain. (Note: currently en_au and en_nz dictionaries are older than
7358 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007359 If the name "cjk" is included East Asian characters are excluded from
7360 spell checking. This is useful when editing text that also has Asian
7361 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007362 Note that the "medical" dictionary does not exist, it is just an
7363 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007364 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007365 As a special case the name of a .spl file can be given as-is. The
7366 first "_xx" in the name is removed and used as the region name
7367 (_xx is an underscore, two letters and followed by a non-letter).
7368 This is mainly for testing purposes. You must make sure the correct
7369 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007370 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007371 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7372 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007373 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007374
Bram Moolenaar98692072006-02-04 00:57:42 +00007375 If the |spellfile.vim| plugin is active and you use a language name
7376 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7377 will ask you if you want to download the file.
7378
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007379 After this option has been set successfully, Vim will source the files
7380 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007381 up to the first character that is not an ASCII letter or number and
7382 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007383
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007384 *'spelloptions'* *'spo'*
7385'spelloptions' 'spo' string (default "")
7386 local to buffer
7387 {not available when compiled without the |+syntax|
7388 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007389 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007390 camel When a word is CamelCased, assume "Cased" is a
7391 separate word: every upper-case character in a word
7392 that comes after a lower case character indicates the
7393 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007394
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007395 *'spellsuggest'* *'sps'*
7396'spellsuggest' 'sps' string (default "best")
7397 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007398 {not available when compiled without the |+syntax|
7399 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007400 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007401 the |spellsuggest()| function. This is a comma-separated list of
7402 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007403
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007404 best Internal method that works best for English. Finds
7405 changes like "fast" and uses a bit of sound-a-like
7406 scoring to improve the ordering.
7407
7408 double Internal method that uses two methods and mixes the
7409 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007410 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007411 word. That only works when the language specifies
7412 sound folding. Can be slow and doesn't always give
7413 better results.
7414
7415 fast Internal method that only checks for simple changes:
7416 character inserts/deletes/swaps. Works well for
7417 simple typing mistakes.
7418
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007419 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007420 Not used for |spellsuggest()|. The number of
7421 suggestions is never more than the value of 'lines'
7422 minus two.
7423
Bram Moolenaar585ee072022-01-29 11:22:17 +00007424 timeout:{millisec} Limit the time searching for suggestions to
7425 {millisec} milli seconds. Applies to the following
7426 methods. When omitted the limit is 5000. When
7427 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007428 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007429
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007430 file:{filename} Read file {filename}, which must have two columns,
7431 separated by a slash. The first column contains the
7432 bad word, the second column the suggested good word.
7433 Example:
7434 theribal/terrible ~
7435 Use this for common mistakes that do not appear at the
7436 top of the suggestion list with the internal methods.
7437 Lines without a slash are ignored, use this for
7438 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007439 The word in the second column must be correct,
7440 otherwise it will not be used. Add the word to an
7441 ".add" file if it is currently flagged as a spelling
7442 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007443 The file is used for all languages.
7444
7445 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7446 trouble with spaces. |v:val| holds the badly spelled
7447 word. The expression must evaluate to a List of
7448 Lists, each with a suggestion and a score.
7449 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007450 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007451 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007452 internal methods use. A lower score is better.
7453 This may invoke |spellsuggest()| if you temporarily
7454 set 'spellsuggest' to exclude the "expr:" part.
7455 Errors are silently ignored, unless you set the
7456 'verbose' option to a non-zero value.
7457
7458 Only one of "best", "double" or "fast" may be used. The others may
7459 appear several times in any order. Example: >
7460 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7461<
7462 This option cannot be set from a |modeline| or in the |sandbox|, for
7463 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007464
7465
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7467'splitbelow' 'sb' boolean (default off)
7468 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469 When on, splitting a window will put the new window below the current
7470 one. |:split|
7471
7472 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7473'splitright' 'spr' boolean (default off)
7474 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007475 When on, splitting a window will put the new window right of the
7476 current one. |:vsplit|
7477
7478 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7479'startofline' 'sol' boolean (default on)
7480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007482 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007483 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007484 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 with a linewise operator, with "%" with a count and to buffer changing
7486 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7487 only has a line number, e.g., ":25" or ":+".
7488 In case of buffer changing commands the cursor is placed at the column
7489 where it was the last time the buffer was edited.
7490 NOTE: This option is set when 'compatible' is set.
7491
Bram Moolenaar00654022011-02-25 14:42:19 +01007492 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007494 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495 {not available when compiled without the |+statusline|
7496 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007497 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007498 Also see |status-line|.
7499
7500 The option consists of printf style '%' items interspersed with
7501 normal text. Each status line item is of the form:
7502 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007503 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007504 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505
Bram Moolenaar238a5642006-02-21 22:12:05 +00007506 When the option starts with "%!" then it is used as an expression,
7507 evaluated and the result is used as the option value. Example: >
7508 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007509< The *g:statusline_winid* variable will be set to the |window-ID| of the
7510 window that the status line belongs to.
7511 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007512 Note that the "%!" expression is evaluated in the context of the
7513 current window and buffer, while %{} items are evaluated in the
7514 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007515
7516 When there is error while evaluating the option then it will be made
7517 empty to avoid further errors. Otherwise screen updating would loop.
7518
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 Note that the only effect of 'ruler' when this option is set (and
7520 'laststatus' is 2) is controlling the output of |CTRL-G|.
7521
7522 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007523 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007524 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007525 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526 minwid Minimum width of the item, padding as set by '-' & '0'.
7527 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007528 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 on the left for text items. Numeric items will be
7530 shifted down to maxwid-2 digits followed by '>'number
7531 where number is the amount of missing digits, much like
7532 an exponential notation.
7533 item A one letter code as described below.
7534
7535 Following is a description of the possible statusline items. The
7536 second character in "item" is the type:
7537 N for number
7538 S for string
7539 F for flags as described below
7540 - not applicable
7541
7542 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007543 f S Path to the file in the buffer, as typed or relative to current
7544 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545 F S Full path to the file in the buffer.
7546 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007547 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007549 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007550 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007551 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007553 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007555 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007557 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7559 being used: "<keymap>"
7560 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007561 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 B N As above, in hexadecimal.
7563 o N Byte number in file of byte under cursor, first byte is 1.
7564 Mnemonic: Offset from start of file (with one added)
7565 {not available when compiled without |+byte_offset| feature}
7566 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007567 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 l N Line number.
7569 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007570 c N Column number (byte index).
7571 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007572 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 p N Percentage through file in lines as in |CTRL-G|.
7574 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007575 percentage described for 'ruler'. Always 3 in length, unless
7576 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007577 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007579 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007580 Note that there is no '%' before the closing '}'. The
7581 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007582 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007583 {% - This is almost same as { except the result of the expression is
7584 re-evaluated as a statusline format string. Thus if the
7585 return value of expr contains % items they will get expanded.
7586 The expression can contain the } character, the end of
7587 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007588 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007589 func! Stl_filename() abort
7590 return "%t"
7591 endfunc
7592< `stl=%{Stl_filename()}` results in `"%t"`
7593 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007594 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595 ( - Start of item group. Can be used for setting the width and
7596 alignment of a section. Must be followed by %) somewhere.
7597 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007598 T N For 'tabline': start of tab page N label. Use %T after the last
7599 label. This information is used for mouse clicks.
7600 X N For 'tabline': start of close tab N label. Use %X after the
7601 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7602 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603 < - Where to truncate line if too long. Default is at the start.
7604 No width fields allowed.
7605 = - Separation point between left and right aligned items.
7606 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007607 # - Set highlight group. The name must follow and then a # again.
7608 Thus use %#HLname# for highlight group HLname. The same
7609 highlighting is used, also for the statusline of non-current
7610 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007611 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007612 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007613 The difference between User{N} and StatusLine will be applied
7614 to StatusLineNC for the statusline of non-current windows.
7615 The number N must be between 1 and 9. See |hl-User1..9|
7616
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007617 When displaying a flag, Vim removes the leading comma, if any, when
7618 that flag comes right after plaintext. This will make a nice display
7619 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620
Bram Moolenaar582fd852005-03-28 20:58:01 +00007621 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007622 not set) and a minwid is not set for the group, the whole group will
7623 become empty. This will make a group like the following disappear
7624 completely from the statusline when none of the flags are set. >
7625 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007626< Beware that an expression is evaluated each and every time the status
7627 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007628 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007629 While evaluating %{} the current buffer and current window will be set
7630 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007631 currently being drawn. The expression will evaluate in this context.
7632 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7633 real current buffer and "g:actual_curwin" to the |window-ID| of the
7634 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007635
Bram Moolenaar30b65812012-07-12 22:01:11 +02007636 The 'statusline' option will be evaluated in the |sandbox| if set from
7637 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007638 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007639
7640 It is not allowed to change text or jump to another window while
7641 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642
7643 If the statusline is not updated when you want it (e.g., after setting
7644 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007645 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007647 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 Otherwise the result is taken as flag text and applied to the rules
7649 described above.
7650
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007651 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007653 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007654
7655 Examples:
7656 Emulate standard status line with 'ruler' set >
7657 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7658< Similar, but add ASCII value of char under the cursor (like "ga") >
7659 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7660< Display byte count and byte value, modified flag in red. >
7661 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7662 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7663< Display a ,GZ flag if a compressed file is loaded >
7664 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7665< In the |:autocmd|'s: >
7666 :let b:gzflag = 1
7667< And: >
7668 :unlet b:gzflag
7669< And define this function: >
7670 :function VarExists(var, val)
7671 : if exists(a:var) | return a:val | else | return '' | endif
7672 :endfunction
7673<
7674 *'suffixes'* *'su'*
7675'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7676 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007677 Files with these suffixes get a lower priority when multiple files
7678 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007679 suffixes. Spaces after the comma are ignored. A dot is also seen as
7680 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007681 separator, precede it with a backslash (see |option-backslash| about
7682 including spaces and backslashes).
7683 See 'wildignore' for completely ignoring files.
7684 The use of |:set+=| and |:set-=| is preferred when adding or removing
7685 suffixes from the list. This avoids problems when a future version
7686 uses another default.
7687
7688 *'suffixesadd'* *'sua'*
7689'suffixesadd' 'sua' string (default "")
7690 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007691 {not available when compiled without the
7692 |+file_in_path| feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007693 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007694 file for the "gf", "[I", etc. commands. Example: >
7695 :set suffixesadd=.java
7696<
7697 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7698'swapfile' 'swf' boolean (default on)
7699 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007700 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007701 swapfile is not wanted for a specific buffer. For example, with
7702 confidential information that even root must not be able to access.
7703 Careful: All text will be in memory:
7704 - Don't use this for big files.
7705 - Recovery will be impossible!
7706 A swapfile will only be present when |'updatecount'| is non-zero and
7707 'swapfile' is set.
7708 When 'swapfile' is reset, the swap file for the current buffer is
7709 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7710 non-zero, a swap file is immediately created.
7711 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007712 If you want to open a new buffer without creating a swap file for it,
7713 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007714 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715
7716 This option is used together with 'bufhidden' and 'buftype' to
7717 specify special kinds of buffers. See |special-buffers|.
7718
7719 *'swapsync'* *'sws'*
7720'swapsync' 'sws' string (default "fsync")
7721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007723 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007724 When this option is empty parts of the swap file may be in memory and
7725 not written to disk. When the system crashes you may lose more work.
7726 On Unix the system does a sync now and then without Vim asking for it,
7727 so the disadvantage of setting this option off is small. On some
7728 systems the swap file will not be written at all. For a unix system
7729 setting it to "sync" will use the sync() call instead of the default
7730 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007731 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007732
7733 *'switchbuf'* *'swb'*
7734'switchbuf' 'swb' string (default "")
7735 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007736 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007737 Mostly for |quickfix| commands some values are also used for other
7738 commands, as mentioned below.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007739 Possible values (comma-separated list):
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740 useopen If included, jump to the first open window that
7741 contains the specified buffer (if there is one).
7742 Otherwise: Do not examine other windows.
7743 This setting is checked with |quickfix| commands, when
7744 jumping to errors (":cc", ":cn", "cp", etc.). It is
7745 also used in all buffer related split commands, for
7746 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007747 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007748 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007749 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007750 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007751 Otherwise: do not split, use current window (when used
7752 in the quickfix window: the previously used window or
7753 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007754 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007755 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007756 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007757 uselast If included, jump to the previously used window when
7758 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007759
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007760 *'synmaxcol'* *'smc'*
7761'synmaxcol' 'smc' number (default 3000)
7762 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007763 {not available when compiled without the |+syntax|
7764 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007765 Maximum column in which to search for syntax items. In long lines the
7766 text after this column is not highlighted and following lines may not
7767 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007768 This helps to avoid very slow redrawing for an XML file that is one
7769 long line.
7770 Set to zero to remove the limit.
7771
Bram Moolenaar071d4272004-06-13 20:20:40 +00007772 *'syntax'* *'syn'*
7773'syntax' 'syn' string (default empty)
7774 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007775 {not available when compiled without the |+syntax|
7776 feature}
7777 When this option is set, the syntax with this name is loaded, unless
7778 syntax highlighting has been switched off with ":syntax off".
7779 Otherwise this option does not always reflect the current syntax (the
7780 b:current_syntax variable does).
7781 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007782 not automatically recognized. Example, in an IDL file:
7783 /* vim: set syntax=idl : */ ~
7784 When a dot appears in the value then this separates two filetype
7785 names. Example:
7786 /* vim: set syntax=c.doxygen : */ ~
7787 This will use the "c" syntax first, then the "doxygen" syntax.
7788 Note that the second one must be prepared to be loaded as an addition,
7789 otherwise it will be skipped. More than one dot may appear.
7790 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007791 :set syntax=OFF
7792< To switch syntax highlighting on according to the current value of the
7793 'filetype' option: >
7794 :set syntax=ON
7795< What actually happens when setting the 'syntax' option is that the
7796 Syntax autocommand event is triggered with the value as argument.
7797 This option is not copied to another buffer, independent of the 's' or
7798 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007799 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007800
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007801 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007802'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007803 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00007804 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007805 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007806 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007807
7808 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007809 option and only when there is no GUI tab line. When 'e' is in
7810 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007811 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007812
7813 The value is evaluated like with 'statusline'. You can use
7814 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007815 the text to be displayed. Use "%1T" for the first label, "%2T" for
7816 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007817
Bram Moolenaare12bab32019-01-08 22:02:56 +01007818 When changing something that is used in 'tabline' that does not
7819 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007820 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007821
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007822 Keep in mind that only one of the tab pages is the current one, others
7823 are invisible and you can't jump to their windows.
7824
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007825
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007826 *'tabpagemax'* *'tpm'*
7827'tabpagemax' 'tpm' number (default 10)
7828 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007829 Maximum number of tab pages to be opened by the |-p| command line
7830 argument or the ":tab all" command. |tabpage|
7831
7832
7833 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007834'tabstop' 'ts' number (default 8)
7835 local to buffer
7836 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007837 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007838
7839 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007840 appear wrong in many places, e.g., when printing it.
7841 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007842
7843 There are four main ways to use tabs in Vim:
7844 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7845 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007846 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847 behave like a tab appears every 4 (or 3) characters.
7848 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7849 'expandtab'. This way you will always insert spaces. The
7850 formatting will never be messed up when 'tabstop' is changed.
7851 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007852 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007853 works when using Vim to edit the file.
7854 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7855 'noexpandtab'. This should then work (for initial indents only)
7856 for any tabstop setting that people use. It might be nice to have
7857 tabs after the first non-blank inserted as spaces if you do this
7858 though. Otherwise aligned comments will be wrong when 'tabstop' is
7859 changed.
7860
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007861 If Vim is compiled with the |+vartabs| feature then the value of
7862 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7863 than an empty string.
7864
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7866'tagbsearch' 'tbs' boolean (default on)
7867 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007868 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007869 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007870 searching makes searching for a tag a LOT faster, but a linear search
7871 will find more tags if the tags file wasn't properly sorted.
7872 Vim normally assumes that your tags files are sorted, or indicate that
7873 they are not sorted. Only when this is not the case does the
7874 'tagbsearch' option need to be switched off.
7875
7876 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007877 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 certain files, or retry all files with a linear search. When
7879 'tagbsearch' is off, only a linear search is done.
7880
7881 Linear searching is done anyway, for one file, when Vim finds a line
7882 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007883 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884< [The whitespace before and after the '0' must be a single <Tab>]
7885
7886 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007887 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007888 instead of a normal tag name, a retry is done with a linear search.
7889 Tags in unsorted tags files, and matches with different case will only
7890 be found in the retry.
7891
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007892 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007893 linear search can be avoided when case is ignored. Use a value of '2'
7894 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7895 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00007896 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
7897 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
7898 used for this as well. Note that case must be folded to uppercase for
7899 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007900
7901 By default, tag searches are case-sensitive. Case is ignored when
7902 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7903 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007904 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7905 'tagcase' is "smart", and the pattern contains only lowercase
7906 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907
7908 When 'tagbsearch' is off, tags searching is slower when a full match
7909 exists, but faster when no full match exists. Tags in unsorted tags
7910 files may only be found with 'tagbsearch' off.
7911 When the tags file is not sorted, or sorted in a wrong way (not on
7912 ASCII byte value), 'tagbsearch' should be off, or the line given above
7913 must be included in the tags file.
7914 This option doesn't affect commands that find all matching tags (e.g.,
7915 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007916
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007917 *'tagcase'* *'tc'*
7918'tagcase' 'tc' string (default "followic")
7919 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007920 This option specifies how case is handled when searching the tags
7921 file:
7922 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007923 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007924 ignore Ignore case
7925 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007926 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007927 NOTE: This option is set to the Vi default value when 'compatible' is
7928 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007929
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007930 *'tagfunc'* *'tfu'*
7931'tagfunc' 'tfu' string (default: empty)
7932 local to buffer
7933 {not available when compiled without the |+eval|
7934 feature}
7935 This option specifies a function to be used to perform tag searches.
7936 The function gets the tag pattern and should return a List of matching
7937 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007938 function and an example. The value can be the name of a function, a
7939 |lambda| or a |Funcref|. See |option-value-function| for more
7940 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007941
Bram Moolenaar071d4272004-06-13 20:20:40 +00007942 *'taglength'* *'tl'*
7943'taglength' 'tl' number (default 0)
7944 global
7945 If non-zero, tags are significant up to this number of characters.
7946
7947 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7948'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7949 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007950 If on and using a tags file in another directory, file names in that
7951 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952 NOTE: This option is set to the Vi default value when 'compatible' is
7953 set and to the Vim default value when 'compatible' is reset.
7954
7955 *'tags'* *'tag'* *E433*
7956'tags' 'tag' string (default "./tags,tags", when compiled with
7957 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7958 global or local to buffer |global-local|
7959 Filenames for the tag command, separated by spaces or commas. To
7960 include a space or comma in a file name, precede it with a backslash
7961 (see |option-backslash| about including spaces and backslashes).
7962 When a file name starts with "./", the '.' is replaced with the path
7963 of the current file. But only when the 'd' flag is not included in
7964 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7965 |tags-option|.
7966 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007967 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7968 find all files named "tags" below "/lib". The filename itself cannot
7969 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7970 files called "tags?". {not available when compiled without the
7971 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007972 The |tagfiles()| function can be used to get a list of the file names
7973 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007974 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7975 files are also supported. They are automatically recognized. The
7976 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7977 differences are ignored (MS-Windows). |emacs-tags|
7978 The use of |:set+=| and |:set-=| is preferred when adding or removing
7979 file names from the list. This avoids problems when a future version
7980 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981
7982 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7983'tagstack' 'tgst' boolean (default on)
7984 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007985 When on, the |tagstack| is used normally. When off, a ":tag" or
7986 ":tselect" command with an argument will not push the tag onto the
7987 tagstack. A following ":tag" without an argument, a ":pop" command or
7988 any other command that uses the tagstack will use the unmodified
7989 tagstack, but does change the pointer to the active entry.
7990 Resetting this option is useful when using a ":tag" command in a
7991 mapping which should not change the tagstack.
7992
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007993 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007994'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007995 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007996 {only available when compiled with the |+tcl/dyn|
7997 feature}
7998 Specifies the name of the Tcl shared library. The default is
7999 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008000 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008001 This option cannot be set from a |modeline| or in the |sandbox|, for
8002 security reasons.
8003
Bram Moolenaar071d4272004-06-13 20:20:40 +00008004 *'term'* *E529* *E530* *E531*
8005'term' string (default is $TERM, if that fails:
8006 in the GUI: "builtin_gui"
8007 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008008 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008009 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008010 on Unix: "ansi"
8011 on VMS: "ansi"
8012 on Win 32: "win32")
8013 global
8014 Name of the terminal. Used for choosing the terminal control
8015 characters. Environment variables are expanded |:set_env|.
8016 For example: >
8017 :set term=$TERM
8018< See |termcap|.
8019
8020 *'termbidi'* *'tbidi'*
8021 *'notermbidi'* *'notbidi'*
8022'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024 {only available when compiled with the |+arabic|
8025 feature}
8026 The terminal is in charge of Bi-directionality of text (as specified
8027 by Unicode). The terminal is also expected to do the required shaping
8028 that some languages (such as Arabic) require.
8029 Setting this option implies that 'rightleft' will not be set when
8030 'arabic' is set and the value of 'arabicshape' will be ignored.
8031 Note that setting 'termbidi' has the immediate effect that
8032 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8033 This option is reset when the GUI is started.
8034 For further details see |arabic.txt|.
8035
8036 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008037'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 Encoding used for the terminal. This specifies what character
8040 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008041 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008042 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008043 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008044 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008045 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8046 Any attempts to set a different value will be rejected, and an error
8047 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008048 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008049 because the Win32 system always passes Unicode characters.
8050 When empty, the same encoding is used as for the 'encoding' option.
8051 This is the normal value.
8052 Not all combinations for 'termencoding' and 'encoding' are valid. See
8053 |encoding-table|.
8054 The value for this option must be supported by internal conversions or
8055 iconv(). When this is not possible no conversion will be done and you
8056 will probably experience problems with non-ASCII characters.
8057 Example: You are working with the locale set to euc-jp (Japanese) and
8058 want to edit a UTF-8 file: >
8059 :let &termencoding = &encoding
8060 :set encoding=utf-8
8061< You need to do this when your system has no locale support for UTF-8.
8062
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008063 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008064'termguicolors' 'tgc' boolean (default off)
8065 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008066 {not available when compiled without the
8067 |+termguicolors| feature}
8068 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008069 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008070
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008071 Requires a ISO-8613-3 compatible terminal. If setting this option
8072 does not work (produces a colorless UI) reading |xterm-true-color|
8073 might help.
8074
8075 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8076 is required. Use this check to find out: >
8077 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008078< This requires Vim to be built with the |+vtp| feature.
8079
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008080 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008081
8082 When using Vim with Windows Terminal, the background of Windows
8083 Terminal is normally filled with the Vim background color. Setting
8084 'termguicolors' and the guibg of the Normal highlight group to NONE
8085 will make the background transparent: >
8086 :hi Normal guibg=NONE
8087<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008088 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008089
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008090 *'termwinkey'* *'twk'*
8091'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008092 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008093 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008094 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008095 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008096 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008097< The string must be one key stroke but can be multiple bytes.
8098 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008099 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008100 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008101
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008102 *'termwinscroll'* *'twsl'*
8103'termwinscroll' 'twsl' number (default 10000)
8104 local to buffer
8105 {not available when compiled without the
8106 |+terminal| feature}
8107 Number of scrollback lines to keep. When going over this limit the
8108 first 10% of the scrollback lines are deleted. This is just to reduce
8109 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008110 Also used as a limit for text sent to the terminal in one write,
8111 multiplied by the number of columns times 3 (average number of bytes
8112 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008113
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008114 *'termwinsize'* *'tws'*
8115'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008116 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008117 Size used when opening the |terminal| window. Format:
8118 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008119 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008120 - When set with a "x" (e.g., "24x80") the terminal size is not
8121 adjusted to the window size. If the window is smaller only the
8122 top-left part is displayed.
8123 - When set with a "*" (e.g., "10*50") the terminal size follows the
8124 window size, but will not be smaller than the specified rows and/or
8125 columns.
8126 - When rows is zero then use the height of the window.
8127 - When columns is zero then use the width of the window.
8128 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008129 - Can be overruled in the |term_start()| options with "term_rows" and
8130 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008131
8132 Examples:
8133 "30x0" uses 30 rows and the current window width.
8134 "20*0" uses at least 20 rows and the current window width.
8135 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008136 Note that the command running in the terminal window may still change
8137 the size of the terminal. In that case the Vim window will be
8138 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008139
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008140 *'termwintype'* *'twt'*
8141'termwintype' 'twt' string (default "")
8142 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008143 {only available when compiled with the |terminal|
8144 feature on MS-Windows}
8145 Specify the virtual console (pty) used when opening the terminal
8146 window.
8147
8148 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008149 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008150 "winpty" use winpty, fail if not supported
8151 "conpty" use |ConPTY|, fail if not supported
8152
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008153 |ConPTY| support depends on the platform. Windows 10 October 2018
8154 Update is the first version that supports ConPTY, however it is still
8155 considered unstable. ConPTY might become stable in the next release
8156 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008157 supported then you cannot open a terminal window.
8158
Bram Moolenaar071d4272004-06-13 20:20:40 +00008159 *'terse'* *'noterse'*
8160'terse' boolean (default off)
8161 global
8162 When set: Add 's' flag to 'shortmess' option (this makes the message
8163 for a search that hits the start or end of the file not being
8164 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8165 shortens a lot of messages}
8166
8167 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8168'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8169 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008170 This option is obsolete. Use 'fileformats'.
8171 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8172 set to the default value for the current system. When 'textauto' is
8173 reset, 'fileformats' is made empty.
8174 NOTE: This option is set to the Vi default value when 'compatible' is
8175 set and to the Vim default value when 'compatible' is reset.
8176
8177 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008178'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179 others: default off)
8180 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008181 This option is obsolete. Use 'fileformat'.
8182 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8183 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8184 "unix".
8185
8186 *'textwidth'* *'tw'*
8187'textwidth' 'tw' number (default 0)
8188 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008189 Maximum width of text that is being inserted. A longer line will be
8190 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008191 this.
8192 'textwidth' is set to 0 when the 'paste' option is set and restored
8193 when 'paste' is reset.
8194 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008196 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008197 NOTE: This option is set to 0 when 'compatible' is set.
8198
8199 *'thesaurus'* *'tsr'*
8200'thesaurus' 'tsr' string (default "")
8201 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008202 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008203 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8204 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008205
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008206 This option is not used if 'thesaurusfunc' is set, either for the
8207 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008208
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008209 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008210 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008211 name. See |option-backslash| about using backslashes. The use of
8212 |:set+=| and |:set-=| is preferred when adding or removing directories
8213 from the list. This avoids problems when a future version uses
8214 another default. Backticks cannot be used in this option for security
8215 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008216
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008217 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008218'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008219 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008220 {not available when compiled without the |+eval|
8221 feature}
8222 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008223 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008224 The value can be the name of a function, a |lambda| or a |Funcref|.
8225 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008226
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008227 This option cannot be set from a |modeline| or in the |sandbox|, for
8228 security reasons.
8229
Bram Moolenaar071d4272004-06-13 20:20:40 +00008230 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8231'tildeop' 'top' boolean (default off)
8232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008233 When on: The tilde command "~" behaves like an operator.
8234 NOTE: This option is reset when 'compatible' is set.
8235
8236 *'timeout'* *'to'* *'notimeout'* *'noto'*
8237'timeout' 'to' boolean (default on)
8238 global
8239 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008240'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008241 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008242 These two options together determine the behavior when part of a
8243 mapped key sequence or keyboard code has been received:
8244
8245 'timeout' 'ttimeout' action ~
8246 off off do not time out
8247 on on or off time out on :mappings and key codes
8248 off on time out on key codes
8249
8250 If both options are off, Vim will wait until either the complete
8251 mapping or key sequence has been received, or it is clear that there
8252 is no mapping or key sequence for the received characters. For
8253 example: if you have mapped "vl" and Vim has received 'v', the next
8254 character is needed to see if the 'v' is followed by an 'l'.
8255 When one of the options is on, Vim will wait for about 1 second for
8256 the next character to arrive. After that the already received
8257 characters are interpreted as single characters. The waiting time can
8258 be changed with the 'timeoutlen' option.
8259 On slow terminals or very busy systems timing out may cause
8260 malfunctioning cursor keys. If both options are off, Vim waits
8261 forever after an entered <Esc> if there are key codes that start
8262 with <Esc>. You will have to type <Esc> twice. If you do not have
8263 problems with key codes, but would like to have :mapped key
8264 sequences not timing out in 1 second, set the 'ttimeout' option and
8265 reset the 'timeout' option.
8266
8267 NOTE: 'ttimeout' is reset when 'compatible' is set.
8268
8269 *'timeoutlen'* *'tm'*
8270'timeoutlen' 'tm' number (default 1000)
8271 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008272
Bram Moolenaar071d4272004-06-13 20:20:40 +00008273 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008274'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008275 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008276 The time in milliseconds that is waited for a key code or mapped key
8277 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8278 when part of a command has been typed.
8279 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8280 different timeout value for key codes is desired set 'ttimeoutlen' to
8281 a non-negative number.
8282
8283 ttimeoutlen mapping delay key code delay ~
8284 < 0 'timeoutlen' 'timeoutlen'
8285 >= 0 'timeoutlen' 'ttimeoutlen'
8286
8287 The timeout only happens when the 'timeout' and 'ttimeout' options
8288 tell so. A useful setting would be >
8289 :set timeout timeoutlen=3000 ttimeoutlen=100
8290< (time out on mapping after three seconds, time out on key codes after
8291 a tenth of a second).
8292
8293 *'title'* *'notitle'*
8294'title' boolean (default off, on when title can be restored)
8295 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008296 When on, the title of the window will be set to the value of
8297 'titlestring' (if it is not empty), or to:
8298 filename [+=-] (path) - VIM
8299 Where:
8300 filename the name of the file being edited
8301 - indicates the file cannot be modified, 'ma' off
8302 + indicates the file was modified
8303 = indicates the file is read-only
8304 =+ indicates the file is read-only and modified
8305 (path) is the path of the file being edited
8306 - VIM the server name |v:servername| or "VIM"
8307 Only works if the terminal supports setting window titles
8308 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008309 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008310 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8311 *X11*
8312 When Vim was compiled with HAVE_X11 defined, the original title will
8313 be restored if possible. The output of ":version" will include "+X11"
8314 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8315 works for the icon name |'icon'|.
8316 But: When Vim was started with the |-X| argument, restoring the title
8317 will not work (except in the GUI).
8318 If the title cannot be restored, it is set to the value of 'titleold'.
8319 You might want to restore the title outside of Vim then.
8320 When using an xterm from a remote machine you can use this command:
8321 rsh machine_name xterm -display $DISPLAY &
8322 then the WINDOWID environment variable should be inherited and the
8323 title of the window should change back to what it should be after
8324 exiting Vim.
8325
8326 *'titlelen'*
8327'titlelen' number (default 85)
8328 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008329 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008330 title. When the title is longer, only the end of the path name is
8331 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008332 Using a percentage makes this adapt to the width of the window. But
8333 it won't work perfectly, because the actual number of characters
8334 available also depends on the font used and other things in the title
8335 bar. When 'titlelen' is zero the full path is used. Otherwise,
8336 values from 1 to 30000 percent can be used.
8337 'titlelen' is also used for the 'titlestring' option.
8338
8339 *'titleold'*
8340'titleold' string (default "Thanks for flying Vim")
8341 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008342 This option will be used for the window title when exiting Vim if the
8343 original title cannot be restored. Only happens if 'title' is on or
8344 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008345 This option cannot be set from a |modeline| or in the |sandbox|, for
8346 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347 *'titlestring'*
8348'titlestring' string (default "")
8349 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008350 When this option is not empty, it will be used for the title of the
8351 window. This happens only when the 'title' option is on.
8352 Only works if the terminal supports setting window titles (currently
8353 Amiga console, Win32 console, all GUI versions and terminals with a
8354 non-empty 't_ts' option).
8355 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008356 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008357
Bram Moolenaar071d4272004-06-13 20:20:40 +00008358 When this option contains printf-style '%' items, they will be
8359 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008360 This option cannot be set in a modeline when 'modelineexpr' is off.
8361
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008363 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008364 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8365< The value of 'titlelen' is used to align items in the middle or right
8366 of the available space.
8367 Some people prefer to have the file name first: >
8368 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8369< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008370 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008371 separating space only when needed.
8372 NOTE: Use of special characters in 'titlestring' may cause the display
8373 to be garbled (e.g., when it contains a CR or NL character).
8374 {not available when compiled without the |+statusline| feature}
8375
8376 *'toolbar'* *'tb'*
8377'toolbar' 'tb' string (default "icons,tooltips")
8378 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008379 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008380 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008381 possible values are:
8382 icons Toolbar buttons are shown with icons.
8383 text Toolbar buttons shown with text.
8384 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008385 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 tooltips Tooltips are active for toolbar buttons.
8387 Tooltips refer to the popup help text which appears after the mouse
8388 cursor is placed over a toolbar button for a brief moment.
8389
8390 If you want the toolbar to be shown with icons as well as text, do the
8391 following: >
8392 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008393< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008394 will show icons if both are requested.
8395
8396 If none of the strings specified in 'toolbar' are valid or if
8397 'toolbar' is empty, this option is ignored. If you want to disable
8398 the toolbar, you need to set the 'guioptions' option. For example: >
8399 :set guioptions-=T
8400< Also see |gui-toolbar|.
8401
8402 *'toolbariconsize'* *'tbis'*
8403'toolbariconsize' 'tbis' string (default "small")
8404 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008405 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008406 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008407 tiny Use tiny icons.
8408 small Use small icons (default).
8409 medium Use medium-sized icons.
8410 large Use large icons.
8411 huge Use even larger icons.
8412 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008414 the current theme. Common dimensions are giant=48x48, huge=32x32,
8415 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416
8417 If 'toolbariconsize' is empty, the global default size as determined
8418 by user preferences or the current theme is used.
8419
8420 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8421'ttybuiltin' 'tbi' boolean (default on)
8422 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008423 When on, the builtin termcaps are searched before the external ones.
8424 When off the builtin termcaps are searched after the external ones.
8425 When this option is changed, you should set the 'term' option next for
8426 the change to take effect, for example: >
8427 :set notbi term=$TERM
8428< See also |termcap|.
8429 Rationale: The default for this option is "on", because the builtin
8430 termcap entries are generally better (many systems contain faulty
8431 xterm entries...).
8432
8433 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8434'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8435 sun-cmd, screen, rxvt, dtterm or
8436 iris-ansi; also on when running Vim in
8437 a DOS console)
8438 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008439 Indicates a fast terminal connection. More characters will be sent to
8440 the screen for redrawing, instead of using insert/delete line
8441 commands. Improves smoothness of redrawing when there are multiple
8442 windows and the terminal does not support a scrolling region.
8443 Also enables the extra writing of characters at the end of each screen
8444 line for lines that wrap. This helps when using copy/paste with the
8445 mouse in an xterm and other terminals.
8446
8447 *'ttymouse'* *'ttym'*
8448'ttymouse' 'ttym' string (default depends on 'term')
8449 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008450 {only in Unix and VMS, doesn't work in the GUI; not
8451 available when compiled without |+mouse|}
8452 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008453 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008454 *xterm-mouse*
8455 xterm xterm-like mouse handling. The mouse generates
8456 "<Esc>[Mscr", where "scr" is three bytes:
8457 "s" = button state
8458 "c" = column plus 33
8459 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008460 This only works up to 223 columns! See "dec",
8461 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008462 xterm2 Works like "xterm", but with the xterm reporting the
8463 mouse position while the mouse is dragged. This works
8464 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008465 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008466 work. See below for how Vim detects this
8467 automatically.
8468 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008469 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008470 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008471 for the row and column. No other mouse events are
8472 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008473 *dec-mouse*
8474 dec DEC terminal mouse handling. The mouse generates a
8475 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008476 This is also available for an Xterm, if it was
8477 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008478 *jsbterm-mouse*
8479 jsbterm JSB term mouse handling.
8480 *pterm-mouse*
8481 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008482 *urxvt-mouse*
8483 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008484 The mouse works only if the terminal supports this
8485 encoding style, but it does not have 223 columns limit
8486 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008487 *sgr-mouse*
8488 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008489 mouse reporting. The mouse works even in columns
8490 beyond 223. This option is backward compatible with
8491 "xterm2" because it can also decode "xterm2" style
8492 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008493
8494 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008495 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8496 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008497 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8498 recognized, if enabled at compile time. DEC terminal mouse codes
8499 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008500 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8501 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008503 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8504 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8505 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008506 Additionally, if vim is compiled with the |+termresponse| feature and
8507 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008508 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008509 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008510 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8511 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8512 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008513 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8514 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008515 :set t_RV=
8516<
8517 *'ttyscroll'* *'tsl'*
8518'ttyscroll' 'tsl' number (default 999)
8519 global
8520 Maximum number of lines to scroll the screen. If there are more lines
8521 to scroll the window is redrawn. For terminals where scrolling is
8522 very slow and redrawing is not slow this can be set to a small number,
8523 e.g., 3, to speed up displaying.
8524
8525 *'ttytype'* *'tty'*
8526'ttytype' 'tty' string (default from $TERM)
8527 global
8528 Alias for 'term', see above.
8529
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008530 *'undodir'* *'udir'*
8531'undodir' 'udir' string (default ".")
8532 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008533 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008534 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008535 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008536 "." means using the directory of the file. The undo file name for
8537 "file.txt" is ".file.txt.un~".
8538 For other directories the file name is the full path of the edited
8539 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008540 When writing: The first directory that exists is used. "." always
8541 works, no directories after "." will be used for writing.
8542 When reading all entries are tried to find an undo file. The first
8543 undo file that exists is used. When it cannot be read an error is
8544 given, no further entry is used.
8545 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008546 This option cannot be set from a |modeline| or in the |sandbox|, for
8547 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008548
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008549 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008550'undofile' 'udf' boolean (default off)
8551 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008552 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008553 When on, Vim automatically saves undo history to an undo file when
8554 writing a buffer to a file, and restores undo history from the same
8555 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008556 The directory where the undo file is stored is specified by 'undodir'.
8557 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008558 The undo file is not read when 'undoreload' causes the buffer from
8559 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008560 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008561 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008562
Bram Moolenaar071d4272004-06-13 20:20:40 +00008563 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008564'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008565 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008566 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008567 is kept in memory, higher numbers will cause more memory to be used.
8568 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008569 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8570 itself: >
8571 set ul=0
8572< But you can also get Vi compatibility by including the 'u' flag in
8573 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008574 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008575 Set to -1 for no undo at all. You might want to do this only for the
8576 current buffer: >
8577 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008578< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008579
8580 The local value is set to -123456 when the global value is to be used.
8581
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008582 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008583
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008584 *'undoreload'* *'ur'*
8585'undoreload' 'ur' number (default 10000)
8586 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008587 Save the whole buffer for undo when reloading it. This applies to the
8588 ":e!" command and reloading for when the buffer changed outside of
8589 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008590 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008591 of lines is smaller than the value of this option.
8592 Set this option to zero to disable undo for a reload.
8593
8594 When saving undo for a reload, any undo file is not read.
8595
8596 Note that this causes the whole buffer to be stored in memory. Set
8597 this option to a lower value if you run out of memory.
8598
Bram Moolenaar071d4272004-06-13 20:20:40 +00008599 *'updatecount'* *'uc'*
8600'updatecount' 'uc' number (default: 200)
8601 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008602 After typing this many characters the swap file will be written to
8603 disk. When zero, no swap file will be created at all (see chapter on
8604 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8605 Vim with the "-n" option, see |startup|. When editing in readonly
8606 mode this option will be initialized to 10000.
8607 The swapfile can be disabled per buffer with |'swapfile'|.
8608 When 'updatecount' is set from zero to non-zero, swap files are
8609 created for all buffers that have 'swapfile' set. When 'updatecount'
8610 is set to zero, existing swap files are not deleted.
8611 Also see |'swapsync'|.
8612 This option has no meaning in buffers where |'buftype'| is "nofile"
8613 or "nowrite".
8614
8615 *'updatetime'* *'ut'*
8616'updatetime' 'ut' number (default 4000)
8617 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008618 If this many milliseconds nothing is typed the swap file will be
8619 written to disk (see |crash-recovery|). Also used for the
8620 |CursorHold| autocommand event.
8621
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008622 *'varsofttabstop'* *'vsts'*
8623'varsofttabstop' 'vsts' string (default "")
8624 local to buffer
8625 {only available when compiled with the |+vartabs|
8626 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008627 A list of the number of spaces that a <Tab> counts for while editing,
8628 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8629 width <Tab>s are being inserted, while in fact a mixture of spaces
8630 and <Tab>s is used. Tab widths are separated with commas, with the
8631 final value applying to all subsequent tabs.
8632
8633 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008634 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008635 to use the following: >
8636 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008637< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8638 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008639
8640 Note that the value of |'softtabstop'| will be ignored while
8641 'varsofttabstop' is set.
8642
8643 *'vartabstop'* *'vts'*
8644'vartabstop' 'vts' string (default "")
8645 local to buffer
8646 {only available when compiled with the |+vartabs|
8647 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008648 A list of the number of spaces that a <Tab> in the file counts for,
8649 separated by commas. Each value corresponds to one tab, with the
8650 final value applying to all subsequent tabs. For example: >
8651 :set vartabstop=4,20,10,8
8652< This will make the first tab 4 spaces wide, the second 20 spaces,
8653 the third 10 spaces, and all following tabs 8 spaces.
8654
8655 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8656 is set.
8657
Bram Moolenaar071d4272004-06-13 20:20:40 +00008658 *'verbose'* *'vbs'*
8659'verbose' 'vbs' number (default 0)
8660 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661 When bigger than zero, Vim will give messages about what it is doing.
8662 Currently, these messages are given:
8663 >= 1 When the viminfo file is read or written.
8664 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008665 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008666 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008667 >= 8 Files for which a group of autocommands is executed.
8668 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008669 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008670 >= 12 Every executed function.
8671 >= 13 When an exception is thrown, caught, finished, or discarded.
8672 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008673 >= 15 Every executed Ex command from a script (truncated at 200
8674 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008675 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008676
8677 This option can also be set with the "-V" argument. See |-V|.
8678 This option is also set by the |:verbose| command.
8679
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008680 When the 'verbosefile' option is set then the verbose messages are not
8681 displayed.
8682
8683 *'verbosefile'* *'vfile'*
8684'verbosefile' 'vfile' string (default empty)
8685 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008686 When not empty all messages are written in a file with this name.
8687 When the file exists messages are appended.
8688 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008689 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008690 Setting 'verbosefile' to a new value is like making it empty first.
8691 The difference with |:redir| is that verbose messages are not
8692 displayed when 'verbosefile' is set.
8693
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008695'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 "$VIM/vimfiles/view",
8697 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008698 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008699 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008700 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008701 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008702 feature}
8703 Name of the directory where to store files for |:mkview|.
8704 This option cannot be set from a |modeline| or in the |sandbox|, for
8705 security reasons.
8706
8707 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008708'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
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}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008712 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008713 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008714 word save and restore ~
8715 cursor cursor position in file and in window
8716 folds manually created folds, opened/closed folds and local
8717 fold options
8718 options options and mappings local to a window or buffer (not
8719 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008720 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008721 slash backslashes in file names replaced with forward
8722 slashes
8723 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008724 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008725 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008726
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008727 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008729 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008730
8731 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008732'viminfo' 'vi' string (Vi default: "", Vim default for
8733 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008734 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8735 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008737 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 feature}
8739 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008740 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8741 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008742 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008743 consisting of a single character identifying the particular parameter,
8744 followed by a number or string which specifies the value of that
8745 parameter. If a particular character is left out, then the default
8746 value is used for that parameter. The following is a list of the
8747 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008748 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008749 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008750 ! When included, save and restore global variables that start
8751 with an uppercase letter, and don't contain a lowercase
8752 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008753 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008754 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008755 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008756 " Maximum number of lines saved for each register. Old name of
8757 the '<' item, with the disadvantage that you need to put a
8758 backslash before the ", otherwise it will be recognized as the
8759 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008760 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008761 % When included, save and restore the buffer list. If Vim is
8762 started with a file name argument, the buffer list is not
8763 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008764 buffer list is restored from the viminfo file. Quickfix
8765 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8766 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008767 When followed by a number, the number specifies the maximum
8768 number of buffers that are stored. Without a number all
8769 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008770 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771 ' Maximum number of previously edited files for which the marks
8772 are remembered. This parameter must always be included when
8773 'viminfo' is non-empty.
8774 Including this item also means that the |jumplist| and the
8775 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008776 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008777 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008778 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779 patterns are also saved. When not included, the value of
8780 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008781 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008783 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008784 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008785 < Maximum number of lines saved for each register. If zero then
8786 registers are not saved. When not included, all lines are
8787 saved. '"' is the old name for this item.
8788 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008789 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008790 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008791 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008792 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008793 c When included, convert the text in the viminfo file from the
8794 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008795 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008796 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008797 f Whether file marks need to be stored. If zero, file marks ('0
8798 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008799 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008801 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008802 h Disable the effect of 'hlsearch' when loading the viminfo
8803 file. When not included, it depends on whether ":nohlsearch"
8804 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008805 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008806 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008807 the 'n'. Must be at the end of the option! If the
8808 'viminfofile' option is set, that file name overrides the one
8809 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008810 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008811 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008812 r Removable media. The argument is a string (up to the next
8813 ','). This parameter can be given several times. Each
8814 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008815 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008816 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8817 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8818 ignored. Maximum length of each 'r' argument is 50
8819 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008820 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008821 s Maximum size of an item in Kbyte. If zero then registers are
8822 not saved. Currently only applies to registers. The default
8823 "s10" will exclude registers with more than 10 Kbyte of text.
8824 Also see the '<' item above: line count limit.
8825
8826 Example: >
8827 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8828<
8829 '50 Marks will be remembered for the last 50 files you
8830 edited.
8831 <1000 Contents of registers (up to 1000 lines each) will be
8832 remembered.
8833 s100 Registers with more than 100 Kbyte text are skipped.
8834 :0 Command-line history will not be saved.
8835 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8836 no / Since '/' is not specified, the default will be used,
8837 that is, save all of the search history, and also the
8838 previous search and substitute patterns.
8839 no % The buffer list will not be saved nor read back.
8840 no h 'hlsearch' highlighting will be restored.
8841
8842 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8843 load the contents of the file, this is not done automatically.
8844
8845 This option cannot be set from a |modeline| or in the |sandbox|, for
8846 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008847 NOTE: This option is set to the Vim default value when 'compatible'
8848 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008849
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008850 *'viminfofile'* *'vif'*
8851'viminfofile' 'vif' string (default: "")
8852 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008853 {not available when compiled without the |+viminfo|
8854 feature}
8855 When non-empty, overrides the file name used for viminfo.
8856 When equal to "NONE" no viminfo file will be read or written.
8857 This option can be set with the |-i| command line flag. The |--clean|
8858 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008859 This option cannot be set from a |modeline| or in the |sandbox|, for
8860 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008861
Bram Moolenaar071d4272004-06-13 20:20:40 +00008862 *'virtualedit'* *'ve'*
8863'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008864 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008865 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008866 block Allow virtual editing in Visual block mode.
8867 insert Allow virtual editing in Insert mode.
8868 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008869 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008870 none When used as the local value, do not allow virtual
8871 editing even when the global value is set. When used
8872 as the global value, "none" is the same as "".
8873 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008874
Bram Moolenaar071d4272004-06-13 20:20:40 +00008875 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008876 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008877 of the line. Useful for selecting a rectangle in Visual mode and
8878 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008879 "onemore" is not the same, it will only allow moving the cursor just
8880 after the last character of the line. This makes some commands more
8881 consistent. Previously the cursor was always past the end of the line
8882 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008883 break some plugins or Vim scripts. For example because |l| can move
8884 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008885 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008886 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008887 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008888 It doesn't make sense to combine "all" with "onemore", but you will
8889 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008890 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008891 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008892
8893 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8894'visualbell' 'vb' boolean (default off)
8895 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008896 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008897 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008898 use: >
8899 :set vb t_vb=
8900< If you want a short flash, you can use this on many terminals: >
8901 :set vb t_vb=[?5h$<100>[?5l
8902< Here $<100> specifies the time, you can use a smaller or bigger value
8903 to get a shorter or longer flash.
8904
8905 Note: Vim will limit the bell to once per half a second. This avoids
8906 having to wait for the flashing to finish when there are lots of
8907 bells, e.g. on key repeat. This also happens without 'visualbell'
8908 set.
8909
Bram Moolenaar071d4272004-06-13 20:20:40 +00008910 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8911 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8912 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008913
8914 Note: When the GUI starts, 't_vb' is reset to its default value. You
8915 might want to set it again in your |gvimrc|.
8916
Bram Moolenaar071d4272004-06-13 20:20:40 +00008917 Does not work on the Amiga, you always get a screen flash.
8918 Also see 'errorbells'.
8919
8920 *'warn'* *'nowarn'*
8921'warn' boolean (default on)
8922 global
8923 Give a warning message when a shell command is used while the buffer
8924 has been changed.
8925
8926 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8927'weirdinvert' 'wiv' boolean (default off)
8928 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008929 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008930 It is provided for backwards compatibility with version 4.x.
8931 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8932 vice versa. Has no effect when the GUI is running.
8933
8934 *'whichwrap'* *'ww'*
8935'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8936 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008937 Allow specified keys that move the cursor left/right to move to the
8938 previous/next line when the cursor is on the first/last character in
8939 the line. Concatenate characters to allow this for these keys:
8940 char key mode ~
8941 b <BS> Normal and Visual
8942 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008943 h "h" Normal and Visual (not recommended)
8944 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008945 < <Left> Normal and Visual
8946 > <Right> Normal and Visual
8947 ~ "~" Normal
8948 [ <Left> Insert and Replace
8949 ] <Right> Insert and Replace
8950 For example: >
8951 :set ww=<,>,[,]
8952< allows wrap only when cursor keys are used.
8953 When the movement keys are used in combination with a delete or change
8954 operator, the <EOL> also counts for a character. This makes "3h"
8955 different from "3dh" when the cursor crosses the end of a line. This
8956 is also true for "x" and "X", because they do the same as "dl" and
8957 "dh". If you use this, you may also want to use the mapping
8958 ":map <BS> X" to make backspace delete the character in front of the
8959 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008960 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008961 line (not an empty line) then it will not move to the next line. This
8962 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008963 NOTE: This option is set to the Vi default value when 'compatible' is
8964 set and to the Vim default value when 'compatible' is reset.
8965
8966 *'wildchar'* *'wc'*
8967'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008969 Character you have to type to start wildcard expansion in the
8970 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008971 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008972 The character is not recognized when used inside a macro. See
8973 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008974 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008975 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008976 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008977< NOTE: This option is set to the Vi default value when 'compatible' is
8978 set and to the Vim default value when 'compatible' is reset.
8979
8980 *'wildcharm'* *'wcm'*
8981'wildcharm' 'wcm' number (default: none (0))
8982 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008983 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008984 recognized when used inside a macro. You can find "spare" command-line
8985 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008986 you'll never actually type 'wildcharm', just use it in mappings that
8987 automatically invoke completion mode, e.g.: >
8988 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008989 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008990< Then after typing :ss you can use CTRL-P & CTRL-N.
8991
8992 *'wildignore'* *'wig'*
8993'wildignore' 'wig' string (default "")
8994 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008995 {not available when compiled without the |+wildignore|
8996 feature}
8997 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008998 patterns is ignored when expanding |wildcards|, completing file or
8999 directory names, and influences the result of |expand()|, |glob()| and
9000 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9002 Also see 'suffixes'.
9003 Example: >
9004 :set wildignore=*.o,*.obj
9005< The use of |:set+=| and |:set-=| is preferred when adding or removing
9006 a pattern from the list. This avoids problems when a future version
9007 uses another default.
9008
Bram Moolenaar94950a92010-12-02 16:01:29 +01009009
Bram Moolenaar81af9252010-12-10 20:35:50 +01009010 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009011'wildignorecase' 'wic' boolean (default off)
9012 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009013 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009014 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009015 Does not apply when the shell is used to expand wildcards, which
9016 happens when there are special characters.
9017
9018
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009020'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009021 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009022 {not available if compiled without the |+wildmenu|
9023 feature}
9024 When 'wildmenu' is on, command-line completion operates in an enhanced
9025 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
9026 the possible matches are shown just above the command line, with the
9027 first match highlighted (overwriting the status line, if there is
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009028 one). This is the behavior without "pum" in 'wildoptions'.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009029 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009030 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9031 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9032 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009033 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009034 If there are more matches than can fit in the line, a ">" is shown on
9035 the right and/or a "<" is shown on the left. The status line scrolls
9036 as needed.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009037 When 'wildoptions' contains "pum", then the completion matches are
9038 shown in a popup menu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009039 The "wildmenu" mode is abandoned when a key is hit that is not used
9040 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009041 While the "wildmenu" is active, not using the popup menu, the
9042 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009043
9044 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9045 <Down> - in filename/menu name completion: move into a
9046 subdirectory or submenu.
9047 <CR> - in menu completion, when the cursor is just after a
9048 dot: move into a submenu.
9049 <Up> - in filename/menu name completion: move up into
9050 parent directory or parent menu.
9051
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009052 When using the popup menu for command line completion, the following
9053 keys have special meanings:
9054 <Down> - select next match (like CTRL-N)
9055 <Left> - in filename/menu name completion: move up into
9056 parent directory or parent menu.
9057 <Right> - in filename/menu name completion: move into a
9058 subdirectory or submenu.
9059 <Up> - select previous match (like CTRL-P)
9060 CTRL-E - end completion, go back to what was there before
9061 selecting a match.
9062 CTRL-N - go to the next entry
9063 CTRL-P - go to the previous entry
9064 CTRL-Y - accept the currently selected match and stop
9065 completion.
9066
Bram Moolenaar071d4272004-06-13 20:20:40 +00009067 This makes the menus accessible from the console |console-menus|.
9068
9069 If you prefer the <Left> and <Right> keys to move the cursor instead
9070 of selecting a different match, use this: >
9071 :cnoremap <Left> <Space><BS><Left>
9072 :cnoremap <Right> <Space><BS><Right>
9073<
9074 The "WildMenu" highlighting is used for displaying the current match
9075 |hl-WildMenu|.
9076
9077 *'wildmode'* *'wim'*
9078'wildmode' 'wim' string (Vim default: "full")
9079 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009081 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009082 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009083 first part specifies the behavior for the first use of 'wildchar',
9084 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009085
9086 Each part consists of a colon separated list consisting of the
9087 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009088 "" Complete only the first match.
9089 "full" Complete the next full match. After the last match,
9090 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009091 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009092 "longest" Complete till longest common string. If this doesn't
9093 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009094 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009095 "lastused" When completing buffer names and more than one buffer
9096 matches, sort buffers by time last used (other than
9097 the current buffer).
9098 When there is only a single match, it is fully completed in all cases.
9099
9100 Examples of useful colon-separated values:
9101 "longest:full" Like "longest", but also start 'wildmenu' if it is
9102 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009103 "list:full" When more than one match, list all matches and
9104 complete first match.
9105 "list:longest" When more than one match, list all matches and
9106 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009107 "list:lastused" When more than one buffer matches, list all matches
9108 and sort buffers by time last used (other than the
9109 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009110
9111 Examples: >
9112 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009113< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009114 :set wildmode=longest,full
9115< Complete longest common string, then each full match >
9116 :set wildmode=list:full
9117< List all matches and complete each full match >
9118 :set wildmode=list,full
9119< List all matches without completing, then each full match >
9120 :set wildmode=longest,list
9121< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009122 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009123
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009124 *'wildoptions'* *'wop'*
9125'wildoptions' 'wop' string (default "")
9126 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009127 {not available when compiled without the |+wildignore|
9128 feature}
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009129 A list of words that change how |cmdline-completion| is done.
9130 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009131 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009132 this value is specified, wildcard expansion will not
9133 be used for completion. The matches will be sorted by
9134 the "best match" rather than alphabetically sorted.
9135 This will find more matches than the wildcard
9136 expansion. Currently fuzzy matching based completion
9137 is not supported for file and directory names and
9138 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009139 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009140 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009141 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009142 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009143 is displayed per line. Often used tag kinds are:
9144 d #define
9145 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009146
Bram Moolenaar071d4272004-06-13 20:20:40 +00009147 *'winaltkeys'* *'wak'*
9148'winaltkeys' 'wak' string (default "menu")
9149 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009150 {only used in Win32, Motif, GTK and Photon GUI}
9151 Some GUI versions allow the access to menu entries by using the ALT
9152 key in combination with a character that appears underlined in the
9153 menu. This conflicts with the use of the ALT key for mappings and
9154 entering special characters. This option tells what to do:
9155 no Don't use ALT keys for menus. ALT key combinations can be
9156 mapped, but there is no automatic handling. This can then be
9157 done with the |:simalt| command.
9158 yes ALT key handling is done by the windowing system. ALT key
9159 combinations cannot be mapped.
9160 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009161 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009162 keys can be mapped.
9163 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9164 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009165 This option is not used for <F10>; on Win32 and with GTK <F10> will
9166 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009167
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009168 *'wincolor'* *'wcr'*
9169'wincolor' 'wcr' string (default empty)
9170 local to window
9171 Highlight group name to use for this window instead of the Normal
9172 color |hl-Normal|.
9173
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009174 *'window'* *'wi'*
9175'window' 'wi' number (default screen height - 1)
9176 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009177 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9178 window and the value is smaller than 'lines' minus one. The screen
9179 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009180 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9181 in a much smarter way, taking care of wrapping lines.
9182 When resizing the Vim window, the value is smaller than 1 or more than
9183 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009184 Note: Do not confuse this with the height of the Vim window, use
9185 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009186
Bram Moolenaar071d4272004-06-13 20:20:40 +00009187 *'winheight'* *'wh'* *E591*
9188'winheight' 'wh' number (default 1)
9189 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009190 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009191 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009192 focus goes to a window that is smaller, its size is increased, at the
9193 cost of the height of other windows.
9194 Set 'winheight' to a small number for normal editing.
9195 Set it to 999 to make the current window fill most of the screen.
9196 Other windows will be only 'winminheight' high. This has the drawback
9197 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9198 to create only two windows, set the option after startup is done,
9199 using the |VimEnter| event: >
9200 au VimEnter * set winheight=999
9201< Minimum value is 1.
9202 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009203 height of the current window.
9204 'winheight' applies to the current window. Use 'winminheight' to set
9205 the minimal height for other windows.
9206
9207 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9208'winfixheight' 'wfh' boolean (default off)
9209 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009210 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009211 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9212 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009213 The height may be changed anyway when running out of room.
9214
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009215 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9216'winfixwidth' 'wfw' boolean (default off)
9217 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009218 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009219 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009220 The width may be changed anyway when running out of room.
9221
Bram Moolenaar071d4272004-06-13 20:20:40 +00009222 *'winminheight'* *'wmh'*
9223'winminheight' 'wmh' number (default 1)
9224 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009225 The minimal height of a window, when it's not the current window.
9226 This is a hard minimum, windows will never become smaller.
9227 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9228 status bar) if necessary. They will return to at least one line when
9229 they become active (since the cursor has to have somewhere to go.)
9230 Use 'winheight' to set the minimal height of the current window.
9231 This option is only checked when making a window smaller. Don't use a
9232 large number, it will cause errors when opening more than a few
9233 windows. A value of 0 to 3 is reasonable.
9234
9235 *'winminwidth'* *'wmw'*
9236'winminwidth' 'wmw' number (default 1)
9237 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009238 The minimal width of a window, when it's not the current window.
9239 This is a hard minimum, windows will never become smaller.
9240 When set to zero, windows may be "squashed" to zero columns (i.e. just
9241 a vertical separator) if necessary. They will return to at least one
9242 line when they become active (since the cursor has to have somewhere
9243 to go.)
9244 Use 'winwidth' to set the minimal width of the current window.
9245 This option is only checked when making a window smaller. Don't use a
9246 large number, it will cause errors when opening more than a few
9247 windows. A value of 0 to 12 is reasonable.
9248
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009249 *'winptydll'*
9250'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9251 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009252 {only available when compiled with the |terminal|
9253 feature on MS-Windows}
9254 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009255 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009256 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009257 a fallback.
9258 Environment variables are expanded |:set_env|.
9259 This option cannot be set from a |modeline| or in the |sandbox|, for
9260 security reasons.
9261
Bram Moolenaar071d4272004-06-13 20:20:40 +00009262 *'winwidth'* *'wiw'* *E592*
9263'winwidth' 'wiw' number (default 20)
9264 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009265 Minimal number of columns for the current window. This is not a hard
9266 minimum, Vim will use fewer columns if there is not enough room. If
9267 the current window is smaller, its size is increased, at the cost of
9268 the width of other windows. Set it to 999 to make the current window
9269 always fill the screen. Set it to a small number for normal editing.
9270 The width is not adjusted after one of the commands to change the
9271 width of the current window.
9272 'winwidth' applies to the current window. Use 'winminwidth' to set
9273 the minimal width for other windows.
9274
9275 *'wrap'* *'nowrap'*
9276'wrap' boolean (default on)
9277 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009278 This option changes how text is displayed. It doesn't change the text
9279 in the buffer, see 'textwidth' for that.
9280 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009281 displaying continues on the next line. When off lines will not wrap
9282 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009283 moved to a part that is not shown, the screen will scroll
9284 horizontally.
9285 The line will be broken in the middle of a word if necessary. See
9286 'linebreak' to get the break at a word boundary.
9287 To make scrolling horizontally a bit more useful, try this: >
9288 :set sidescroll=5
9289 :set listchars+=precedes:<,extends:>
9290< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009291 This option can't be set from a |modeline| when the 'diff' option is
9292 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009293
9294 *'wrapmargin'* *'wm'*
9295'wrapmargin' 'wm' number (default 0)
9296 local to buffer
9297 Number of characters from the right window border where wrapping
9298 starts. When typing text beyond this limit, an <EOL> will be inserted
9299 and inserting continues on the next line.
9300 Options that add a margin, such as 'number' and 'foldcolumn', cause
9301 the text width to be further reduced. This is Vi compatible.
9302 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009303 This option is set to 0 when 'paste' is set and restored when 'paste'
9304 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009305 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009306
9307 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9308'wrapscan' 'ws' boolean (default on) *E384* *E385*
9309 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009310 Searches wrap around the end of the file. Also applies to |]s| and
9311 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009312
9313 *'write'* *'nowrite'*
9314'write' boolean (default on)
9315 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009316 Allows writing files. When not set, writing a file is not allowed.
9317 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009318 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009319 argument. Filtering text is still possible, even though this requires
9320 writing a temporary file.
9321
9322 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9323'writeany' 'wa' boolean (default off)
9324 global
9325 Allows writing to any file with no need for "!" override.
9326
9327 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9328'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9329 otherwise)
9330 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009331 Make a backup before overwriting a file. The backup is removed after
9332 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009333 also on.
9334 WARNING: Switching this option off means that when Vim fails to write
9335 your buffer correctly and then, for whatever reason, Vim exits, you
9336 lose both the original file and what you were writing. Only reset
9337 this option if your file system is almost full and it makes the write
9338 fail (and make sure not to exit Vim until the write was successful).
9339 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009340 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009341 Depending on 'backupcopy' the backup is a new file or the original
9342 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009343 NOTE: This option is set to the default value when 'compatible' is
9344 set.
9345
9346 *'writedelay'* *'wd'*
9347'writedelay' 'wd' number (default 0)
9348 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009349 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009350 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009351 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009352
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009353 *'xtermcodes'* *'noxtermcodes'*
9354'xtermcodes' boolean (default on)
9355 global
9356 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009357 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009358 key codes and number of colors from the terminal. This takes care of
9359 various configuration options of the terminal that cannot be obtained
9360 from the termlib/terminfo entry, see |xterm-codes|.
9361 A side effect may be that t_Co changes and Vim will redraw the
9362 display.
9363
9364
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009365 vim:tw=78:ts=8:noet:ft=help:norl: